diff options
8 files changed, 214 insertions, 3 deletions
diff --git a/holmes-actions/pom.xml b/holmes-actions/pom.xml index 4e23cc5..6d139f0 100644 --- a/holmes-actions/pom.xml +++ b/holmes-actions/pom.xml @@ -12,7 +12,7 @@ <parent>
<groupId>org.onap.holmes.common</groupId>
<artifactId>holmes-common-parent</artifactId>
- <version>1.3.6-SNAPSHOT</version>
+ <version>1.3.7-SNAPSHOT</version>
</parent>
<name>holmes-common-service</name>
@@ -181,5 +181,4 @@ </plugin>
</plugins>
</build>
-
</project>
diff --git a/holmes-actions/src/main/java/org/onap/holmes/common/ConfigFileScanner.java b/holmes-actions/src/main/java/org/onap/holmes/common/ConfigFileScanner.java new file mode 100644 index 0000000..efea832 --- /dev/null +++ b/holmes-actions/src/main/java/org/onap/holmes/common/ConfigFileScanner.java @@ -0,0 +1,55 @@ +/** + * Copyright 2021 ZTE Corporation. + * <p> + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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. + */ + +package org.onap.holmes.common; + +import org.apache.commons.lang3.StringUtils; +import org.onap.holmes.common.utils.FileUtils; + +import java.io.File; +import java.util.HashMap; +import java.util.Map; + +public class ConfigFileScanner { + public synchronized Map<String, String> scan(String path, String fileNamePattern) { + File dir = new File(path); + Map<String, String> ret = new HashMap(); + if (!dir.isDirectory()) { + ret.putAll(readFile(dir)); + } else { + for (File file : dir.listFiles(pathname -> StringUtils.isBlank(fileNamePattern) ? + true : pathname.getName().contains(fileNamePattern))) { + if (!file.isDirectory()) { + ret.putAll(readFile(file)); + } + } + } + return ret; + } + + public synchronized Map<String, String> scan(String path) { + return scan(path, null); + } + + private Map<String, String> readFile(File file) { + Map<String, String> ret = new HashMap(); + String contents = FileUtils.readTextFile(file.getAbsolutePath()); + if (StringUtils.isNotBlank(contents)) { + ret.put(file.getAbsolutePath(), contents); + } + return ret; + } +} diff --git a/holmes-actions/src/main/java/org/onap/holmes/common/utils/FileUtils.java b/holmes-actions/src/main/java/org/onap/holmes/common/utils/FileUtils.java new file mode 100644 index 0000000..cf5de1c --- /dev/null +++ b/holmes-actions/src/main/java/org/onap/holmes/common/utils/FileUtils.java @@ -0,0 +1,49 @@ +/** + * Copyright 2021 ZTE Corporation. + * <p> + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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. + */ + +package org.onap.holmes.common.utils; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.BufferedReader; +import java.io.FileNotFoundException; +import java.io.FileReader; +import java.io.IOException; + +public class FileUtils { + + final static private Logger LOGGER = LoggerFactory.getLogger(FileUtils.class); + + static public String readTextFile(String path) { + try { + BufferedReader br = new BufferedReader(new FileReader(path)); + StringBuilder sb = new StringBuilder(); + String line; + while ((line = br.readLine()) != null) { + sb.append(line); + } + return sb.toString(); + } catch (FileNotFoundException e) { + LOGGER.warn("No file found: {}", path); + } catch (IOException e) { + LOGGER.error(String.format("Failed to read file contents from '%s'.", path), e); + } catch (Exception e) { + LOGGER.warn("Unknown exception occurred!", e); + } + return null; + } +} diff --git a/holmes-actions/src/test/java/org/onap/holmes/common/ConfigFileScannerTest.java b/holmes-actions/src/test/java/org/onap/holmes/common/ConfigFileScannerTest.java new file mode 100644 index 0000000..4778ec4 --- /dev/null +++ b/holmes-actions/src/test/java/org/onap/holmes/common/ConfigFileScannerTest.java @@ -0,0 +1,60 @@ +/** + * Copyright 2021 ZTE Corporation. + * <p> + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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. + */ + +package org.onap.holmes.common; + +import org.junit.Rule; +import org.junit.Test; +import org.junit.rules.ExpectedException; +import org.junit.runner.RunWith; +import org.powermock.modules.junit4.PowerMockRunner; + +import java.util.Map; + +import static org.hamcrest.core.Is.is; +import static org.hamcrest.core.IsEqual.equalTo; +import static org.junit.Assert.assertThat; + +@RunWith(PowerMockRunner.class) +public class ConfigFileScannerTest { + + @Rule + ExpectedException thrown = ExpectedException.none(); + + @Test + public void testScan_file_normal() { + ConfigFileScanner scanner = new ConfigFileScanner(); + String file = ConfigFileScannerTest.class.getResource("/ConfigFileScannerTestData.txt").getFile(); + Map<String, String> files = scanner.scan(file); + assertThat(files.values().iterator().next(), equalTo("isTest=true")); + } + + @Test + public void testScan_file_empty() { + ConfigFileScanner scanner = new ConfigFileScanner(); + String file = ConfigFileScannerTest.class.getResource("/ConfigFileScannerEmpty.txt").getFile(); + Map<String, String> files = scanner.scan(file); + assertThat(files.size(), is(0)); + } + + @Test + public void testScan_directory_normal() { + ConfigFileScanner scanner = new ConfigFileScanner(); + String file = ConfigFileScannerTest.class.getResource("/").getFile(); + Map<String, String> files = scanner.scan(file); + assertThat(files.size(), is(5)); + } +}
\ No newline at end of file diff --git a/holmes-actions/src/test/java/org/onap/holmes/common/utils/FileUtilsTest.java b/holmes-actions/src/test/java/org/onap/holmes/common/utils/FileUtilsTest.java new file mode 100644 index 0000000..bb46f6b --- /dev/null +++ b/holmes-actions/src/test/java/org/onap/holmes/common/utils/FileUtilsTest.java @@ -0,0 +1,47 @@ +/** + * Copyright 2021 ZTE Corporation. + * <p> + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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. + */ + +package org.onap.holmes.common.utils; + +import org.junit.Test; +import org.onap.holmes.common.ConfigFileScanner; +import org.onap.holmes.common.ConfigFileScannerTest; + +import java.util.Map; + +import static org.hamcrest.core.Is.is; +import static org.hamcrest.core.IsEqual.equalTo; +import static org.hamcrest.core.IsNull.nullValue; +import static org.junit.Assert.*; + +public class FileUtilsTest { + + @Test + public void readTextFile_normal() { + String path = FileUtilsTest.class.getResource("/ConfigFileScannerTestData.txt").getFile(); + assertThat(FileUtils.readTextFile(path), equalTo("isTest=true")); + } + + @Test + public void readTextFile_not_found_exception() { + assertThat(FileUtils.readTextFile("a-non-exist-path"), nullValue()); + } + + @Test + public void readTextFile_directory(){ + assertThat(FileUtils.readTextFile("/"), nullValue()); + } +}
\ No newline at end of file diff --git a/holmes-actions/src/test/resources/ConfigFileScannerEmpty.txt b/holmes-actions/src/test/resources/ConfigFileScannerEmpty.txt new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/holmes-actions/src/test/resources/ConfigFileScannerEmpty.txt diff --git a/holmes-actions/src/test/resources/ConfigFileScannerTestData.txt b/holmes-actions/src/test/resources/ConfigFileScannerTestData.txt new file mode 100644 index 0000000..b393d0c --- /dev/null +++ b/holmes-actions/src/test/resources/ConfigFileScannerTestData.txt @@ -0,0 +1 @@ +isTest=true
\ No newline at end of file @@ -20,7 +20,7 @@ <artifactId>holmes-common-parent</artifactId>
<packaging>pom</packaging>
- <version>1.3.6-SNAPSHOT</version>
+ <version>1.3.7-SNAPSHOT</version>
<name>holmes-common</name>
<modules>
<module>holmes-actions</module>
|