diff --git a/sechub-adapter/src/main/java/com/mercedesbenz/sechub/adapter/FileBasedAdapterMetaDataCallback.java b/sechub-adapter/src/main/java/com/mercedesbenz/sechub/adapter/FileBasedAdapterMetaDataCallback.java index 7bb4343911..506978825e 100644 --- a/sechub-adapter/src/main/java/com/mercedesbenz/sechub/adapter/FileBasedAdapterMetaDataCallback.java +++ b/sechub-adapter/src/main/java/com/mercedesbenz/sechub/adapter/FileBasedAdapterMetaDataCallback.java @@ -31,7 +31,7 @@ public FileBasedAdapterMetaDataCallback(File file) { public void persist(AdapterMetaData metaData) { String metaDataJson = JSONConverter.get().toJSON(metaData); try { - writer.save(file, metaDataJson, true); + writer.writeTextToFile(file, metaDataJson, true); } catch (IOException e) { throw new IllegalStateException("Was not able to store meta data!", e); } @@ -45,7 +45,7 @@ public AdapterMetaData getMetaDataOrNull() { } try { - String data = reader.loadTextFile(file); + String data = reader.readTextFromFile(file); if (data == null || data.isEmpty()) { return null; } diff --git a/sechub-adapter/src/test/java/com/mercedesbenz/sechub/adapter/FileBasedAdapterMetaDataCallbackTest.java b/sechub-adapter/src/test/java/com/mercedesbenz/sechub/adapter/FileBasedAdapterMetaDataCallbackTest.java index 70c3866450..962bd2b0e7 100644 --- a/sechub-adapter/src/test/java/com/mercedesbenz/sechub/adapter/FileBasedAdapterMetaDataCallbackTest.java +++ b/sechub-adapter/src/test/java/com/mercedesbenz/sechub/adapter/FileBasedAdapterMetaDataCallbackTest.java @@ -59,7 +59,7 @@ void reading_an_empty_file_does_return_null() throws Exception { void reading_a_clean_json_does_return_empty_metadata_object() throws Exception { /* prepare */ TestFileWriter writer = new TestFileWriter(); - writer.save(testFile, "{}", true); + writer.writeTextToFile(testFile, "{}", true); /* execute */ AdapterMetaData metaData = callbackToTest.getMetaDataOrNull(); diff --git a/sechub-api-java/src/test/java/com/mercedesbenz/sechub/api/generator/InternalAccessModelFileGenerator.java b/sechub-api-java/src/test/java/com/mercedesbenz/sechub/api/generator/InternalAccessModelFileGenerator.java index b94fad9414..63b5b08ef9 100644 --- a/sechub-api-java/src/test/java/com/mercedesbenz/sechub/api/generator/InternalAccessModelFileGenerator.java +++ b/sechub-api-java/src/test/java/com/mercedesbenz/sechub/api/generator/InternalAccessModelFileGenerator.java @@ -98,7 +98,7 @@ private void generateAbstractModel(MapGenInfo info) throws Exception { template.addLine(" }"); template.addLine("}"); - context.getTextFileWriter().save(genFile, template.getCode(), true); + context.getTextFileWriter().writeTextToFile(genFile, template.getCode(), true); } diff --git a/sechub-api-java/src/test/java/com/mercedesbenz/sechub/api/generator/PublicModelFileGenerator.java b/sechub-api-java/src/test/java/com/mercedesbenz/sechub/api/generator/PublicModelFileGenerator.java index 6bdd03a235..b7dc6e885f 100644 --- a/sechub-api-java/src/test/java/com/mercedesbenz/sechub/api/generator/PublicModelFileGenerator.java +++ b/sechub-api-java/src/test/java/com/mercedesbenz/sechub/api/generator/PublicModelFileGenerator.java @@ -110,7 +110,7 @@ private void generatetPublicModel(MapGenInfo info, boolean overwritePublicModelF template.addLine(""); template.addLine("}"); - context.getTextFileWriter().save(genFile, template.getCode(), overwritePublicModelFiles); + context.getTextFileWriter().writeTextToFile(genFile, template.getCode(), overwritePublicModelFiles); } diff --git a/sechub-commons-archive/src/test/java/com/mercedesbenz/sechub/commons/archive/ArchiveSupportTest.java b/sechub-commons-archive/src/test/java/com/mercedesbenz/sechub/commons/archive/ArchiveSupportTest.java index 154f15930b..70db925fed 100644 --- a/sechub-commons-archive/src/test/java/com/mercedesbenz/sechub/commons/archive/ArchiveSupportTest.java +++ b/sechub-commons-archive/src/test/java/com/mercedesbenz/sechub/commons/archive/ArchiveSupportTest.java @@ -284,7 +284,7 @@ void compress_zip_single_data_txt_file_compressed_output_contains_same_content() File targetFile = new File(parentFolder, "sourcecode.zip"); TextFileWriter writer = new TextFileWriter(); - writer.save(textFile, "This is just a test content", true); + writer.writeTextToFile(textFile, "This is just a test content", true); /* execute */ supportToTest.compressFolder(ArchiveType.ZIP, dataFolder, targetFile); @@ -307,7 +307,7 @@ private void assertFileContains(File file, String expectedContent) throws IOExce fail("File:" + file + " does not exist!"); } TextFileReader reader = new TextFileReader(); - String content = reader.loadTextFile(file); + String content = reader.readTextFromFile(file); assertEquals(expectedContent, content); } @@ -324,8 +324,8 @@ void compress_zip_two_txt_files_compressed_output_contains_same_content() throws File targetFile = new File(parentFolder, "sourcecode.zip"); TextFileWriter writer = new TextFileWriter(); - writer.save(textFile1, "text1", true); - writer.save(textFile2, "text2", true); + writer.writeTextToFile(textFile1, "text1", true); + writer.writeTextToFile(textFile2, "text2", true); /* execute */ supportToTest.compressFolder(ArchiveType.ZIP, dataFolder, targetFile); diff --git a/sechub-commons-model/src/main/java/com/mercedesbenz/sechub/commons/TextFileReader.java b/sechub-commons-model/src/main/java/com/mercedesbenz/sechub/commons/TextFileReader.java index 918c85b969..1b69932759 100644 --- a/sechub-commons-model/src/main/java/com/mercedesbenz/sechub/commons/TextFileReader.java +++ b/sechub-commons-model/src/main/java/com/mercedesbenz/sechub/commons/TextFileReader.java @@ -6,34 +6,49 @@ import java.io.FileInputStream; import java.io.IOException; import java.io.InputStreamReader; +import java.nio.charset.Charset; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * A class to read text from files. Will always use UTF-8. + * + * @author Albert Tregnaghi + * + */ public class TextFileReader { + private static final String DEFAULT_LINE_BREAK = "\n"; + private static final Charset CHARSET_UTF8 = Charset.forName("UTF-8"); + + private static final Logger LOG = LoggerFactory.getLogger(TextFileReader.class); + /** - * Load complete text file with default line break (new line) + * Read complete text from file with default line break * * @param file resource to load - * @return string, never {@link NullPointerException} - * @throws IOException + * @return string, never null + * @throws IOException when IO problems occur */ - public String loadTextFile(File file) throws IOException { - return loadTextFile(file, "\n"); + public String readTextFromFile(File file) throws IOException { + return readTextFromFile(file, DEFAULT_LINE_BREAK); } /** - * Load complete text file + * Read complete text from file * * @param file resource to load * @param lineBreak the line break to use - * @return - * @throws IOException + * @return string, never null + * @throws IOException when IO problems occur */ - public String loadTextFile(File file, String lineBreak) throws IOException { - return loadTextFile(file, lineBreak, null); + public String readTextFromFile(File file, String lineBreak) throws IOException { + return readTextFromFile(file, lineBreak, null); } /** - * Loads text file - if max amount of lines is defined, only this amount of + * Read text from file - if max amount of lines is defined, only this amount of * lines will be read. * * @param file resource to load @@ -41,14 +56,16 @@ public String loadTextFile(File file, String lineBreak) throws IOException { * @param maxAmountOfLines maximum amount lines to read - minimum is 1. One line * will always be returned, even when the value is lower * than 1! - * @return - * @throws IOException + * @return string, never null + * @throws IOException when IO problems occur */ - public String loadTextFile(File file, String lineBreak, Integer maxAmountOfLines) throws IOException { + public String readTextFromFile(File file, String lineBreak, Integer maxAmountOfLines) throws IOException { + LOG.trace("Read text from file: {}", file); + StringBuilder sb = new StringBuilder(); int linesRead = 0; - try (BufferedReader br = new BufferedReader(new InputStreamReader(new FileInputStream(file), "UTF-8"))) { + try (BufferedReader br = new BufferedReader(new InputStreamReader(new FileInputStream(file), CHARSET_UTF8))) { String line = null; while ((line = br.readLine()) != null) { diff --git a/sechub-commons-model/src/main/java/com/mercedesbenz/sechub/commons/TextFileWriter.java b/sechub-commons-model/src/main/java/com/mercedesbenz/sechub/commons/TextFileWriter.java index 0ec812fc0e..2dd0465a72 100644 --- a/sechub-commons-model/src/main/java/com/mercedesbenz/sechub/commons/TextFileWriter.java +++ b/sechub-commons-model/src/main/java/com/mercedesbenz/sechub/commons/TextFileWriter.java @@ -12,8 +12,15 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * A class to write text to files. Will always use UTF-8. + * + * @author Albert Tregnaghi + * + */ public class TextFileWriter { + private static final Charset CHARSET_UTF_8 = Charset.forName("UTF-8"); private static final Logger LOG = LoggerFactory.getLogger(TextFileWriter.class); /** @@ -26,11 +33,7 @@ public class TextFileWriter { * before write * @throws IOException */ - public void save(File targetFile, String text, boolean overwrite) throws IOException { - internalSave(targetFile, text, overwrite, Charset.forName("UTF-8")); - } - - private void internalSave(File targetFile, String text, boolean overwrite, Charset charset) throws IOException { + public void writeTextToFile(File targetFile, String text, boolean overwrite) throws IOException { if (targetFile == null) { throw new IllegalArgumentException("null not allowed as file!"); } @@ -59,7 +62,7 @@ private void internalSave(File targetFile, String text, boolean overwrite, Chars throw new IllegalStateException("was not able to create new file:" + targetFile); } } - try (BufferedWriter bw = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(targetFile), charset))) { + try (BufferedWriter bw = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(targetFile), CHARSET_UTF_8))) { bw.write(text); } diff --git a/sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/RemoteCredentialContainerTest.java b/sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/RemoteCredentialContainerTest.java index ecc43415d1..6654d5a485 100644 --- a/sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/RemoteCredentialContainerTest.java +++ b/sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/RemoteCredentialContainerTest.java @@ -20,7 +20,7 @@ class RemoteCredentialContainerTest { @Test void resolve_remote_credentials_by_location_and_accept_all_types() { /* prepare */ - String json = TestFileReader.loadTextFile(new File("./src/test/resources/sechub_remote_credentials_config.json")); + String json = TestFileReader.readTextFromFile(new File("./src/test/resources/sechub_remote_credentials_config.json")); RemoteCredentialConfiguration configuration = RemoteCredentialConfiguration.fromJSONString(json); containerToTest = new RemoteCredentialContainerFactory().create(configuration); String location1 = "https://github.com/username/project"; @@ -58,7 +58,7 @@ void resolve_remote_credentials_by_location_and_accept_all_types() { @Test void resolve_remote_credentials_by_location_and_accept_specific_types() { /* prepare */ - String json = TestFileReader.loadTextFile(new File("./src/test/resources/sechub_remote_credentials_config.json")); + String json = TestFileReader.readTextFromFile(new File("./src/test/resources/sechub_remote_credentials_config.json")); RemoteCredentialConfiguration configuration = RemoteCredentialConfiguration.fromJSONString(json); containerToTest = new RemoteCredentialContainerFactory().create(configuration); String type1 = "docker"; @@ -158,7 +158,7 @@ void resolve_credentials_from_configuration_where_no_types_are_set_but_all_types @NullSource void resolve_remote_credential_pattern_by_location_with_empty_or_null_location(String location) { /* prepare */ - String json = TestFileReader.loadTextFile(new File("./src/test/resources/sechub_remote_credentials_config.json")); + String json = TestFileReader.readTextFromFile(new File("./src/test/resources/sechub_remote_credentials_config.json")); RemoteCredentialConfiguration configuration = RemoteCredentialConfiguration.fromJSONString(json); containerToTest = new RemoteCredentialContainerFactory().create(configuration); @@ -174,7 +174,7 @@ void resolve_remote_credential_pattern_by_location_with_empty_or_null_location(S @NullSource void resolve_remote_credential_by_unknown_location_with_empty_or_null_type(String type) { /* prepare */ - String json = TestFileReader.loadTextFile(new File("./src/test/resources/sechub_remote_credentials_config.json")); + String json = TestFileReader.readTextFromFile(new File("./src/test/resources/sechub_remote_credentials_config.json")); RemoteCredentialConfiguration configuration = RemoteCredentialConfiguration.fromJSONString(json); containerToTest = new RemoteCredentialContainerFactory().create(configuration); String location = "unknown-location"; diff --git a/sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/SecHubConfigurationModelSupportTest.java b/sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/SecHubConfigurationModelSupportTest.java index b29db47872..93d9106e7a 100644 --- a/sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/SecHubConfigurationModelSupportTest.java +++ b/sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/SecHubConfigurationModelSupportTest.java @@ -681,7 +681,7 @@ void sechub_secret_scan_config_source_example__source_required_only_by_secret_sc } static SecHubConfigurationModel loadModel(String testFileName) { - String json = TestFileReader.loadTextFile(new File("./src/test/resources/" + testFileName)); + String json = TestFileReader.readTextFromFile(new File("./src/test/resources/" + testFileName)); return converter.fromJSON(SecHubConfigurationModel.class, json); } } diff --git a/sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/SecHubConfigurationModelValidatorTest.java b/sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/SecHubConfigurationModelValidatorTest.java index 5d832bd13f..0ff3f27301 100644 --- a/sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/SecHubConfigurationModelValidatorTest.java +++ b/sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/SecHubConfigurationModelValidatorTest.java @@ -1370,7 +1370,7 @@ void model_has_multiple_header_values_from_file_ref_and_direct_value_specified_h @ValueSource(strings = { "src/test/resources/sechub_config_web_scan_no_intersection_of_urls_of_same_header.json" }) void explicit_definitions_for_the_same_header_for_certain_urls_but_list_of_urls_have_no_intersections_has_no_errors(String testFilePath) { /* prepare */ - String json = TestFileReader.loadTextFile(testFilePath); + String json = TestFileReader.readTextFromFile(testFilePath); SecHubScanConfiguration sechubConfiguration = SecHubScanConfiguration.createFromJSON(json); modelSupportCollectedScanTypes.add(ScanType.WEB_SCAN); @@ -1388,7 +1388,7 @@ void explicit_definitions_for_the_same_header_for_certain_urls_but_list_of_urls_ void explicit_definitions_for_the_same_header_for_certain_urls_but_list_of_urls_have_no_intersections_with_lower_and_upper_cases_has_no_errors( String testFilePath) { /* prepare */ - String json = TestFileReader.loadTextFile(testFilePath); + String json = TestFileReader.readTextFromFile(testFilePath); SecHubScanConfiguration sechubConfiguration = SecHubScanConfiguration.createFromJSON(json); modelSupportCollectedScanTypes.add(ScanType.WEB_SCAN); @@ -1404,7 +1404,7 @@ void explicit_definitions_for_the_same_header_for_certain_urls_but_list_of_urls_ @ValueSource(strings = { "src/test/resources/sechub_config_web_scan_default_and_explicit_definitions_for_urls_for_header.json" }) void default_for_a_header_with_explicit_definitions_for_the_same_header_for_certain_urls_has_no_errors(String testFilePath) { /* prepare */ - String json = TestFileReader.loadTextFile(testFilePath); + String json = TestFileReader.readTextFromFile(testFilePath); SecHubScanConfiguration sechubConfiguration = SecHubScanConfiguration.createFromJSON(json); modelSupportCollectedScanTypes.add(ScanType.WEB_SCAN); @@ -1421,7 +1421,7 @@ void default_for_a_header_with_explicit_definitions_for_the_same_header_for_cert "src/test/resources/sechub_config_web_scan_duplicated_default_with_upper_case.json" }) void duplicated_default_for_the_same_header_has_error(String testFilePath) { /* prepare */ - String json = TestFileReader.loadTextFile(testFilePath); + String json = TestFileReader.readTextFromFile(testFilePath); SecHubScanConfiguration sechubConfiguration = SecHubScanConfiguration.createFromJSON(json); modelSupportCollectedScanTypes.add(ScanType.WEB_SCAN); @@ -1438,7 +1438,7 @@ void duplicated_default_for_the_same_header_has_error(String testFilePath) { "src/test/resources/sechub_config_web_scan_intersection_of_urls_of_same_header_missing_slash.json" }) void explicit_definitions_for_the_same_header_for_certain_urls_but_list_of_urls_do_have_intersections_has_error(String testFilePath) { /* prepare */ - String json = TestFileReader.loadTextFile(testFilePath); + String json = TestFileReader.readTextFromFile(testFilePath); SecHubScanConfiguration sechubConfiguration = SecHubScanConfiguration.createFromJSON(json); modelSupportCollectedScanTypes.add(ScanType.WEB_SCAN); @@ -1577,7 +1577,7 @@ void include_too_long_results_in_error() { @Test void can_read_sechub_web_scan_config_with_wildcards() { /* prepare */ - String json = TestFileReader.loadTextFile("src/test/resources/sechub_config_web_scan_includes_excludes_with_wildcards.json"); + String json = TestFileReader.readTextFromFile("src/test/resources/sechub_config_web_scan_includes_excludes_with_wildcards.json"); SecHubScanConfiguration sechubConfiguration = SecHubScanConfiguration.createFromJSON(json); modelSupportCollectedScanTypes.add(ScanType.WEB_SCAN); @@ -1619,7 +1619,7 @@ void when_sechub_config_has_exactly_maximum_size_allowed_error_SECHUB_CONFIGURAT @ValueSource(strings = { "src/test/resources/sechub_remote_data_config_binary_code_scan_example.json", "src/test/resources/sechub_remote_data_config_source_code_scan_example.json" }) void when_remote_sechub_configuration_is_valid_no_errors_are_reported(String file) { - String json = TestFileReader.loadTextFile(file); + String json = TestFileReader.readTextFromFile(file); SecHubScanConfiguration sechubConfiguration = SecHubScanConfiguration.createFromJSON(json); modelSupportCollectedScanTypes.add(ScanType.CODE_SCAN); @@ -1633,7 +1633,7 @@ void when_remote_sechub_configuration_is_valid_no_errors_are_reported(String fil @Test void when_multiple_remote_configurations_are_configured_error_REMOTE_DATA_CONFIGURATION_ONLY_FOR_ONE_SOURCE_OR_BINARY() { /* prepare */ - String json = TestFileReader.loadTextFile("src/test/resources/sechub_remote_data_config_invalid_multi_config.json"); + String json = TestFileReader.readTextFromFile("src/test/resources/sechub_remote_data_config_invalid_multi_config.json"); SecHubScanConfiguration sechubConfiguration = SecHubScanConfiguration.createFromJSON(json); modelSupportCollectedScanTypes.add(ScanType.CODE_SCAN); @@ -1648,7 +1648,7 @@ void when_multiple_remote_configurations_are_configured_error_REMOTE_DATA_CONFIG @Test void when_remote_configuration_location_is_not_defined_error_REMOTE_DATA_CONFIGURATION_LOCATION_NOT_DEFINED() { /* prepare */ - String json = TestFileReader.loadTextFile("src/test/resources/sechub_remote_data_config_invalid_missing_location.json"); + String json = TestFileReader.readTextFromFile("src/test/resources/sechub_remote_data_config_invalid_missing_location.json"); SecHubScanConfiguration sechubConfiguration = SecHubScanConfiguration.createFromJSON(json); modelSupportCollectedScanTypes.add(ScanType.CODE_SCAN); @@ -1663,7 +1663,7 @@ void when_remote_configuration_location_is_not_defined_error_REMOTE_DATA_CONFIGU @Test void when_remote_configuration_has_empty_credentials_error_REMOTE_DATA_CONFIGURATION_USER_NOT_DEFINED() { /* prepare */ - String json = TestFileReader.loadTextFile("src/test/resources/sechub_remote_data_config_invalid_credentials_empty.json"); + String json = TestFileReader.readTextFromFile("src/test/resources/sechub_remote_data_config_invalid_credentials_empty.json"); SecHubScanConfiguration sechubConfiguration = SecHubScanConfiguration.createFromJSON(json); modelSupportCollectedScanTypes.add(ScanType.CODE_SCAN); @@ -1678,7 +1678,7 @@ void when_remote_configuration_has_empty_credentials_error_REMOTE_DATA_CONFIGURA @Test void when_remote_configuration_credential_user_has_no_username_error_REMOTE_DATA_CONFIGURATION_USER_NAME_NOT_DEFINED() { /* prepare */ - String json = TestFileReader.loadTextFile("src/test/resources/sechub_remote_data_config_invalid_user_credential_missing_username.json"); + String json = TestFileReader.readTextFromFile("src/test/resources/sechub_remote_data_config_invalid_user_credential_missing_username.json"); SecHubScanConfiguration sechubConfiguration = SecHubScanConfiguration.createFromJSON(json); modelSupportCollectedScanTypes.add(ScanType.CODE_SCAN); @@ -1693,7 +1693,7 @@ void when_remote_configuration_credential_user_has_no_username_error_REMOTE_DATA @Test void when_remote_configuration_credential_user_has_no_password_error_REMOTE_DATA_CONFIGURATION_USER_PASSWORD_NOT_DEFINED() { /* prepare */ - String json = TestFileReader.loadTextFile("src/test/resources/sechub_remote_data_config_invalid_user_credential_missing_password.json"); + String json = TestFileReader.readTextFromFile("src/test/resources/sechub_remote_data_config_invalid_user_credential_missing_password.json"); SecHubScanConfiguration sechubConfiguration = SecHubScanConfiguration.createFromJSON(json); modelSupportCollectedScanTypes.add(ScanType.CODE_SCAN); @@ -1708,7 +1708,7 @@ void when_remote_configuration_credential_user_has_no_password_error_REMOTE_DATA @Test void when_remote_configuration_is_mixed_with_filesystem_REMOTE_REMOTE_DATA_MIXED_WITH_FILESYSTEM_NOT_ALLOWED() { /* prepare */ - String json = TestFileReader.loadTextFile("src/test/resources/sechub_remote_data_config_invalid_config_with_filesystem.json"); + String json = TestFileReader.readTextFromFile("src/test/resources/sechub_remote_data_config_invalid_config_with_filesystem.json"); SecHubScanConfiguration sechubConfiguration = SecHubScanConfiguration.createFromJSON(json); modelSupportCollectedScanTypes.add(ScanType.CODE_SCAN); @@ -1723,7 +1723,7 @@ void when_remote_configuration_is_mixed_with_filesystem_REMOTE_REMOTE_DATA_MIXED @Test void when_remote_data_is_configured_for_binaries_and_sources_error() { /* prepare */ - String json = TestFileReader.loadTextFile("src/test/resources/sechub_remote_data_config_invalid_source_and_binaries.json"); + String json = TestFileReader.readTextFromFile("src/test/resources/sechub_remote_data_config_invalid_source_and_binaries.json"); SecHubScanConfiguration sechubConfiguration = SecHubScanConfiguration.createFromJSON(json); modelSupportCollectedScanTypes.add(ScanType.CODE_SCAN); diff --git a/sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/SecHubReportModelTest.java b/sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/SecHubReportModelTest.java index be8759b8b3..f761c31b84 100644 --- a/sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/SecHubReportModelTest.java +++ b/sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/SecHubReportModelTest.java @@ -33,7 +33,7 @@ void empty_model_does_not_contain(String notContained) { @Test void sechub_example_result_7_can_be_loaded_and_transformed_from_json() { /* prepare */ - String json = TestFileReader.loadTextFile("src/test/resources/report/sechub-testreport7-secret-scan-with-revision-data-and-metadata.json"); + String json = TestFileReader.readTextFromFile("src/test/resources/report/sechub-testreport7-secret-scan-with-revision-data-and-metadata.json"); /* execute 1 - read */ SecHubReportModel model = SecHubReportModel.fromJSONString(json); @@ -60,7 +60,7 @@ void sechub_example_result_7_can_be_loaded_and_transformed_from_json() { @Test void sechub_example_result_6_can_be_loaded_and_transformed_from_json() { /* prepare */ - String json = TestFileReader.loadTextFile("src/test/resources/report/sechub-testreport6-secret-scan-with-revision-data.json"); + String json = TestFileReader.readTextFromFile("src/test/resources/report/sechub-testreport6-secret-scan-with-revision-data.json"); /* execute */ SecHubReportModel model = SecHubReportModel.fromJSONString(json); @@ -80,7 +80,7 @@ void sechub_example_result_6_can_be_loaded_and_transformed_from_json() { @Test void sechub_example_result_5_can_be_loaded_and_transformed_from_json() { /* prepare */ - String json = TestFileReader.loadTextFile("src/test/resources/report/sechub-testreport5-version-control-data.json"); + String json = TestFileReader.readTextFromFile("src/test/resources/report/sechub-testreport5-version-control-data.json"); /* execute */ SecHubReportModel result = SecHubReportModel.fromJSONString(json); @@ -96,7 +96,7 @@ void sechub_example_result_5_can_be_loaded_and_transformed_from_json() { @Test void sechub_example_result_4_can_be_loaded_and_transformed_from_json() { /* prepare */ - String json = TestFileReader.loadTextFile("src/test/resources/report/sechub-testreport4-multiple-web-findings.json"); + String json = TestFileReader.readTextFromFile("src/test/resources/report/sechub-testreport4-multiple-web-findings.json"); /* execute */ SecHubReportModel result = SecHubReportModel.fromJSONString(json); @@ -108,7 +108,7 @@ void sechub_example_result_4_can_be_loaded_and_transformed_from_json() { @Test void a_report_without_status_and_messages_can_be_read_and_when_traffic_light_is_red_status_is_failed() { /* prepare */ - String jsonNoStatusOrMessages = TestFileReader.loadTextFile(new File("./src/test/resources/report/sechub-testreport3.json"), "\n"); + String jsonNoStatusOrMessages = TestFileReader.readTextFromFile(new File("./src/test/resources/report/sechub-testreport3.json"), "\n"); /* execute */ SecHubReportModel report = SecHubReportModel.fromJSONString(jsonNoStatusOrMessages); @@ -126,7 +126,7 @@ void a_report_without_status_and_messages_can_be_read_and_when_traffic_light_is_ @Test void a_report_without_status_and_messages_can_be_read_and_when_traffic_light_is_green_status_is_ok() { /* prepare */ - String jsonNoStatusOrMessages = TestFileReader.loadTextFile(new File("./src/test/resources/report/sechub-testreport1.json"), "\n"); + String jsonNoStatusOrMessages = TestFileReader.readTextFromFile(new File("./src/test/resources/report/sechub-testreport1.json"), "\n"); /* execute */ SecHubReportModel report = SecHubReportModel.fromJSONString(jsonNoStatusOrMessages); @@ -144,7 +144,7 @@ void a_report_without_status_and_messages_can_be_read_and_when_traffic_light_is_ @Test void a_report_with_status_failed_and_messages_can_be_read() { /* prepare */ - String jsonWithStatusAndMessages = TestFileReader.loadTextFile(new File("./src/test/resources/report/sechub-testreport2.json"), "\n"); + String jsonWithStatusAndMessages = TestFileReader.readTextFromFile(new File("./src/test/resources/report/sechub-testreport2.json"), "\n"); /* execute */ SecHubReportModel report = SecHubReportModel.fromJSONString(jsonWithStatusAndMessages); diff --git a/sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/SecHubScanConfigurationTest.java b/sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/SecHubScanConfigurationTest.java index bc5dd7c9bd..cb9c78e752 100644 --- a/sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/SecHubScanConfigurationTest.java +++ b/sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/SecHubScanConfigurationTest.java @@ -18,7 +18,7 @@ class SecHubScanConfigurationTest { void sechub_job_config_example1_JSON_can_be_deserialized_and_contains_expected_login_url() { /* prepare */ - String json = TestFileReader.loadTextFile(new File("./src/test/resources/sechub_config_example1.json")); + String json = TestFileReader.readTextFromFile(new File("./src/test/resources/sechub_config_example1.json")); /* execute */ SecHubScanConfiguration scanConfig = SecHubScanConfiguration.createFromJSON(json); @@ -31,7 +31,7 @@ void sechub_job_config_example1_JSON_can_be_deserialized_and_contains_expected_l void sechub_job_config_license_scan_JSON_can_be_deserialized_and_contains_expected_source_data_reference() { /* prepare */ - String json = TestFileReader.loadTextFile(new File("./src/test/resources/sechub_license_scan_config_source_example.json")); + String json = TestFileReader.readTextFromFile(new File("./src/test/resources/sechub_license_scan_config_source_example.json")); /* execute */ SecHubScanConfiguration scanConfig = SecHubScanConfiguration.createFromJSON(json); @@ -46,7 +46,7 @@ void sechub_job_config_license_scan_JSON_can_be_deserialized_and_contains_expect void sechub_job_config_license_scan_JSON_can_be_deserialized_even_with_unknown_key() { /* prepare */ - String json = TestFileReader.loadTextFile(new File("./src/test/resources/sechub_license_scan_non_existing_key.json")); + String json = TestFileReader.readTextFromFile(new File("./src/test/resources/sechub_license_scan_non_existing_key.json")); /* execute */ SecHubScanConfiguration config = SecHubScanConfiguration.createFromJSON(json); @@ -76,7 +76,7 @@ void sechub_job_config_license_scan_JSON_can_be_deserialized_even_with_unknown_k void sechub_job_config_fantasy_scan_type_only_no_official_scan_types_inside_but_can_be_read() { /* prepare */ - String json = TestFileReader.loadTextFile(new File("./src/test/resources/sechub_unknown_scan_type.json")); + String json = TestFileReader.readTextFromFile(new File("./src/test/resources/sechub_unknown_scan_type.json")); /* execute */ SecHubScanConfiguration scanConfig = SecHubScanConfiguration.createFromJSON(json); @@ -92,7 +92,7 @@ void sechub_job_config_fantasy_scan_type_only_no_official_scan_types_inside_but_ void sechub_job_config_contains_data_section_when_only_fantasy_scan_type_defined() { /* prepare */ - String json = TestFileReader.loadTextFile(new File("./src/test/resources/sechub_unknown_scan_type.json")); + String json = TestFileReader.readTextFromFile(new File("./src/test/resources/sechub_unknown_scan_type.json")); /* execute */ SecHubScanConfiguration scanConfig = SecHubScanConfiguration.createFromJSON(json); @@ -110,7 +110,7 @@ void sechub_job_config_contains_data_section_when_only_fantasy_scan_type_defined void sechub_job_config_license_scan_JSON_can_be_deserialized_and_contains_expected_binary_data_reference() { /* prepare */ - String json = TestFileReader.loadTextFile(new File("./src/test/resources/sechub_license_scan_config_binary_example.json")); + String json = TestFileReader.readTextFromFile(new File("./src/test/resources/sechub_license_scan_config_binary_example.json")); /* execute */ SecHubScanConfiguration scanConfig = SecHubScanConfiguration.createFromJSON(json); @@ -125,7 +125,7 @@ void sechub_job_config_license_scan_JSON_can_be_deserialized_and_contains_expect void sechub_job_config_secret_scan_JSON_can_be_deserialized_and_contains_expected_source_data_reference() { /* prepare */ - String json = TestFileReader.loadTextFile(new File("./src/test/resources/sechub_secret_scan_config_source_example.json")); + String json = TestFileReader.readTextFromFile(new File("./src/test/resources/sechub_secret_scan_config_source_example.json")); /* execute */ SecHubScanConfiguration scanConfig = SecHubScanConfiguration.createFromJSON(json); @@ -140,7 +140,7 @@ void sechub_job_config_secret_scan_JSON_can_be_deserialized_and_contains_expecte void sechub_job_config_secret_scan_JSON_can_be_deserialized_and_contains_expected_binary_data_reference() { /* prepare */ - String json = TestFileReader.loadTextFile(new File("./src/test/resources/sechub_secret_scan_config_binary_example.json")); + String json = TestFileReader.readTextFromFile(new File("./src/test/resources/sechub_secret_scan_config_binary_example.json")); /* execute */ SecHubScanConfiguration scanConfig = SecHubScanConfiguration.createFromJSON(json); @@ -155,7 +155,7 @@ void sechub_job_config_secret_scan_JSON_can_be_deserialized_and_contains_expecte void sechub_remote_source_code_scan_configuration_contains_location_and_type() { /* prepare */ - String json = TestFileReader.loadTextFile(new File("./src/test/resources/sechub_remote_data_config_source_code_scan_example.json")); + String json = TestFileReader.readTextFromFile(new File("./src/test/resources/sechub_remote_data_config_source_code_scan_example.json")); /* execute */ SecHubScanConfiguration config = SecHubScanConfiguration.createFromJSON(json); @@ -199,7 +199,7 @@ void sechub_remote_source_code_scan_configuration_contains_location_and_type() { void sechub_remote_binary_code_scan_configuration_contains_location_and_type() { /* prepare */ - String json = TestFileReader.loadTextFile(new File("./src/test/resources/sechub_remote_data_config_binary_code_scan_example.json")); + String json = TestFileReader.readTextFromFile(new File("./src/test/resources/sechub_remote_data_config_binary_code_scan_example.json")); /* execute */ SecHubScanConfiguration config = SecHubScanConfiguration.createFromJSON(json); diff --git a/sechub-commons-pds/src/main/java/com/mercedesbenz/sechub/commons/pds/PDSUserMessageSupport.java b/sechub-commons-pds/src/main/java/com/mercedesbenz/sechub/commons/pds/PDSUserMessageSupport.java index 9b7c20acd2..a68f919b18 100644 --- a/sechub-commons-pds/src/main/java/com/mercedesbenz/sechub/commons/pds/PDSUserMessageSupport.java +++ b/sechub-commons-pds/src/main/java/com/mercedesbenz/sechub/commons/pds/PDSUserMessageSupport.java @@ -39,7 +39,7 @@ public void writeMessage(SecHubMessage message) throws IOException { File file = new File(messageFolder, fileName); - writer.save(file, message.getText(), false); + writer.writeTextToFile(file, message.getText(), false); } private String createUniqueFileName(SecHubMessage message) { diff --git a/sechub-commons-pds/src/test/java/com/mercedesbenz/sechub/commons/pds/ProcessAdapterTest.java b/sechub-commons-pds/src/test/java/com/mercedesbenz/sechub/commons/pds/ProcessAdapterTest.java index 32b297818b..3824c079c2 100644 --- a/sechub-commons-pds/src/test/java/com/mercedesbenz/sechub/commons/pds/ProcessAdapterTest.java +++ b/sechub-commons-pds/src/test/java/com/mercedesbenz/sechub/commons/pds/ProcessAdapterTest.java @@ -39,7 +39,7 @@ void process_adapter_enter_input_works_as_expected() throws Exception { // the bash script has written the input from stdin to a file, now we read and // check the content: - String output = TestFileReader.loadTextFile(tempFile); + String output = TestFileReader.readTextFromFile(tempFile); assertEquals("user-input=my-user input...via stdin", output); } diff --git a/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/AsciidocGenerator.java b/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/AsciidocGenerator.java index 409e3f762e..58f90fed04 100644 --- a/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/AsciidocGenerator.java +++ b/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/AsciidocGenerator.java @@ -25,7 +25,7 @@ import com.mercedesbenz.sechub.docgen.usecase.UseCaseRestDocModel; import com.mercedesbenz.sechub.docgen.usecase.UseCaseRestDocModelAsciiDocGenerator; import com.mercedesbenz.sechub.docgen.util.ClasspathDataCollector; -import com.mercedesbenz.sechub.docgen.util.TextFileWriter; +import com.mercedesbenz.sechub.docgen.util.DocGenTextFileWriter; import com.mercedesbenz.sechub.pds.PDSStartupAssertEnvironmentVariablesUsed; import com.mercedesbenz.sechub.sharedkernel.usecases.UseCaseIdentifier; @@ -35,7 +35,7 @@ public class AsciidocGenerator implements Generator { ClasspathDataCollector collector; - TextFileWriter writer = new TextFileWriter(); + DocGenTextFileWriter writer = new DocGenTextFileWriter(); /* ---------------------------------- */ /* ----- GENERATORS ----------------- */ @@ -146,11 +146,11 @@ private void generate(String path) throws IOException { private void generateAndCopySystemTestsDocFiles(GenContext context) throws IOException { String asciidoc = systemTestDocGenerator.generateDefaultFallbackTable(); File tableGenFile = new File(context.documentsGenFolder, "gen_systemtests_default_fallbacks_table.adoc"); - writer.save(tableGenFile, asciidoc); + writer.writeTextToFile(tableGenFile, asciidoc); asciidoc = systemTestDocGenerator.generateRuntimeVariableTable(); tableGenFile = new File(context.documentsGenFolder, "gen_systemtests_runtime_variables_table.adoc"); - writer.save(tableGenFile, asciidoc); + writer.writeTextToFile(tableGenFile, asciidoc); /* copy system test example files to doc */ File systemTestExampleGenFolder = new File("./../sechub-systemtest/build/gen/example"); @@ -166,17 +166,17 @@ private void generateSecHubModuleAndModuleGroupFiles(GenContext context) throws // module description String modulesTableGenData = moduleDescriptionTableGenerator.generate(); File modulesTableGenFile = new File(context.documentsGenFolder, "gen_modules_table.adoc"); - writer.save(modulesTableGenFile, modulesTableGenData); + writer.writeTextToFile(modulesTableGenFile, modulesTableGenData); // module group -> module String moduleGroupsTableGenData = moduleGroupToModuleTableGenerator.generate(); File moduleGroupToModuleTableGenFile = new File(context.documentsGenFolder, "gen_modulegroup_to_module_table.adoc"); - writer.save(moduleGroupToModuleTableGenFile, moduleGroupsTableGenData); + writer.writeTextToFile(moduleGroupToModuleTableGenFile, moduleGroupsTableGenData); // module -> modules group String moduleToModuleGroupTableGenData = moduleToModuleGroupTableGenerator.generate(); File moduleToModuleGroupTableGenFile = new File(context.documentsGenFolder, "gen_module_to_modulegroup_table.adoc"); - writer.save(moduleToModuleGroupTableGenFile, moduleToModuleGroupTableGenData); + writer.writeTextToFile(moduleToModuleGroupTableGenFile, moduleToModuleGroupTableGenData); } @@ -224,7 +224,7 @@ private void generateCheckmarxPDSSolutionParts(GenContext context) throws IOExce File clientGenDocFolder = new File(context.documentsGenFolder, "pds-solutions"); File targetFile = new File(clientGenDocFolder, "gen_checkmarx_wrapper_env_and_job_parameter_table.adoc"); - writer.save(targetFile, table); + writer.writeTextToFile(targetFile, table); } private void generateClientParts(GenContext context) throws IOException { @@ -232,7 +232,7 @@ private void generateClientParts(GenContext context) throws IOException { String defaultZipAllowedFilePatternsTable = clientDocFilesGenerator.generateDefaultZipAllowedFilePatternsTable(); File clientGenDocFolder = new File(context.documentsGenFolder, "client"); File targetFile = new File(clientGenDocFolder, "gen_table_default_zip_allowed_file_patterns.adoc"); - writer.save(targetFile, defaultZipAllowedFilePatternsTable); + writer.writeTextToFile(targetFile, defaultZipAllowedFilePatternsTable); } private void generateExampleFiles(GenContext context) throws IOException { @@ -244,7 +244,7 @@ private void generateExampleFiles(GenContext context) throws IOException { private void generateExample(String endingfileName, File documentsGenFolder, String content) throws IOException { File examplesFolder = new File(documentsGenFolder, "examples"); File targetFile = new File(examplesFolder, "gen_example_" + endingfileName); - writer.save(targetFile, content); + writer.writeTextToFile(targetFile, content); } private void generateSecHubProfilesOverview(GenContext context) throws IOException { @@ -271,7 +271,7 @@ private void generateSpringProfilePlantUML(File diagramsGenFolder, SpringProfile } String text = geno.generate(config); File targetFile = new File(diagramsGenFolder, "gen_springprofiles" + addition + ".puml"); - writer.save(targetFile, text); + writer.writeTextToFile(targetFile, text); } private void generateMessagingFiles(GenContext context) throws IOException { @@ -286,11 +286,11 @@ private void generateUseCaseFiles(GenContext context) throws IOException { String useCaseAsciidoc = useCaseModelAsciiDocGenerator.generateAsciidoc(model, context.diagramsGenFolder); File targetFile = new File(context.documentsGenFolder, "gen_usecases.adoc"); - writer.save(targetFile, useCaseAsciidoc); + writer.writeTextToFile(targetFile, useCaseAsciidoc); String usecaseRestDoc = useCaseRestDocModelAsciiDocGenerator.generateAsciidoc(writer, restDocModel, true, UseCaseIdentifier.values()); File targetFile2 = new File(context.documentsGenFolder, "gen_uc_restdoc.adoc"); - writer.save(targetFile2, usecaseRestDoc); + writer.writeTextToFile(targetFile2, usecaseRestDoc); } private void generatePDSUseCaseFiles(GenContext context) throws IOException { @@ -299,7 +299,7 @@ private void generatePDSUseCaseFiles(GenContext context) throws IOException { String useCaseAsciidoc = useCaseModelAsciiDocGenerator.generateAsciidoc(model, context.diagramsGenFolder, false, false); File targetFile = new File(context.documentsGenFolder, "gen_pds-usecases.adoc"); - writer.save(targetFile, useCaseAsciidoc); + writer.writeTextToFile(targetFile, useCaseAsciidoc); } static void output(String text) { @@ -348,32 +348,32 @@ public void fetchDomainMessagingParts() { public void generateSecHubSystemPropertiesDescription(GenContext context) throws IOException { String text = propertiesGenerator.generate(getCollector().fetchMustBeDocumentParts(), context.sechubEnvVariableRegistry); - writer.save(context.systemProperitesFile, text); + writer.writeTextToFile(context.systemProperitesFile, text); } public void generatePDSSystemPropertiesDescription(GenContext context) throws IOException { String text = propertiesGenerator.generate(getCollector().fetchPDSMustBeDocumentParts(), context.pdsEnvVariableRegistry); - writer.save(context.pdsSystemProperitesFile, text); + writer.writeTextToFile(context.pdsSystemProperitesFile, text); } private void generatePDSExecutorConfigurationParamters(GenContext context) throws IOException { String text = pdsExecutorConfigParameterGenerator.generatePDSExecutorConfigurationParamters(context.pdsPDSExecutorConfigParametersFile); - writer.save(context.pdsPDSExecutorConfigParametersFile, text); + writer.writeTextToFile(context.pdsPDSExecutorConfigParametersFile, text); } public void generateSecHubJavaLaunchExample(GenContext context) throws IOException { String text = javaLaunchExampleGenerator.generate(getCollector().fetchMustBeDocumentParts(), context.sechubEnvVariableRegistry); - writer.save(context.javaLaunchExampleFile, text); + writer.writeTextToFile(context.javaLaunchExampleFile, text); } public void generateSecHubScheduleDescription(GenContext context) throws IOException { String text = scheduleDescriptionGenerator.generate(getCollector()); - writer.save(context.scheduleDescriptionFile, text); + writer.writeTextToFile(context.scheduleDescriptionFile, text); } private void generateSecHubMockPropertiesDescription(GenContext context) throws IOException { String text = propertiesGenerator.generate(getCollector().fetchMockAdapterSpringValueDocumentationParts(), context.sechubEnvVariableRegistry); - writer.save(context.specialMockValuePropertiesFile, text); + writer.writeTextToFile(context.specialMockValuePropertiesFile, text); } private ClasspathDataCollector getCollector() { diff --git a/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/kubernetes/KubernetesTemplateFilesGenerator.java b/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/kubernetes/KubernetesTemplateFilesGenerator.java index d8a1bd45c5..7ac4830ab3 100644 --- a/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/kubernetes/KubernetesTemplateFilesGenerator.java +++ b/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/kubernetes/KubernetesTemplateFilesGenerator.java @@ -16,7 +16,7 @@ import com.mercedesbenz.sechub.docgen.spring.SpringValueExtractor; import com.mercedesbenz.sechub.docgen.spring.SpringValueExtractor.SpringValue; import com.mercedesbenz.sechub.docgen.util.ClasspathDataCollector; -import com.mercedesbenz.sechub.docgen.util.TextFileWriter; +import com.mercedesbenz.sechub.docgen.util.DocGenTextFileWriter; class KubernetesTemplateFilesGenerator implements Generator { @@ -27,12 +27,12 @@ class KubernetesTemplateFilesGenerator implements Generator { SpringValueExtractor springValueExtractor; SpringScheduleExtractor springScheduledExtractor; - TextFileWriter writer; + DocGenTextFileWriter writer; public KubernetesTemplateFilesGenerator() { this.springValueExtractor = new SpringValueExtractor(); this.springScheduledExtractor = new SpringScheduleExtractor(); - this.writer = new TextFileWriter(); + this.writer = new DocGenTextFileWriter(); } public static void main(String[] args) throws Exception { @@ -71,7 +71,7 @@ public void generate(KubernetesFiles result, List list) throw generateSecretShellScriptsAndMissingSecretFiles(result); /* last but not least create output file */ File generatedDeploymentFilePart = new File(ensureKubernetesGenFolder(), "sechub-server-environment-deployment-parts.gen.yaml"); - writer.save(generatedDeploymentFilePart, result.serverDeploymentYaml); + writer.writeTextToFile(generatedDeploymentFilePart, result.serverDeploymentYaml); output("Written generated deployment file:" + generatedDeploymentFilePart); } @@ -213,7 +213,7 @@ private void createSecretShellScriptAndFiles(KubernetesFiles result, File target String shellName = createShellScriptName(secretName); allShellScriptNames.add(shellName); File targetFile = new File(targetFolder, shellName); - writer.save(targetFile, sb.toString(), true); + writer.writeTextToFile(targetFile, sb.toString(), true); output("Updated/Created:" + targetFile); } @@ -253,7 +253,7 @@ private void createSecretShellScriptAndFiles(KubernetesFiles result, File target sb.append("./").append(shellScriptName).append("\n"); } File targetFile = new File(targetFolder, createShellScriptName("all")); - writer.save(targetFile, sb.toString(), true); + writer.writeTextToFile(targetFile, sb.toString(), true); output("Updated/Created:" + targetFile); } diff --git a/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/messaging/DomainMessagingFilesGenerator.java b/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/messaging/DomainMessagingFilesGenerator.java index 44e447cad3..865b9d5040 100644 --- a/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/messaging/DomainMessagingFilesGenerator.java +++ b/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/messaging/DomainMessagingFilesGenerator.java @@ -8,15 +8,15 @@ import com.mercedesbenz.sechub.docgen.messaging.DomainMessagingModel.Domain; import com.mercedesbenz.sechub.docgen.messaging.DomainMessagingModel.DomainPart; -import com.mercedesbenz.sechub.docgen.util.TextFileWriter; +import com.mercedesbenz.sechub.docgen.util.DocGenTextFileWriter; import com.mercedesbenz.sechub.sharedkernel.messaging.MessageID; public class DomainMessagingFilesGenerator { - private TextFileWriter writer; + private DocGenTextFileWriter writer; private DomainMessagingModelPlantUMLGenerator domainMessagingModelPlantUMLGenerator; - public DomainMessagingFilesGenerator(TextFileWriter writer) { + public DomainMessagingFilesGenerator(DocGenTextFileWriter writer) { this.writer = writer; this.domainMessagingModelPlantUMLGenerator = new DomainMessagingModelPlantUMLGenerator(); } @@ -57,7 +57,7 @@ public void generateMessagingFiles(File messagingFile, File diagramsGenFolder, D sb.append("\n"); sb.append("include::message2usecases_" + createMessagingLinkId(id) + ".adoc[]\n"); } - writer.save(messagingFile, sb.toString()); + writer.writeTextToFile(messagingFile, sb.toString()); } public static String createMessagingLinkId(MessageID messageId) { @@ -76,7 +76,7 @@ private void generateMessagingPlantumlFile(File diagramsGenFolder, DomainMessagi MessageID[] messageIdsToInspect) throws IOException { String generatedPlantuml = domainMessagingModelPlantUMLGenerator.generate(model, title, messageIdsToInspect, true); File targetFile = new File(diagramsGenFolder, targetFileName); - writer.save(targetFile, generatedPlantuml); + writer.writeTextToFile(targetFile, generatedPlantuml); } public DomainMessagingModel createReducedClone(DomainMessagingModel originModel) { diff --git a/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/messaging/UseCaseEventMessageLinkAsciidocGenerator.java b/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/messaging/UseCaseEventMessageLinkAsciidocGenerator.java index 7744086448..e9ed37957c 100644 --- a/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/messaging/UseCaseEventMessageLinkAsciidocGenerator.java +++ b/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/messaging/UseCaseEventMessageLinkAsciidocGenerator.java @@ -12,7 +12,7 @@ import org.slf4j.LoggerFactory; import com.mercedesbenz.sechub.docgen.usecase.UseCaseAsciiDocFactory; -import com.mercedesbenz.sechub.docgen.util.TextFileWriter; +import com.mercedesbenz.sechub.docgen.util.DocGenTextFileWriter; import com.mercedesbenz.sechub.sharedkernel.messaging.MessageID; import com.mercedesbenz.sechub.sharedkernel.usecases.UseCaseIdentifier; @@ -25,14 +25,14 @@ public class UseCaseEventMessageLinkAsciidocGenerator { private static final Logger LOG = LoggerFactory.getLogger(UseCaseEventMessageLinkAsciidocGenerator.class); - private TextFileWriter writer; + private DocGenTextFileWriter writer; private File outputFolder; private Map> usecaseToMessageIdMap = new TreeMap<>(); public UseCaseEventMessageLinkAsciidocGenerator(Map> usecaseToMessageIdMap, File outputFolder) { this.outputFolder = outputFolder; this.usecaseToMessageIdMap = usecaseToMessageIdMap; - this.writer = new TextFileWriter(); + this.writer = new DocGenTextFileWriter(); } public void generate() throws IOException { @@ -52,7 +52,7 @@ private void generateLinkUsecaseToMessagesFile(UseCaseIdentifier identifier) thr String id = UseCaseEventOverviewPlantUmlGenerator.createUsecaseId(identifier); File file = new File(outputFolder, "usecase2messages_" + id + ".adoc"); - writer.save(file, ab.getAsciiDoc()); + writer.writeTextToFile(file, ab.getAsciiDoc()); } private AsciidocBuilder generateLinkUsecaseToMessagesContent(UseCaseIdentifier identifier) { @@ -78,7 +78,7 @@ private void generateLinkMessageToUsecasesFile(MessageID identifier) throws IOEx String id = DomainMessagingFilesGenerator.createMessagingLinkId(identifier); File file = new File(outputFolder, "message2usecases_" + id + ".adoc"); - writer.save(file, ab.getAsciiDoc()); + writer.writeTextToFile(file, ab.getAsciiDoc()); } private AsciidocBuilder generateLinkMessageToUsecasesContent(MessageID identifier) { diff --git a/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/messaging/UseCaseEventOverviewPlantUmlGenerator.java b/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/messaging/UseCaseEventOverviewPlantUmlGenerator.java index 2bdefe5a62..4b53c541a7 100644 --- a/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/messaging/UseCaseEventOverviewPlantUmlGenerator.java +++ b/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/messaging/UseCaseEventOverviewPlantUmlGenerator.java @@ -14,8 +14,8 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import com.mercedesbenz.sechub.docgen.util.TextFileReader; -import com.mercedesbenz.sechub.docgen.util.TextFileWriter; +import com.mercedesbenz.sechub.docgen.util.DocGenTextFileReader; +import com.mercedesbenz.sechub.docgen.util.DocGenTextFileWriter; import com.mercedesbenz.sechub.sharedkernel.messaging.IntegrationTestEventHistory; import com.mercedesbenz.sechub.sharedkernel.messaging.IntegrationTestEventHistoryInspection; import com.mercedesbenz.sechub.sharedkernel.usecases.UseCaseIdentifier; @@ -34,16 +34,16 @@ public class UseCaseEventOverviewPlantUmlGenerator { private static final Logger LOG = LoggerFactory.getLogger(UseCaseEventOverviewPlantUmlGenerator.class); private File folderToStartFrom; - private TextFileReader reader; - private TextFileWriter writer; + private DocGenTextFileReader reader; + private DocGenTextFileWriter writer; private File outputFolder; private Map> usecaseNameToMessageIdsMap = new TreeMap<>(); public UseCaseEventOverviewPlantUmlGenerator(File jsonEventDataFolder, File outputFolder) { this.folderToStartFrom = jsonEventDataFolder; this.outputFolder = outputFolder; - this.reader = new TextFileReader(); - this.writer = new TextFileWriter(); + this.reader = new DocGenTextFileReader(); + this.writer = new DocGenTextFileWriter(); } /** @@ -115,7 +115,7 @@ private void generateFile(File jsonSourceFile) { if (jsonSourceFile.getAbsolutePath().endsWith("uc_admin_enables_scheduler_job_processing.json")) { System.out.println("got"); } - String json = reader.loadTextFile(jsonSourceFile); + String json = reader.readTextFromFile(jsonSourceFile); IntegrationTestEventHistory history = IntegrationTestEventHistory.fromJSONString(json); try { generate(history, usecaseIdentifier, variant); @@ -191,7 +191,7 @@ private void generate(IntegrationTestEventHistory history, UseCaseIdentifier use /* write PLANTUML file */ File targetFile = new File(outputFolder, createPlantumlFileSubPathByUsecase(usecaseIdentifier.name(), variant)); - writer.save(targetFile, pb.getPlantUML()); + writer.writeTextToFile(targetFile, pb.getPlantUML()); } diff --git a/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/usecase/UseCaseRestDocModelAsciiDocGenerator.java b/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/usecase/UseCaseRestDocModelAsciiDocGenerator.java index 791d99785a..ee271aa269 100644 --- a/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/usecase/UseCaseRestDocModelAsciiDocGenerator.java +++ b/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/usecase/UseCaseRestDocModelAsciiDocGenerator.java @@ -16,8 +16,8 @@ import com.mercedesbenz.sechub.docgen.AsciidocUtil; import com.mercedesbenz.sechub.docgen.RestDocResourceModel; import com.mercedesbenz.sechub.docgen.usecase.UseCaseModel.UseCaseEntry; -import com.mercedesbenz.sechub.docgen.util.TextFileReader; -import com.mercedesbenz.sechub.docgen.util.TextFileWriter; +import com.mercedesbenz.sechub.docgen.util.DocGenTextFileReader; +import com.mercedesbenz.sechub.docgen.util.DocGenTextFileWriter; import com.mercedesbenz.sechub.sharedkernel.usecases.UseCaseGroup; import com.mercedesbenz.sechub.sharedkernel.usecases.UseCaseIdentifier; import com.mercedesbenz.sechub.sharedkernel.usecases.UseCaseRestDoc; @@ -25,7 +25,7 @@ public class UseCaseRestDocModelAsciiDocGenerator { - private TextFileReader reader = new TextFileReader(); + private DocGenTextFileReader reader = new DocGenTextFileReader(); // [options="header",cols="1,1,1"] // |=== @@ -35,7 +35,7 @@ public class UseCaseRestDocModelAsciiDocGenerator { // |Row2A |Row2B |Row2Cs // |Row3A |Row3B |Row3C // |=== - public String generateAsciidoc(TextFileWriter writer, UseCaseRestDocModel model, boolean technical, UseCaseIdentifier... usecases) { + public String generateAsciidoc(DocGenTextFileWriter writer, UseCaseRestDocModel model, boolean technical, UseCaseIdentifier... usecases) { Objects.requireNonNull(writer); Objects.requireNonNull(model); @@ -170,7 +170,7 @@ private void appendRestDefinition(Context context, UseCaseRestDocEntry entry, Ma private void appendGeneralRequestInformation(Context context, Map map) { File resourceFile = map.get(SpringRestDocOutput.RESOURCE); if (resourceFile != null) { - String json = reader.loadTextFile(resourceFile); + String json = reader.readTextFromFile(resourceFile); RestDocResourceModel model = RestDocResourceModel.fromString(json); context.addLine("[options=\"header\",cols=\"1,6\",title=\"General request information\"]"); @@ -236,7 +236,7 @@ private void addDescription(Context context, UseCaseRestDocEntry entry, File fil private boolean isGeneratedFileEmpty(File file) { boolean justEmpty = false; if (SpringRestDocOutput.RESPONSE_BODY.isRepresentedBy(file)) { - String content = reader.loadTextFile(file, "\n"); + String content = reader.readTextFromFile(file); justEmpty = AsciidocUtil.isEmptyAsciidocContent(content); } return justEmpty; diff --git a/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/util/DocGenTextFileReader.java b/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/util/DocGenTextFileReader.java new file mode 100644 index 0000000000..0bceca11e5 --- /dev/null +++ b/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/util/DocGenTextFileReader.java @@ -0,0 +1,27 @@ +// SPDX-License-Identifier: MIT +package com.mercedesbenz.sechub.docgen.util; + +import java.io.File; + +import com.mercedesbenz.sechub.commons.TextFileReader; + +public class DocGenTextFileReader { + + private TextFileReader reader = new TextFileReader(); + + /** + * Read text from file + * + * @param file file to read from + * @return text, never null + * + * @throws IllegalStateException if file cannot be read. + */ + public String readTextFromFile(File file) { + try { + return reader.readTextFromFile(file); + } catch (Exception e) { + throw new IllegalStateException("Doc generation / test case corrupt: Cannot read test file " + file.getAbsolutePath(), e); + } + } +} diff --git a/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/util/TextFileWriter.java b/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/util/DocGenTextFileWriter.java similarity index 64% rename from sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/util/TextFileWriter.java rename to sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/util/DocGenTextFileWriter.java index 26a9098a87..ac36784cad 100644 --- a/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/util/TextFileWriter.java +++ b/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/util/DocGenTextFileWriter.java @@ -1,55 +1,26 @@ // SPDX-License-Identifier: MIT package com.mercedesbenz.sechub.docgen.util; -import java.io.BufferedReader; import java.io.BufferedWriter; import java.io.File; import java.io.FileWriter; import java.io.IOException; -import java.nio.file.Files; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import com.mercedesbenz.sechub.docgen.GeneratorConstants; -public class TextFileWriter { +public class DocGenTextFileWriter { - private static final Logger LOG = LoggerFactory.getLogger(TextFileWriter.class); + private static final Logger LOG = LoggerFactory.getLogger(DocGenTextFileWriter.class); private LicenseHeaderProvider licenseHeaderProvider; - public TextFileWriter() { + public DocGenTextFileWriter() { licenseHeaderProvider = new LicenseHeaderProvider(); } - public void addMissingHeaders(File targetFile) throws IOException { - /* read content */ - String origin = read(targetFile); - if (origin.contains(LicenseHeaderProvider.LICENSE_SPDX_IDENTIFIER)) { - /* already contained - ignore */ - return; - } - /* do save, will add header if necessary */ - save(targetFile, origin, true); - } - - private String read(File file) throws IOException { - StringBuilder sb = new StringBuilder(); - try (BufferedReader br = Files.newBufferedReader(file.toPath())) { - String readLine = null; - boolean notFirstLine = false; - while ((readLine = br.readLine()) != null) { - if (notFirstLine) { - sb.append("\n"); - } - notFirstLine = true; - sb.append(readLine); - } - } - return sb.toString(); - } - /** * Save text file, does overwrite existing ones! Adds missing headers * @@ -57,8 +28,8 @@ private String read(File file) throws IOException { * @param origin * @throws IOException */ - public void save(File targetFile, String origin) throws IOException { - save(targetFile, origin, true); + public void writeTextToFile(File targetFile, String origin) throws IOException { + writeTextToFile(targetFile, origin, true); } /** @@ -70,7 +41,7 @@ public void save(File targetFile, String origin) throws IOException { * @param overwrite * @throws IOException */ - public void save(File targetFile, String origin, boolean overwrite) throws IOException { + public void writeTextToFile(File targetFile, String origin, boolean overwrite) throws IOException { if (targetFile == null) { throw new IllegalArgumentException("null not allowed as file!"); } diff --git a/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/util/TextFileReader.java b/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/util/TextFileReader.java deleted file mode 100644 index ea80b084a3..0000000000 --- a/sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/util/TextFileReader.java +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: MIT -package com.mercedesbenz.sechub.docgen.util; - -import java.io.BufferedReader; -import java.io.File; -import java.io.FileInputStream; -import java.io.InputStreamReader; - -public class TextFileReader { - - public String loadTextFile(File file) { - return loadTextFile(file, "\n"); - } - - public String loadTextFile(File file, String lineBreak) { - StringBuilder sb = new StringBuilder(); - - try (BufferedReader br = new BufferedReader(new InputStreamReader(new FileInputStream(file), "UTF-8"))) { - String line = null; - - boolean firstEntry = true; - while ((line = br.readLine()) != null) { - if (!firstEntry) { - sb.append(lineBreak); - } - sb.append(line); - firstEntry = false;// this prevents additional line break at end of file... - } - return sb.toString(); - } catch (Exception e) { - throw new IllegalStateException("Testcase corrupt: Cannot read test file " + file.getAbsolutePath(), e); - } - } -} diff --git a/sechub-doc/src/test/java/com/mercedesbenz/sechub/ExampleFilesValidTest.java b/sechub-doc/src/test/java/com/mercedesbenz/sechub/ExampleFilesValidTest.java index 0f9233c1c9..e4e7a9dd6a 100644 --- a/sechub-doc/src/test/java/com/mercedesbenz/sechub/ExampleFilesValidTest.java +++ b/sechub-doc/src/test/java/com/mercedesbenz/sechub/ExampleFilesValidTest.java @@ -33,7 +33,7 @@ class ExampleFilesValidTest { void check_pds_config_example1_can_be_loaded_and_is_valid() throws Exception { /* execute */ - String json = TestFileReader.loadTextFile("src/docs/asciidoc/documents/pds/product_delegation_server_config_example1.json"); + String json = TestFileReader.readTextFromFile("src/docs/asciidoc/documents/pds/product_delegation_server_config_example1.json"); PDSServerConfiguration configuration = PDSServerConfiguration.fromJSON(json); /* test */ @@ -66,7 +66,7 @@ void check_pds_config_example1_can_be_loaded_and_is_valid() throws Exception { @EnumSource(ExampleFile.class) void every_sechub_config_file_is_valid(ExampleFile file) { /* prepare */ - String json = TestFileReader.loadTextFile(file.getPath()); + String json = TestFileReader.readTextFromFile(file.getPath()); SecHubScanConfiguration config = null; /* execute */ @@ -85,7 +85,7 @@ void every_sechub_config_file_is_valid(ExampleFile file) { "WEBSCAN_OPENAPI_WITH_DATA_REFERENCE" }, mode = EnumSource.Mode.INCLUDE) void every_sechub_config_webscan_file_is_valid_and_has_a_target_uri(ExampleFile file) { /* prepare */ - String json = TestFileReader.loadTextFile(file.getPath()); + String json = TestFileReader.readTextFromFile(file.getPath()); /* execute */ SecHubScanConfiguration config = SecHubScanConfiguration.createFromJSON(json); diff --git a/sechub-doc/src/test/java/com/mercedesbenz/sechub/docgen/AsciidocGeneratorTest.java b/sechub-doc/src/test/java/com/mercedesbenz/sechub/docgen/AsciidocGeneratorTest.java index d129cd32a0..e45ad83beb 100644 --- a/sechub-doc/src/test/java/com/mercedesbenz/sechub/docgen/AsciidocGeneratorTest.java +++ b/sechub-doc/src/test/java/com/mercedesbenz/sechub/docgen/AsciidocGeneratorTest.java @@ -14,7 +14,7 @@ import com.mercedesbenz.sechub.docgen.spring.ScheduleDescriptionGenerator; import com.mercedesbenz.sechub.docgen.spring.SystemPropertiesDescriptionGenerator; import com.mercedesbenz.sechub.docgen.util.ClasspathDataCollector; -import com.mercedesbenz.sechub.docgen.util.TextFileWriter; +import com.mercedesbenz.sechub.docgen.util.DocGenTextFileWriter; public class AsciidocGeneratorTest { @@ -26,7 +26,7 @@ public void before() throws Exception { generatorToTest.collector = mock(ClasspathDataCollector.class); generatorToTest.propertiesGenerator = mock(SystemPropertiesDescriptionGenerator.class); generatorToTest.scheduleDescriptionGenerator = mock(ScheduleDescriptionGenerator.class); - generatorToTest.writer = mock(TextFileWriter.class); + generatorToTest.writer = mock(DocGenTextFileWriter.class); when(generatorToTest.propertiesGenerator.generate(any(), any())).thenReturn("properties-test"); when(generatorToTest.scheduleDescriptionGenerator.generate(generatorToTest.collector)).thenReturn("schedule-test"); @@ -70,7 +70,7 @@ public void calls_properties_generator_and_saves() throws Exception { /* test */ verify(generatorToTest.propertiesGenerator).generate(any(), any()); - verify(generatorToTest.writer).save(genContext.systemProperitesFile, "properties-test"); + verify(generatorToTest.writer).writeTextToFile(genContext.systemProperitesFile, "properties-test"); } @@ -86,7 +86,7 @@ public void calls_schedule_generator_and_saves() throws Exception { /* test */ verify(generatorToTest.scheduleDescriptionGenerator).generate(generatorToTest.collector); - verify(generatorToTest.writer).save(genContext.scheduleDescriptionFile, "schedule-test"); + verify(generatorToTest.writer).writeTextToFile(genContext.scheduleDescriptionFile, "schedule-test"); } diff --git a/sechub-doc/src/test/java/com/mercedesbenz/sechub/docgen/RestDocResourceModelTest.java b/sechub-doc/src/test/java/com/mercedesbenz/sechub/docgen/RestDocResourceModelTest.java index 3029c463a9..7abf8a876a 100644 --- a/sechub-doc/src/test/java/com/mercedesbenz/sechub/docgen/RestDocResourceModelTest.java +++ b/sechub-doc/src/test/java/com/mercedesbenz/sechub/docgen/RestDocResourceModelTest.java @@ -7,7 +7,7 @@ import org.junit.jupiter.api.Test; -import com.mercedesbenz.sechub.docgen.util.TextFileReader; +import com.mercedesbenz.sechub.docgen.util.DocGenTextFileReader; class RestDocResourceModelTest { @@ -15,8 +15,8 @@ class RestDocResourceModelTest { void test() { /* prepare */ File file = new File("./src/test/resources/restdoc/test_resource_1.json"); - TextFileReader reader = new TextFileReader(); - String json = reader.loadTextFile(file); + DocGenTextFileReader reader = new DocGenTextFileReader(); + String json = reader.readTextFromFile(file); /* execute */ RestDocResourceModel model = RestDocResourceModel.fromString(json); diff --git a/sechub-doc/src/test/java/com/mercedesbenz/sechub/docgen/adopt/AdoptionChecker.java b/sechub-doc/src/test/java/com/mercedesbenz/sechub/docgen/adopt/AdoptionChecker.java index b9e5276aaa..c014a91885 100644 --- a/sechub-doc/src/test/java/com/mercedesbenz/sechub/docgen/adopt/AdoptionChecker.java +++ b/sechub-doc/src/test/java/com/mercedesbenz/sechub/docgen/adopt/AdoptionChecker.java @@ -28,13 +28,13 @@ public void assertAdoptedClassEqualsFileLocatedAt(String packageName, String cla */ File adoptedFile = new File("./src/main/java/" + javaClassNameToPath(adoptedClass)); - String adopted = reader.loadTextFile(adoptedFile); + String adopted = reader.readTextFromFile(adoptedFile); String adoptedChanged = adopted.replaceAll(Pattern.quote(adoptedClass.getSimpleName()), Matcher.quoteReplacement(className)); adoptedChanged = adoptedChanged.replaceAll(Pattern.quote(adoptedClass.getPackageName()), Matcher.quoteReplacement(packageName)); String pathname = "./../sechub-systemtest/src/main/java/" + javaClassToPath(packageName, className); File originFile = new File(pathname); - String origin = reader.loadTextFile(originFile); + String origin = reader.readTextFromFile(originFile); String originReduced = withoutCommentsOrEmptyLines(origin); String adoptedReduced = withoutCommentsOrEmptyLines(adoptedChanged); diff --git a/sechub-doc/src/test/java/com/mercedesbenz/sechub/docgen/util/TextFileWriterTest.java b/sechub-doc/src/test/java/com/mercedesbenz/sechub/docgen/util/TextFileWriterTest.java index d35debd9f7..cf67737cb1 100644 --- a/sechub-doc/src/test/java/com/mercedesbenz/sechub/docgen/util/TextFileWriterTest.java +++ b/sechub-doc/src/test/java/com/mercedesbenz/sechub/docgen/util/TextFileWriterTest.java @@ -14,11 +14,11 @@ public class TextFileWriterTest { - private TextFileWriter writerToTest; + private DocGenTextFileWriter writerToTest; @BeforeEach void before() throws Exception { - writerToTest = new TextFileWriter(); + writerToTest = new DocGenTextFileWriter(); } @Test @@ -33,7 +33,7 @@ void is_able_to_save_a_file_having_path_not_createad_before() throws Exception { assertFalse(targetFile.exists()); /* execute */ - writerToTest.save(targetFile, "text"); + writerToTest.writeTextToFile(targetFile, "text"); /* test */ assertTrue(subFolder.exists()); diff --git a/sechub-doc/src/test/java/com/mercedesbenz/sechub/restdoc/RestDocSanityTest.java b/sechub-doc/src/test/java/com/mercedesbenz/sechub/restdoc/RestDocSanityTest.java index e964c3c91f..44667905d3 100644 --- a/sechub-doc/src/test/java/com/mercedesbenz/sechub/restdoc/RestDocSanityTest.java +++ b/sechub-doc/src/test/java/com/mercedesbenz/sechub/restdoc/RestDocSanityTest.java @@ -7,7 +7,7 @@ import org.junit.jupiter.api.Test; -import com.mercedesbenz.sechub.docgen.util.TextFileReader; +import com.mercedesbenz.sechub.docgen.util.DocGenTextFileReader; class RestDocSanityTest { @@ -18,7 +18,7 @@ void check_restdoc_tests_are_not_using_any_imports_of_com_epages() { assertTrue(file.exists()); assertTrue(file.isDirectory()); - TextFileReader reader = new TextFileReader(); + DocGenTextFileReader reader = new DocGenTextFileReader(); StringBuilder sb = new StringBuilder(); int count = 0; @@ -26,7 +26,7 @@ void check_restdoc_tests_are_not_using_any_imports_of_com_epages() { for (File sourceFile : file.listFiles((dirFile, name) -> name.endsWith("RestDocTest.java"))) { count++; // System.out.println("sourcefile:"+sourceFile); - String sourceCode = reader.loadTextFile(sourceFile); + String sourceCode = reader.readTextFromFile(sourceFile); if (sourceCode.indexOf("import static com.epages") != -1) { sb.append("- ").append(sourceFile.getName()).append(" does use static import of com.epages. Must be changed.\n"); } else if (sourceCode.indexOf("import com.epages") != -1) { diff --git a/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/SecurityTestHelper.java b/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/SecurityTestHelper.java index 7e6e07b3d8..182188aa40 100644 --- a/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/SecurityTestHelper.java +++ b/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/SecurityTestHelper.java @@ -377,7 +377,7 @@ private void ensureCipherTestDone() throws Exception { } File file = new File("./build/test-results/ciphertest/sechub-" + targetType.id + ".json"); - String text = TestFileReader.loadTextFile(file); + String text = TestFileReader.readTextFromFile(file); ObjectMapper mapper = JSONTestSupport.DEFAULT.createObjectMapper(); cipherTestData = mapper.readValue(text.getBytes(), CipherTestData.class); diff --git a/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/api/AsUser.java b/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/api/AsUser.java index 0a53267ff3..0a260f0274 100644 --- a/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/api/AsUser.java +++ b/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/api/AsUser.java @@ -637,7 +637,7 @@ public String getHTMLJobReport(TestProject project, UUID jobUUID) { String html = getRestHelper().getStringFromURL(getUrlBuilder().buildGetJobReportUrl(project.getProjectId(), jobUUID), MediaType.TEXT_HTML); if (enableHTMLautoDumps) { try { - getWriter().save(new File("./build/test-results/html-reports/" + jobUUID + ".html"), html, false); + getWriter().writeTextToFile(new File("./build/test-results/html-reports/" + jobUUID + ".html"), html, false); } catch (IOException e) { throw new IllegalStateException("Was not able to dump HTML data", e); } diff --git a/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/api/TestAPI.java b/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/api/TestAPI.java index 92f61a8f96..25e26c37fd 100644 --- a/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/api/TestAPI.java +++ b/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/api/TestAPI.java @@ -1600,7 +1600,7 @@ public static List fetchJobRunStatisticData(UUID execut */ public static void storeTestReport(String fileName, String reportData) { try { - writer.save(new File(testReportStorageFolder, fileName), reportData, true); + writer.writeTextToFile(new File(testReportStorageFolder, fileName), reportData, true); } catch (Exception e) { LOG.error("Was not able to store sechub test report: {}", fileName, e); } diff --git a/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/api/WithSecHubClient.java b/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/api/WithSecHubClient.java index dc3fb18867..87156fd97d 100644 --- a/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/api/WithSecHubClient.java +++ b/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/api/WithSecHubClient.java @@ -288,7 +288,7 @@ public AssertAsyncResult startAsynchronScanFor(TestProject project, SecHubScanCo File file = tempFile.toFile(); TextFileWriter writer = new TextFileWriter(); - writer.save(file, configAsJson, true); + writer.writeTextToFile(file, configAsJson, true); return startAsynchronScanFor(project, environmentVariables, apiTokenStrategy, file); } catch (IOException e) { diff --git a/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/internal/MockedAdapterSetupAccess.java b/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/internal/MockedAdapterSetupAccess.java index 705e38b884..c29318e67e 100644 --- a/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/internal/MockedAdapterSetupAccess.java +++ b/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/internal/MockedAdapterSetupAccess.java @@ -18,7 +18,7 @@ public class MockedAdapterSetupAccess { private Map mapIdToMockCombination = new HashMap(); private MockedAdapterSetupAccess() { - String json = TestFileReader.loadTextFile(new File("../sechub-other/mockdata/mockdata_setup.json")); + String json = TestFileReader.readTextFromFile(new File("../sechub-other/mockdata/mockdata_setup.json")); setup = TestJSONHelper.get().createFromJSON(json, MockedAdapterSetup.class); List entries = setup.getEntries(); diff --git a/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/internal/SecHubClientExecutor.java b/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/internal/SecHubClientExecutor.java index 479215bc84..beacc15173 100644 --- a/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/internal/SecHubClientExecutor.java +++ b/sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/internal/SecHubClientExecutor.java @@ -407,7 +407,7 @@ private File ensureExampleContentFoldersExist() { if (!testFile1.exists()) { try { TestFileWriter writer = new TestFileWriter(); - writer.save("class TestMeifYouCan {}", testFile1, Charset.forName("UTF-8")); + writer.writeTextToFile("class TestMeifYouCan {}", testFile1, Charset.forName("UTF-8")); } catch (IOException e) { throw new IllegalStateException("Cannot create test output!", e); } diff --git a/sechub-integrationtest/src/test/java/com/mercedesbenz/sechub/integrationtest/scenario2/FileUploadSizeScenario2IntTest.java b/sechub-integrationtest/src/test/java/com/mercedesbenz/sechub/integrationtest/scenario2/FileUploadSizeScenario2IntTest.java index 6f49de62df..a561756004 100644 --- a/sechub-integrationtest/src/test/java/com/mercedesbenz/sechub/integrationtest/scenario2/FileUploadSizeScenario2IntTest.java +++ b/sechub-integrationtest/src/test/java/com/mercedesbenz/sechub/integrationtest/scenario2/FileUploadSizeScenario2IntTest.java @@ -237,7 +237,7 @@ private void testErrorOrUploadDoneAsExpected(TestData data, UUID jobUUID, UnitTe assertNotNull("Downloaded filesize file may not be null!", downloadedFileSizeFile); assertTrue("Downloaded filesize file must exist!", downloadedFileSizeFile.exists()); - String fetchedSizeAsString = TestFileReader.loadTextFile(downloadedFileSizeFile); + String fetchedSizeAsString = TestFileReader.readTextFromFile(downloadedFileSizeFile); long fetchedSize = Long.parseLong(fetchedSizeAsString); assertEquals("Fetched file size not as expected for " + data.fileNameAtServerSide + " !", realFileSizeInBytes, fetchedSize); diff --git a/sechub-integrationtest/src/test/java/com/mercedesbenz/sechub/integrationtest/scenario6/DirectPDSAPICheckmarxWrapperScenario6IntTest.java b/sechub-integrationtest/src/test/java/com/mercedesbenz/sechub/integrationtest/scenario6/DirectPDSAPICheckmarxWrapperScenario6IntTest.java index fd00d31208..2892f275e8 100644 --- a/sechub-integrationtest/src/test/java/com/mercedesbenz/sechub/integrationtest/scenario6/DirectPDSAPICheckmarxWrapperScenario6IntTest.java +++ b/sechub-integrationtest/src/test/java/com/mercedesbenz/sechub/integrationtest/scenario6/DirectPDSAPICheckmarxWrapperScenario6IntTest.java @@ -37,7 +37,7 @@ public void pds_techuser_can_start_checkmarx_scan_with_job_configuration_and_PDS /* prepare */ TestUser user = PDS_TECH_USER; - String json =TestFileReader.loadTextFile("src/test/resources/pds/checkmarx-wrapper/checkmarx-pds-job1.json"); + String json =TestFileReader.readTextFromFile("src/test/resources/pds/checkmarx-wrapper/checkmarx-pds-job1.json"); String createResult = asPDSUser(PDS_ADMIN). createJobByJsonConfiguration(json); diff --git a/sechub-pds-commons-core/src/test/java/com/mercedesbenz/sechub/pds/commons/core/config/PDSServerConfigurationTest.java b/sechub-pds-commons-core/src/test/java/com/mercedesbenz/sechub/pds/commons/core/config/PDSServerConfigurationTest.java index 1b645d5f53..080648eb8c 100644 --- a/sechub-pds-commons-core/src/test/java/com/mercedesbenz/sechub/pds/commons/core/config/PDSServerConfigurationTest.java +++ b/sechub-pds-commons-core/src/test/java/com/mercedesbenz/sechub/pds/commons/core/config/PDSServerConfigurationTest.java @@ -18,7 +18,7 @@ class PDSServerConfigurationTest { void a_correct_server_configuration_file_can_be_read_as_json() throws Exception { /* prepare */ - String json = TestFileReader.loadTextFile(new File("./src/test/resources/config/pds-config-example1.json")); + String json = TestFileReader.readTextFromFile(new File("./src/test/resources/config/pds-config-example1.json")); /* execute */ PDSServerConfiguration configuration = PDSServerConfiguration.fromJSON(json); @@ -49,7 +49,7 @@ void a_correct_server_configuration_file_can_be_read_as_json() throws Exception @Test void a_server_configuration_with_unknown_entries_can_be_read() throws Exception { /* prepare */ - String json = TestFileReader.loadTextFile(new File("./src/test/resources/config/pds-config-example2-with-unknown-parts.json")); + String json = TestFileReader.readTextFromFile(new File("./src/test/resources/config/pds-config-example2-with-unknown-parts.json")); /* execute */ PDSServerConfiguration configuration = PDSServerConfiguration.fromJSON(json); @@ -61,7 +61,8 @@ void a_server_configuration_with_unknown_entries_can_be_read() throws Exception @Test void example_configuration_from_documentation_can_be_loaded() throws Exception { /* prepare */ - String json = TestFileReader.loadTextFile(new File("./..//sechub-doc/src/docs/asciidoc/documents/pds/product_delegation_server_config_example1.json")); + String json = TestFileReader + .readTextFromFile(new File("./..//sechub-doc/src/docs/asciidoc/documents/pds/product_delegation_server_config_example1.json")); /* execute */ PDSServerConfiguration configuration = PDSServerConfiguration.fromJSON(json); diff --git a/sechub-pds-tools/src/main/java/com/mercedesbenz/sechub/pds/tools/generator/PDSSolutionTestFilesGenerator.java b/sechub-pds-tools/src/main/java/com/mercedesbenz/sechub/pds/tools/generator/PDSSolutionTestFilesGenerator.java index ae7ca3b465..e013811980 100644 --- a/sechub-pds-tools/src/main/java/com/mercedesbenz/sechub/pds/tools/generator/PDSSolutionTestFilesGenerator.java +++ b/sechub-pds-tools/src/main/java/com/mercedesbenz/sechub/pds/tools/generator/PDSSolutionTestFilesGenerator.java @@ -110,7 +110,7 @@ private Path resolveWorkingDirectory(File workingDirectory) { } private void writeSecHubConfigurationToTempFolder() throws JSONConverterException, IOException { - writer.save(new File(targetFolder, "original-used-sechub-configfile.json"), JSONConverter.get().toJSON(config, true), false); + writer.writeTextToFile(new File(targetFolder, "original-used-sechub-configfile.json"), JSONConverter.get().toJSON(config, true), false); } @@ -120,7 +120,7 @@ private String writeReducedConfigFile() throws IOException { recucedSecHubConfigJson = JSONConverter.get().toJSON(reducedConfig, true); File reducedSecHubConfigFile = new File(targetFolder, "reducedSecHubJson_for_" + scanType.getId() + ".json"); - writer.save(reducedSecHubConfigFile, recucedSecHubConfigJson, true); + writer.writeTextToFile(reducedSecHubConfigFile, recucedSecHubConfigJson, true); return recucedSecHubConfigJson; } @@ -133,7 +133,7 @@ private void writePDSJobDataFile(String reducedSecHubConfigJson) throws IOExcept String pdsJobDataJson = JSONConverter.get().toJSON(data, true); File pdsJobDataFile = new File(targetFolder, "pdsJobData.json"); - writer.save(pdsJobDataFile, pdsJobDataJson, true); + writer.writeTextToFile(pdsJobDataFile, pdsJobDataJson, true); } private void ensureScanType(String wantedScanType) { @@ -145,7 +145,7 @@ private void ensureSecHubConfiguration(String pathToSecHubConfigFile) throws IOE if (!originConfigFile.exists()) { throw new FileNotFoundException("Sechub configuration file not found:" + originConfigFile.getAbsolutePath()); } - String json = reader.loadTextFile(originConfigFile); + String json = reader.readTextFromFile(originConfigFile); config = JSONConverter.get().fromJSON(SecHubConfigurationModel.class, json); } diff --git a/sechub-pds-tools/src/main/java/com/mercedesbenz/sechub/pds/tools/systemtest/SystemTestLauncher.java b/sechub-pds-tools/src/main/java/com/mercedesbenz/sechub/pds/tools/systemtest/SystemTestLauncher.java index 88d7b9b8cc..53d399a6cf 100644 --- a/sechub-pds-tools/src/main/java/com/mercedesbenz/sechub/pds/tools/systemtest/SystemTestLauncher.java +++ b/sechub-pds-tools/src/main/java/com/mercedesbenz/sechub/pds/tools/systemtest/SystemTestLauncher.java @@ -102,7 +102,7 @@ private void handleTestConfigurationFile(SystemTestCommand systemTestCommand, Sy if (!file.exists()) { throw new FileNotFoundException("Test configuration file does not exist:" + file.getAbsolutePath()); } - String configAsText = reader.loadTextFile(file); + String configAsText = reader.readTextFromFile(file); SystemTestConfiguration testConfiguration = JSONConverter.get().fromJSON(SystemTestConfiguration.class, configAsText); builder.testConfiguration(testConfiguration); diff --git a/sechub-pds-tools/src/test/java/com/mercedesbenz/sechub/pds/tools/systemtest/SystemTestLauncherTest.java b/sechub-pds-tools/src/test/java/com/mercedesbenz/sechub/pds/tools/systemtest/SystemTestLauncherTest.java index 3acb94e3e6..e8eabff31f 100644 --- a/sechub-pds-tools/src/test/java/com/mercedesbenz/sechub/pds/tools/systemtest/SystemTestLauncherTest.java +++ b/sechub-pds-tools/src/test/java/com/mercedesbenz/sechub/pds/tools/systemtest/SystemTestLauncherTest.java @@ -159,7 +159,7 @@ void system_test_parameters_are_build_from_command_as_expected__no_tests_to_run_ private String loadJsonAsPrettyPrinted(String path) throws IOException { TextFileReader reader = new TextFileReader(); - String json = reader.loadTextFile(new File(path)); + String json = reader.readTextFromFile(new File(path)); SystemTestConfiguration expectedConfiguration = JSONConverter.get().fromJSON(SystemTestConfiguration.class, json); String expectedPrettyJson = JSONConverter.get().toJSON(expectedConfiguration, true); return expectedPrettyJson; diff --git a/sechub-pds/src/main/java/com/mercedesbenz/sechub/pds/execution/PDSMessageCollector.java b/sechub-pds/src/main/java/com/mercedesbenz/sechub/pds/execution/PDSMessageCollector.java index 1449137e5f..f30219380f 100644 --- a/sechub-pds/src/main/java/com/mercedesbenz/sechub/pds/execution/PDSMessageCollector.java +++ b/sechub-pds/src/main/java/com/mercedesbenz/sechub/pds/execution/PDSMessageCollector.java @@ -28,7 +28,7 @@ public List collect(File folder) { for (File file : folder.listFiles()) { try { - String text = reader.loadTextFile(file); + String text = reader.readTextFromFile(file); SecHubMessageType type = SecHubMessageType.INFO; String fileName = file.getName().toUpperCase(); diff --git a/sechub-pds/src/main/java/com/mercedesbenz/sechub/pds/job/PDSWorkspaceService.java b/sechub-pds/src/main/java/com/mercedesbenz/sechub/pds/job/PDSWorkspaceService.java index 31586fa29c..e8d1fedd53 100644 --- a/sechub-pds/src/main/java/com/mercedesbenz/sechub/pds/job/PDSWorkspaceService.java +++ b/sechub-pds/src/main/java/com/mercedesbenz/sechub/pds/job/PDSWorkspaceService.java @@ -177,7 +177,7 @@ private void writeMetaData(UUID jobUUID, String metaData) throws IOException { LOG.debug("Meta data found for PDS job {} - will create metadata file {}", jobUUID, metaDataFile); TextFileWriter writer = new TextFileWriter(); - writer.save(metaDataFile, metaData, true); + writer.writeTextToFile(metaDataFile, metaData, true); LOG.info("Created meta data file for PDS job {}", jobUUID); } } @@ -592,7 +592,7 @@ public void sendEvent(UUID jobUUID, ExecutionEventType eventType, ExecutionEvent LOG.debug("Send event {} to workspace for sechub job: {}", eventType, jobUUID); try { - textFileWriter.save(eventFileToWrite, eventJson, true); + textFileWriter.writeTextToFile(eventFileToWrite, eventJson, true); } catch (IOException e) { LOG.error("Was not able to send event: {} with text: '{}' to workspace for PDS job: {}", eventType, eventJson, jobUUID, e); throw new IllegalStateException("Execution event storage failed for job: " + jobUUID, e); @@ -622,7 +622,7 @@ public ExecutionEventData fetchEventDataOrNull(UUID jobUUID, ExecutionEventType } String json = null; try { - json = textFileReader.loadTextFile(eventFileToRead); + json = textFileReader.readTextFromFile(eventFileToRead); } catch (IOException e) { LOG.error("Was not able to read event: {} from file: '{}' of PDS job: {}", eventType, eventFileToRead, jobUUID, e); throw new IllegalStateException("Execution event reading failed for job: " + jobUUID, e); diff --git a/sechub-pds/src/test/java/com/mercedesbenz/sechub/pds/execution/PDSMessageCollectorTest.java b/sechub-pds/src/test/java/com/mercedesbenz/sechub/pds/execution/PDSMessageCollectorTest.java index 6d5c72d68c..f5acce4e5d 100644 --- a/sechub-pds/src/test/java/com/mercedesbenz/sechub/pds/execution/PDSMessageCollectorTest.java +++ b/sechub-pds/src/test/java/com/mercedesbenz/sechub/pds/execution/PDSMessageCollectorTest.java @@ -63,7 +63,7 @@ void when_folder_has_one_file_with_not_ERROR_or_WARNING_at_the_beginning_an_info String messageText = "I am a message!"; TestFileWriter writer = new TestFileWriter(); - writer.save(new File(tempDir, fileName), messageText, false); + writer.writeTextToFile(new File(tempDir, fileName), messageText, false); /* execute */ List result = collectorToTest.collect(tempDir); @@ -86,7 +86,7 @@ void when_folder_has_one_file_with_WARNING_at_the_beginning_a_warning_message_is String messageText = "I am a warn message!"; TestFileWriter writer = new TestFileWriter(); - writer.save(new File(tempDir, fileName), messageText, false); + writer.writeTextToFile(new File(tempDir, fileName), messageText, false); /* execute */ List result = collectorToTest.collect(tempDir); @@ -109,7 +109,7 @@ void when_folder_has_one_file_with_ERROR_at_the_beginning_a_error_message_is_res String messageText = "I am an error message!"; TestFileWriter writer = new TestFileWriter(); - writer.save(new File(tempDir, fileName), messageText, false); + writer.writeTextToFile(new File(tempDir, fileName), messageText, false); /* execute */ List result = collectorToTest.collect(tempDir); diff --git a/sechub-pds/src/test/java/com/mercedesbenz/sechub/pds/job/PDSWorkspaceServiceTest.java b/sechub-pds/src/test/java/com/mercedesbenz/sechub/pds/job/PDSWorkspaceServiceTest.java index 405f97da6b..91049320fa 100644 --- a/sechub-pds/src/test/java/com/mercedesbenz/sechub/pds/job/PDSWorkspaceServiceTest.java +++ b/sechub-pds/src/test/java/com/mercedesbenz/sechub/pds/job/PDSWorkspaceServiceTest.java @@ -169,7 +169,7 @@ void when_job_has_metadata_a_metadata_file_is_created_in_workspace_containing_co /* test */ File metaDataFile = serviceToTest.getMetaDataFile(jobUUID); assertTrue(metaDataFile.exists()); - assertEquals("this is my metadata", TestFileReader.loadTextFile(metaDataFile)); + assertEquals("this is my metadata", TestFileReader.readTextFromFile(metaDataFile)); } @Test diff --git a/sechub-scan/src/test/java/com/mercedesbenz/sechub/domain/scan/analytic/ClocJsonAnalyticDataImporterTest.java b/sechub-scan/src/test/java/com/mercedesbenz/sechub/domain/scan/analytic/ClocJsonAnalyticDataImporterTest.java index 61fbe121fc..7832d70511 100644 --- a/sechub-scan/src/test/java/com/mercedesbenz/sechub/domain/scan/analytic/ClocJsonAnalyticDataImporterTest.java +++ b/sechub-scan/src/test/java/com/mercedesbenz/sechub/domain/scan/analytic/ClocJsonAnalyticDataImporterTest.java @@ -25,8 +25,8 @@ class ClocJsonAnalyticDataImporterTest { @BeforeAll static void beforeAll() { - sechubClocJSON = TestFileReader.loadTextFile(new File("./src/test/resources/cloc/cloc-sechub.json")); - gosecClocJSON = TestFileReader.loadTextFile(new File("./src/test/resources/cloc/cloc-gosec.json")); + sechubClocJSON = TestFileReader.readTextFromFile(new File("./src/test/resources/cloc/cloc-sechub.json")); + gosecClocJSON = TestFileReader.readTextFromFile(new File("./src/test/resources/cloc/cloc-gosec.json")); } @BeforeEach diff --git a/sechub-sereco/src/test/java/com/mercedesbenz/sechub/sereco/importer/SensitiveDataMaskingServiceTest.java b/sechub-sereco/src/test/java/com/mercedesbenz/sechub/sereco/importer/SensitiveDataMaskingServiceTest.java index e04f24478e..5bd333b742 100644 --- a/sechub-sereco/src/test/java/com/mercedesbenz/sechub/sereco/importer/SensitiveDataMaskingServiceTest.java +++ b/sechub-sereco/src/test/java/com/mercedesbenz/sechub/sereco/importer/SensitiveDataMaskingServiceTest.java @@ -214,7 +214,7 @@ private SecHubConfigurationModel createConfigWithOutSensitive() { private SecHubConfigurationModel createConfiguration(boolean withSensitiveHeaders) { String path = withSensitiveHeaders ? SECHUB_WEBSCAN_CONFIG_FILE_WITH_SENSITIVE_HEADERS : SECHUB_WEBSCAN_CONFIG_FILE_WITHOUT_SENSITIVE_HEADERS; - String sechubConfigJson = TestFileReader.loadTextFile(path); + String sechubConfigJson = TestFileReader.readTextFromFile(path); SecHubConfigurationModel result = SecHubConfiguration.createFromJSON(sechubConfigJson); return result; } diff --git a/sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/runtime/ArtifactStorageSecHubClientListener.java b/sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/runtime/ArtifactStorageSecHubClientListener.java index 62ebbb6c9b..79c9565ed0 100644 --- a/sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/runtime/ArtifactStorageSecHubClientListener.java +++ b/sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/runtime/ArtifactStorageSecHubClientListener.java @@ -67,7 +67,7 @@ public void afterReportDownload(UUID jobUUID, SecHubReport report) { File targetFile = new File(targetFolder.toFile(), "sechub-report.json"); try { - textFileWriter.save(targetFile, prettyPrintedJson, true); + textFileWriter.writeTextToFile(targetFile, prettyPrintedJson, true); } catch (IOException e) { LOG.error("Was not able to store sechub config file: {}", targetFile, e); } @@ -98,7 +98,7 @@ private void copySourceFileToTargetFolder(Path sourceFile, Path targetFolder) { private void storeSecHubJobUUIDFile(UUID secHubJobUUID, Path targetFolder) { File targetFile = new File(targetFolder.toFile(), "sechub-job-uuid.txt"); try { - textFileWriter.save(targetFile, secHubJobUUID.toString(), true); + textFileWriter.writeTextToFile(targetFile, secHubJobUUID.toString(), true); } catch (IOException e) { LOG.error("Was not able to store sechub job uuid file: {}", targetFile, e); } diff --git a/sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/runtime/SystemTestRuntimeMetaData.java b/sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/runtime/SystemTestRuntimeMetaData.java index 6e0464d9bd..8355baa74f 100644 --- a/sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/runtime/SystemTestRuntimeMetaData.java +++ b/sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/runtime/SystemTestRuntimeMetaData.java @@ -69,7 +69,7 @@ public void register(PDSSolutionDefinition solution, SystemTestRuntimeContext co LOG.debug("Read existing PDS server configuration file: {}", pdsServerConfigFilePath); String pdsServerConfigurationJson; try { - pdsServerConfigurationJson = textFileReader.loadTextFile(pdsServerConfigFilePath.toFile()); + pdsServerConfigurationJson = textFileReader.readTextFromFile(pdsServerConfigFilePath.toFile()); } catch (IOException e) { throw new WrongConfigurationException("Was not able to load PDS server configration file: {}! ", context, e); } diff --git a/sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/runtime/launch/ExecutionSupport.java b/sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/runtime/launch/ExecutionSupport.java index b1516110a0..7df828f328 100644 --- a/sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/runtime/launch/ExecutionSupport.java +++ b/sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/runtime/launch/ExecutionSupport.java @@ -192,7 +192,7 @@ private void writeProcessContainerExecutionErrorFile(File workingDirectory, Proc """.formatted(processContainer.getUuid(), new File("./").getAbsolutePath(), workingDirectory.getAbsolutePath(), StacktraceUtil.createFullTraceDescription(reason)); try { - textFileWriter.save(processContainerErrorFile.toFile(), data, true); + textFileWriter.writeTextToFile(processContainerErrorFile.toFile(), data, true); } catch (IOException e) { LOG.error("Was not able to write error file for process container:{}", processContainer.getUuid(), e); } @@ -204,14 +204,14 @@ private void fetchStreamsAndWriteProcessFile(ProcessContainer processContainer) Path errorFile = locationSupport.ensureErrorFile(processContainer); try { - String outputTextLine = textFileReader.loadTextFile(outputFile.toFile(), "\n", 1); + String outputTextLine = textFileReader.readTextFromFile(outputFile.toFile(), "\n", 1); processContainer.outputMessage = outputTextLine; } catch (IOException e) { LOG.error("Was not able to read output for process container:{}", processContainer.getUuid(), e); } try { - String errorTextLine = textFileReader.loadTextFile(errorFile.toFile(), "\n", 1); + String errorTextLine = textFileReader.readTextFromFile(errorFile.toFile(), "\n", 1); processContainer.errorMessage = errorTextLine; } catch (IOException e) { LOG.error("Was not able to read error for process container:{}", processContainer.getUuid(), e); @@ -222,7 +222,7 @@ private void fetchStreamsAndWriteProcessFile(ProcessContainer processContainer) private void writeToFile(ProcessContainer processContainer) { Path metaDataFile = locationSupport.ensureProcessContainerFile(processContainer); try { - textFileWriter.save(metaDataFile.toFile(), JSONConverter.get().toJSON(processContainer, true), true); + textFileWriter.writeTextToFile(metaDataFile.toFile(), JSONConverter.get().toJSON(processContainer, true), true); } catch (IOException e) { throw new SystemTestRuntimeException("Was not able to write file:" + metaDataFile, e); } diff --git a/sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/runtime/testengine/SystemTestRuntimeTestEngine.java b/sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/runtime/testengine/SystemTestRuntimeTestEngine.java index 3cba054964..448556f5f5 100644 --- a/sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/runtime/testengine/SystemTestRuntimeTestEngine.java +++ b/sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/runtime/testengine/SystemTestRuntimeTestEngine.java @@ -209,7 +209,7 @@ private void handleScanLogFile(Path scanLogFile, TestEngineTestContext testConte private void handlePDSMetaDataFile(Path metaDataFile, TestEngineTestContext testContext, Path sechubJobFolder) throws IOException { LOG.debug("Handle PDS meta data file: {}", metaDataFile); - String metaDataJson = textFileReader.loadTextFile(metaDataFile.toFile()); + String metaDataJson = textFileReader.readTextFromFile(metaDataFile.toFile()); MetaDataModel metaData = JSONConverter.get().fromJSON(MetaDataModel.class, metaDataJson); String pdsJobUUID = metaData.getValueAsStringOrNull(PDSMetaDataKeys.PDS_JOB_UUID); @@ -244,24 +244,24 @@ private void storePdsJobData(String pdsJobUUID, Path pdsJobFolder, PDSSolutionDe Path systemtestInfoFile = pdsJobFolder.resolve("systemtest-info.txt"); String output = client.fetchJobOutputStreamContentAsText(pdsJobUUID); - textFileWriter.save(outputStreamFile.toFile(), output, true); + textFileWriter.writeTextToFile(outputStreamFile.toFile(), output, true); String error = client.fetchJobErrorStreamContentAsText(pdsJobUUID); - textFileWriter.save(errorStreamFile.toFile(), error, true); + textFileWriter.writeTextToFile(errorStreamFile.toFile(), error, true); String result = client.fetchJobResultAsText(pdsJobUUID); - textFileWriter.save(resultFile.toFile(), result, true); + textFileWriter.writeTextToFile(resultFile.toFile(), result, true); String jobMetaData = client.fetchJobMetaDataAsText(pdsJobUUID); - textFileWriter.save(jobMetaDataFile.toFile(), jobMetaData, true); + textFileWriter.writeTextToFile(jobMetaDataFile.toFile(), jobMetaData, true); SecHubMessagesList messages = client.fetchJobMessages(pdsJobUUID); String messagesAsString = JSONConverter.get().toJSON(messages, true); - textFileWriter.save(sechubMessagesFile.toFile(), messagesAsString, true); + textFileWriter.writeTextToFile(sechubMessagesFile.toFile(), messagesAsString, true); StringBuilder sb = new StringBuilder(); sb.append("Solution name: ").append(solution.getName()); - textFileWriter.save(systemtestInfoFile.toFile(), sb.toString(), true); + textFileWriter.writeTextToFile(systemtestInfoFile.toFile(), sb.toString(), true); } private TestEngineTestContext createTestContext(TestDefinition test, SystemTestRuntimeContext runtimeContext) { @@ -671,7 +671,7 @@ private void storeSecHubConfigFile(SecHubConfigurationModel configuration) { File targetFile = new File(targetFolder.toFile(), "sechub-config.json"); try { - textFileWriter.save(targetFile, prettyPrintedJson, true); + textFileWriter.writeTextToFile(targetFile, prettyPrintedJson, true); } catch (IOException e) { LOG.error("Was not able to store sechub config file: {}", targetFile, e); } diff --git a/sechub-systemtest/src/test/java/com/mercedesbenz/sechub/systemtest/SystemTestDryRunTest.java b/sechub-systemtest/src/test/java/com/mercedesbenz/sechub/systemtest/SystemTestDryRunTest.java index 658d9311e9..33f4f626a2 100644 --- a/sechub-systemtest/src/test/java/com/mercedesbenz/sechub/systemtest/SystemTestDryRunTest.java +++ b/sechub-systemtest/src/test/java/com/mercedesbenz/sechub/systemtest/SystemTestDryRunTest.java @@ -58,7 +58,7 @@ void beforeEach(TestInfo info) { @Test void faked_xray_can_be_executed_without_errors() throws IOException { String path = "./src/test/resources/systemtest_xray_licensescan_example.json"; - String json = TestFileReader.loadTextFile(path); + String json = TestFileReader.readTextFromFile(path); SystemTestConfiguration configuration = JSONConverter.get().fromJSON(SystemTestConfiguration.class, json); @@ -260,23 +260,23 @@ void faked_gosec_can_be_executed_without_errors() throws IOException { fail("The execution failed:"+result.toString()); } // we now check that all test output was written by our test scripts to files - String sechubStartOutputData = TestFileReader.loadTextFile(secHubStartOutputFile); + String sechubStartOutputData = TestFileReader.readTextFromFile(secHubStartOutputFile); assertEquals("sechub-started and TEST_NUMBER_LIST=2_should_be_2", sechubStartOutputData); // special case: inside this script we wait some time before the output is done // means: we can test if waitForStage information is correct handled by framework - String gosecStartOutputData = TestFileReader.loadTextFile(goSecStartOutputFile); + String gosecStartOutputData = TestFileReader.readTextFromFile(goSecStartOutputFile); assertEquals("gosec-started with param2=secondCallIsForPDS and C_test_var_number_added=2_should_be_2, B_TEST2=value2, D_RESOLVED_SECRET is like path=true, parameter3 is still a secret=true", gosecStartOutputData); - String sechubStopOutputData = TestFileReader.loadTextFile(secHubStopOutputFile); + String sechubStopOutputData = TestFileReader.readTextFromFile(secHubStopOutputFile); assertEquals("sechub-stopped with param2=second and parm3=third-as:"+var_Text+" and Y_TEST=testy", sechubStopOutputData); - String gosecStopOutputData = TestFileReader.loadTextFile(goSecStopOutputFile); + String gosecStopOutputData = TestFileReader.readTextFromFile(goSecStopOutputFile); assertEquals("gosec-stopped with param2=second and parm3=third-as:"+var_Text+" and X_TEST=testx", gosecStopOutputData); // Here we check if the test1 output file preparation was written to test folder Path preparationOutputFile = tempWorkspaceFolder.resolve("tests/test1/"+PREPARE_TEST1_OUPTUT_FILE_NAME); - String preparationOutputFileContent = TestFileReader.loadTextFile(preparationOutputFile); + String preparationOutputFileContent = TestFileReader.readTextFromFile(preparationOutputFile); assertEquals("Output from prepare-test1.sh", preparationOutputFileContent); diff --git a/sechub-systemtest/src/test/java/com/mercedesbenz/sechub/systemtest/SystemTestExampleWriter.java b/sechub-systemtest/src/test/java/com/mercedesbenz/sechub/systemtest/SystemTestExampleWriter.java index 55b3611dc7..3e7c1f943a 100644 --- a/sechub-systemtest/src/test/java/com/mercedesbenz/sechub/systemtest/SystemTestExampleWriter.java +++ b/sechub-systemtest/src/test/java/com/mercedesbenz/sechub/systemtest/SystemTestExampleWriter.java @@ -23,7 +23,7 @@ public static void writeExample(SystemTestConfiguration configuration, String na TextFileWriter writer = new TextFileWriter(); File generatedSecHubDocExampleFile = new File("./build/gen/example/" + name); - writer.save(generatedSecHubDocExampleFile, configurationAsPrettyPrintedJson, true); + writer.writeTextToFile(generatedSecHubDocExampleFile, configurationAsPrettyPrintedJson, true); LOG.info("Wrote configuration data as example doc file into: {}", generatedSecHubDocExampleFile.getAbsolutePath()); } diff --git a/sechub-systemtest/src/test/java/com/mercedesbenz/sechub/systemtest/SystemTestLocalGoSecManualTest.java b/sechub-systemtest/src/test/java/com/mercedesbenz/sechub/systemtest/SystemTestLocalGoSecManualTest.java index 2120f21133..617984b50d 100644 --- a/sechub-systemtest/src/test/java/com/mercedesbenz/sechub/systemtest/SystemTestLocalGoSecManualTest.java +++ b/sechub-systemtest/src/test/java/com/mercedesbenz/sechub/systemtest/SystemTestLocalGoSecManualTest.java @@ -66,7 +66,7 @@ void manual_local_gosec_test_can_run_without_errors() throws IOException { LOG.info("CONFIG : {}", configFile); TextFileReader reader = new TextFileReader(); - String json = reader.loadTextFile(new File("./src/test/resources/"+configFile)); + String json = reader.readTextFromFile(new File("./src/test/resources/"+configFile)); SystemTestConfiguration config = JSONConverter.get().fromJSON(SystemTestConfiguration.class, json); TestEnvironmentProvider environmentProvider= TestConfigUtil.createEnvironmentProviderForSecrets() ; diff --git a/sechub-systemtest/src/test/java/com/mercedesbenz/sechub/systemtest/config/SystemTestConfigurationTest.java b/sechub-systemtest/src/test/java/com/mercedesbenz/sechub/systemtest/config/SystemTestConfigurationTest.java index cc2f895e34..a7388b8abb 100644 --- a/sechub-systemtest/src/test/java/com/mercedesbenz/sechub/systemtest/config/SystemTestConfigurationTest.java +++ b/sechub-systemtest/src/test/java/com/mercedesbenz/sechub/systemtest/config/SystemTestConfigurationTest.java @@ -34,7 +34,7 @@ class SystemTestConfigurationTest { void xray_license_config_can_be_read_and_contains_license_check() throws Exception { /* prepare */ String path = "./src/test/resources/systemtest_xray_licensescan_example.json"; - String json = TestFileReader.loadTextFile(path); + String json = TestFileReader.readTextFromFile(path); /* execute */ SystemTestConfiguration result = JSONConverter.get().fromJSON(SystemTestConfiguration.class, json); diff --git a/sechub-test/src/test/java/com/mercedesbenz/sechub/test/report/ReportTestHelper.java b/sechub-test/src/test/java/com/mercedesbenz/sechub/test/report/ReportTestHelper.java index c5935a0604..6509cf0d25 100644 --- a/sechub-test/src/test/java/com/mercedesbenz/sechub/test/report/ReportTestHelper.java +++ b/sechub-test/src/test/java/com/mercedesbenz/sechub/test/report/ReportTestHelper.java @@ -39,19 +39,19 @@ public class ReportTestHelper { private static final Logger LOG = LoggerFactory.getLogger(ReportTestHelper.class); public static String load3rdPartyReportAsString(String fullName) { - return TestFileReader.loadTextFile(new File(REPORT_PATH + "input/" + fullName)); + return TestFileReader.readTextFromFile(new File(REPORT_PATH + "input/" + fullName)); } public static String loadSarifReport(String name) { - return TestFileReader.loadTextFile(new File(REPORT_PATH + "input/" + name + ".sarif.json")); + return TestFileReader.readTextFromFile(new File(REPORT_PATH + "input/" + name + ".sarif.json")); } public static String loadSecHubReportFileTemplate(String name) { - return TestFileReader.loadTextFile(new File(REPORT_PATH + "input/" + name + ".sechub-template.json")); + return TestFileReader.readTextFromFile(new File(REPORT_PATH + "input/" + name + ".sechub-template.json")); } public static String loadExpectedSecHubReportOutputFile(String name) { - return TestFileReader.loadTextFile(new File(REPORT_PATH + "output/" + name + ".sechub.json")); + return TestFileReader.readTextFromFile(new File(REPORT_PATH + "output/" + name + ".sechub.json")); } public static String transformSarifToSecHubReportJSON(String sarifJson, ProductIdentifier productIdentifier, String sechubJobUUID) diff --git a/sechub-test/src/test/java/com/mercedesbenz/sechub/test/report/ThymeLeafHTMLReportingTest.java b/sechub-test/src/test/java/com/mercedesbenz/sechub/test/report/ThymeLeafHTMLReportingTest.java index 957746aa52..82de29c04a 100644 --- a/sechub-test/src/test/java/com/mercedesbenz/sechub/test/report/ThymeLeafHTMLReportingTest.java +++ b/sechub-test/src/test/java/com/mercedesbenz/sechub/test/report/ThymeLeafHTMLReportingTest.java @@ -27,7 +27,7 @@ import com.mercedesbenz.sechub.commons.model.SecHubReportMetaData; import com.mercedesbenz.sechub.commons.model.SecHubReportModel; import com.mercedesbenz.sechub.commons.model.TrafficLightSupport; -import com.mercedesbenz.sechub.docgen.util.TextFileWriter; +import com.mercedesbenz.sechub.docgen.util.DocGenTextFileWriter; import com.mercedesbenz.sechub.domain.scan.SecHubExecutionException; import com.mercedesbenz.sechub.domain.scan.report.HTMLScanResultReportModelBuilder; import com.mercedesbenz.sechub.domain.scan.report.ScanReport; @@ -256,7 +256,7 @@ void example8_pseudo_gitleaks_sarif_with_version_control_transformed_to_sechub_r private void storeHTMLOutputAsFile(String htmlResult, String name) throws IOException { TestFileWriter writer = new TestFileWriter(); - writer.save(new File("./build/test-data/thymeleaf-test/" + name + ".html"), htmlResult, true); + writer.writeTextToFile(new File("./build/test-data/thymeleaf-test/" + name + ".html"), htmlResult, true); } private String processThymeLeafTemplates(TestReportContext context) throws IOException, SecHubExecutionException { @@ -280,8 +280,8 @@ private void storeAsFileForDevelopmentWhenTempFilesAreKept(String content, TestR return; } Path testFile = TestUtil.createTempFileInBuildFolder("thymeleaf-html-reporttest-" + context.exampleName + "." + fileEnding); - TextFileWriter writer = new TextFileWriter(); - writer.save(testFile.toFile(), content); + DocGenTextFileWriter writer = new DocGenTextFileWriter(); + writer.writeTextToFile(testFile.toFile(), content); LOG.info("Wrote test file to:{}", testFile); } diff --git a/sechub-testframework/src/main/java/com/mercedesbenz/sechub/test/CSSFileToFragementMerger.java b/sechub-testframework/src/main/java/com/mercedesbenz/sechub/test/CSSFileToFragementMerger.java index 4203c0be11..90695cada1 100644 --- a/sechub-testframework/src/main/java/com/mercedesbenz/sechub/test/CSSFileToFragementMerger.java +++ b/sechub-testframework/src/main/java/com/mercedesbenz/sechub/test/CSSFileToFragementMerger.java @@ -16,8 +16,8 @@ public class CSSFileToFragementMerger { private static final TestFileWriter writer = new TestFileWriter(); public void merge(File cssFile, File fragmentsFile) throws IOException { - String cssContent = TestFileReader.loadTextFile(cssFile); - String fragmentsContent = TestFileReader.loadTextFile(fragmentsFile); + String cssContent = TestFileReader.readTextFromFile(cssFile); + String fragmentsContent = TestFileReader.readTextFromFile(fragmentsFile); int fragmentIndex = fragmentsContent.indexOf(CSS_FRAGMENT_START); @@ -31,7 +31,7 @@ public void merge(File cssFile, File fragmentsFile) throws IOException { } String newFragmentContent = fragmentsContent.substring(0, fragmentIndex) + "\n" + cssContent + "\n" + fragmentsContent.substring(closeStyleIndex); - writer.save(fragmentsFile, newFragmentContent, true); + writer.writeTextToFile(fragmentsFile, newFragmentContent, true); LOG.info("Updated fragment file: {}\nfrom with CSS content of: {}", fragmentsFile, cssFile); } diff --git a/sechub-testframework/src/main/java/com/mercedesbenz/sechub/test/TestFileReader.java b/sechub-testframework/src/main/java/com/mercedesbenz/sechub/test/TestFileReader.java index e0365087c5..adf6553d27 100644 --- a/sechub-testframework/src/main/java/com/mercedesbenz/sechub/test/TestFileReader.java +++ b/sechub-testframework/src/main/java/com/mercedesbenz/sechub/test/TestFileReader.java @@ -10,23 +10,30 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * A class to read test files. Will always use UTF-8 for text files. This class + * may only be used by tests! + * + * @author Albert Tregnaghi + * + */ public class TestFileReader { private static final Logger LOG = LoggerFactory.getLogger(TestFileReader.class); - public static String loadTextFile(Path pathToFile) { - return loadTextFile(pathToFile.toFile()); + public static String readTextFromFile(Path pathToFile) { + return readTextFromFile(pathToFile.toFile()); } - public static String loadTextFile(String pathToFile) { - return loadTextFile(new File(pathToFile)); + public static String readTextFromFile(String pathToFile) { + return readTextFromFile(new File(pathToFile)); } - public static String loadTextFile(File file) { - return loadTextFile(file, "\n"); + public static String readTextFromFile(File file) { + return readTextFromFile(file, "\n"); } - public static String loadTextFile(File file, String lineBreak) { + public static String readTextFromFile(File file, String lineBreak) { if (TestUtil.isTraceEnabled()) { LOG.info("Loading file:{}", file); } diff --git a/sechub-testframework/src/main/java/com/mercedesbenz/sechub/test/TestFileWriter.java b/sechub-testframework/src/main/java/com/mercedesbenz/sechub/test/TestFileWriter.java index f8aa266735..2a3ef988ff 100644 --- a/sechub-testframework/src/main/java/com/mercedesbenz/sechub/test/TestFileWriter.java +++ b/sechub-testframework/src/main/java/com/mercedesbenz/sechub/test/TestFileWriter.java @@ -11,27 +11,31 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * A class to write test files. Will always use UTF-8 for text files. This class + * may only be used by tests! + * + * @author Albert Tregnaghi + * + */ public class TestFileWriter { + private static final Charset CHARSET_UTF_8 = Charset.forName("UTF-8"); private static final Logger LOG = LoggerFactory.getLogger(TestFileWriter.class); public void write(File targetFile, String text) throws IOException { - save(targetFile, text, false); + writeTextToFile(targetFile, text, false); } - public void save(String text, File targetFile, Charset charset) throws IOException { - internalSave(targetFile, text, true, charset); + public void writeTextToFile(String text, File targetFile, Charset charset) throws IOException { + internalWriteTextToFile(targetFile, text, true, charset); } - public void write(File targetFile, String text, boolean overwrite) throws IOException { - save(targetFile, text, overwrite); + public void writeTextToFile(File targetFile, String text, boolean overwrite) throws IOException { + internalWriteTextToFile(targetFile, text, overwrite, CHARSET_UTF_8); } - public void save(File targetFile, String text, boolean overwrite) throws IOException { - internalSave(targetFile, text, overwrite, Charset.forName("UTF-8")); - } - - private void internalSave(File targetFile, String text, boolean overwrite, Charset charset) throws IOException { + private void internalWriteTextToFile(File targetFile, String text, boolean overwrite, Charset charset) throws IOException { if (targetFile == null) { throw new IllegalArgumentException("null not allowed as file!"); } diff --git a/sechub-wrapper-checkmarx/src/main/java/com/mercedesbenz/sechub/wrapper/checkmarx/scan/CheckmarxWrapperStorageService.java b/sechub-wrapper-checkmarx/src/main/java/com/mercedesbenz/sechub/wrapper/checkmarx/scan/CheckmarxWrapperStorageService.java index 8b646d3b5b..dcb885e9fc 100644 --- a/sechub-wrapper-checkmarx/src/main/java/com/mercedesbenz/sechub/wrapper/checkmarx/scan/CheckmarxWrapperStorageService.java +++ b/sechub-wrapper-checkmarx/src/main/java/com/mercedesbenz/sechub/wrapper/checkmarx/scan/CheckmarxWrapperStorageService.java @@ -38,7 +38,7 @@ private void writeProductResult(AdapterExecutionResult adapterResult) throws IOE } File pdsResultFile = new File(pdsResultFilePath); - writer.save(pdsResultFile, adapterResult.getProductResult(), true); + writer.writeTextToFile(pdsResultFile, adapterResult.getProductResult(), true); } private void writeProductMessages(AdapterExecutionResult adapterResult) throws IOException { diff --git a/sechub-wrapper-checkmarx/src/test/java/com/mercedesbenz/sechub/wrapper/checkmarx/scan/CheckmarxWrapperScanContextTest.java b/sechub-wrapper-checkmarx/src/test/java/com/mercedesbenz/sechub/wrapper/checkmarx/scan/CheckmarxWrapperScanContextTest.java index 02408ed449..de1cea6b42 100644 --- a/sechub-wrapper-checkmarx/src/test/java/com/mercedesbenz/sechub/wrapper/checkmarx/scan/CheckmarxWrapperScanContextTest.java +++ b/sechub-wrapper-checkmarx/src/test/java/com/mercedesbenz/sechub/wrapper/checkmarx/scan/CheckmarxWrapperScanContextTest.java @@ -77,7 +77,7 @@ void created_source_input_stream_can_be_read_and_contains_data_of_recompressed_f Path testFolder = TestUtil.createTempDirectoryInBuildFolder("chmx-wrapper-input-stream"); File extractedFolder = new File(testFolder.toFile(), "extracted"); extractedFolder.mkdirs(); - writer.save(new File(extractedFolder, "at-least-one-file.txt"), "content", false); + writer.writeTextToFile(new File(extractedFolder, "at-least-one-file.txt"), "content", false); File expectedCompressFolder = new File(extractedFolder.getParentFile(), "recompressed"); File expectedTargetFile = new File(expectedCompressFolder, CommonConstants.FILENAME_SOURCECODE_ZIP); @@ -93,7 +93,7 @@ void created_source_input_stream_can_be_read_and_contains_data_of_recompressed_f public Void answer(InvocationOnMock invocation) throws Throwable { // we simulate that archive support writes a "ZIP" file - instead of doing // a real compression the mock writes a single line into the output file. - writer.save(expectedTargetFile, singleLineInWrittenFile, false); + writer.writeTextToFile(expectedTargetFile, singleLineInWrittenFile, false); return null; } }).when(archiveSupport).compressFolder(eq(ArchiveType.ZIP), eq(extractedFolder), eq(expectedTargetFile)); diff --git a/sechub-wrapper-checkmarx/src/test/java/com/mercedesbenz/sechub/wrapper/checkmarx/scan/CheckmarxWrapperStorageServiceTest.java b/sechub-wrapper-checkmarx/src/test/java/com/mercedesbenz/sechub/wrapper/checkmarx/scan/CheckmarxWrapperStorageServiceTest.java index d1ff726056..18eba451a2 100644 --- a/sechub-wrapper-checkmarx/src/test/java/com/mercedesbenz/sechub/wrapper/checkmarx/scan/CheckmarxWrapperStorageServiceTest.java +++ b/sechub-wrapper-checkmarx/src/test/java/com/mercedesbenz/sechub/wrapper/checkmarx/scan/CheckmarxWrapperStorageServiceTest.java @@ -57,7 +57,7 @@ void service_stores_product_result_as_file_at_defined_location_by_writer() throw serviceToTest.store(result); /* test */ - verify(writer).save(resultFile, "content", true); + verify(writer).writeTextToFile(resultFile, "content", true); } @@ -75,7 +75,7 @@ void service_stores_product_messages_and_result_and_writes_product_messages() th serviceToTest.store(result); /* test */ - verify(writer).save(resultFile, "content1", true); + verify(writer).writeTextToFile(resultFile, "content1", true); verify(messageSupport).writeMessages(eq(Arrays.asList(message1, message2))); } diff --git a/sechub-wrapper-owasp-zap/src/main/java/com/mercedesbenz/sechub/zapwrapper/config/RuleProvider.java b/sechub-wrapper-owasp-zap/src/main/java/com/mercedesbenz/sechub/zapwrapper/config/RuleProvider.java index 4dc48c8b3f..ae5d732708 100644 --- a/sechub-wrapper-owasp-zap/src/main/java/com/mercedesbenz/sechub/zapwrapper/config/RuleProvider.java +++ b/sechub-wrapper-owasp-zap/src/main/java/com/mercedesbenz/sechub/zapwrapper/config/RuleProvider.java @@ -54,7 +54,7 @@ public DeactivatedRuleReferences fetchDeactivatedRuleReferences(File rulesDeactv private String readFileContent(File file) { try { - return reader.loadTextFile(file); + return reader.readTextFromFile(file); } catch (IOException e) { throw new ZapWrapperRuntimeException("Error reading file: " + file, e, ZapWrapperExitCode.IO_ERROR); } diff --git a/sechub-wrapper-owasp-zap/src/main/java/com/mercedesbenz/sechub/zapwrapper/config/SecHubScanConfigProvider.java b/sechub-wrapper-owasp-zap/src/main/java/com/mercedesbenz/sechub/zapwrapper/config/SecHubScanConfigProvider.java index 9c483f3959..e33fec6c45 100644 --- a/sechub-wrapper-owasp-zap/src/main/java/com/mercedesbenz/sechub/zapwrapper/config/SecHubScanConfigProvider.java +++ b/sechub-wrapper-owasp-zap/src/main/java/com/mercedesbenz/sechub/zapwrapper/config/SecHubScanConfigProvider.java @@ -19,7 +19,7 @@ public SecHubScanConfiguration getSecHubWebConfiguration(File secHubConfigFile) String sechubConfigJson; SecHubScanConfiguration sechubScanConfig; try { - sechubConfigJson = fileReader.loadTextFile(secHubConfigFile); + sechubConfigJson = fileReader.readTextFromFile(secHubConfigFile); sechubScanConfig = SecHubScanConfiguration.createFromJSON(sechubConfigJson); } catch (IOException e) { throw new ZapWrapperRuntimeException("Was not able to read sechub config file: " + secHubConfigFile, e, ZapWrapperExitCode.IO_ERROR); diff --git a/sechub-wrapper-owasp-zap/src/main/java/com/mercedesbenz/sechub/zapwrapper/scan/ZapScanner.java b/sechub-wrapper-owasp-zap/src/main/java/com/mercedesbenz/sechub/zapwrapper/scan/ZapScanner.java index 0ca1232b18..1284a9feea 100644 --- a/sechub-wrapper-owasp-zap/src/main/java/com/mercedesbenz/sechub/zapwrapper/scan/ZapScanner.java +++ b/sechub-wrapper-owasp-zap/src/main/java/com/mercedesbenz/sechub/zapwrapper/scan/ZapScanner.java @@ -815,7 +815,7 @@ private String readHeaderValueFromFile(HTTPHeaderConfiguration httpHeader) { headerFile = scanContext.getHeaderValueFiles().getOrDefault(httpHeader.getName(), null); try { if (headerFile != null) { - return fileReader.loadTextFile(headerFile.getAbsoluteFile()); + return fileReader.readTextFromFile(headerFile.getAbsoluteFile()); } } catch (IOException e) { SecHubMessage message = new SecHubMessage(SecHubMessageType.ERROR, "Could not read header value from file: " + headerFile); diff --git a/sechub-wrapper-owasp-zap/src/test/java/com/mercedesbenz/sechub/zapwrapper/helper/SecHubWebScanConfigurationHelperTest.java b/sechub-wrapper-owasp-zap/src/test/java/com/mercedesbenz/sechub/zapwrapper/helper/SecHubWebScanConfigurationHelperTest.java index 2a95c6c398..e2d45ba707 100644 --- a/sechub-wrapper-owasp-zap/src/test/java/com/mercedesbenz/sechub/zapwrapper/helper/SecHubWebScanConfigurationHelperTest.java +++ b/sechub-wrapper-owasp-zap/src/test/java/com/mercedesbenz/sechub/zapwrapper/helper/SecHubWebScanConfigurationHelperTest.java @@ -38,7 +38,7 @@ void determines_AuthenticationType_sechub_config_is_null() { void determines_AuthenticationType_sechub_config_has_basic_auth() { /* prepare */ File file = new File("src/test/resources/sechub-config-examples/basic-auth.json"); - String sechubConfigJSON = TestFileReader.loadTextFile(file); + String sechubConfigJSON = TestFileReader.readTextFromFile(file); SecHubScanConfiguration sechubConfig = SecHubScanConfiguration.createFromJSON(sechubConfigJSON); SecHubWebScanConfiguration secHubWebScanConfiguration = sechubConfig.getWebScan().get(); diff --git a/sechub-wrapper-owasp-zap/src/test/java/com/mercedesbenz/sechub/zapwrapper/scan/ZapScannerTest.java b/sechub-wrapper-owasp-zap/src/test/java/com/mercedesbenz/sechub/zapwrapper/scan/ZapScannerTest.java index 9ad2f0e4eb..1b3d4b6302 100644 --- a/sechub-wrapper-owasp-zap/src/test/java/com/mercedesbenz/sechub/zapwrapper/scan/ZapScannerTest.java +++ b/sechub-wrapper-owasp-zap/src/test/java/com/mercedesbenz/sechub/zapwrapper/scan/ZapScannerTest.java @@ -138,7 +138,7 @@ void deactivate_rules_results_in_rules_are_deactivated() throws ClientApiExcepti deactivatedReferences.addRuleReference(new RuleReference("Cross-Site-Scripting-(Reflected)-40012", "second-info")); deactivatedReferences.addRuleReference(new RuleReference("Path-Traversal-6", "third-info")); - String json = TestFileReader.loadTextFile("src/test/resources/zap-available-rules/zap-full-ruleset.json"); + String json = TestFileReader.readTextFromFile("src/test/resources/zap-available-rules/zap-full-ruleset.json"); ZapFullRuleset ruleSet = new ZapFullRuleset().fromJSON(json); when(clientApiFacade.disablePassiveScannerRule(any())).thenReturn(null); @@ -319,7 +319,7 @@ void add_replacer_rules_for_headers_with_data_section_results_add_replacer_rule_ void set_includes_and_excludes_api_facade_is_called_once_for_each_include_and_once_for_exclude(String sechubConfigFile) throws ClientApiException, MalformedURLException { /* prepare */ - String json = TestFileReader.loadTextFile(sechubConfigFile); + String json = TestFileReader.readTextFromFile(sechubConfigFile); SecHubWebScanConfiguration sechubWebScanConfig = SecHubScanConfiguration.createFromJSON(json).getWebScan().get(); IncludeExcludeToZapURLHelper helper = new IncludeExcludeToZapURLHelper(); @@ -370,7 +370,7 @@ void import_openapi_file_but_api_file_is_null_api_facade_is_never_called() throw void import_openapi_file_api_facade_is_called_once(String sechubConfigFile) throws ClientApiException { /* prepare */ String contextId = "context-id"; - String json = TestFileReader.loadTextFile(sechubConfigFile); + String json = TestFileReader.readTextFromFile(sechubConfigFile); SecHubWebScanConfiguration sechubWebScanConfig = SecHubScanConfiguration.createFromJSON(json).getWebScan().get(); List apiFiles = new ArrayList<>(); @@ -394,7 +394,7 @@ void import_openapi_file_api_facade_is_called_once(String sechubConfigFile) thro void import_openapi_defintion_from_url_api_facade_is_called_once(String sechubConfigFile) throws ClientApiException { /* prepare */ String contextId = "context-id"; - String json = TestFileReader.loadTextFile(sechubConfigFile); + String json = TestFileReader.readTextFromFile(sechubConfigFile); SecHubWebScanConfiguration sechubWebScanConfig = SecHubScanConfiguration.createFromJSON(json).getWebScan().get(); when(scanContext.getSecHubWebScanConfiguration()).thenReturn(sechubWebScanConfig); @@ -415,7 +415,7 @@ void import_openapi_defintion_from_url_api_facade_is_called_once(String sechubCo void import_openapi_from_file_and_from_url_api_facade_is_called_once(String sechubConfigFile) throws ClientApiException { /* prepare */ String contextId = "context-id"; - String json = TestFileReader.loadTextFile(sechubConfigFile); + String json = TestFileReader.readTextFromFile(sechubConfigFile); SecHubWebScanConfiguration sechubWebScanConfig = SecHubScanConfiguration.createFromJSON(json).getWebScan().get(); List apiFiles = new ArrayList<>(); @@ -553,7 +553,7 @@ void import_client_certificate_file_but_without_password_api_facade_is_called_on void configure_login_inside_zap_using_no_auth_and_unsupported_auth_return_null(String sechubConfigFile) throws ClientApiException { /* prepare */ String contextId = "context-id"; - String json = TestFileReader.loadTextFile(sechubConfigFile); + String json = TestFileReader.readTextFromFile(sechubConfigFile); SecHubWebScanConfiguration sechubWebScanConfig = SecHubScanConfiguration.createFromJSON(json).getWebScan().get(); when(scanContext.getSecHubWebScanConfiguration()).thenReturn(sechubWebScanConfig); @@ -571,7 +571,7 @@ void configure_login_inside_zap_using_basic_auth_results_in_expected_calls() thr String contextId = "context-id"; String userId = "user-id"; URL targetUrl = URI.create("https:127.0.0.1:8000").toURL(); - String json = TestFileReader.loadTextFile("src/test/resources/sechub-config-examples/basic-auth.json"); + String json = TestFileReader.readTextFromFile("src/test/resources/sechub-config-examples/basic-auth.json"); SecHubWebScanConfiguration sechubWebScanConfig = SecHubScanConfiguration.createFromJSON(json).getWebScan().get(); BasicLoginConfiguration basicLoginConfiguration = sechubWebScanConfig.getLogin().get().getBasic().get(); String userName = new String(basicLoginConfiguration.getUser()); diff --git a/sechub-wrapper-prepare/src/main/java/com/mercedesbenz/sechub/wrapper/prepare/PrepareWrapperResultService.java b/sechub-wrapper-prepare/src/main/java/com/mercedesbenz/sechub/wrapper/prepare/PrepareWrapperResultService.java index 47dda2d19b..3dbf317ecd 100644 --- a/sechub-wrapper-prepare/src/main/java/com/mercedesbenz/sechub/wrapper/prepare/PrepareWrapperResultService.java +++ b/sechub-wrapper-prepare/src/main/java/com/mercedesbenz/sechub/wrapper/prepare/PrepareWrapperResultService.java @@ -36,7 +36,7 @@ private void writeProductResult(AdapterExecutionResult adapterResult) throws IOE } File pdsResultFile = new File(pdsResultFilePath); - writer.save(pdsResultFile, adapterResult.getProductResult(), true); + writer.writeTextToFile(pdsResultFile, adapterResult.getProductResult(), true); } private void writeProductMessages(AdapterExecutionResult adapterResult) throws IOException { diff --git a/sechub-wrapper-prepare/src/main/java/com/mercedesbenz/sechub/wrapper/prepare/modules/test/IntegrationTestPrepareWrapperModule.java b/sechub-wrapper-prepare/src/main/java/com/mercedesbenz/sechub/wrapper/prepare/modules/test/IntegrationTestPrepareWrapperModule.java index e383e94792..e7888f8f36 100644 --- a/sechub-wrapper-prepare/src/main/java/com/mercedesbenz/sechub/wrapper/prepare/modules/test/IntegrationTestPrepareWrapperModule.java +++ b/sechub-wrapper-prepare/src/main/java/com/mercedesbenz/sechub/wrapper/prepare/modules/test/IntegrationTestPrepareWrapperModule.java @@ -108,7 +108,7 @@ private void createIntegrationTestFiles(IntegrationTestContext integrationTestCo INFO:i am just an information from IntegrationTestPrepareWrapperModule """; - writer.save(dataFile.toFile(), mediumIntegrationTestData, false); + writer.writeTextToFile(dataFile.toFile(), mediumIntegrationTestData, false); } catch (IOException e) { throw new RuntimeException("Error while files in directory: " + downloadPath, e); diff --git a/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/PrepareWrapperResultServiceTest.java b/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/PrepareWrapperResultServiceTest.java index 377b1170e4..b856be9183 100644 --- a/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/PrepareWrapperResultServiceTest.java +++ b/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/PrepareWrapperResultServiceTest.java @@ -55,7 +55,7 @@ void service_stores_product_result_as_file_at_defined_location_by_writer() throw serviceToTest.store(result); /* test */ - verify(writer).save(resultFile, "content", true); + verify(writer).writeTextToFile(resultFile, "content", true); } @Test @@ -72,7 +72,7 @@ void service_stores_product_messages_and_result_and_writes_product_messages() th serviceToTest.store(result); /* test */ - verify(writer).save(resultFile, "content1", true); + verify(writer).writeTextToFile(resultFile, "content1", true); verify(messageSupport).writeMessages(eq(Arrays.asList(message1, message2))); } } \ No newline at end of file diff --git a/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/modules/git/GitPrepareWrapperModuleTest.java b/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/modules/git/GitPrepareWrapperModuleTest.java index b872440eab..70525f1ec5 100644 --- a/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/modules/git/GitPrepareWrapperModuleTest.java +++ b/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/modules/git/GitPrepareWrapperModuleTest.java @@ -100,7 +100,7 @@ void prepare_successful_with_user_credentials_configured() throws IOException { Path repository = tempDir.toPath().resolve(gitDownloadFolder).resolve(testRepo); Path gitFile = repository.resolve(".git"); - writer.save(gitFile.toFile(), "some text", true); + writer.writeTextToFile(gitFile.toFile(), "some text", true); List subfolder = new ArrayList<>(); subfolder.add(repository); @@ -150,7 +150,7 @@ void prepare_successful_when_no_credentials_are_configured() throws IOException Path repository = tempDir.toPath().resolve(gitDownloadFolder).resolve(testRepo); Path gitFile = repository.resolve(".git"); - writer.save(gitFile.toFile(), "some text", true); + writer.writeTextToFile(gitFile.toFile(), "some text", true); List subfolder = new ArrayList<>(); subfolder.add(repository); @@ -206,7 +206,7 @@ void isDownloadSuccessful_returns_true_when_git_file_in_directory() throws IOExc Path repository = tempDir.toPath().resolve(testRepo); Path gitFile = repository.resolve(".git"); - writer.save(gitFile.toFile(), "some text", true); + writer.writeTextToFile(gitFile.toFile(), "some text", true); GitContext context = mock(GitContext.class); when(context.getToolDownloadDirectory()).thenReturn(tempDir.toPath()); @@ -228,7 +228,7 @@ void isDownloadSuccessful_returns_false_when_no_git_file_in_directory() throws I Path repository = tempDir.toPath().resolve(testRepo); Path javaFile = repository.resolve("class.java"); - writer.save(javaFile.toFile(), "some text", true); + writer.writeTextToFile(javaFile.toFile(), "some text", true); GitContext context = mock(GitContext.class); when(context.getToolDownloadDirectory()).thenReturn(tempDir.toPath()); diff --git a/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/modules/skopeo/SkopeoPrepareWrapperModuleTest.java b/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/modules/skopeo/SkopeoPrepareWrapperModuleTest.java index 0559ff4cc4..408962e8d9 100644 --- a/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/modules/skopeo/SkopeoPrepareWrapperModuleTest.java +++ b/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/modules/skopeo/SkopeoPrepareWrapperModuleTest.java @@ -116,7 +116,7 @@ void prepare_successful_when_user_credentials_are_configured_correctly() throws Path testFile = Path.of("testimage.tar"); Path downloadDirectory = tempDir.resolve(SkopeoWrapperConstants.DOWNLOAD_DIRECTORY_NAME); - writer.save(downloadDirectory.resolve(testFile).toFile(), "some text", true); + writer.writeTextToFile(downloadDirectory.resolve(testFile).toFile(), "some text", true); PrepareWrapperEnvironment environment = mock(PrepareWrapperEnvironment.class); when(environment.getPdsJobWorkspaceLocation()).thenReturn(tempDir.toString()); @@ -164,7 +164,7 @@ void prepare_does_validate_download_and_cleanup_docker_image_when_no_credentials Path downloadDirectory = tempDir.resolve(SkopeoWrapperConstants.DOWNLOAD_DIRECTORY_NAME); Path testFile = downloadDirectory.resolve("testimage.tar"); - writer.save(testFile.toFile(), "some text", true); + writer.writeTextToFile(testFile.toFile(), "some text", true); PrepareWrapperEnvironment environment = mock(PrepareWrapperEnvironment.class); when(environment.getPdsJobWorkspaceLocation()).thenReturn(tempDir.toString()); diff --git a/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/upload/FileNameSupportTest.java b/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/upload/FileNameSupportTest.java index 6fefa6fd8f..07b285a847 100644 --- a/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/upload/FileNameSupportTest.java +++ b/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/upload/FileNameSupportTest.java @@ -34,7 +34,7 @@ void getRepositoriesFromDirectory_returns_subfolder() throws IOException { String subfolder = "/subfolder"; String file = subfolder + "/test"; - writer.save(new File(tempDir + file), "testText", true); + writer.writeTextToFile(new File(tempDir + file), "testText", true); /* execute */ List result = fileNameSupportToTest.getRepositoriesFromDirectory(tempDir.toPath()); @@ -54,8 +54,8 @@ void getRepositoriesFromDirectory_returns_multiple_directories() throws IOExcept String path = tempDir.getAbsolutePath(); String subfolder1 = "/subfolder"; String subfolder2 = "/subfolder2"; - writer.save(new File(path + subfolder1 + "/hello"), "testText", true); - writer.save(new File(path + subfolder2 + "/hello"), "testText", true); + writer.writeTextToFile(new File(path + subfolder1 + "/hello"), "testText", true); + writer.writeTextToFile(new File(path + subfolder2 + "/hello"), "testText", true); /* execute */ List result = fileNameSupportToTest.getRepositoriesFromDirectory(tempDir.toPath()); @@ -85,7 +85,7 @@ void getTarFilesFromDirectory_returns_tar_file() throws IOException { String path = tempDir.getAbsolutePath(); String tarFile = "/test-tar-file.tar"; - writer.save(new File(path + tarFile), "testText", true); + writer.writeTextToFile(new File(path + tarFile), "testText", true); /* execute */ List result = fileNameSupportToTest.getTarFilesFromDirectory(tempDir.toPath()); @@ -105,8 +105,8 @@ void getTarFilesFromDirectory_returns_multiple_tar_files() throws IOException { String path = tempDir.getAbsolutePath(); String tarFile1 = "/test-tar-file1.tar"; String tarFile2 = "/test-tar-file2.tar"; - writer.save(new File(path + tarFile1), "testText", true); - writer.save(new File(path + tarFile2), "testText", true); + writer.writeTextToFile(new File(path + tarFile1), "testText", true); + writer.writeTextToFile(new File(path + tarFile2), "testText", true); /* execute */ List result = fileNameSupportToTest.getTarFilesFromDirectory(tempDir.toPath()); diff --git a/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/upload/PrepareWrapperArchiveCreatorTest.java b/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/upload/PrepareWrapperArchiveCreatorTest.java index 9dd193bbc9..dfc476e843 100644 --- a/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/upload/PrepareWrapperArchiveCreatorTest.java +++ b/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/upload/PrepareWrapperArchiveCreatorTest.java @@ -53,9 +53,9 @@ void createArchive_creates_archive_for_binary() throws IOException { Path uploadDirectory = tempDir.toPath().resolve(Path.of("upload")); Path testDownload = tempDir.toPath().resolve(Path.of("test-download")); Path testTarFilename = Path.of("test-tar.tar"); - writer.save(testDownload.resolve(testTarFilename).toFile(), "testText", true); + writer.writeTextToFile(testDownload.resolve(testTarFilename).toFile(), "testText", true); - String json = TestFileReader.loadTextFile(new File("./src/test/resources/sechub_remote_data_config_binary_code_scan_example.json")); + String json = TestFileReader.readTextFromFile(new File("./src/test/resources/sechub_remote_data_config_binary_code_scan_example.json")); PrepareWrapperContext context = mock(PrepareWrapperContext.class); PrepareWrapperEnvironment environment = mock(PrepareWrapperEnvironment.class); @@ -88,9 +88,9 @@ void createArchive_creates_archive_for_source() throws IOException { Path uploadDirectory = tempDir.toPath().resolve(Path.of("upload")); Path testDownload = tempDir.toPath().resolve(Path.of("test-download")); Path testRepoName = Path.of("test-repos"); - writer.save(testDownload.resolve(testRepoName).resolve(Path.of(".git")).toFile(), "testText", true); + writer.writeTextToFile(testDownload.resolve(testRepoName).resolve(Path.of(".git")).toFile(), "testText", true); - String json = TestFileReader.loadTextFile(new File("./src/test/resources/sechub_remote_data_config_source_code_scan_example.json")); + String json = TestFileReader.readTextFromFile(new File("./src/test/resources/sechub_remote_data_config_source_code_scan_example.json")); PrepareWrapperContext context = mock(PrepareWrapperContext.class); PrepareWrapperEnvironment environment = mock(PrepareWrapperEnvironment.class); diff --git a/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/upload/PrepareWrapperFileUploadServiceTest.java b/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/upload/PrepareWrapperFileUploadServiceTest.java index a264f83243..36aa3b9953 100644 --- a/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/upload/PrepareWrapperFileUploadServiceTest.java +++ b/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/upload/PrepareWrapperFileUploadServiceTest.java @@ -113,7 +113,7 @@ void uploadFile_throws_exception_when_checkSum_is_null() throws IOException { File tempDir = Files.createTempDirectory("test-sechub_archive-creator").toFile(); tempDir.deleteOnExit(); File file = new File(tempDir + "testfile.tar"); - writer.save(file, "testText", true); + writer.writeTextToFile(file, "testText", true); /* execute */ IllegalArgumentException exception = assertThrows(IllegalArgumentException.class, () -> { @@ -134,7 +134,7 @@ void uploadFile_successfully_uploads_binary_file() throws IOException { File tempDir = Files.createTempDirectory("test-sechub_archive-creator").toFile(); tempDir.deleteOnExit(); File file = new File(tempDir + "testfile.tar"); - writer.save(file, "someExampleText", true); + writer.writeTextToFile(file, "someExampleText", true); /* execute */ uploadServiceToTest.uploadFile(projectId, jobUUID, file, checkSum); @@ -156,7 +156,7 @@ void uploadFile_successfully_uploads_source_zip_file() throws IOException { File tempDir = Files.createTempDirectory("test-sechub_archive-creator").toFile(); tempDir.deleteOnExit(); File file = new File(tempDir + "testfile.zip"); - writer.save(file, "someExampleText", true); + writer.writeTextToFile(file, "someExampleText", true); /* execute */ uploadServiceToTest.uploadFile(projectId, jobUUID, file, checkSum); diff --git a/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/upload/PrepareWrapperSechubConfigurationSupportTest.java b/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/upload/PrepareWrapperSechubConfigurationSupportTest.java index 7989b4ba9d..6346254028 100644 --- a/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/upload/PrepareWrapperSechubConfigurationSupportTest.java +++ b/sechub-wrapper-prepare/src/test/java/com/mercedesbenz/sechub/wrapper/prepare/upload/PrepareWrapperSechubConfigurationSupportTest.java @@ -108,7 +108,7 @@ void replaceRemoteDataWithFilesystem_returns_SecHubConfigurationModel_when_SecHu @Test void replaceRemoteDataWithFilesystem_returns_SecHubConfigurationModel_when_SecHubConfigurationModel_data_binaries_is_not_empty() throws IOException { /* prepare */ - writer.save(testDownload.resolve(testTarFilename).toFile(), "testText", true); + writer.writeTextToFile(testDownload.resolve(testTarFilename).toFile(), "testText", true); SecHubConfigurationModel model = loadModelFromTestFile("sechub_remote_data_config_binary_code_scan_example.json"); @@ -136,7 +136,7 @@ void replaceRemoteDataWithFilesystem_returns_SecHubConfigurationModel_when_SecHu @Test void replaceRemoteDataWithFilesystem_returns_SecHubConfigurationModel_when_SecHubConfigurationModel_data_sources_is_not_empty() throws IOException { /* prepare */ - writer.save(testDownload.resolve(testRepoName).resolve(Path.of(".git")).toFile(), "testText", true); + writer.writeTextToFile(testDownload.resolve(testRepoName).resolve(Path.of(".git")).toFile(), "testText", true); SecHubConfigurationModel model = loadModelFromTestFile("sechub_remote_data_config_source_code_scan_example.json"); @@ -164,7 +164,7 @@ void replaceRemoteDataWithFilesystem_returns_SecHubConfigurationModel_when_SecHu @Test void replaceRemoteDataWithFilesystem_returns_expected_SecHubConfigurationModel_for_remote_binaries() throws IOException { /* prepare */ - writer.save(testDownload.resolve(testTarFilename).toFile(), "testText", true); + writer.writeTextToFile(testDownload.resolve(testTarFilename).toFile(), "testText", true); SecHubConfigurationModel model = loadModelFromTestFile("sechub_remote_data_config_binary_code_scan_example.json"); @@ -194,7 +194,7 @@ void replaceRemoteDataWithFilesystem_returns_expected_SecHubConfigurationModel_f @Test void replaceRemoteDataWithFilesystem_returns_expected_SecHubConfigurationModel_for_remote_sources() throws IOException { /* prepare */ - writer.save(testDownload.resolve(testRepoName).resolve(Path.of(".git")).toFile(), "testText", true); + writer.writeTextToFile(testDownload.resolve(testRepoName).resolve(Path.of(".git")).toFile(), "testText", true); SecHubConfigurationModel model = loadModelFromTestFile("sechub_remote_data_config_source_code_scan_example.json"); when(prepareContext.getSecHubConfiguration()).thenReturn(model); @@ -221,7 +221,7 @@ void replaceRemoteDataWithFilesystem_returns_expected_SecHubConfigurationModel_f } private SecHubConfigurationModel loadModelFromTestFile(String fileName) { - String json = TestFileReader.loadTextFile(new File("./src/test/resources/" + fileName)); + String json = TestFileReader.readTextFromFile(new File("./src/test/resources/" + fileName)); return createFromJSON(json); } } \ No newline at end of file diff --git a/sechub-wrapper-secret-validator/src/main/java/com/mercedesbenz/sechub/wrapper/secret/validator/cli/SecretValidatorCLI.java b/sechub-wrapper-secret-validator/src/main/java/com/mercedesbenz/sechub/wrapper/secret/validator/cli/SecretValidatorCLI.java index f94910142a..fd7e18170b 100644 --- a/sechub-wrapper-secret-validator/src/main/java/com/mercedesbenz/sechub/wrapper/secret/validator/cli/SecretValidatorCLI.java +++ b/sechub-wrapper-secret-validator/src/main/java/com/mercedesbenz/sechub/wrapper/secret/validator/cli/SecretValidatorCLI.java @@ -35,7 +35,7 @@ public void run(String... args) throws Exception { SarifSchema210 report = executionService.execute(); String json = JSONConverter.get().toJSON(report, true); - fileWriter.save(pdsJobResult.getFile(), json, true); + fileWriter.writeTextToFile(pdsJobResult.getFile(), json, true); } catch (Exception e) { LOG.error("Execution failed!", e); System.exit(1); diff --git a/sechub-wrapper-secret-validator/src/main/java/com/mercedesbenz/sechub/wrapper/secret/validator/execution/SecretValidatorExecutionContextFactory.java b/sechub-wrapper-secret-validator/src/main/java/com/mercedesbenz/sechub/wrapper/secret/validator/execution/SecretValidatorExecutionContextFactory.java index 1cb1b3069c..03ca70bc14 100644 --- a/sechub-wrapper-secret-validator/src/main/java/com/mercedesbenz/sechub/wrapper/secret/validator/execution/SecretValidatorExecutionContextFactory.java +++ b/sechub-wrapper-secret-validator/src/main/java/com/mercedesbenz/sechub/wrapper/secret/validator/execution/SecretValidatorExecutionContextFactory.java @@ -57,7 +57,7 @@ private SarifSchema210 createSarifReport(File pdsResultFile) { } try { - String sarifReportJson = reader.loadTextFile(pdsResultFile); + String sarifReportJson = reader.readTextFromFile(pdsResultFile); return JSONConverter.get().fromJSON(SarifSchema210.class, sarifReportJson); } catch (Exception e) { throw new IllegalStateException("Creating SARIF report model from: " + pdsResultFile + " failed!", e); @@ -72,7 +72,7 @@ private Map createRuleConfigurations( } try { - String validatorConfigJson = reader.loadTextFile(validatorConfigFile); + String validatorConfigJson = reader.readTextFromFile(validatorConfigFile); SecretValidatorConfigurationModelList configurationDataList = JSONConverter.get().fromJSON(SecretValidatorConfigurationModelList.class, validatorConfigJson); diff --git a/sechub-wrapper-secret-validator/src/test/java/com/mercedesbenz/sechub/wrapper/secret/validator/execution/SecretValidatorExecutionServiceTest.java b/sechub-wrapper-secret-validator/src/test/java/com/mercedesbenz/sechub/wrapper/secret/validator/execution/SecretValidatorExecutionServiceTest.java index b4e3efc859..11d9ed2184 100644 --- a/sechub-wrapper-secret-validator/src/test/java/com/mercedesbenz/sechub/wrapper/secret/validator/execution/SecretValidatorExecutionServiceTest.java +++ b/sechub-wrapper-secret-validator/src/test/java/com/mercedesbenz/sechub/wrapper/secret/validator/execution/SecretValidatorExecutionServiceTest.java @@ -232,7 +232,7 @@ private SecretValidatorExecutionContext createValidExecutionContext() { private SarifSchema210 createSarifReport(File file) { try { - String sarifReportJson = TestFileReader.loadTextFile(file); + String sarifReportJson = TestFileReader.readTextFromFile(file); return JSONConverter.get().fromJSON(SarifSchema210.class, sarifReportJson); } catch (Exception e) { throw new IllegalStateException("Creating SARIF report model from: " + file + " failed!", e); @@ -241,7 +241,7 @@ private SarifSchema210 createSarifReport(File file) { private Map createRuleConfigurations(File file) { try { - String validatorConfigJson = TestFileReader.loadTextFile(file); + String validatorConfigJson = TestFileReader.readTextFromFile(file); SecretValidatorConfigurationModelList configurationDataList = JSONConverter.get().fromJSON(SecretValidatorConfigurationModelList.class, validatorConfigJson); diff --git a/sechub-wrapper-xray/src/test/java/com/mercedesbenz/sechub/wrapper/xray/util/ZipFileExtractorTest.java b/sechub-wrapper-xray/src/test/java/com/mercedesbenz/sechub/wrapper/xray/util/ZipFileExtractorTest.java index 053d47c805..0108859a15 100644 --- a/sechub-wrapper-xray/src/test/java/com/mercedesbenz/sechub/wrapper/xray/util/ZipFileExtractorTest.java +++ b/sechub-wrapper-xray/src/test/java/com/mercedesbenz/sechub/wrapper/xray/util/ZipFileExtractorTest.java @@ -1,8 +1,8 @@ // SPDX-License-Identifier: MIT package com.mercedesbenz.sechub.wrapper.xray.util; -import static com.mercedesbenz.sechub.test.TestFileReader.loadTextFile; -import static com.mercedesbenz.sechub.test.TestUtil.createTempDirectoryInBuildFolder; +import static com.mercedesbenz.sechub.test.TestFileReader.*; +import static com.mercedesbenz.sechub.test.TestUtil.*; import static org.junit.jupiter.api.Assertions.*; import java.io.File; @@ -57,10 +57,10 @@ void unzipFile_with_zip_files() throws IOException, XrayWrapperReportException { assertFileExists(expectedFile03); assertFileExists(expectedFileSomeFile); - assertEquals("testfile01", loadTextFile(expectedFile01)); - assertEquals("testfile02", loadTextFile(expectedFile02)); - assertEquals("testfile03", loadTextFile(expectedFile03)); - assertEquals("somefile", loadTextFile(expectedFileSomeFile)); + assertEquals("testfile01", readTextFromFile(expectedFile01)); + assertEquals("testfile02", readTextFromFile(expectedFile02)); + assertEquals("testfile03", readTextFromFile(expectedFile03)); + assertEquals("somefile", readTextFromFile(expectedFileSomeFile)); } private void assertFileExists(Path path) {