aboutsummaryrefslogtreecommitdiffstats
path: root/rest-services/cbs-client/src/test/java/org/onap/dcaegen2/services/sdk/rest/services/cbs/client/api/CbsClientConfigurationTest.java
blob: 2cc221ef1d4098319c5c58efd097d018e99b3060 (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
/*
 * ============LICENSE_START====================================
 * DCAEGEN2-SERVICES-SDK
 * =========================================================
 * Copyright (C) 2019-2021 Nokia. 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.
 * ============LICENSE_END=====================================
 */

package org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api;


import org.junit.Rule;
import org.junit.contrib.java.lang.system.EnvironmentVariables;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.exceptions.CbsClientConfigurationException;
import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.CbsClientConfiguration;
import org.onap.dcaegen2.services.sdk.security.ssl.Passwords;

import java.net.URISyntaxException;
import java.nio.file.Paths;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;

/**
 * @author <a href="mailto:piotr.jaszczyk@nokia.com">Piotr Jaszczyk</a>
 * @since February 2019
 */
class CbsClientConfigurationTest {

    private static final String ENV_DCAE_CA_CERTPATH = "DCAE_CA_CERTPATH";
    private static final String ENV_CONFIG_BINDING_SERVICE = "CONFIG_BINDING_SERVICE";
    private static final String ENV_CONFIG_BINDING_SERVICE_SERVICE_PORT = "CONFIG_BINDING_SERVICE_SERVICE_PORT";
    private static final String ENV_HOSTNAME = "HOSTNAME";
    private static final String ENV_CONSUL_HOST = "CONSUL_HOST";
    private static final String ENV_CBS_CLIENT_CONFIG_PATH = "CBS_CLIENT_CONFIG_PATH";
    private static final String ENV_CBS_CLIENT_POLICY_PATH = "CBS_CLIENT_POLICY_PATH";

    @Rule
    public final EnvironmentVariables envs = new EnvironmentVariables();

    @BeforeEach
    void setUp(){
        envs.clear(ENV_DCAE_CA_CERTPATH, ENV_CONFIG_BINDING_SERVICE, ENV_CONFIG_BINDING_SERVICE_SERVICE_PORT,
            ENV_HOSTNAME, ENV_CONSUL_HOST, ENV_CBS_CLIENT_CONFIG_PATH, ENV_CBS_CLIENT_POLICY_PATH);
    }

    @Test
    void fromEnvironment_shouldReturnConfigurationForConnectionWithoutTls_when_DCAE_CA_CERTPATH_isEmpty() {
        // given
        createBasicValidEnvsConfiguration();
        envs.set(ENV_DCAE_CA_CERTPATH, "");

        // when
        CbsClientConfiguration configuration = CbsClientConfiguration.fromEnvironment();

        // then
        assertThat(configuration.trustStoreKeys()).isEqualTo(null);
        assertThat(configuration.protocol()).isEqualTo("http");
    }

    @Test
    void fromEnvironment_shouldReturnConfigurationForConnectionOverTls_when_DCAE_CA_CERTPATH_isSet() throws URISyntaxException {
        // given
        envs.set(ENV_DCAE_CA_CERTPATH, preparePathToCertFile());
        envs.set(ENV_CONFIG_BINDING_SERVICE, "config-binding-service");
        envs.set(ENV_HOSTNAME, "dcae-prh");
        envs.set(ENV_CONSUL_HOST, "consul-server.onap");

        // when
        CbsClientConfiguration configuration = CbsClientConfiguration.fromEnvironment();

        // then
        assertThat(configuration.trustStoreKeys()).isNotNull();
        assertThat(configuration.protocol()).isEqualTo("https");
    }

    @Test
    void fromEnvironment_shouldReturnConfigurationWithCorrectConfigPath_when_CBS_CLIENT_CONFIG_PATH_isSet() {
        // given
        createBasicValidEnvsConfiguration();
        envs.set(ENV_CBS_CLIENT_CONFIG_PATH, "/new/config/path/application.yaml");

        // when
        CbsClientConfiguration configuration = CbsClientConfiguration.fromEnvironment();

        // then
        assertThat(configuration).isNotNull();
        assertThat(configuration.configMapFilePath()).isEqualTo("/new/config/path/application.yaml");
    }

    @Test
    void fromEnvironment_shouldReturnConfigurationWithCorrectPolicyPath_when_CBS_CLIENT_POLICY_PATH_isSet() {
        // given
        createBasicValidEnvsConfiguration();
        envs.set(ENV_CBS_CLIENT_POLICY_PATH, "/new/config/path/policy.json");

        // when
        CbsClientConfiguration configuration = CbsClientConfiguration.fromEnvironment();

        // then
        assertThat(configuration).isNotNull();
        assertThat(configuration.policySyncFilePath()).isEqualTo("/new/config/path/policy.json");
    }

    @Test
    void fromEnvironment_shouldReturnConfigurationWithDefaultPolicyAndConfigPaths_whenEnvsNotSet() {
        // given
        createBasicValidEnvsConfiguration();

        // when
        CbsClientConfiguration configuration = CbsClientConfiguration.fromEnvironment();

        // then
        assertThat(configuration).isNotNull();
        assertThat(configuration.configMapFilePath()).isEqualTo("/app-config/application_config.yaml");
        assertThat(configuration.policySyncFilePath()).isEqualTo("/etc/policies/policies.json");
    }

    @Test
    void fromEnvironment_shouldReturn_CbsClientConfigurationException_When_DCAE_CA_CERTPATH_is_Null() {
        // given
        envs.set(ENV_DCAE_CA_CERTPATH, null);
        envs.set(ENV_CONFIG_BINDING_SERVICE_SERVICE_PORT, "9090");
        envs.set(ENV_CONFIG_BINDING_SERVICE, "config-binding-service");
        envs.set(ENV_HOSTNAME, "dcae-prh");
        envs.set(ENV_CONSUL_HOST, "consul-server.onap");

        // when
        CbsClientConfiguration configuration = CbsClientConfiguration.fromEnvironment();

        // then
        assertThat(configuration.trustStoreKeys()).isNull();
        assertThat(configuration.protocol()).isEqualTo("http");
    }

    @Test
    void fromEnvironment_shouldReturn_CbsClientConfigurationException_WhenAllEnvVariablesAreMissing() {
        assertThatExceptionOfType(CbsClientConfigurationException.class)
                .isThrownBy(CbsClientConfiguration::fromEnvironment);
    }

    @Test
    void fromEnvironment_shouldReturn_CbsClientConfigurationException_When_DCAE_CA_CERTPATH_isWrong() {
        // given
        envs.set(ENV_DCAE_CA_CERTPATH, "/home/cacert.pem");
        envs.set(ENV_HOSTNAME, "dcae-prh");
        envs.set(ENV_CONFIG_BINDING_SERVICE, "config-binding-service");
        envs.set(ENV_CONSUL_HOST, "consul-server.onap");

        // then
        assertThatExceptionOfType(CbsClientConfigurationException.class)
                .isThrownBy(CbsClientConfiguration::fromEnvironment)
                .withMessageContaining("Required files do not exist in /home directory");
    }

    @Test
    void fromEnvironment_shouldReturn_CbsClientConfigurationException_When_HOSTNAME_isMissing() throws URISyntaxException {
        // given
        envs.set(ENV_HOSTNAME, "");
        envs.set(ENV_DCAE_CA_CERTPATH, preparePathToCertFile());
        envs.set(ENV_CONFIG_BINDING_SERVICE, "config-binding-service");
        envs.set(ENV_CONSUL_HOST, "consul-server.onap");

        // then
        assertThatExceptionOfType(CbsClientConfigurationException.class)
                .isThrownBy(CbsClientConfiguration::fromEnvironment)
                .withMessageContaining("Cannot read HOSTNAME from environment.");
    }

    @Test
    void fromEnvironment_shouldReturn_CbsClientConfigurationException_When_CONFIG_BINDING_SERVICE_SERVICE_PORT_isEmpty() {
        // given
        envs.set(ENV_CONFIG_BINDING_SERVICE_SERVICE_PORT, "");
        envs.set(ENV_DCAE_CA_CERTPATH, "");
        envs.set(ENV_HOSTNAME, "dcae-prh");
        envs.set(ENV_CONFIG_BINDING_SERVICE, "config-binding-service");
        envs.set(ENV_CONSUL_HOST, "consul-server.onap");

        // then
        assertThatExceptionOfType(CbsClientConfigurationException.class)
                .isThrownBy(CbsClientConfiguration::fromEnvironment)
                .withMessageContaining("Cannot read CONFIG_BINDING_SERVICE_SERVICE_PORT from environment.");
    }

    private void createBasicValidEnvsConfiguration() {
        envs.set(ENV_CONFIG_BINDING_SERVICE, "config-binding-service");
        envs.set(ENV_CONFIG_BINDING_SERVICE_SERVICE_PORT, "10000");
        envs.set(ENV_HOSTNAME, "dcae-prh");
        envs.set(ENV_CONSUL_HOST, "consul-server.onap");
    }

    private String preparePathToCertFile() throws URISyntaxException {
        return Paths.get(Passwords.class.getResource("/test-certs/cacert.pem").toURI()) + "";
    }
}