Merge "Add log level configuration by system environment variable"

6 files changed, 279 insertions, 4 deletions

diff --git a/src/main/java/org/onap/sdc/helmvalidator/HelmValidatorApplication.java b/src/main/java/org/onap/sdc/helmvalidator/HelmValidatorApplication.java
index b8bed69..0d094f6 100644
--- a/src/main/java/org/onap/sdc/helmvalidator/HelmValidatorApplication.java
+++ b/src/main/java/org/onap/sdc/helmvalidator/HelmValidatorApplication.java
@@ -20,14 +20,18 @@
 
 package org.onap.sdc.helmvalidator;
 
-import org.springframework.boot.SpringApplication;
+import org.onap.sdc.helmvalidator.config.LoggerConfig;
+import org.onap.sdc.helmvalidator.config.EnvProvider;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.builder.SpringApplicationBuilder;
 
 @SpringBootApplication
 public class HelmValidatorApplication {
 
     public static void main(String[] args) {
-        SpringApplication.run(HelmValidatorApplication.class, args);
+        new SpringApplicationBuilder(HelmValidatorApplication.class)
+            .properties(new LoggerConfig(EnvProvider.getStandardProvider()).getLoggerProperties())
+            .run(args);
     }
 
 }
diff --git a/src/main/java/org/onap/sdc/helmvalidator/config/EnvProvider.java b/src/main/java/org/onap/sdc/helmvalidator/config/EnvProvider.java
new file mode 100644
index 0000000..47b82ec
--- /dev/null
+++ b/src/main/java/org/onap/sdc/helmvalidator/config/EnvProvider.java
@@ -0,0 +1,46 @@
+/*
+ * ============LICENSE_START=======================================================
+ * SDC-HELM-VALIDATOR
+ * ================================================================================
+ * Copyright (C) 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.sdc.helmvalidator.config;
+
+import java.util.Optional;
+import org.springframework.stereotype.Service;
+
+@Service
+public class EnvProvider {
+
+    public static EnvProvider getStandardProvider() {
+        return new EnvProvider();
+    }
+
+    public String readEnvVariable(String envVariableName) {
+        return Optional.ofNullable(getSystemEnv(envVariableName))
+            .orElseGet(this::getDefaultValue);
+    }
+
+    private String getSystemEnv(String envVariableName) {
+        return System.getenv(envVariableName);
+    }
+
+    private String getDefaultValue() {
+        return LogLevel.getDefaultLevel();
+    }
+
+}
diff --git a/src/main/java/org/onap/sdc/helmvalidator/config/LogLevel.java b/src/main/java/org/onap/sdc/helmvalidator/config/LogLevel.java
new file mode 100644
index 0000000..c97e9dd
--- /dev/null
+++ b/src/main/java/org/onap/sdc/helmvalidator/config/LogLevel.java
@@ -0,0 +1,44 @@
+/*
+ * ============LICENSE_START=======================================================
+ * SDC-HELM-VALIDATOR
+ * ================================================================================
+ * Copyright (C) 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.sdc.helmvalidator.config;
+
+import java.util.List;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+public enum LogLevel {
+    FATAL,
+    ERROR,
+    WARN,
+    INFO,
+    DEBUG,
+    TRACE;
+
+    static String getDefaultLevel() {
+        return ERROR.toString();
+    }
+
+    static List<String> getSupportedLevels() {
+        return Stream.of(values())
+            .map(Enum::toString)
+            .collect(Collectors.toList());
+    }
+}
diff --git a/src/main/java/org/onap/sdc/helmvalidator/config/LoggerConfig.java b/src/main/java/org/onap/sdc/helmvalidator/config/LoggerConfig.java
new file mode 100644
index 0000000..dc27800
--- /dev/null
+++ b/src/main/java/org/onap/sdc/helmvalidator/config/LoggerConfig.java
@@ -0,0 +1,84 @@
+/*
+ * ============LICENSE_START=======================================================
+ * SDC-HELM-VALIDATOR
+ * ================================================================================
+ * Copyright (C) 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.sdc.helmvalidator.config;
+
+import java.util.Optional;
+import java.util.Properties;
+import javax.annotation.PostConstruct;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.stereotype.Service;
+
+@Service
+public class LoggerConfig {
+
+    private static final String LOG_LEVEL_ENV = "LOG_LEVEL";
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(LoggerConfig.class);
+
+    private final EnvProvider envProvider;
+
+    public LoggerConfig(EnvProvider envProvider) {
+        this.envProvider = envProvider;
+    }
+
+    public Properties getLoggerProperties() {
+        String level = getLogLevel();
+        Properties loggerProperties = new Properties();
+        loggerProperties.setProperty("logging.level.web", level);
+        loggerProperties.setProperty("logging.level.org.springframework", level);
+        loggerProperties.setProperty("logging.level.org.apache.catalina.core", level);
+        loggerProperties.setProperty("logging.level.org.onap.sdc.helmvalidator", level);
+        loggerProperties.setProperty("spring.mvc.log-request-details", isDebugLevel().toString());
+
+        return loggerProperties;
+    }
+
+    private String getLogLevel() {
+        return Optional.of(getLogLevelEnvVariable())
+            .map(String::toUpperCase)
+            .filter(this::isSupportedLevel)
+            .orElseGet(LogLevel::getDefaultLevel);
+    }
+
+    private String getLogLevelEnvVariable() {
+        return envProvider.readEnvVariable(LOG_LEVEL_ENV);
+    }
+
+    private Boolean isDebugLevel() {
+        return getLogLevel().equals("DEBUG");
+    }
+
+    private boolean isSupportedLevel(String level) {
+        return LogLevel.getSupportedLevels().stream()
+            .anyMatch(logLevel -> logLevel.equalsIgnoreCase(level));
+    }
+
+    @PostConstruct
+    private void logConfigurationLevelValue() {
+        String logLevel = getLogLevelEnvVariable();
+        if (!isSupportedLevel(logLevel)) {
+            LOGGER.error("Log level '{}' not match to supported levels. Available values:  {}", logLevel,
+                LogLevel.getSupportedLevels());
+            LOGGER.error("Log level set to default: {}", LogLevel.getDefaultLevel());
+        }
+    }
+}
diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties
index 3fef31f..f9dea88 100644
--- a/src/main/resources/application.properties
+++ b/src/main/resources/application.properties
@@ -1,4 +1,9 @@
-logging.level.web="ERROR"
-spring.mvc.log-request-details=false
 app.config.charts-base-path=/charts
 spring.jackson.default-property-inclusion=NON_NULL
+
+logging.file.name=/var/log/onap/application.log
+logging.logback.rollingpolicy.file-name-pattern=/var/log/onap/application-%d{yyyy-MM-dd}.%i.log
+logging.logback.rollingpolicy.max-file-size=1MB
+logging.logback.rollingpolicy.total-size-cap=10MB
+logging.logback.rollingpolicy.max-history=30
+logging.logback.rollingpolicy.clean-history-on-start=true
diff --git a/src/test/java/org/onap/sdc/helmvalidator/config/LoggerConfigTest.java b/src/test/java/org/onap/sdc/helmvalidator/config/LoggerConfigTest.java
new file mode 100644
index 0000000..b2ae9e5
--- /dev/null
+++ b/src/test/java/org/onap/sdc/helmvalidator/config/LoggerConfigTest.java
@@ -0,0 +1,92 @@
+/*
+ * ============LICENSE_START=======================================================
+ * SDC-HELM-VALIDATOR
+ * ================================================================================
+ * Copyright (C) 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.sdc.helmvalidator.config;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import java.util.Properties;
+import org.junit.jupiter.api.Test;
+
+class LoggerConfigTest {
+
+    private static final boolean WITHOUT_DETAILS = false;
+    private static final boolean WITH_DETAILS = true;
+    private static final String EXPECTED_ERROR = "ERROR";
+    private static final String EXPECTED_DEBUG = "DEBUG";
+
+    private final EnvProvider envProvider = mock(EnvProvider.class);
+    private final LoggerConfig loggerConfig = new LoggerConfig(envProvider);
+
+    @Test
+    void shouldProvideCorrectPropertiesForErrorLogLevel() {
+        when(envProvider.readEnvVariable(anyString())).thenReturn("ERROR");
+
+        Properties properties = loggerConfig.getLoggerProperties();
+
+        assertThatAllLogPropertiesHasExpectedValue(properties, EXPECTED_ERROR);
+        assertThatRequestDetailsPropertyHasExpectedValue(properties, WITHOUT_DETAILS);
+    }
+
+    @Test
+    void shouldProvideCorrectPropertiesForEnvInLowerCase() {
+        when(envProvider.readEnvVariable(anyString())).thenReturn("error");
+
+        Properties properties = loggerConfig.getLoggerProperties();
+
+        assertThatAllLogPropertiesHasExpectedValue(properties, EXPECTED_ERROR);
+        assertThatRequestDetailsPropertyHasExpectedValue(properties, WITHOUT_DETAILS);
+    }
+
+    @Test
+    void shouldProvideCorrectPropertiesForDebugLevel() {
+        when(envProvider.readEnvVariable(anyString())).thenReturn("DEBUG");
+
+        Properties properties = loggerConfig.getLoggerProperties();
+
+        assertThatAllLogPropertiesHasExpectedValue(properties, EXPECTED_DEBUG);
+        assertThatRequestDetailsPropertyHasExpectedValue(properties, WITH_DETAILS);
+    }
+
+    @Test
+    void shouldProvideCorrectPropertiesForNotSupportedLevel() {
+        when(envProvider.readEnvVariable(anyString())).thenReturn("notSupportedLevel");
+
+        Properties properties = loggerConfig.getLoggerProperties();
+
+        assertThatAllLogPropertiesHasExpectedValue(properties, "ERROR");
+        assertThatRequestDetailsPropertyHasExpectedValue(properties, WITHOUT_DETAILS);
+    }
+
+    private void assertThatAllLogPropertiesHasExpectedValue(Properties properties, String expectedValue) {
+        assertThat(properties.getProperty("logging.level.web")).isEqualTo(expectedValue);
+        assertThat(properties.getProperty("logging.level.org.springframework")).isEqualTo(expectedValue);
+        assertThat(properties.getProperty("logging.level.org.apache.catalina.core")).isEqualTo(expectedValue);
+        assertThat(properties.getProperty("logging.level.org.onap.sdc.helmvalidator")).isEqualTo(expectedValue);
+    }
+
+    private void assertThatRequestDetailsPropertyHasExpectedValue(Properties properties, Boolean expected) {
+        assertThat(properties.getProperty("spring.mvc.log-request-details")).isEqualTo(expected.toString());
+    }
+
+}