aboutsummaryrefslogtreecommitdiffstats
path: root/rest-services/cbs-client/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/cbs/client/impl/CbsClientEnvironmentParsing.java
blob: 21dfb5edd431a16ef4a1dee3474d07abfcca1d7f (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
/*
 * ============LICENSE_START=======================================================
 * DCAEGEN2-SERVICES-SDK
 * ================================================================================
 * Copyright (C) 2021-2022 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.impl;

import com.google.gson.JsonArray;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonPrimitive;
import java.util.HashMap;
import java.util.Map.Entry;
import org.jetbrains.annotations.NotNull;
import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.exceptions.EnvironmentParsingException;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * <p>Config Binding Service client environment variables parsing.</p>
 *
 * @since 1.8.4
 */
public class CbsClientEnvironmentParsing {

    private static final Pattern shellEnvPattern = Pattern.compile("\\$\\{(.+?)}");

    private CbsClientEnvironmentParsing() {
    }

    /**
     * <p>
     * This method will do a lookup of shell variables in provided jsonObject and replace it with found environment variables.
     * </p>
     * <p>
     * In case of failure during resolving environment variables, EnvironmentParsingException is thrown.
     * </p>
     *
     * @param jsonObject
     * @return JsonObject
     * @since 1.8.4
     */
    public static JsonObject processEnvironmentVariables(JsonObject jsonObject) {
        JsonObject jsonObjectCopy = jsonObject.deepCopy();
        processJsonObject(jsonObjectCopy);
        return jsonObjectCopy;
    }

    private static void processJsonObject(JsonObject jsonObject) {
        for (Map.Entry<String, JsonElement> entry : jsonObject.entrySet()) {
            processJsonObjectEntry(jsonObject, entry);
        }
    }

    private static void processJsonObjectEntry(JsonObject jsonObject, Map.Entry<String, JsonElement> entry) {
        if (entry.getValue().isJsonArray()) {
            processJsonArray(entry.getValue().getAsJsonArray());
        } else if (entry.getValue().isJsonObject()) {
            processJsonObject(entry.getValue().getAsJsonObject());
        } else {
            Map<String, String> systemEnvMatches = getSystemEnvMatches(entry);
            if (systemEnvMatches.isEmpty()) {
                return;
            }
            String result = getReplacedValue(entry.getValue().getAsString(), systemEnvMatches);

            jsonObject.addProperty(entry.getKey(), result);
        }
    }

    @NotNull
    private static Map<String, String> getSystemEnvMatches(Entry<String, JsonElement> entry) {
        Matcher matcher = getMatcher(entry.getValue().getAsString());
        Map<String,String> systemEnvMatches = new HashMap<>();
        while (matcher.find()) {
            String stringTobeReplaced = matcher.group(0);
            String systemEnv = matcher.group(1);
            systemEnvMatches.put(stringTobeReplaced, systemEnv);
        }
        return systemEnvMatches;
    }

    private static String getReplacedValue(String inputValue, Map<String, String> systemEnvMatches) {
        String result = inputValue;
        for (Entry<String, String> valueToReplace : systemEnvMatches.entrySet()) {
            result = result.replace(valueToReplace.getKey(), getValueFromSystemEnv(valueToReplace.getValue()));
        }
        return result;
    }

    private static void processJsonArray(JsonArray jsonArray) {
        for (int i = 0; i < jsonArray.size(); i++) {
            if (jsonArray.get(i).isJsonObject()) {
                processJsonObject(jsonArray.get(i).getAsJsonObject());
            } else if (jsonArray.get(i).isJsonArray()) {
                processJsonArray(jsonArray.get(i).getAsJsonArray());
            } else {
                Matcher matcher = getMatcher(jsonArray.get(i).getAsString());
                if (matcher.find()) {
                    jsonArray.set(i, new JsonPrimitive(getValueFromSystemEnv(matcher.group(1))));
                }
            }
        }
    }

    private static Matcher getMatcher(String value) {
        return shellEnvPattern.matcher(value);
    }

    private static String getValueFromSystemEnv( String envName) {
        String envValue = System.getenv(envName);
        if (envValue == null || "".equals(envValue)) {
            throw new EnvironmentParsingException("Cannot read " + envName + " from environment.");
        }
        return envValue;
    }
}