aboutsummaryrefslogtreecommitdiffstats
path: root/runtime-acm/src/test/java/org/onap/policy/clamp/acm/runtime/commissioning/CommissioningProviderTest.java
blob: 35731d0e0874cf46bb0011b015a5ede79e85cafd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2021 Nordix Foundation.
 *  Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.clamp.acm.runtime.commissioning;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.PropertyNamingStrategies;
import com.fasterxml.jackson.module.jsonSchema.factories.SchemaFactoryWrapper;
import java.util.List;
import java.util.Map;
import org.junit.jupiter.api.Test;
import org.onap.policy.clamp.acm.runtime.instantiation.InstantiationUtils;
import org.onap.policy.clamp.models.acm.persistence.provider.AutomationCompositionProvider;
import org.onap.policy.clamp.models.acm.persistence.provider.ParticipantProvider;
import org.onap.policy.clamp.models.acm.persistence.provider.ServiceTemplateProvider;
import org.onap.policy.common.utils.coder.Coder;
import org.onap.policy.common.utils.coder.StandardCoder;
import org.onap.policy.models.tosca.authorative.concepts.ToscaCapabilityType;
import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
import org.onap.policy.models.tosca.authorative.concepts.ToscaDataType;
import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeTemplate;
import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeType;
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
import org.onap.policy.models.tosca.authorative.concepts.ToscaRelationshipType;
import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
import org.onap.policy.models.tosca.authorative.concepts.ToscaTopologyTemplate;

class CommissioningProviderTest {
    private static final String TOSCA_SERVICE_TEMPLATE_YAML =
        "src/test/resources/rest/servicetemplates/pmsh_multiple_ac_tosca.yaml";
    private static final String COMMON_TOSCA_SERVICE_TEMPLATE_YAML =
        "src/test/resources/rest/servicetemplates/full-tosca-with-common-properties.yaml";

    private static final Coder CODER = new StandardCoder();
    private final ObjectMapper mapper = new ObjectMapper();

    /**
     * Test the fetching of automation composition definitions (ToscaServiceTemplates).
     *
     * @throws Exception .
     */
    @Test
    void testGetAutomationCompositionDefinitions() throws Exception {
        var acProvider = mock(AutomationCompositionProvider.class);
        var participantProvider = mock(ParticipantProvider.class);
        var serviceTemplateProvider = mock(ServiceTemplateProvider.class);

        CommissioningProvider provider =
            new CommissioningProvider(serviceTemplateProvider, acProvider, null, participantProvider);

        List<ToscaNodeTemplate> listOfTemplates = provider.getAutomationCompositionDefinitions(null, null);
        assertThat(listOfTemplates).isEmpty();

        when(acProvider.getFilteredNodeTemplates(any()))
            .thenReturn(List.of(new ToscaNodeTemplate(), new ToscaNodeTemplate()));
        listOfTemplates = provider.getAutomationCompositionDefinitions(null, null);
        assertThat(listOfTemplates).hasSize(2);
    }

    /**
     * Test the creation of automation composition definitions (ToscaServiceTemplates).
     *
     * @throws Exception .
     */
    @Test
    void testCreateAutomationCompositionDefinitions() throws Exception {
        var serviceTemplateProvider = mock(ServiceTemplateProvider.class);
        var acProvider = mock(AutomationCompositionProvider.class);
        var participantProvider = mock(ParticipantProvider.class);

        CommissioningProvider provider =
            new CommissioningProvider(serviceTemplateProvider, acProvider, null, participantProvider);

        List<ToscaNodeTemplate> listOfTemplates = provider.getAutomationCompositionDefinitions(null, null);
        assertThat(listOfTemplates).isEmpty();

        ToscaServiceTemplate serviceTemplate = InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
        when(serviceTemplateProvider.createServiceTemplate(serviceTemplate)).thenReturn(serviceTemplate);

        // Response should return the number of node templates present in the service template
        List<ToscaConceptIdentifier> affectedDefinitions = provider
            .createAutomationCompositionDefinitions(serviceTemplate).getAffectedAutomationCompositionDefinitions();
        assertThat(affectedDefinitions).hasSize(13);

        when(acProvider.getFilteredNodeTemplates(any()))
            .thenReturn(List.of(new ToscaNodeTemplate(), new ToscaNodeTemplate()));

        listOfTemplates = provider.getAutomationCompositionDefinitions(null, null);
        assertThat(listOfTemplates).hasSize(2);
    }

