Merge pull request #476 from authorjapps/409-csvsource-from-file

ISSUE-409 # Added support for csv file in the `parameterized` `csvSource`
authorjapps · Jan 27, 2024 · 0c0d93e · 0c0d93e
2 parents eaf1487 + dcad5cc
commit 0c0d93e
Show file tree

Hide file tree

Showing 14 changed files with 200 additions and 31 deletions.
diff --git a/core/src/main/java/org/jsmart/zerocode/core/domain/Parameterized.java b/core/src/main/java/org/jsmart/zerocode/core/domain/Parameterized.java
@@ -1,17 +1,33 @@
 package org.jsmart.zerocode.core.domain;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.ObjectReader;
+import org.apache.commons.lang.StringUtils;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.Collections;
 import java.util.List;
+import java.util.Optional;
+import java.util.stream.Collectors;
 
 public class Parameterized {
     private final List<Object> valueSource;
     private final List<String> csvSource;
+    private final Boolean ignoreHeader;
 
     public Parameterized(
             @JsonProperty("valueSource") List<Object> valueSource,
-            @JsonProperty("csvSource") List<String> csvSource) {
+            @JsonProperty("csvSource") JsonNode csvSourceJsonNode,
+            @JsonProperty("ignoreHeader") Boolean ignoreHeader) {
         this.valueSource = valueSource;
-        this.csvSource = csvSource;
+        this.ignoreHeader = Optional.ofNullable(ignoreHeader).orElse(false);
+        this.csvSource = getCsvSourceFrom(csvSourceJsonNode);
     }
 
     public List<Object> getValueSource() {
@@ -22,6 +38,43 @@ public List<String> getCsvSource() {
         return csvSource;
     }
 
+    private List<String> getCsvSourceFrom(JsonNode csvSourceJsonNode) {
+        try {
+            if (csvSourceJsonNode.isArray()) {
+                return readCsvSourceFromJson(csvSourceJsonNode);
+
+            } else {
+                return readCsvSourceFromExternalCsvFile(csvSourceJsonNode);
+            }
+        } catch (IOException e) {
+            throw new RuntimeException("Error deserializing csvSource", e);
+        }
+    }
+
+    private List<String> readCsvSourceFromJson(JsonNode csvSourceJsonNode) throws IOException {
+        ObjectMapper mapper = new ObjectMapper();
+        ObjectReader reader = mapper.readerFor(new TypeReference<List<String>>() {
+        });
+        return reader.readValue(csvSourceJsonNode);
+    }
+
+    private List<String> readCsvSourceFromExternalCsvFile(JsonNode csvSourceJsonNode) throws IOException {
+        String csvSourceFilePath = csvSourceJsonNode.textValue();
+        if (StringUtils.isNotBlank(csvSourceFilePath)) {
+            Path path = Paths.get("./src/test/resources/",csvSourceFilePath);
+            List<String> csvSourceFileLines = Files.lines(path)
+                    .filter(StringUtils::isNotBlank)
+                    .collect(Collectors.toList());
+            if (this.ignoreHeader) {
+                return csvSourceFileLines.stream()
+                        .skip(1)
+                        .collect(Collectors.toList());
+            }
+            return csvSourceFileLines;
+        }
+        return Collections.emptyList();
+    }
+
     @Override
     public String toString() {
         return "Parameterized{" +

diff --git a/...java/org/jsmart/zerocode/core/engine/preprocessor/ZeroCodeParameterizedProcessorImpl.java b/...java/org/jsmart/zerocode/core/engine/preprocessor/ZeroCodeParameterizedProcessorImpl.java
@@ -4,17 +4,19 @@
 import com.google.inject.Inject;
 import com.google.inject.Singleton;
 import com.univocity.parsers.csv.CsvParser;
+import org.apache.commons.collections.CollectionUtils;
+import org.apache.commons.lang.text.StrSubstitutor;
+import org.jsmart.zerocode.core.domain.ScenarioSpec;
+import org.slf4j.Logger;
+
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.atomic.AtomicLong;
-import org.apache.commons.lang.text.StrSubstitutor;
-import org.jsmart.zerocode.core.domain.ScenarioSpec;
-import org.slf4j.Logger;
 
-import static org.jsmart.zerocode.core.di.provider.CsvParserProvider.LINE_SEPARATOR;
 import static org.jsmart.zerocode.core.constants.ZerocodeConstants.DSL_FORMAT;
+import static org.jsmart.zerocode.core.di.provider.CsvParserProvider.LINE_SEPARATOR;
 import static org.slf4j.LoggerFactory.getLogger;
 
 /**
@@ -25,17 +27,17 @@
  * <p>
  * Parameters can be
  * "parameterized": [
- *      200,
- *      "Hello",
- *      true
+ * 200,
+ * "Hello",
+ * true
  * ]
  * <p>
  * -or-
  * <p>
  * "parameterizedCsv": [
- *      "1,    2,   200",
- *      "11,  22, 400",
- *      "21,  31, 500"
+ * "1,    2,   200",
+ * "11,  22, 400",
+ * "21,  31, 500"
  * ]
  * <p>
  * In each the above cases, the step will execute 3 times.
@@ -64,15 +66,15 @@ public ZeroCodeParameterizedProcessorImpl(ObjectMapper objectMapper, CsvParser c
     @Override
     public ScenarioSpec resolveParameterized(ScenarioSpec scenario, int iteration) {
 
-        if(scenario.getParameterized() == null){
+        if (scenario.getParameterized() == null) {
 
             return scenario;
 
         } else if (scenario.getParameterized().getValueSource() != null) {
 
             return resolveParamsValues(scenario, iteration);
 
-        } else if (scenario.getParameterized().getCsvSource() != null) {
+        } else if (CollectionUtils.isNotEmpty(scenario.getParameterized().getCsvSource())) {
 
             return resolveParamsCsv(scenario, iteration);
 

diff --git a/core/src/test/java/org/jsmart/zerocode/core/domain/ParameterizedTest.java b/core/src/test/java/org/jsmart/zerocode/core/domain/ParameterizedTest.java
@@ -10,7 +10,9 @@
 import org.junit.Test;
 import org.junit.runner.RunWith;
 
-import static org.hamcrest.CoreMatchers.hasItem;
+import java.io.IOException;
+
+import static org.hamcrest.CoreMatchers.*;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.core.Is.is;
 
@@ -58,4 +60,33 @@ public void testSerDe_csvSource() throws Exception {
         assertThat(parameterized.getCsvSource(), hasItem("11,      22,        400"));
     }
 
+    @Test
+    public void shouldReadCsvSourceFromCsvFile() throws IOException {
+        //given
+        String jsonDocumentAsString =
+                smartUtils.getJsonDocumentAsString("unit_test_files/engine_unit_test_jsons/08.1_parameterized_csv_source_from_file.json");
+
+        //when
+        Parameterized parameterized = mapper.readValue(jsonDocumentAsString, Parameterized.class);
+
+        //then
+        assertThat(parameterized.getCsvSource(), hasItem("octocat,The Octocat,San Francisco,583231"));
+        assertThat(parameterized.getCsvSource(), hasItem("siddhagalaxy,Sidd,UK,33847730"));
+    }
+
+    @Test
+    public void shouldReadCsvSourceFromCsvFileIgnoringHeader() throws IOException {
+        //given
+        String jsonDocumentAsString =
+                smartUtils.getJsonDocumentAsString("unit_test_files/engine_unit_test_jsons/08.2_parameterized_csv_source_from_file_containing_header.json");
+
+        //when
+        Parameterized parameterized = mapper.readValue(jsonDocumentAsString, Parameterized.class);
+
+        //then
+        assertThat(parameterized.getCsvSource(), hasItem("octocat,The Octocat,San Francisco,583231"));
+        assertThat(parameterized.getCsvSource(), hasItem("siddhagalaxy,Sidd,UK,33847730"));
+        assertThat(parameterized.getCsvSource(), everyItem(not(is("user,name,city,userid"))));//assert header is ignored
+    }
+
 }
diff --git a/core/src/test/java/org/jsmart/zerocode/core/utils/SmartUtilsTest.java b/core/src/test/java/org/jsmart/zerocode/core/utils/SmartUtilsTest.java
@@ -74,14 +74,14 @@ public void willGetJsonFileIntoA_JavaString() throws Exception {
     }
 
     @Test
-    public void willReadAllfileNamesFrom_TestResource() throws Exception {
+    public void willReadAllfileNamesFrom_TestResource() {
         List<String> allTestCaseFiles = SmartUtils.getAllEndPointFiles("unit_test_files/engine_unit_test_jsons");
-        assertThat(allTestCaseFiles.size(), is(20));
+        assertThat(allTestCaseFiles.size(), is(22));
         assertThat(allTestCaseFiles.get(0), is("unit_test_files/engine_unit_test_jsons/00_test_json_single_step_verifications.json"));
     }
 
     @Test
-    public void willReadAllfileNames_AND_return_FlowSpecList() throws Exception {
+    public void willReadAllfileNames_AND_return_FlowSpecList() {
         List<ScenarioSpec> allTestCaseFiles = smartUtils.getScenarioSpecListByPackage("unit_test_files/test_scenario_cases");
 
         assertThat(allTestCaseFiles.size(), is(3));
@@ -91,19 +91,19 @@ public void willReadAllfileNames_AND_return_FlowSpecList() throws Exception {
 
 
     @Test(expected = RuntimeException.class)
-    public void willReadAllfiles_find_DuplicatesScenarioNamenames_old_style() throws Exception {
+    public void willReadAllfiles_find_DuplicatesScenarioNamenames_old_style() {
         smartUtils.checkDuplicateScenarios("unit_test_files/test_scenario_cases");
     }
 
     @Test
-    public void willReadAllfiles_find_DuplicateScenarioNames() throws Exception {
+    public void willReadAllfiles_find_DuplicateScenarioNames() {
         expectedException.expect(RuntimeException.class);
         expectedException.expectMessage("Oops! Can not run with multiple Scenarios with same name.");
         smartUtils.checkDuplicateScenarios("unit_test_files/test_scenario_cases");
     }
 
     @Test
-    public void willEvaluatePlaceHolder() throws Exception {
+    public void willEvaluatePlaceHolder() {
 
         String aString = "Hello_${WORLD}";
         List<String> placeHolders = getTestCaseTokens(aString);
@@ -118,7 +118,7 @@ public void willEvaluatePlaceHolder() throws Exception {
     }
 
     @Test
-    public void testNullOrEmptyString_withPlaceHolders() throws Exception {
+    public void testNullOrEmptyString_withPlaceHolders() {
 
         String aString = "";
         List<String> placeHolders = getTestCaseTokens(aString);
@@ -130,7 +130,7 @@ public void testNullOrEmptyString_withPlaceHolders() throws Exception {
     }
 
     @Test
-    public void testReplaceTokensOrPlaceHolders() throws Exception {
+    public void testReplaceTokensOrPlaceHolders() {
         String aString = "_${ENV_PROPERTY_NAME}";
 
         Map<String, String> paramMap = new HashMap<>();
@@ -142,7 +142,7 @@ public void testReplaceTokensOrPlaceHolders() throws Exception {
     }
 
     @Test
-    public void testEnvValue() throws Exception {
+    public void testEnvValue() {
 
         final String javaHomeValue = SmartUtils.getEnvPropertyValue("JAVA_HOME");
         assertThat(javaHomeValue, notNullValue());
@@ -228,7 +228,7 @@ public void testScenarioFile_absolutePath() throws Exception {
 
     @Ignore("Tested in local laptop. Ignored for Ci build. Follow testSuiteFolder_absolutePath() like flow ")
     @Test
-    public void testSuiteFolder_symAbsolutePath() throws Exception {
+    public void testSuiteFolder_symAbsolutePath() {
         String absPath = "~/dev/ZEROCODE_REPOS/zerocode/core/src/test/resources/unit_test_files/cherry_pick_tests";
         List<String> allScenarios = SmartUtils.retrieveScenariosByAbsPath(absPath);
         assertThat(allScenarios.size(), is(2));
@@ -242,9 +242,7 @@ private static File createCascadeIfNotExisting(String fileName) {
             Path path = Paths.get(fileName);
             Files.createDirectories(path.getParent());
 
-            File file = new File(fileName);
-
-            return file;
+            return new File(fileName);
         } catch (IOException exx) {
             throw new RuntimeException("Create file '" + fileName + "' Exception" + exx);
         }

diff --git a/...urces/unit_test_files/engine_unit_test_jsons/08.1_parameterized_csv_source_from_file.json b/...urces/unit_test_files/engine_unit_test_jsons/08.1_parameterized_csv_source_from_file.json
@@ -0,0 +1,8 @@
+{
+    "valueSource": [
+        "hello",
+        123,
+        true
+    ],
+    "csvSource": "unit_test_files/engine_unit_test_jsons/params.csv"
+}
diff --git a/...les/engine_unit_test_jsons/08.2_parameterized_csv_source_from_file_containing_header.json b/...les/engine_unit_test_jsons/08.2_parameterized_csv_source_from_file_containing_header.json
@@ -0,0 +1,9 @@
+{
+    "valueSource": [
+        "hello",
+        123,
+        true
+    ],
+    "ignoreHeader": true,
+    "csvSource": "unit_test_files/engine_unit_test_jsons/params_with_header.csv"
+}
diff --git a/core/src/test/resources/unit_test_files/engine_unit_test_jsons/params.csv b/core/src/test/resources/unit_test_files/engine_unit_test_jsons/params.csv
@@ -0,0 +1,2 @@
+octocat,The Octocat,San Francisco,583231
+siddhagalaxy,Sidd,UK,33847730
diff --git a/core/src/test/resources/unit_test_files/engine_unit_test_jsons/params_with_header.csv b/core/src/test/resources/unit_test_files/engine_unit_test_jsons/params_with_header.csv
@@ -0,0 +1,3 @@
+user,name,city,userid
+octocat,The Octocat,San Francisco,583231
+siddhagalaxy,Sidd,UK,33847730
diff --git a/...ng/src/main/java/org/jsmart/zerocode/zerocodejavaexec/httpclient/JustHelloWorldSuite.java b/...ng/src/main/java/org/jsmart/zerocode/zerocodejavaexec/httpclient/JustHelloWorldSuite.java
@@ -1,11 +1,8 @@
 package org.jsmart.zerocode.zerocodejavaexec.httpclient;
 
-import org.jsmart.zerocode.core.domain.Scenario;
 import org.jsmart.zerocode.core.domain.TargetEnv;
 import org.jsmart.zerocode.core.domain.TestPackageRoot;
 import org.jsmart.zerocode.core.runner.ZeroCodePackageRunner;
-import org.jsmart.zerocode.core.runner.ZeroCodeUnitRunner;
-import org.junit.Test;
 import org.junit.runner.RunWith;
 
 @TargetEnv("hello_github_host.properties")

diff --git a/...rt/zerocode/testhelp/tests/helloworldparameterizedcsv/HelloWorldParameterizedCsvTest.java b/...rt/zerocode/testhelp/tests/helloworldparameterizedcsv/HelloWorldParameterizedCsvTest.java
@@ -15,4 +15,14 @@ public class HelloWorldParameterizedCsvTest {
     public void testGetByUserNames_csv() throws Exception {
     }
 
+    @Test
+    @Scenario("parameterized_csv/hello_world_test_parameterized_csv_source_files.json")
+    public void testGetByUserNames_csvSourceFiles() throws Exception {
+    }
+
+    @Test
+    @Scenario("parameterized_csv/hello_world_test_parameterized_csv_source_file_ignore_header.json")
+    public void testGetByUserNames_csvSourceFiles_ignoringHeader() throws Exception {
+    }
+
 }
diff --git a/...urces/parameterized_csv/hello_world_test_parameterized_csv_source_file_ignore_header.json b/...urces/parameterized_csv/hello_world_test_parameterized_csv_source_file_ignore_header.json
@@ -0,0 +1,26 @@
+{
+    "scenarioName": "Fetch and assert GitHub userIds by their userNames",
+    "steps": [
+        {
+            "name": "get_user_details",
+            "url": "/users/${0}",
+            "method": "GET",
+            "request": {
+            },
+            "assertions": {
+                "status": 200,
+                "body": {
+                    "login" : "${0}",
+                    "type" : "User",
+                    "name" : "${1}",
+                    "location" : "${2}",
+                    "id" : "$EQ.${3}"
+                }
+            }
+        }
+    ],
+    "parameterized": {
+        "ignoreHeader": true,
+        "csvSource":"parameterized_csv/params_with_header.csv"
+    }
+}
diff --git a/...src/test/resources/parameterized_csv/hello_world_test_parameterized_csv_source_files.json b/...src/test/resources/parameterized_csv/hello_world_test_parameterized_csv_source_files.json
@@ -0,0 +1,25 @@
+{
+    "scenarioName": "Fetch and assert GitHub userIds by their userNames",
+    "steps": [
+        {
+            "name": "get_user_details",
+            "url": "/users/${0}",
+            "method": "GET",
+            "request": {
+            },
+            "assertions": {
+                "status": 200,
+                "body": {
+                    "login" : "${0}",
+                    "type" : "User",
+                    "name" : "${1}",
+                    "location" : "${2}",
+                    "id" : "$EQ.${3}"
+                }
+            }
+        }
+    ],
+    "parameterized": {
+        "csvSource":"parameterized_csv/params.csv"
+    }
+}
diff --git a/http-testing/src/test/resources/parameterized_csv/params.csv b/http-testing/src/test/resources/parameterized_csv/params.csv
@@ -0,0 +1,2 @@
+octocat,The Octocat,San Francisco,583231
+siddhagalaxy,Sidd,UK,33847730
diff --git a/http-testing/src/test/resources/parameterized_csv/params_with_header.csv b/http-testing/src/test/resources/parameterized_csv/params_with_header.csv
@@ -0,0 +1,3 @@
+user,name,city,userid
+octocat,The Octocat,San Francisco,583231
+siddhagalaxy,Sidd,UK,33847730
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		octocat,The Octocat,San Francisco,583231
		siddhagalaxy,Sidd,UK,33847730