Extend OCL to have service provider details.

eclipse-xpanse · Jan 17, 2024 · 525476c · 525476c
1 parent 0de5f91
commit 525476c
Show file tree

Hide file tree

Showing 20 changed files with 126 additions and 8 deletions.
diff --git a/modules/api/src/main/java/org/eclipse/xpanse/api/controllers/ServiceTemplateApi.java b/modules/api/src/main/java/org/eclipse/xpanse/api/controllers/ServiceTemplateApi.java
@@ -217,7 +217,7 @@ public List<ServiceTemplateDetailVo> listServiceTemplates(
             @RequestParam(name = "serviceVersion", required = false) String serviceVersion,
             @Parameter(name = "serviceHostingType", description = "who hosts ths cloud resources")
             @RequestParam(name = "serviceHostingType", required = false)
-            ServiceHostingType serviceHostingType) {
+                    ServiceHostingType serviceHostingType) {
         ServiceTemplateQueryModel query = getServiceTemplateQueryModel(
                 categoryName, cspName, serviceName, serviceVersion, serviceHostingType);
         List<ServiceTemplateEntity> serviceEntities =
@@ -309,6 +309,8 @@ private ServiceTemplateDetailVo convertToServiceTemplateDetailVo(
                             .openApi(serviceTemplateEntity.getId().toString())).withRel("openApi"));
             serviceTemplateDetailVo.setServiceHostingType(
                     serviceTemplateEntity.getServiceHostingType());
+            serviceTemplateDetailVo.setServiceProviderContactDetails(
+                    serviceTemplateDetailVo.getServiceProviderContactDetails());
             return serviceTemplateDetailVo;
         }
         return null;

diff --git a/.../main/java/org/eclipse/xpanse/modules/database/servicetemplate/ServiceTemplateEntity.java b/.../main/java/org/eclipse/xpanse/modules/database/servicetemplate/ServiceTemplateEntity.java
@@ -29,6 +29,7 @@
 import org.eclipse.xpanse.modules.models.service.common.enums.Category;
 import org.eclipse.xpanse.modules.models.service.common.enums.Csp;
 import org.eclipse.xpanse.modules.models.servicetemplate.Ocl;
+import org.eclipse.xpanse.modules.models.servicetemplate.ServiceProviderContactDetails;
 import org.eclipse.xpanse.modules.models.servicetemplate.enums.ServiceHostingType;
 import org.eclipse.xpanse.modules.models.servicetemplate.enums.ServiceRegistrationState;
 import org.eclipse.xpanse.modules.models.servicetemplate.utils.JsonObjectSchema;