    /**
     * Test the fetching of a full ToscaServiceTemplate object - as opposed to the reduced template that is being
     * tested in the testGetToscaServiceTemplateReduced() test.
     *
     */
    @Test
    void testGetToscaServiceTemplate() throws Exception {
        var serviceTemplateProvider = mock(ServiceTemplateProvider.class);
        var acProvider = mock(AutomationCompositionProvider.class);
        var participantProvider = mock(ParticipantProvider.class);

        CommissioningProvider provider =
            new CommissioningProvider(serviceTemplateProvider, acProvider, null, participantProvider);
        ToscaServiceTemplate serviceTemplate =
            InstantiationUtils.getToscaServiceTemplate(COMMON_TOSCA_SERVICE_TEMPLATE_YAML);
        when(serviceTemplateProvider.createServiceTemplate(serviceTemplate)).thenReturn(serviceTemplate);

        provider.createAutomationCompositionDefinitions(serviceTemplate);
        verify(serviceTemplateProvider).createServiceTemplate(serviceTemplate);

        when(serviceTemplateProvider.getToscaServiceTemplate(eq(null), eq(null))).thenReturn(serviceTemplate);

        ToscaServiceTemplate returnedServiceTemplate = provider.getToscaServiceTemplate(null, null);
        assertThat(returnedServiceTemplate).isNotNull();

        Map<String, ToscaNodeTemplate> nodeTemplates =
            returnedServiceTemplate.getToscaTopologyTemplate().getNodeTemplates();

        assertThat(nodeTemplates).hasSize(8);
    }

    /**
     * Test the fetching of a reduced ToscaServiceTemplate with only some of the objects from the full template.
     * The reduced template does not contain: DataTypesAsMap or PolicyTypesAsMap.
     *
     */
    @Test
    void testGetToscaServiceTemplateReduced() throws Exception {
        var serviceTemplateProvider = mock(ServiceTemplateProvider.class);
        var acProvider = mock(AutomationCompositionProvider.class);
        var participantProvider = mock(ParticipantProvider.class);

        CommissioningProvider provider =
            new CommissioningProvider(serviceTemplateProvider, acProvider, null, participantProvider);
        ToscaServiceTemplate serviceTemplate =
            InstantiationUtils.getToscaServiceTemplate(COMMON_TOSCA_SERVICE_TEMPLATE_YAML);
        when(serviceTemplateProvider.createServiceTemplate(serviceTemplate)).thenReturn(serviceTemplate);

        provider.createAutomationCompositionDefinitions(serviceTemplate);

        when(serviceTemplateProvider.getServiceTemplateList(any(), any())).thenReturn(List.of(serviceTemplate));

        String returnedServiceTemplate = provider.getToscaServiceTemplateReduced(null, null);
        assertThat(returnedServiceTemplate).isNotNull();
        ToscaServiceTemplate parsedServiceTemplate = CODER.decode(returnedServiceTemplate, ToscaServiceTemplate.class);

        assertThat(parsedServiceTemplate.getToscaTopologyTemplate().getNodeTemplates()).hasSize(8);
    }

    /**
     * Tests the different schemas being returned from the schema endpoint. As schemas of the different
     * sections of the Tosca Service Templates can be returned by the API, this test must cover all of the
     * different sections.
     *
     */
    @Test
    void testGetToscaServiceTemplateSchema() throws Exception {
        var serviceTemplateProvider = mock(ServiceTemplateProvider.class);
        var acProvider = mock(AutomationCompositionProvider.class);
        var participantProvider = mock(ParticipantProvider.class);

        CommissioningProvider provider =
            new CommissioningProvider(serviceTemplateProvider, acProvider, null, participantProvider);
        ToscaServiceTemplate serviceTemplate =
            InstantiationUtils.getToscaServiceTemplate(COMMON_TOSCA_SERVICE_TEMPLATE_YAML);
        when(serviceTemplateProvider.createServiceTemplate(serviceTemplate)).thenReturn(serviceTemplate);

        provider.createAutomationCompositionDefinitions(serviceTemplate);

        mapper.setPropertyNamingStrategy(PropertyNamingStrategies.SNAKE_CASE);

        Map<String, Class<?>> sections = Map.of("all", ToscaServiceTemplate.class, "data_types", ToscaDataType.class,
            "capability_types", ToscaCapabilityType.class, "node_types", ToscaNodeType.class, "relationship_types",
            ToscaRelationshipType.class, "policy_types", ToscaPolicyType.class, "topology_template",
            ToscaTopologyTemplate.class, "node_templates", List.class);

        for (Map.Entry<String, Class<?>> entry : sections.entrySet()) {
            String returnedServiceTemplateSchema = provider.getToscaServiceTemplateSchema(entry.getKey());
            assertThat(returnedServiceTemplateSchema).isNotNull();

            var visitor = new SchemaFactoryWrapper();

            if (entry.getKey().equals("node_templates")) {
                mapper.acceptJsonFormatVisitor(
                    mapper.getTypeFactory().constructCollectionType(List.class, ToscaNodeTemplate.class), visitor);
            } else {
                mapper.acceptJsonFormatVisitor(mapper.constructType(entry.getValue()), visitor);
            }

            var jsonSchema = visitor.finalSchema();
            String localServiceTemplateSchema = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(jsonSchema);
            assertThat(localServiceTemplateSchema).isEqualTo(returnedServiceTemplateSchema);
        }
    }
}