First proposal for the structure for pythonsdk based scenarios

Issue-ID: TEST-240

Change-Id: Ic989b26442b868363af7b3872bff49dd70d78be0
Signed-off-by: Michal Jagiello <michal.jagiello@t-mobile.pl>

4 files changed, 376 insertions, 0 deletions

diff --git a/src/onaptests/steps/instantiate/__init__.py b/src/onaptests/steps/instantiate/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/src/onaptests/steps/instantiate/__init__.py
diff --git a/src/onaptests/steps/instantiate/service_ala_carte.py b/src/onaptests/steps/instantiate/service_ala_carte.py
new file mode 100644
index 0000000..dad6563
--- /dev/null
+++ b/src/onaptests/steps/instantiate/service_ala_carte.py
@@ -0,0 +1,168 @@
+import time
+from uuid import uuid4
+from yaml import load
+
+from onapsdk.aai.cloud_infrastructure import CloudRegion, Tenant
+from onapsdk.aai.business import Customer
+from onapsdk.aai.business.owning_entity import OwningEntity as AaiOwningEntity
+from onapsdk.configuration import settings
+from onapsdk.sdc.service import Service
+from onapsdk.so.instantiation import ServiceInstantiation
+from onapsdk.vid import Project
+
+from ..base import BaseStep, YamlTemplateBaseStep
+from ..cloud.connect_service_subscription_to_cloud_region import ConnectServiceSubToCloudRegionStep
+from ..onboard.service import ServiceOnboardStep, YamlTemplateServiceOnboardStep
+
+
+class ServiceAlaCarteInstantiateStep(BaseStep):
+    """Instantiate service a'la carte."""
+
+    def __init__(self, cleanup=False):
+        """Initialize step.
+
+        Substeps:
+            - ServiceOnboardStep,
+            - ConnectServiceSubToCloudRegionStep.
+        """
+        super().__init__(cleanup=cleanup)
+        self.add_step(ServiceOnboardStep(cleanup))
+        self.add_step(ConnectServiceSubToCloudRegionStep(cleanup))
+
+    def execute(self):
+        """Instantiate service.
+
+        Use settings values:
+         - SERVICE_NAME,
+         - GLOBAL_CUSTOMER_ID,
+         - CLOUD_REGION_CLOUD_OWNER,
+         - CLOUD_REGION_ID,
+         - TENANT_ID,
+         - OWNING_ENTITY,
+         - PROJECT,
+         - SERVICE_INSTANCE_NAME.
+        """
+        super().execute()
+        service = Service(settings.SERVICE_NAME)
+        customer: Customer = Customer.get_by_global_customer_id(settings.GLOBAL_CUSTOMER_ID)
+        cloud_region: CloudRegion = CloudRegion.get_by_id(
+            cloud_owner=settings.CLOUD_REGION_CLOUD_OWNER,
+            cloud_region_id=settings.CLOUD_REGION_ID,
+        )
+        tenant: Tenant = cloud_region.get_tenant(settings.TENANT_ID)
+        owning_entity = AaiOwningEntity.get_by_owning_entity_name(settings.OWNING_ENTITY)
+        vid_project = Project.create(settings.PROJECT)
+
+        service_instantiation = ServiceInstantiation.instantiate_so_ala_carte(
+            service,
+            cloud_region,
+            tenant,
+            customer,
+            owning_entity,
+            vid_project,
+            service_instance_name=settings.SERVICE_INSTANCE_NAME
+        )
+        while not service_instantiation.finished:
+            time.sleep(10)
+
+
+class YamlTemplateServiceAlaCarteInstantiateStep(YamlTemplateBaseStep):
+    """Instantiate service a'la carte using YAML template."""
+
+    def __init__(self, cleanup=False):
+        """Initialize step.
+
+        Substeps:
+            - YamlTemplateServiceOnboardStep,
+            - ConnectServiceSubToCloudRegionStep.
+        """
+        super().__init__(cleanup=cleanup)
+        self._yaml_template: dict = None
+        self.add_step(YamlTemplateServiceOnboardStep(cleanup))
+        self.add_step(ConnectServiceSubToCloudRegionStep(cleanup))
+
+    @property
+    def yaml_template(self) -> dict:
+        """Step YAML template.
+
+        Load from file if it's a root step, get from parent otherwise.
+
+        Returns:
+            dict: Step YAML template
+
+        """
+        if self.is_root:
+            if not self._yaml_template:
+                with open(settings.SERVICE_YAML_TEMPLATE, "r") as yaml_template:
+                    self._yaml_template: dict = load(yaml_template)
+            return self._yaml_template
+        return self.parent.yaml_template
+
+    @property
+    def service_name(self) -> str:
+        """Service name.
+
+        Get from YAML template if it's a root step, get from parent otherwise.
+
+        Returns:
+            str: Service name
+
+        """
+        if self.is_root:
+            return next(iter(self.yaml_template.keys()))
+        return self.parent.service_name
+
+    @property
+    def service_instance_name(self) -> str:
+        """Service instance name.
+
+        Generate using `service_name` and `uuid4()` function if it's a root step,
+            get from parent otherwise.
+
+        Returns:
+            str: Service instance name
+
+        """
+        if self.is_root:
+            return f"{self.service_name}-{str(uuid4())}"
+        return self.parent.service_instance_name
+
+    def execute(self):
+        """Instantiate service.
+
+        Use settings values:
+         - GLOBAL_CUSTOMER_ID,
+         - CLOUD_REGION_CLOUD_OWNER,
+         - CLOUD_REGION_ID,
+         - TENANT_ID,
+         - OWNING_ENTITY,
+         - PROJECT.
+
+        Raises:
+            Exception: Service instantiation failed
+
+        """
+        super().execute()
+        service = Service(self.service_name)
+        customer: Customer = Customer.get_by_global_customer_id(settings.GLOBAL_CUSTOMER_ID)
+        cloud_region: CloudRegion = CloudRegion.get_by_id(
+            cloud_owner=settings.CLOUD_REGION_CLOUD_OWNER,
+            cloud_region_id=settings.CLOUD_REGION_ID,
+        )
+        tenant: Tenant = cloud_region.get_tenant(settings.TENANT_ID)
+        owning_entity = AaiOwningEntity.get_by_owning_entity_name(settings.OWNING_ENTITY)
+        vid_project = Project.create(settings.PROJECT)
+
+        service_instantiation = ServiceInstantiation.instantiate_so_ala_carte(
+            service,
+            cloud_region,
+            tenant,
+            customer,
+            owning_entity,
+            vid_project,
+            service_instance_name=self.service_instance_name
+        )
+        while not service_instantiation.finished:
+            time.sleep(10)
+        if service_instantiation.failed:
+            raise Exception("Service instantiation failed")
diff --git a/src/onaptests/steps/instantiate/vf_module_ala_carte.py b/src/onaptests/steps/instantiate/vf_module_ala_carte.py
new file mode 100644
index 0000000..fd4b368
--- /dev/null
+++ b/src/onaptests/steps/instantiate/vf_module_ala_carte.py
@@ -0,0 +1,112 @@
+import time
+from typing import Iterable
+from uuid import uuid4
+from yaml import load
+
+from onapsdk.aai.business import Customer, ServiceInstance, ServiceSubscription
+from onapsdk.configuration import settings
+from onapsdk.so.instantiation import VnfParameter
+
+from ..base import YamlTemplateBaseStep
+from .vnf_ala_carte import YamlTemplateVnfAlaCarteInstantiateStep
+
+
+class YamlTemplateVfModuleAlaCarteInstantiateStep(YamlTemplateBaseStep):
+    """Instantiate vf module a'la carte using YAML template."""
+
+    def __init__(self, cleanup=False):
+        """Initialize step.
+
+        Substeps:
+            - YamlTemplateVnfAlaCarteInstantiateStep.
+        """
+        super().__init__(cleanup=cleanup)
+        self._yaml_template: dict = None
+        self.add_step(YamlTemplateVnfAlaCarteInstantiateStep(cleanup))
+
+    @property
+    def yaml_template(self) -> dict:
+        """Step YAML template.
+
+        Load from file if it's a root step, get from parent otherwise.
+
+        Returns:
+            dict: Step YAML template
+
+        """
+        if self.is_root:
+            if not self._yaml_template:
+                with open(settings.SERVICE_YAML_TEMPLATE, "r") as yaml_template:
+                    self._yaml_template: dict = load(yaml_template)
+            return self._yaml_template
+        return self.parent.yaml_template
+
+    @property
+    def service_name(self) -> str:
+        """Service name.
+
+        Get from YAML template if it's a root step, get from parent otherwise.
+
+        Returns:
+            str: Service name
+
+        """
+        if self.is_root:
+            return next(iter(self.yaml_template.keys()))
+        return self.parent.service_name
+
+    @property
+    def service_instance_name(self) -> str:
+        """Service instance name.
+
+        Generate using `service_name` and `uuid4()` function if it's a root step,
+            get from parent otherwise.
+
+        Returns:
+            str: Service instance name
+
+        """
+        if self.is_root:
+            return f"{self.service_name}-{str(uuid4())}"
+        return self.parent.service_instance_name
+
+    def get_vnf_parameters(self, vnf_name: str) -> Iterable[VnfParameter]:
+        """Get VNF parameters from YAML template.
+
+        Args:
+            vnf_name (str): VNF name to get parameters for.
+
+        Yields:
+            Iterator[Iterable[VnfParameter]]: VNF parameter
+
+        """
+        for vnf in self.yaml_template[self.service_name]["vnfs"]:
+            if vnf["vnf_name"] == vnf_name:
+                for vnf_parameter in vnf["vnf_parameters"]:
+                    yield VnfParameter(
+                        name=vnf_parameter["name"],
+                        value=vnf_parameter["value"]
+                    )
+
+    def execute(self) -> None:
+        """Instantiate Vf module.
+
+        Use settings values:
+         - GLOBAL_CUSTOMER_ID.
+
+        Raises:
+            Exception: Vf module instantiation failed
+
+        """
+        super().execute()
+        customer: Customer = Customer.get_by_global_customer_id(settings.GLOBAL_CUSTOMER_ID)
+        service_subscription: ServiceSubscription = customer.get_service_subscription_by_service_type(self.service_name)
+        service_instance: ServiceInstance = service_subscription.get_service_instance_by_name(self.service_instance_name)
+        for vnf_instance in service_instance.vnf_instances:
+            vf_module_instantiation = vnf_instance.add_vf_module(
+                vnf_instance.vnf.vf_module,
+                vnf_parameters= self.get_vnf_parameters(vnf_instance.vnf.vnf_name))
+            while not vf_module_instantiation.finished:
+                time.sleep(10)
+            if vf_module_instantiation.failed:
+                raise Exception("Vf module instantiation failed")
diff --git a/src/onaptests/steps/instantiate/vnf_ala_carte.py b/src/onaptests/steps/instantiate/vnf_ala_carte.py
new file mode 100644
index 0000000..116b574
--- /dev/null
+++ b/src/onaptests/steps/instantiate/vnf_ala_carte.py
@@ -0,0 +1,96 @@
+import time
+from uuid import uuid4
+from yaml import load
+
+from onapsdk.aai.business import Customer, ServiceInstance, ServiceSubscription
+from onapsdk.configuration import settings
+from onapsdk.sdc.service import Service
+from onapsdk.vid import LineOfBusiness, Platform
+
+from ..base import YamlTemplateBaseStep
+from .service_ala_carte import YamlTemplateServiceAlaCarteInstantiateStep
+
+
+class YamlTemplateVnfAlaCarteInstantiateStep(YamlTemplateBaseStep):
+    """Instantiate vnf a'la carte using YAML template."""
+
+    def __init__(self, cleanup=False):
+        """Initialize step.
+
+        Substeps:
+            - YamlTemplateServiceAlaCarteInstantiateStep.
+        """
+        super().__init__(cleanup=cleanup)
+        self._yaml_template: dict = None
+        self.add_step(YamlTemplateServiceAlaCarteInstantiateStep(cleanup))
+
+    @property
+    def yaml_template(self) -> dict:
+        """Step YAML template.
+
+        Load from file if it's a root step, get from parent otherwise.
+
+        Returns:
+            dict: Step YAML template
+
+        """
+        if self.is_root:
+            if not self._yaml_template:
+                with open(settings.SERVICE_YAML_TEMPLATE, "r") as yaml_template:
+                    self._yaml_template: dict = load(yaml_template)
+            return self._yaml_template
+        return self.parent.yaml_template
+
+    @property
+    def service_name(self) -> str:
+        """Service name.
+
+        Get from YAML template if it's a root step, get from parent otherwise.
+
+        Returns:
+            str: Service name
+
+        """
+        if self.is_root:
+            return next(iter(self.yaml_template.keys()))
+        return self.parent.service_name
+
+    @property
+    def service_instance_name(self) -> str:
+        """Service instance name.
+
+        Generate using `service_name` and `uuid4()` function if it's a root step,
+            get from parent otherwise.
+
+        Returns:
+            str: Service instance name
+
+        """
+        if self.is_root:
+            return f"{self.service_name}-{str(uuid4())}"
+        return self.parent.service_instance_name
+
+    def execute(self):
+        """Instantiate vnf.
+
+        Use settings values:
+         - GLOBAL_CUSTOMER_ID,
+         - LINE_OF_BUSINESS.
+
+        Raises:
+            Exception: VNF instantiation failed
+
+        """
+        super().execute()
+        service: Service = Service(self.service_name)
+        customer: Customer = Customer.get_by_global_customer_id(settings.GLOBAL_CUSTOMER_ID)
+        service_subscription: ServiceSubscription = customer.get_service_subscription_by_service_type(self.service_name)
+        service_instance: ServiceInstance = service_subscription.get_service_instance_by_name(self.service_instance_name)
+        line_of_business: LineOfBusiness = LineOfBusiness(settings.LINE_OF_BUSINESS)
+        platform: Platform = Platform(settings.PLATFORM)
+        for idx, vnf in service.vnfs:
+            vnf_instantiation = service_instance.add_vnf(vnf, line_of_business, platform, f"{self.service_instance_name}_vnf_{idx}")
+            while not vnf_instantiation.finished:
+                time.sleep(10)
+            if vnf_instantiation.failed:
+                raise Exception("Vnf instantiation failed")