gerrit.onap Code Review - policy/clamp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2022 Nordix Foundation.
   4  *  Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.clamp.acm.runtime.commissioning;
  23
  24 import static org.assertj.core.api.Assertions.assertThat;
  25 import static org.mockito.ArgumentMatchers.any;
  26 import static org.mockito.Mockito.mock;
  27 import static org.mockito.Mockito.verify;
  28 import static org.mockito.Mockito.when;
  29 import static org.onap.policy.clamp.acm.runtime.util.CommonTestData.TOSCA_SERVICE_TEMPLATE_YAML;
  30 import static org.onap.policy.clamp.acm.runtime.util.CommonTestData.TOSCA_ST_TEMPLATE_YAML;
  31
  32 import com.fasterxml.jackson.databind.ObjectMapper;
  33 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
  34 import com.fasterxml.jackson.module.jsonSchema.factories.SchemaFactoryWrapper;
  35 import java.util.List;
  36 import java.util.Map;
  37 import java.util.Objects;
  38 import org.junit.jupiter.api.Test;
  39 import org.onap.policy.clamp.acm.runtime.instantiation.InstantiationUtils;
  40 import org.onap.policy.clamp.models.acm.persistence.provider.AutomationCompositionProvider;
  41 import org.onap.policy.clamp.models.acm.persistence.provider.ParticipantProvider;
  42 import org.onap.policy.clamp.models.acm.persistence.provider.ServiceTemplateProvider;
  43 import org.onap.policy.common.utils.coder.Coder;
  44 import org.onap.policy.common.utils.coder.StandardCoder;
  45 import org.onap.policy.models.tosca.authorative.concepts.ToscaCapabilityType;
  46 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  47 import org.onap.policy.models.tosca.authorative.concepts.ToscaDataType;
  48 import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeTemplate;
  49 import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeType;
  50 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
  51 import org.onap.policy.models.tosca.authorative.concepts.ToscaRelationshipType;
  52 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  53 import org.onap.policy.models.tosca.authorative.concepts.ToscaTopologyTemplate;
  54
  55 class CommissioningProviderTest {
  56
  57     private static final Coder CODER = new StandardCoder();
  58     private final ObjectMapper mapper = new ObjectMapper();
  59
  60     /**
  61      * Test the fetching of automation composition definitions (ToscaServiceTemplates).
  62      *
  63      * @throws Exception .
  64      */
  65     @Test
  66     void testGetAutomationCompositionDefinitions() throws Exception {
  67         var acProvider = mock(AutomationCompositionProvider.class);
  68         var participantProvider = mock(ParticipantProvider.class);
  69         var serviceTemplateProvider = mock(ServiceTemplateProvider.class);
  70
  71         CommissioningProvider provider =
  72             new CommissioningProvider(serviceTemplateProvider, acProvider, null, participantProvider);
  73
  74         List<ToscaNodeTemplate> listOfTemplates = provider.getAutomationCompositionDefinitions(null, null);
  75         assertThat(listOfTemplates).isEmpty();
  76
  77         when(acProvider.getFilteredNodeTemplates(any()))
  78             .thenReturn(List.of(new ToscaNodeTemplate(), new ToscaNodeTemplate()));
  79         listOfTemplates = provider.getAutomationCompositionDefinitions(null, null);
  80         assertThat(listOfTemplates).hasSize(2);
  81     }
  82
  83     /**
  84      * Test the creation of automation composition definitions (ToscaServiceTemplates).
  85      *
  86      * @throws Exception .
  87      */
  88     @Test
  89     void testCreateAutomationCompositionDefinitions() throws Exception {
  90         var serviceTemplateProvider = mock(ServiceTemplateProvider.class);
  91         var acProvider = mock(AutomationCompositionProvider.class);
  92         var participantProvider = mock(ParticipantProvider.class);
  93
  94         CommissioningProvider provider =
  95             new CommissioningProvider(serviceTemplateProvider, acProvider, null, participantProvider);
  96
  97         List<ToscaNodeTemplate> listOfTemplates = provider.getAutomationCompositionDefinitions(null, null);
  98         assertThat(listOfTemplates).isEmpty();
  99
 100         ToscaServiceTemplate serviceTemplate = InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
 101         when(serviceTemplateProvider.createServiceTemplate(serviceTemplate)).thenReturn(serviceTemplate);
 102
 103         // Response should return the number of node templates present in the service template
 104         List<ToscaConceptIdentifier> affectedDefinitions = provider
 105             .createAutomationCompositionDefinitions(serviceTemplate).getAffectedAutomationCompositionDefinitions();
 106         assertThat(affectedDefinitions).hasSize(13);
 107
 108         when(acProvider.getFilteredNodeTemplates(any()))
 109             .thenReturn(List.of(new ToscaNodeTemplate(), new ToscaNodeTemplate()));
 110
 111         listOfTemplates = provider.getAutomationCompositionDefinitions(null, null);
 112         assertThat(listOfTemplates).hasSize(2);
 113     }
 114
 115     /**
 116      * Test the fetching of a full ToscaServiceTemplate object - as opposed to the reduced template that is being
 117      * tested in the testGetToscaServiceTemplateReduced() test.
 118      *
 119      */
 120     @Test
 121     void testGetToscaServiceTemplate() throws Exception {
 122         var serviceTemplateProvider = mock(ServiceTemplateProvider.class);
 123         var acProvider = mock(AutomationCompositionProvider.class);
 124         var participantProvider = mock(ParticipantProvider.class);
 125
 126         CommissioningProvider provider =
 127             new CommissioningProvider(serviceTemplateProvider, acProvider, null, participantProvider);
 128         ToscaServiceTemplate serviceTemplate =
 129             InstantiationUtils.getToscaServiceTemplate(TOSCA_ST_TEMPLATE_YAML);
 130         when(serviceTemplateProvider.createServiceTemplate(serviceTemplate)).thenReturn(serviceTemplate);
 131
 132         provider.createAutomationCompositionDefinitions(serviceTemplate);
 133         verify(serviceTemplateProvider).createServiceTemplate(serviceTemplate);
 134
 135         when(serviceTemplateProvider.getToscaServiceTemplate(null, null)).thenReturn(serviceTemplate);
 136
 137         ToscaServiceTemplate returnedServiceTemplate = provider.getToscaServiceTemplate(null, null);
 138         assertThat(returnedServiceTemplate).isNotNull();
 139
 140         Map<String, ToscaNodeTemplate> nodeTemplates =
 141             returnedServiceTemplate.getToscaTopologyTemplate().getNodeTemplates();
 142
 143         assertThat(nodeTemplates).hasSize(8);
 144     }
 145
 146     /**
 147      * Test the fetching of a reduced ToscaServiceTemplate with only some of the objects from the full template.
 148      * The reduced template does not contain: DataTypesAsMap or PolicyTypesAsMap.
 149      *
 150      */
 151     @Test
 152     void testGetToscaServiceTemplateReduced() throws Exception {
 153         var serviceTemplateProvider = mock(ServiceTemplateProvider.class);
 154         var acProvider = mock(AutomationCompositionProvider.class);
 155         var participantProvider = mock(ParticipantProvider.class);
 156
 157         CommissioningProvider provider =
 158             new CommissioningProvider(serviceTemplateProvider, acProvider, null, participantProvider);
 159         ToscaServiceTemplate serviceTemplate =
 160             InstantiationUtils.getToscaServiceTemplate(TOSCA_ST_TEMPLATE_YAML);
 161         when(serviceTemplateProvider.createServiceTemplate(serviceTemplate)).thenReturn(serviceTemplate);
 162
 163         provider.createAutomationCompositionDefinitions(serviceTemplate);
 164
 165         when(serviceTemplateProvider.getServiceTemplateList(any(), any())).thenReturn(List.of(
 166             Objects.requireNonNull(serviceTemplate)));
 167
 168         String returnedServiceTemplate = provider.getToscaServiceTemplateReduced(null, null);
 169         assertThat(returnedServiceTemplate).isNotNull();
 170         ToscaServiceTemplate parsedServiceTemplate = CODER.decode(returnedServiceTemplate, ToscaServiceTemplate.class);
 171
 172         assertThat(parsedServiceTemplate.getToscaTopologyTemplate().getNodeTemplates()).hasSize(8);
 173     }
 174
 175     /**
 176      * Tests the different schemas being returned from the schema endpoint. As schemas of the different
 177      * sections of the Tosca Service Templates can be returned by the API, this test must cover all of the
 178      * different sections.
 179      *
 180      */
 181     @Test
 182     void testGetToscaServiceTemplateSchema() throws Exception {
 183         var serviceTemplateProvider = mock(ServiceTemplateProvider.class);
 184         var acProvider = mock(AutomationCompositionProvider.class);
 185         var participantProvider = mock(ParticipantProvider.class);
 186
 187         CommissioningProvider provider =
 188             new CommissioningProvider(serviceTemplateProvider, acProvider, null, participantProvider);
 189         ToscaServiceTemplate serviceTemplate =
 190             InstantiationUtils.getToscaServiceTemplate(TOSCA_ST_TEMPLATE_YAML);
 191         when(serviceTemplateProvider.createServiceTemplate(serviceTemplate)).thenReturn(serviceTemplate);
 192
 193         provider.createAutomationCompositionDefinitions(serviceTemplate);
 194
 195         mapper.setPropertyNamingStrategy(PropertyNamingStrategies.SNAKE_CASE);
 196
 197         Map<String, Class<?>> sections = Map.of("all", ToscaServiceTemplate.class, "data_types", ToscaDataType.class,
 198             "capability_types", ToscaCapabilityType.class, "node_types", ToscaNodeType.class, "relationship_types",
 199             ToscaRelationshipType.class, "policy_types", ToscaPolicyType.class, "topology_template",
 200             ToscaTopologyTemplate.class, "node_templates", List.class);
 201
 202         for (Map.Entry<String, Class<?>> entry : sections.entrySet()) {
 203             String returnedServiceTemplateSchema = provider.getToscaServiceTemplateSchema(entry.getKey());
 204             assertThat(returnedServiceTemplateSchema).isNotNull();
 205
 206             var visitor = new SchemaFactoryWrapper();
 207
 208             if (entry.getKey().equals("node_templates")) {
 209                 mapper.acceptJsonFormatVisitor(
 210                     mapper.getTypeFactory().constructCollectionType(List.class, ToscaNodeTemplate.class), visitor);
 211             } else {
 212                 mapper.acceptJsonFormatVisitor(mapper.constructType(entry.getValue()), visitor);
 213             }
 214
 215             var jsonSchema = visitor.finalSchema();
 216             String localServiceTemplateSchema = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(jsonSchema);
 217             assertThat(localServiceTemplateSchema).isEqualTo(returnedServiceTemplateSchema);
 218         }
 219     }
 220 }