summaryrefslogtreecommitdiffstats
path: root/so-cnfm/so-cnfm-lcm/so-cnfm-lcm-bpmn-flows/src/test/java/org/onap/so/cnfm/lcm/bpmn/flows/extclients/helm/HelmClientTest.java
blob: 1856dec5e417260208d1d49531bd457147d1ca1e (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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2023 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.so.cnfm.lcm.bpmn.flows.extclients.helm;

import static org.junit.Assert.assertEquals;
import static org.mockito.ArgumentMatchers.argThat;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import org.junit.Test;
import org.mockito.ArgumentMatcher;
import org.onap.so.cnfm.lcm.bpmn.flows.Constants;
import org.onap.so.cnfm.lcm.bpmn.flows.exceptions.HelmClientExecuteException;
import org.onap.so.cnfm.lcm.bpmn.flows.utils.PropertiesToYamlConverter;
import org.onap.so.cnfm.lcm.database.beans.utils.Utils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;


/**
 *
 * @author Waqas Ikram (waqas.ikram@est.tech)
 *
 */
public class HelmClientTest {
    private static final Logger logger = LoggerFactory.getLogger(HelmClientTest.class);

    private static final int SUCCESSFUL_EXIT_CODE = 0;
    private static final int FAILED_EXIT_CODE = 1;

    private static final Path DUMMY_HELM_CHART = Paths.get("/some/dir/dummy/dummy-chart.tgz");
    private static final Path DUMMY_KUBE_CONFIG = Paths.get("/some/dir/dummy/kube-config");
    private static final String DUMMY_RELEASE_NAME = "RELEASE_NAME";
    private static final PropertiesToYamlConverter PROPERTIES_TO_YAML_CONVERTER = new PropertiesToYamlConverter();
    private static final List<String> EXPECTED_COMMANDS = Arrays.asList("helm", "install", DUMMY_RELEASE_NAME, "-n",
            "default", DUMMY_HELM_CHART.toString(), "--dry-run", "--kubeconfig", DUMMY_KUBE_CONFIG.toString());

    private static final List<String> EXPECTED_GET_KUBE_KINDS_COMMANDS = Arrays.asList("sh", "-c",
            "helm template " + DUMMY_RELEASE_NAME + " -n default " + DUMMY_HELM_CHART.toString() + " --dry-run"
                    + " --kubeconfig " + DUMMY_KUBE_CONFIG.toString() + " --skip-tests | grep kind | uniq");

    private static final List<String> EXPECTED_GET_KUBE_KINDS_MANIFEST_COMMANDS =
            Arrays.asList("sh", "-c", "helm get manifest " + DUMMY_RELEASE_NAME + " -n default --kubeconfig "
                    + DUMMY_KUBE_CONFIG.toString() + " | grep kind | uniq");

    private static final List<String> EXPECTED_HELM_INSTALL_COMMANDS = Arrays.asList("sh", "-c", "helm install "
            + DUMMY_RELEASE_NAME + " -n default " + DUMMY_HELM_CHART + " --kubeconfig " + DUMMY_KUBE_CONFIG.toString());

    private static final List<String> EXPECTED_HELM_UNINSTALL_COMMANDS = Arrays.asList("helm", "uninstall",
            DUMMY_RELEASE_NAME, "-n", "default", "--kubeconfig", DUMMY_KUBE_CONFIG.toString());

    @Test(expected = Test.None.class)
    public void testRunHelmChartInstallWithDryRunFlag_successfulCase() throws Exception {

        try (final ByteArrayInputStream errorStream = new ByteArrayInputStream("".getBytes());
                final ByteArrayInputStream inputStream = new ByteArrayInputStream("Successful".getBytes());) {

            final ProcessBuilder mockedProcessBuilder = mock(ProcessBuilder.class);

            final ListMatcher expectedCommandsMatcher = new ListMatcher(EXPECTED_COMMANDS);
            mockProcessBuilder(mockedProcessBuilder, expectedCommandsMatcher, errorStream, inputStream,
                    SUCCESSFUL_EXIT_CODE, EXPECTED_COMMANDS);

            final HelmClient objUnderTest =
                    new StubbedHelmClientImpl(PROPERTIES_TO_YAML_CONVERTER, mockedProcessBuilder);

            objUnderTest.runHelmChartInstallWithDryRunFlag(DUMMY_RELEASE_NAME, DUMMY_KUBE_CONFIG, DUMMY_HELM_CHART);
        }

    }

    @Test(expected = HelmClientExecuteException.class)
    public void testRunHelmChartInstallWithDryRunFlag_processFailed_throwException() throws Exception {

        try (final ByteArrayInputStream errorStream = new ByteArrayInputStream("process failed".getBytes());
                final ByteArrayInputStream inputStream = new ByteArrayInputStream("".getBytes());) {

            final ProcessBuilder mockedProcessBuilder = mock(ProcessBuilder.class);

            final ListMatcher expectedCommandsMatcher = new ListMatcher(EXPECTED_COMMANDS);
            mockProcessBuilder(mockedProcessBuilder, expectedCommandsMatcher, errorStream, inputStream, FAILED_EXIT_CODE,
                    EXPECTED_COMMANDS);

            final HelmClient objUnderTest =
                    new StubbedHelmClientImpl(PROPERTIES_TO_YAML_CONVERTER, mockedProcessBuilder);

            objUnderTest.runHelmChartInstallWithDryRunFlag(DUMMY_RELEASE_NAME, DUMMY_KUBE_CONFIG, DUMMY_HELM_CHART);
        }
    }

    @Test
    public void testGetKubeKinds_successfulCase() throws Exception {

        try (final ByteArrayInputStream errorStream = new ByteArrayInputStream("".getBytes());
                final ByteArrayInputStream inputStream =
                        new ByteArrayInputStream(Constants.KIND_REPLICA_SET.getBytes());) {

            final ProcessBuilder mockedProcessBuilder = mock(ProcessBuilder.class);

            final ListMatcher expectedCommandsMatcher = new ListMatcher(EXPECTED_GET_KUBE_KINDS_COMMANDS);
            mockProcessBuilder(mockedProcessBuilder, expectedCommandsMatcher, errorStream, inputStream, SUCCESSFUL_EXIT_CODE,
                    EXPECTED_GET_KUBE_KINDS_COMMANDS);

            final HelmClient objUnderTest =
                    new StubbedHelmClientImpl(PROPERTIES_TO_YAML_CONVERTER, mockedProcessBuilder);
            final List<String> actualKubeKinds =
                    objUnderTest.getKubeKinds(DUMMY_RELEASE_NAME, DUMMY_KUBE_CONFIG, DUMMY_HELM_CHART);

            assertEquals(Arrays.asList(Constants.KIND_REPLICA_SET), actualKubeKinds);

        }
    }

    @Test
    public void testGetKubeKindsUsingManifestCommand_successfulCase() throws Exception {

        try (final ByteArrayInputStream errorStream = new ByteArrayInputStream("".getBytes());
                final ByteArrayInputStream inputStream =
                        new ByteArrayInputStream(Constants.KIND_DAEMON_SET.getBytes());) {

            final ProcessBuilder mockedProcessBuilder = mock(ProcessBuilder.class);

            final ListMatcher expectedCommandsMatcher = new ListMatcher(EXPECTED_GET_KUBE_KINDS_MANIFEST_COMMANDS);
            mockProcessBuilder(mockedProcessBuilder, expectedCommandsMatcher, errorStream, inputStream, SUCCESSFUL_EXIT_CODE,
                    EXPECTED_GET_KUBE_KINDS_COMMANDS);

            final HelmClient objUnderTest =
                    new StubbedHelmClientImpl(PROPERTIES_TO_YAML_CONVERTER, mockedProcessBuilder);

            final List<String> actualKubeKinds =
                    objUnderTest.getKubeKindsUsingManifestCommand(DUMMY_RELEASE_NAME, DUMMY_KUBE_CONFIG);
            assertEquals(Arrays.asList(Constants.KIND_DAEMON_SET), actualKubeKinds);
        }
    }

    @Test(expected = Test.None.class)
    public void testInstallHelmChart_successfulCase() throws Exception {

        try (final ByteArrayInputStream errorStream = new ByteArrayInputStream("".getBytes());
                final ByteArrayInputStream inputStream = new ByteArrayInputStream("Successful".getBytes());) {

            final ProcessBuilder mockedProcessBuilder = mock(ProcessBuilder.class);

            final ListMatcher expectedCommandsMatcher = new ListMatcher(EXPECTED_HELM_INSTALL_COMMANDS);
            mockProcessBuilder(mockedProcessBuilder, expectedCommandsMatcher, errorStream, inputStream, SUCCESSFUL_EXIT_CODE,
                    EXPECTED_HELM_INSTALL_COMMANDS);

            final HelmClient objUnderTest =
                    new StubbedHelmClientImpl(PROPERTIES_TO_YAML_CONVERTER, mockedProcessBuilder);

            objUnderTest.installHelmChart(DUMMY_RELEASE_NAME, DUMMY_KUBE_CONFIG, DUMMY_HELM_CHART,
                    Collections.emptyMap());
        }
    }

    @Test(expected = Test.None.class)
    public void testUnInstallHelmChart_successfulCase() throws Exception {

        try (final ByteArrayInputStream errorStream = new ByteArrayInputStream("".getBytes());
                final ByteArrayInputStream inputStream = new ByteArrayInputStream("Successful".getBytes());) {

            final ProcessBuilder mockedProcessBuilder = mock(ProcessBuilder.class);

            final ListMatcher expectedCommandsMatcher = new ListMatcher(EXPECTED_HELM_UNINSTALL_COMMANDS);
            mockProcessBuilder(mockedProcessBuilder, expectedCommandsMatcher, errorStream, inputStream, SUCCESSFUL_EXIT_CODE,
                    EXPECTED_HELM_UNINSTALL_COMMANDS);

            final HelmClient objUnderTest =
                    new StubbedHelmClientImpl(PROPERTIES_TO_YAML_CONVERTER, mockedProcessBuilder);

            objUnderTest.unInstallHelmChart(DUMMY_RELEASE_NAME, DUMMY_KUBE_CONFIG);
        }
    }

    private void mockProcessBuilder(final ProcessBuilder mockedProcessBuilder,
            final ListMatcher expectedCommandsMatcher, final ByteArrayInputStream errorStream,
            final ByteArrayInputStream inputStream, final int exitCode, final List<String> expectedCommands)
            throws InterruptedException, IOException {

        final Process mockedProcess = mock(Process.class);
        when(mockedProcessBuilder.command(argThat(expectedCommandsMatcher))).thenReturn(mockedProcessBuilder);
        when(mockedProcess.getErrorStream()).thenReturn(errorStream);
        when(mockedProcess.getInputStream()).thenReturn(inputStream);
        when(mockedProcess.exitValue()).thenReturn(exitCode);
        when(mockedProcess.waitFor()).thenReturn(0);
        when(mockedProcessBuilder.command()).thenReturn(expectedCommands);
        when(mockedProcessBuilder.start()).thenReturn(mockedProcess);
    }

    private class ListMatcher implements ArgumentMatcher<List<String>> {

        private final List<String> expectArgumentList;

        public ListMatcher(final List<String> expectArgumentList) {
            this.expectArgumentList = expectArgumentList;
        }

        @Override
        public boolean matches(final List<String> actualArgumentList) {
            final boolean result = Utils.isEquals(expectArgumentList, actualArgumentList);
            if (!result) {
                logger.error("Mismatch arguments expected: {}, actual: {}", expectArgumentList, actualArgumentList);
            }
            return result;
        }
    }

    private class StubbedHelmClientImpl extends HelmClientImpl {

        private final ProcessBuilder processBuilder;

        public StubbedHelmClientImpl(final PropertiesToYamlConverter propertiesToYamlConverter,
                final ProcessBuilder processBuilder) {
            super(propertiesToYamlConverter);
            this.processBuilder = processBuilder;
        }

        @Override
        ProcessBuilder getProcessBuilder() {
            return processBuilder;
        }

    }

}