aboutsummaryrefslogtreecommitdiffstats
path: root/runtime-controlloop/src/test/java/org/onap/policy/clamp/controlloop/runtime/commissioning/CommissioningProviderTest.java
blob: 956b5e9116f04d73dd7d942a029de47e730b783e (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
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2021 Nordix Foundation.
 * ================================================================================
 * 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.controlloop.runtime.commissioning;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;

import java.util.ArrayList;
import java.util.List;
import org.junit.Before;
import org.junit.Test;
import org.onap.policy.clamp.controlloop.runtime.main.parameters.ClRuntimeParameterGroup;
import org.onap.policy.common.utils.coder.Coder;
import org.onap.policy.common.utils.coder.CoderException;
import org.onap.policy.common.utils.coder.StandardCoder;
import org.onap.policy.common.utils.coder.YamlJsonTranslator;
import org.onap.policy.common.utils.resources.ResourceUtils;
import org.onap.policy.models.provider.PolicyModelsProviderParameters;
import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
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.ToscaServiceTemplate;

public class CommissioningProviderTest {
    private static final String TOSCA_SERVICE_TEMPLATE_YAML =
            "src/test/resources/rest/servicetemplates/pmsh_multiple_cl_tosca.yaml";
    private static final String TEMPLATE_IS_NULL = ".*serviceTemplate is marked non-null but is null";
    private static final Coder CODER = new StandardCoder();
    private static final YamlJsonTranslator yamlTranslator = new YamlJsonTranslator();
    private static int dbNum = 0;
    private static final Object lockit = new Object();
    private PolicyModelsProviderParameters databaseProviderParameters;

    private static String getParameterGroupAsString() {
        dbNum++;
        return ResourceUtils.getResourceAsString("src/test/resources/parameters/TestParameters.json")
                .replace("jdbc:h2:mem:testdb", "jdbc:h2:mem:commissioningdb" + dbNum);
    }

    /**
     * Sets up db provider parameters before each test.
     *
     * @throws CoderException .
     */
    @Before
    public void setupDbProviderParameters() throws CoderException {
        synchronized (lockit) {
            databaseProviderParameters = CODER.decode(getParameterGroupAsString(), ClRuntimeParameterGroup.class)
                    .getDatabaseProviderParameters();
        }
    }

    /**
     * Test the fetching of control loop definitions (ToscaServiceTemplates).
     *
     * @throws Exception .
     */
    @Test
    public void testGetControlLoopDefinitions() throws Exception {
        List<ToscaNodeTemplate> listOfTemplates;

        try (CommissioningProvider provider = new CommissioningProvider(databaseProviderParameters)) {
            ToscaServiceTemplate serviceTemplate = yamlTranslator
                    .fromYaml(ResourceUtils.getResourceAsString(TOSCA_SERVICE_TEMPLATE_YAML),
                            ToscaServiceTemplate.class);


            listOfTemplates = provider.getControlLoopDefinitions(null, null);
            assertThat(listOfTemplates).isEmpty();

            provider.createControlLoopDefinitions(serviceTemplate);
            listOfTemplates = provider.getControlLoopDefinitions(null, null);
            assertThat(listOfTemplates).hasSize(2);

            //Test Filtering
            listOfTemplates = provider.getControlLoopDefinitions("org.onap.domain.pmsh.PMSHControlLoopDefinition",
                    "1.2.3");
            assertThat(listOfTemplates).hasSize(1);
            for (ToscaNodeTemplate template : listOfTemplates) {
                //Other CL elements contain PMSD instead of PMSH in their name
                assertFalse(template.getName().contains("PMSD"));
            }

            //Test Wrong Name
            listOfTemplates = provider.getControlLoopDefinitions("WrongControlLoopName", "0.0.0");
            assertThat(listOfTemplates).isEmpty();
        }
    }

    /**
     * Test the creation of control loop definitions (ToscaServiceTemplates).
     *
     * @throws Exception .
     */
    @Test
    public void testCreateControlLoopDefinitions() throws Exception {
        List<ToscaNodeTemplate> listOfTemplates;

        try (CommissioningProvider provider = new CommissioningProvider(databaseProviderParameters)) {
            //Test Service template is null
            assertThatThrownBy(() -> provider.createControlLoopDefinitions(null)).hasMessageMatching(TEMPLATE_IS_NULL);
            listOfTemplates = provider.getControlLoopDefinitions(null, null);
            assertThat(listOfTemplates).isEmpty();

            ToscaServiceTemplate serviceTemplate = yamlTranslator
                    .fromYaml(ResourceUtils.getResourceAsString(TOSCA_SERVICE_TEMPLATE_YAML),
                            ToscaServiceTemplate.class);

            // Response should return the number of node templates present in the service template
            List<ToscaConceptIdentifier> affectedDefinitions =
                    provider.createControlLoopDefinitions(serviceTemplate).getAffectedControlLoopDefinitions();
            assertThat(affectedDefinitions).hasSize(13);
            listOfTemplates = provider.getControlLoopDefinitions(null, null);
            assertThat(listOfTemplates).hasSize(2);
        }
    }

    /**
     * Test the deletion of control loop definitions (ToscaServiceTemplate).
     *
     * @throws Exception .
     */
    @Test
    public void testDeleteControlLoopDefinitions() throws Exception {
        List<ToscaNodeTemplate> listOfTemplates;

        try (CommissioningProvider provider = new CommissioningProvider(databaseProviderParameters)) {
            ToscaServiceTemplate serviceTemplate = yamlTranslator
                    .fromYaml(ResourceUtils.getResourceAsString(TOSCA_SERVICE_TEMPLATE_YAML),
                            ToscaServiceTemplate.class);

            listOfTemplates = provider.getControlLoopDefinitions(null, null);
            assertThat(listOfTemplates).isEmpty();

            provider.createControlLoopDefinitions(serviceTemplate);
            listOfTemplates = provider.getControlLoopDefinitions(null, null);
            assertThat(listOfTemplates).hasSize(2);

            provider.deleteControlLoopDefinition(serviceTemplate.getName(), serviceTemplate.getVersion());
            listOfTemplates = provider.getControlLoopDefinitions(null, null);
            assertThat(listOfTemplates).isEmpty();
        }
    }

    /**
     * Test the fetching of control loop element definitions.
     *
     * @throws Exception .
     */
    @Test
    public void testGetControlLoopElementDefinitions() throws Exception {
        try (CommissioningProvider provider = new CommissioningProvider(databaseProviderParameters)) {
            ToscaServiceTemplate serviceTemplate = yamlTranslator
                    .fromYaml(ResourceUtils.getResourceAsString(TOSCA_SERVICE_TEMPLATE_YAML),
                            ToscaServiceTemplate.class);

            provider.getControlLoopDefinitions(null, null);

            provider.createControlLoopDefinitions(serviceTemplate);
            List<ToscaNodeTemplate> controlLoopDefinitionList = provider.getControlLoopDefinitions(
                    "org.onap.domain.pmsh.PMSHControlLoopDefinition", "1.2.3");

            List<ToscaNodeTemplate> controlLoopElementNodeTemplates =
                    provider.getControlLoopElementDefinitions(controlLoopDefinitionList.get(0));

            // 4 PMSH control loop elements definitions.
            assertThat(controlLoopElementNodeTemplates).hasSize(4);

            List<ToscaNodeType> derivedTypes = getDerivedNodeTypes(serviceTemplate);
            for (ToscaNodeTemplate template : controlLoopElementNodeTemplates) {
                assertTrue(checkNodeType(template, derivedTypes));
            }
        }
    }

    private boolean checkNodeType(ToscaNodeTemplate template, List<ToscaNodeType> derivedNodeTypes) {
        String controlLoopElementType = "org.onap.policy.clamp.controlloop.ControlLoopElement";
        for (ToscaNodeType derivedType : derivedNodeTypes) {
            if (template.getType().equals(derivedType.getName()) || template.getType().equals(controlLoopElementType)) {
                return true;
            }
        }
        return false;
    }

    private List<ToscaNodeType> getDerivedNodeTypes(ToscaServiceTemplate serviceTemplate) {
        String type = "org.onap.policy.clamp.controlloop.ControlLoopElement";
        List<ToscaNodeType> nodeTypes = new ArrayList<>();
        for (ToscaNodeType nodeType : serviceTemplate.getNodeTypes().values()) {
            if (nodeType.getDerivedFrom().equals(type)) {
                nodeTypes.add(nodeType);
            }
        }
        return nodeTypes;
    }
}