@@ -83,6 +84,11 @@ public class ServiceTemplateEntity extends CreateModifiedTime {
     @Enumerated(EnumType.STRING)
     private ServiceRegistrationState serviceRegistrationState;
 
+    @Column(name = "SERVICE_PROVIDER_CONTACT_DETAILS", columnDefinition = "json", nullable = false)
+    @Type(value = JsonType.class)
+    @Convert(converter = ObjectJsonConverter.class)
+    private ServiceProviderContactDetails serviceProviderContactDetails;
+
     @Column(name = "SERVICE_VARIABLES_JSON_SCHEMA", columnDefinition = "json", nullable = false)
     @Type(value = JsonType.class)
     @Convert(converter = ObjectJsonConverter.class)

diff --git a/...t/java/org/eclipse/xpanse/modules/database/servicetemplate/ServiceTemplateEntityTest.java b/...t/java/org/eclipse/xpanse/modules/database/servicetemplate/ServiceTemplateEntityTest.java
@@ -15,6 +15,7 @@
 import org.eclipse.xpanse.modules.models.service.common.enums.Csp;
 import org.eclipse.xpanse.modules.models.service.utils.ServiceVariablesJsonSchemaGenerator;
 import org.eclipse.xpanse.modules.models.servicetemplate.Ocl;
+import org.eclipse.xpanse.modules.models.servicetemplate.ServiceProviderContactDetails;
 import org.eclipse.xpanse.modules.models.servicetemplate.enums.ServiceRegistrationState;
 import org.eclipse.xpanse.modules.models.servicetemplate.utils.JsonObjectSchema;
 import org.eclipse.xpanse.modules.models.servicetemplate.utils.OclLoader;
@@ -32,6 +33,7 @@ class ServiceTemplateEntityTest {
             ServiceRegistrationState.REGISTERED;
     private Ocl ocl;
     private JsonObjectSchema jsonObjectSchema;
+    private ServiceProviderContactDetails serviceProviderContactDetails;
 
     private ServiceTemplateEntity test;
 
@@ -54,6 +56,7 @@ void setUp() throws Exception {
         test.setOcl(ocl);
         test.setServiceRegistrationState(SERVICE_STATE);
         test.setJsonObjectSchema(jsonObjectSchema);
+        test.setServiceProviderContactDetails(serviceProviderContactDetails);
     }
 
     @Test
@@ -68,6 +71,7 @@ void testToString() {
                         + "serviceHostingType=null" + ", "
                         + "ocl=" + ocl + ", "
                         + "serviceRegistrationState=" + SERVICE_STATE + ", "
+                        + "serviceProviderContactDetails=" + serviceProviderContactDetails + ", "
                         + "jsonObjectSchema=" + jsonObjectSchema + ")";
         assertEquals(expectedToString, test.toString());
     }
@@ -145,6 +149,13 @@ void testEqualsAndHashCode() {
         assertNotEquals(test.hashCode(), test1.hashCode());
         assertNotEquals(test1.hashCode(), test2.hashCode());
 
+        test1.setServiceProviderContactDetails(serviceProviderContactDetails);
+        assertNotEquals(test, test1);
+        assertNotEquals(test, test2);
+        assertNotEquals(test1, test2);
+        assertNotEquals(test.hashCode(), test1.hashCode());
+        assertNotEquals(test1.hashCode(), test2.hashCode());
+
         test1.setJsonObjectSchema(jsonObjectSchema);
         assertEquals(test, test1);
         assertNotEquals(test, test2);

diff --git a/modules/models/src/main/java/org/eclipse/xpanse/modules/models/servicetemplate/Ocl.java b/modules/models/src/main/java/org/eclipse/xpanse/modules/models/servicetemplate/Ocl.java
@@ -98,6 +98,11 @@ public class Ocl implements Serializable {
             + "for deploying cloud resources.")
     private ServiceHostingType serviceHostingType;
 
+    @Valid
+    @NotNull
+    @Schema(description = "The contact details of the service provider.")
+    private ServiceProviderContactDetails serviceProviderContactDetails;
+
     /**
      * an OCL object might be passed to different plugins for processing, in case any plugin want to
      * change the property of Ocl, we should not change the original Object, we should change a deep

diff --git a/...java/org/eclipse/xpanse/modules/models/servicetemplate/ServiceProviderContactDetails.java b/...java/org/eclipse/xpanse/modules/models/servicetemplate/ServiceProviderContactDetails.java
@@ -0,0 +1,39 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * SPDX-FileCopyrightText: Huawei Inc.
+ */
+
+package org.eclipse.xpanse.modules.models.servicetemplate;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.Size;
+import java.util.List;
+import lombok.Data;
+
+/**
+ * The contact details of the Cloud Service Provider.
+ */
+@Data
+public class ServiceProviderContactDetails {
+
+    @Valid
+    @Size(min = 1)
+    @Schema(description = "The email details of the service provider.")
+    private List<String> email;
+
+    @Valid
+    @Size(min = 1)
+    @Schema(description = "The phone details of the service provider.")
+    private List<String> phone;
+
+    @Valid
+    @Size(min = 1)
+    @Schema(description = "The chat details of the service provider.")
+    private List<String> chat;
+
+    @Valid
+    @Size(min = 1)
+    @Schema(description = "The website details of the service provider.")
+    private List<String> website;
+}
diff --git a/.../java/org/eclipse/xpanse/modules/models/servicetemplate/view/ServiceTemplateDetailVo.java b/.../java/org/eclipse/xpanse/modules/models/servicetemplate/view/ServiceTemplateDetailVo.java
@@ -26,6 +26,7 @@
 import org.eclipse.xpanse.modules.models.servicetemplate.Deployment;
 import org.eclipse.xpanse.modules.models.servicetemplate.Flavor;
 import org.eclipse.xpanse.modules.models.servicetemplate.Region;
+import org.eclipse.xpanse.modules.models.servicetemplate.ServiceProviderContactDetails;
 import org.eclipse.xpanse.modules.models.servicetemplate.enums.ServiceHostingType;
 import org.eclipse.xpanse.modules.models.servicetemplate.enums.ServiceRegistrationState;
 import org.springframework.hateoas.RepresentationModel;
@@ -117,4 +118,8 @@ public class ServiceTemplateDetailVo extends RepresentationModel<ServiceTemplate
     @Schema(description = "State of registered service.")
     private ServiceRegistrationState serviceRegistrationState;
 
+    @NotNull
+    @Schema(description = "The contact details of the service provider.")
+    private ServiceProviderContactDetails serviceProviderContactDetails;
+
 }
diff --git a/modules/models/src/test/java/org/eclipse/xpanse/modules/models/servicetemplate/OclTest.java b/modules/models/src/test/java/org/eclipse/xpanse/modules/models/servicetemplate/OclTest.java
@@ -36,6 +36,7 @@ class OclTest {
     private static List<Flavor> flavors;
     private static Billing billing;
     private static Ocl ocl;
+    private static  ServiceProviderContactDetails serviceProviderContactDetails;
     private static final ServiceHostingType serviceHostingType = ServiceHostingType.SELF;
 
     @BeforeEach
@@ -72,6 +73,7 @@ void setUp() {
         ocl.setFlavors(flavors);
         ocl.setBilling(billing);
         ocl.setServiceHostingType(serviceHostingType);
+        ocl.setServiceProviderContactDetails(serviceProviderContactDetails);
     }
 
     @Test
@@ -105,6 +107,7 @@ public void testDeepCopy() {
         assertNotSame(ocl.getDeployment(), aCopy.getDeployment());
         assertEquals(ocl.getDeployment().getKind(), aCopy.getDeployment().getKind());
         assertEquals(ocl.getServiceHostingType(), aCopy.getServiceHostingType());
+        assertEquals(ocl.getServiceProviderContactDetails(), aCopy.getServiceProviderContactDetails());
     }
 
     @Test
@@ -187,6 +190,7 @@ public void testEqualsAndHashCode() {
 
         ocl1.setBilling(billing);
         ocl1.setServiceHostingType(ServiceHostingType.SELF);
+        ocl1.setServiceProviderContactDetails(serviceProviderContactDetails);
         assertEquals(ocl, ocl1);
         assertNotEquals(ocl1, ocl2);
         assertEquals(ocl.hashCode(), ocl1.hashCode());
@@ -207,7 +211,8 @@ void testToString() {
                 ", deployment=" + deployment +
                 ", flavors=" + flavors +
                 ", billing=" + billing +
-                ", serviceHostingType=" +  serviceHostingType +
+                ", serviceHostingType=" + serviceHostingType +
+                ", serviceProviderContactDetails=" +  serviceProviderContactDetails +
                 ")";
 
         assertEquals(expectedString, ocl.toString());

diff --git a/...a/org/eclipse/xpanse/modules/models/servicetemplate/view/ServiceTemplateDetailVoTest.java b/...a/org/eclipse/xpanse/modules/models/servicetemplate/view/ServiceTemplateDetailVoTest.java
@@ -20,6 +20,7 @@
 import org.eclipse.xpanse.modules.models.servicetemplate.Deployment;
 import org.eclipse.xpanse.modules.models.servicetemplate.Flavor;
 import org.eclipse.xpanse.modules.models.servicetemplate.Region;
+import org.eclipse.xpanse.modules.models.servicetemplate.ServiceProviderContactDetails;
 import org.eclipse.xpanse.modules.models.servicetemplate.enums.ServiceHostingType;
 import org.eclipse.xpanse.modules.models.servicetemplate.enums.ServiceRegistrationState;
 import org.junit.jupiter.api.BeforeEach;
@@ -43,6 +44,7 @@ class ServiceTemplateDetailVoTest {
     private static final OffsetDateTime lastModifiedTime = OffsetDateTime.now();
     private static final ServiceRegistrationState serviceRegistrationState =
             ServiceRegistrationState.REGISTERED;
+    private static ServiceProviderContactDetails serviceProviderContactDetails;
     private static List<@Valid Region> regions;
     private static List<@Valid DeployVariable> variables;
     private static List<@Valid Flavor> flavors;
@@ -85,6 +87,7 @@ void setUp() {
         serviceTemplateDetailVo.setLastModifiedTime(lastModifiedTime);
         serviceTemplateDetailVo.setServiceRegistrationState(serviceRegistrationState);
         serviceTemplateDetailVo.setServiceHostingType(ServiceHostingType.SERVICE_VENDOR);
+        serviceTemplateDetailVo.setServiceProviderContactDetails(serviceProviderContactDetails);
     }
 
     @Test
@@ -105,7 +108,10 @@ void testGetterAndSetter() {
         assertEquals(lastModifiedTime, serviceTemplateDetailVo.getLastModifiedTime());
         assertEquals(serviceRegistrationState,
                 serviceTemplateDetailVo.getServiceRegistrationState());
-        assertEquals(ServiceHostingType.SERVICE_VENDOR, serviceTemplateDetailVo.getServiceHostingType());
+        assertEquals(ServiceHostingType.SERVICE_VENDOR,
+                serviceTemplateDetailVo.getServiceHostingType());
+        assertEquals(serviceProviderContactDetails,
+                serviceTemplateDetailVo.getServiceProviderContactDetails());
     }
 
     @Test
@@ -218,6 +224,7 @@ public void testEqualsAndHashCode() {
 
         serviceTemplateDetailVo1.setServiceRegistrationState(serviceRegistrationState);
         serviceTemplateDetailVo1.setServiceHostingType(ServiceHostingType.SERVICE_VENDOR);
+        serviceTemplateDetailVo1.setServiceProviderContactDetails(serviceProviderContactDetails);
         assertEquals(serviceTemplateDetailVo, serviceTemplateDetailVo1);
         assertNotEquals(serviceTemplateDetailVo1, serviceTemplateDetailVo2);
         assertEquals(serviceTemplateDetailVo.hashCode(), serviceTemplateDetailVo1.hashCode());
@@ -243,7 +250,8 @@ void testToString() {
                 "serviceHostingType=" + ServiceHostingType.SERVICE_VENDOR + ", " +
                 "createTime=" + createTime + ", " +
                 "lastModifiedTime=" + lastModifiedTime + ", " +
-                "serviceRegistrationState=" + serviceRegistrationState + ")";
+                "serviceRegistrationState=" + serviceRegistrationState + ", " +
+                "serviceProviderContactDetails=" + serviceProviderContactDetails + ")";
 
         assertEquals(expectedToString, serviceTemplateDetailVo.toString());
     }

diff --git a/...ator/src/test/java/org/eclipse/xpanse/modules/orchestrator/deployment/DeployTaskTest.java b/...ator/src/test/java/org/eclipse/xpanse/modules/orchestrator/deployment/DeployTaskTest.java
@@ -9,6 +9,7 @@
 import org.eclipse.xpanse.modules.models.service.common.enums.Csp;
 import org.eclipse.xpanse.modules.models.service.deploy.DeployRequest;
 import org.eclipse.xpanse.modules.models.servicetemplate.Ocl;
+import org.eclipse.xpanse.modules.models.servicetemplate.ServiceProviderContactDetails;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
@@ -18,12 +19,15 @@ class DeployTaskTest {
     DeployResourceHandler handler = deployResult -> {
     };
     Ocl ocl = new Ocl();
+    ServiceProviderContactDetails serviceProviderContactDetails =
+            new ServiceProviderContactDetails();
     DeployRequest deployRequest = new DeployRequest();
     private DeployTask test;
 
     @BeforeEach
     void setUp() {
         test = new DeployTask();
+        ocl.setServiceProviderContactDetails(null);
         test.setId(id);
         test.setOcl(ocl);
         test.setDeployRequest(deployRequest);
@@ -108,10 +112,12 @@ void testToString() {
                 + "namespace=null, "
                 + "deployRequest=DeployRequest(super=DeployRequestBase(userId=null, category=null, "
                 + "serviceName=null, customerServiceName=null, version=null, region=null, "
-                + "csp=null, flavor=null, serviceHostingType=null, ocl=null, serviceRequestProperties=null), id=null),"
-                + " ocl=Ocl(category=null, version=null, name=null, serviceVersion=null, "
-                + "description=null, namespace=null, icon=null, cloudServiceProvider=null, "
-                + "deployment=null, flavors=null, billing=null, serviceHostingType=null), deployResourceHandler=null, serviceTemplateId=null)";
+                + "csp=null, flavor=null, serviceHostingType=null, ocl=null, "
+                + "serviceRequestProperties=null), id=null), ocl=Ocl(category=null, version=null, "
+                + "name=null, serviceVersion=null, description=null, namespace=null, icon=null, "
+                + "cloudServiceProvider=null, deployment=null, flavors=null, billing=null, "
+                + "serviceHostingType=null, serviceProviderContactDetails=null), "
+                + "deployResourceHandler=null, serviceTemplateId=null)";
         assertEquals(exceptedString, test.toString());
 
     }

diff --git a/...plate/src/main/java/org/eclipse/xpanse/modules/servicetemplate/ServiceTemplateManage.java b/...plate/src/main/java/org/eclipse/xpanse/modules/servicetemplate/ServiceTemplateManage.java
@@ -148,6 +148,7 @@ private ServiceTemplateEntity getNewServiceTemplateEntity(Ocl ocl) {
         entity.setServiceHostingType(ocl.getServiceHostingType());
         entity.setOcl(ocl);
         entity.setServiceRegistrationState(ServiceRegistrationState.REGISTERED);
+        entity.setServiceProviderContactDetails(ocl.getServiceProviderContactDetails());
         return entity;
     }
 

diff --git a/runtime/src/test/resources/ocl_test.yaml b/runtime/src/test/resources/ocl_test.yaml
@@ -58,6 +58,9 @@ flavors:
     properties:
       worker_nodes_count: 5
       flavor_id: c7.xlarge.4
+# The contact details of the service.
+serviceProviderContactDetails:
+  email: ["test@test.com"]
 deployment:
   # kind, Supported values are terraform, pulumi, crossplane.
   kind: terraform

diff --git a/runtime/src/test/resources/ocl_testOpenApi.yaml b/runtime/src/test/resources/ocl_testOpenApi.yaml
@@ -58,6 +58,9 @@ flavors:
     properties:
       worker_nodes_count: 5
       flavor_id: c7.xlarge.4
+# The contact details of the service.
+serviceProviderContactDetails:
+  email: ["test@test.com"]
 deployment:
   # kind, Supported values are terraform, pulumi, crossplane.
   kind: terraform

diff --git a/runtime/src/test/resources/ocl_test_dummy.yaml b/runtime/src/test/resources/ocl_test_dummy.yaml
@@ -58,6 +58,9 @@ flavors:
     properties:
       worker_nodes_count: 5
       flavor_id: c7.xlarge.4
+# The contact details of the service.
+serviceProviderContactDetails:
+  email: ["test@test.com"]
 deployment:
   # kind, Supported values are terraform, pulumi, crossplane.
   kind: terraform

diff --git a/samples/flexibleEngine-K8S.yml b/samples/flexibleEngine-K8S.yml
@@ -58,6 +58,9 @@ flavors:
     properties:
       worker_nodes_count: 5
       flavor_id: s6.xlarge.4
+# The contact details of the service.
+serviceProviderContactDetails:
+  email: ["test@test.com"]
 deployment:
   # kind, Supported values are terraform, pulumi, crossplane.
   kind: terraform

diff --git a/samples/flexibleEngine-Kafka.yml b/samples/flexibleEngine-Kafka.yml
@@ -58,6 +58,9 @@ flavors:
     properties:
       worker_nodes_count: 5
       flavor_id: s6.xlarge.4
+# The contact details of the service.
+serviceProviderContactDetails:
+  email: ["test@test.com"]
 deployment:
   # kind, Supported values are terraform, pulumi, crossplane.
   kind: terraform

diff --git a/samples/huawei-K8S.yml b/samples/huawei-K8S.yml
@@ -58,6 +58,9 @@ flavors:
     properties:
       worker_nodes_count: 5
       flavor_id: c7.xlarge.4
+# The contact details of the service.
+serviceProviderContactDetails:
+  email: ["test@test.com"]
 deployment:
   # kind, Supported values are terraform, pulumi, crossplane.
   kind: terraform

diff --git a/samples/huawei-Kafka-terraform_module.yml b/samples/huawei-Kafka-terraform_module.yml
@@ -58,6 +58,9 @@ flavors:
     properties:
       worker_nodes_count: 5
       flavor_id: c7.xlarge.4
+# The contact details of the service.
+serviceProviderContactDetails:
+  email: ["test@test.com"]
 deployment:
   # kind, Supported values are terraform, pulumi, crossplane.
   kind: terraform

diff --git a/samples/huawei-Kafka.yml b/samples/huawei-Kafka.yml
@@ -58,6 +58,9 @@ flavors:
     properties:
       worker_nodes_count: 5
       flavor_id: c7.xlarge.4
+# The contact details of the service.
+serviceProviderContactDetails:
+  email: ["test@test.com"]
 deployment:
   # kind, Supported values are terraform, pulumi, crossplane.
   kind: terraform

diff --git a/samples/openstack-Kafka.yml b/samples/openstack-Kafka.yml
@@ -58,6 +58,9 @@ flavors:
     properties:
       worker_nodes_count: 5
       flavor_id: cirros512
+# The contact details of the service.
+serviceProviderContactDetails:
+  email: ["test@test.com"]
 deployment:
   # kind, Supported values are terraform, pulumi, crossplane.
   kind: terraform

diff --git a/samples/scs-Kafka.yml b/samples/scs-Kafka.yml
@@ -62,6 +62,9 @@ flavors:
       worker_nodes_count: 5
       flavor_name: SCS-4V:8:20
       image_name: Ubuntu 20.04
+# The contact details of the service.
+serviceProviderContactDetails:
+  email: ["test@test.com"]
 deployment:
   # kind, Supported values are terraform, pulumi, crossplane.
   kind: terraform