add node product

Author: hanstrompert

.gitignore

@@ -1 +1,4 @@
 .python-version
+.DS_Store
+.idea/
+__pycache__/

alembic.ini

@@ -0,0 +1,45 @@
+# A generic, single database configuration.
+
+[alembic]
+# template used to generate migration files
+file_template = %%(year)d-%%(month).2d-%%(day).2d_%%(rev)s_%%(slug)s
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+script_location = migrations
+version_locations = %(here)s/migrations/versions/schema
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

main.py

@@ -2,6 +2,9 @@
 from orchestrator.cli.main import app as core_cli
 from orchestrator.settings import AppSettings
 
+import products  # noqa: F401  Side-effects
+import workflows  # noqa: F401  Side-effects
+
 app = OrchestratorCore(base_settings=AppSettings())
 
 if __name__ == "__main__":

migrations/env.py

@@ -0,0 +1,92 @@
+import logging
+import os
+from alembic import context
+from sqlalchemy import engine_from_config, pool
+
+import orchestrator
+from orchestrator.db.database import BaseModel
+from orchestrator.settings import app_settings
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+logger = logging.getLogger("alembic.env")
+
+config.set_main_option("sqlalchemy.url", app_settings.DATABASE_URI)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = BaseModel.metadata
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url, target_metadata=target_metadata, literal_binds=True, dialect_opts={"paramstyle": "named"}
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+
+    # this callback is used to prevent an auto-migration from being generated
+    # when there are no changes to the schema
+    # reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html
+    def process_revision_directives(context, revision, directives):  # type: ignore
+        if getattr(config.cmd_opts, "autogenerate", False):
+            script = directives[0]
+            if script.upgrade_ops.is_empty():
+                directives[:] = []
+                logger.info("No changes in schema detected.")
+
+    engine = engine_from_config(
+        config.get_section(config.config_ini_section), prefix="sqlalchemy.", poolclass=pool.NullPool
+    )
+
+    connection = engine.connect()
+    context.configure(
+        connection=connection,
+        target_metadata=target_metadata,
+        process_revision_directives=process_revision_directives,
+        compare_type=True,
+    )
+    try:
+        with context.begin_transaction():
+            context.run_migrations()
+    finally:
+        connection.close()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

migrations/helpers.py

@@ -0,0 +1,3 @@
+from orchestrator.migrations.helpers import *
+
+# Write your own helper functions below this line.

migrations/script.py.mako

@@ -0,0 +1,23 @@
+"""${message}.
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+import sqlalchemy as sa
+from alembic import op
+${imports if imports else ""}
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+branch_labels = ${repr(branch_labels)}
+depends_on = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

migrations/versions/schema/2023-10-24_a77227fe5455_create_data_head.py

@@ -0,0 +1,21 @@
+"""Create data head.
+
+Revision ID: a77227fe5455
+Revises:
+Create Date: 2023-10-24T15:39:44.415922
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = "a77227fe5455"
+down_revision = None
+branch_labels = ("data",)
+depends_on = "da5c9f4cce1c"
+
+
+def upgrade() -> None:
+    pass
+
+
+def downgrade() -> None:
+    pass

migrations/versions/schema/2023-10-24_c580416cfd12_add_node.py

@@ -0,0 +1,120 @@
+"""Add node product.
+
+Revision ID: c580416cfd12
+Revises: a77227fe5455
+Create Date: 2023-10-24 15:39:47.037726
+
+"""
+from uuid import uuid4
+
+from alembic import op
+from orchestrator.migrations.helpers import (
+    create,
+    create_workflow,
+    delete,
+    delete_workflow,
+    ensure_default_workflows,
+)
+from orchestrator.targets import Target
+
+# revision identifiers, used by Alembic.
+revision = "c580416cfd12"
+down_revision = "a77227fe5455"
+branch_labels = None
+depends_on = None
+
+new_products = {
+    "products": {
+        "node Cisco": {
+            "product_id": uuid4(),
+            "product_type": "Node",
+            "description": "Network node",
+            "tag": "NODE",
+            "status": "active",
+            "product_blocks": [
+                "Node",
+            ],
+            "fixed_inputs": {
+                "node_type": "Cisco",
+            },
+        },
+        "node Nokia": {
+            "product_id": uuid4(),
+            "product_type": "Node",
+            "description": "Network node",
+            "tag": "NODE",
+            "status": "active",
+            "product_blocks": [
+                "Node",
+            ],
+            "fixed_inputs": {
+                "node_type": "Nokia",
+            },
+        },
+    },
+    "product_blocks": {
+        "Node": {
+            "product_block_id": uuid4(),
+            "description": "node product block",
+            "tag": "NODE",
+            "status": "active",
+            "resources": {
+                "node_name": "Unique name of the node",
+                "role": "Role of the node in the network",
+                "node_description": "Description of the node",
+                "type": "Type of the node",
+                "site": "Site where the node is located",
+                "status": "Operational status of the node",
+                "ims_id": "ID of the node in the inventory management system",
+                "nrm_id": "ID of the node in the network resource manager",
+                "ipv4_ipam_id": "ID of the node’s iPv4 loopback address in IPAM",
+                "ipv6_ipam_id": "ID of the node’s iPv6 loopback address in IPAM",
+            },
+            "depends_on_block_relations": [],
+        },
+    },
+    "workflows": {},
+}
+
+new_workflows = [
+    {
+        "name": "create_node",
+        "target": Target.CREATE,
+        "description": "Create node",
+        "product_type": "Node",
+    },
+    {
+        "name": "modify_node",
+        "target": Target.MODIFY,
+        "description": "Modify node",
+        "product_type": "Node",
+    },
+    {
+        "name": "terminate_node",
+        "target": Target.TERMINATE,
+        "description": "Terminate node",
+        "product_type": "Node",
+    },
+    {
+        "name": "validate_node",
+        "target": Target.SYSTEM,
+        "description": "Validate node",
+        "product_type": "Node",
+    },
+]
+
+
+def upgrade() -> None:
+    conn = op.get_bind()
+    create(conn, new_products)
+    for workflow in new_workflows:
+        create_workflow(conn, workflow)
+    ensure_default_workflows(conn)
+
+
+def downgrade() -> None:
+    conn = op.get_bind()
+    for workflow in new_workflows:
+        delete_workflow(conn, workflow["name"])
+
+    delete(conn, new_products)

products/__init__.py

@@ -0,0 +1,10 @@
+from orchestrator.domain import SUBSCRIPTION_MODEL_REGISTRY
+
+from products.product_types.node import Node
+
+SUBSCRIPTION_MODEL_REGISTRY.update(
+    {
+        "node Cisco": Node,
+        "node Nokia": Node,
+        }
+)  # fmt:skip