Replace uniVocity CSV library with jackson-csv #702

rkampani · rkampani · commit 4307c54aca4f · 2025-04-25T14:26:41.000-05:00
diff --git a/core/pom.xml b/core/pom.xml
@@ -63,12 +63,8 @@
             <artifactId>jackson-dataformat-yaml</artifactId>
         </dependency>
         <dependency>
-            <groupId>com.univocity</groupId>
-            <artifactId>univocity-parsers</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>com.google.code.gson</groupId>
-            <artifactId>gson</artifactId>
+            <groupId>com.fasterxml.jackson.dataformat</groupId>
+            <artifactId>jackson-dataformat-csv</artifactId>
         </dependency>
         <dependency>
             <groupId>org.apache.kafka</groupId>
diff --git a/core/src/main/java/org/jsmart/zerocode/core/db/DbCsvLoader.java b/core/src/main/java/org/jsmart/zerocode/core/db/DbCsvLoader.java
@@ -10,20 +10,21 @@
 
 import org.apache.commons.dbutils.QueryRunner;
 import org.apache.commons.lang3.StringUtils;
+import org.jsmart.zerocode.core.di.provider.CsvParserProvider;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.univocity.parsers.csv.CsvParser;
+
 
 /**
  * Data loading in the database from a CSV external source
  */
 class DbCsvLoader {
 	private static final Logger LOGGER = LoggerFactory.getLogger(DbCsvLoader.class);
 	private Connection conn;
-	private CsvParser csvParser;
+	private CsvParserProvider csvParser;
 
-	public DbCsvLoader(Connection conn, CsvParser csvParser) {
+	public DbCsvLoader(Connection conn, CsvParserProvider csvParser) {
 		this.conn = conn;
 		this.csvParser = csvParser;
 	}
diff --git a/core/src/main/java/org/jsmart/zerocode/core/db/DbSqlExecutor.java b/core/src/main/java/org/jsmart/zerocode/core/db/DbSqlExecutor.java
@@ -1,11 +1,13 @@
 package org.jsmart.zerocode.core.db;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.dataformat.csv.CsvParser;
 import com.google.inject.Inject;
 import com.google.inject.name.Named;
-import com.univocity.parsers.csv.CsvParser;
+
 
 import org.apache.commons.dbutils.DbUtils;
+import org.jsmart.zerocode.core.di.provider.CsvParserProvider;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import java.sql.Connection;
@@ -36,7 +38,7 @@ public class DbSqlExecutor {
 	@Named("db.driver.password") private String password;
 	
     @Inject
-    private CsvParser csvParser;
+    private CsvParserProvider csvParser;
 	
 	/**
 	 * The LOADCSV operation inserts the content of a CSV file into a table,
diff --git a/core/src/main/java/org/jsmart/zerocode/core/di/module/CsvParserModule.java b/core/src/main/java/org/jsmart/zerocode/core/di/module/CsvParserModule.java
@@ -2,15 +2,15 @@
 
 import com.google.inject.Binder;
 import com.google.inject.Module;
-import com.univocity.parsers.csv.CsvParser;
 import jakarta.inject.Singleton;
+import org.jsmart.zerocode.core.di.provider.CsvParserInterface;
 import org.jsmart.zerocode.core.di.provider.CsvParserProvider;
 
 public class CsvParserModule implements Module {
 
     @Override
     public void configure(Binder binder) {
-        binder.bind(CsvParser.class).toProvider(CsvParserProvider.class).in(Singleton.class);
+        binder.bind(CsvParserInterface.class).toProvider(CsvParserProvider.class).in(Singleton.class);
     }
 }
 
diff --git a/core/src/main/java/org/jsmart/zerocode/core/di/provider/CsvParserInterface.java b/core/src/main/java/org/jsmart/zerocode/core/di/provider/CsvParserInterface.java
@@ -0,0 +1,21 @@
+package org.jsmart.zerocode.core.di.provider;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.List;
+
+/**
+ * Defines a contract for parsing a single line of CSV data into a string array.
+ * Implementations should handle CSV lines with a specified format, such as
+ * comma-separated fields with optional quoting and escaping.
+ */
+public interface CsvParserInterface {
+    /**
+     * Parses a single line of CSV data into an array of fields.
+     *
+     * @param line the CSV line to parse, which may include quoted fields and escaped characters
+     * @return an array of strings representing the parsed fields; may be empty if the line is invalid
+     * @throws IOException if an error occurs during parsing, such as malformed CSV data
+     */
+    String[] parseLine(final String line) throws IOException;
+}
diff --git a/core/src/main/java/org/jsmart/zerocode/core/di/provider/CsvParserProvider.java b/core/src/main/java/org/jsmart/zerocode/core/di/provider/CsvParserProvider.java
@@ -1,27 +1,61 @@
 package org.jsmart.zerocode.core.di.provider;
 
-import com.univocity.parsers.csv.CsvParser;
-import com.univocity.parsers.csv.CsvParserSettings;
+
+import com.fasterxml.jackson.databind.ObjectReader;
+import com.fasterxml.jackson.dataformat.csv.CsvMapper;
+import com.fasterxml.jackson.dataformat.csv.CsvParser;
+import com.fasterxml.jackson.dataformat.csv.CsvSchema;
 import jakarta.inject.Provider;
+import org.apache.commons.lang3.StringUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
 
-public class CsvParserProvider implements Provider<CsvParser> {
+public class CsvParserProvider implements Provider<JacksonCsvParserAdapter> {
+    private static final Logger logger = LoggerFactory.getLogger(CsvParserProvider.class);
+    private static final JacksonCsvParserAdapter instance;
     public static final String LINE_SEPARATOR = "\n";
+    private static final String CARRIAGE_RETURN = "\r";
+
+    static {
+        final CsvSchema schema = createCsvSchema();
+        final ObjectReader mapper =  new CsvMapper()
+                .enable(CsvParser.Feature.TRIM_SPACES)
+                .readerFor(String[].class)
+                .with(schema);
+        instance = new JacksonCsvParserAdapter(mapper);
+    }
 
     @Override
-    public CsvParser get() {
-        CsvParserSettings settings = createCsvSettings();
-        return new CsvParser(settings);
+    public JacksonCsvParserAdapter get() {
+        return instance;
+    }
+
+    public String[] parseLine(final String line) {
+        try {
+            return instance.parseLine(sanitizeLine(line));
+        } catch (final IOException e) {
+            logger.warn("Failed to parse line: {}", line, e);
+            return new String[0];
+        }
+    }
+
+    private String sanitizeLine(final String line) {
+        if (StringUtils.isNotBlank(line) && !line.contains(CARRIAGE_RETURN)) {
+            return line;
+        }
+        return line.replace(CARRIAGE_RETURN, StringUtils.EMPTY);
     }
 
-    private CsvParserSettings createCsvSettings() {
-        CsvParserSettings settings = new CsvParserSettings();
-        settings.getFormat().setDelimiter(",");
-        settings.getFormat().setQuote('\'');
-        settings.getFormat().setQuoteEscape('\'');
-        settings.setEmptyValue("");
-        settings.getFormat().setLineSeparator("\n");
-        settings.setAutoConfigurationEnabled(false);
-        return settings;
+    private static CsvSchema createCsvSchema() {
+        return CsvSchema.builder()
+                .setColumnSeparator(',')
+                .setQuoteChar('\'')
+                .setEscapeChar('\'')
+                .setNullValue("")
+                .setLineSeparator(LINE_SEPARATOR)
+                .build();
     }
 
 }
diff --git a/core/src/main/java/org/jsmart/zerocode/core/di/provider/JacksonCsvParserAdapter.java b/core/src/main/java/org/jsmart/zerocode/core/di/provider/JacksonCsvParserAdapter.java
@@ -0,0 +1,18 @@
+package org.jsmart.zerocode.core.di.provider;
+
+import com.fasterxml.jackson.databind.ObjectReader;
+
+import java.io.IOException;
+import java.io.StringReader;
+
+public class JacksonCsvParserAdapter implements CsvParserInterface {
+
+    private final ObjectReader mapper;
+    public JacksonCsvParserAdapter(final ObjectReader mapper) {
+        this.mapper = mapper;
+    }
+    @Override
+    public String[] parseLine(final String line) throws IOException {
+        return mapper.readValue(new StringReader(line));
+    }
+}
diff --git a/core/src/main/java/org/jsmart/zerocode/core/engine/preprocessor/ZeroCodeParameterizedProcessorImpl.java b/core/src/main/java/org/jsmart/zerocode/core/engine/preprocessor/ZeroCodeParameterizedProcessorImpl.java
@@ -3,9 +3,9 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.google.inject.Inject;
 import com.google.inject.Singleton;
-import com.univocity.parsers.csv.CsvParser;
 import org.apache.commons.collections4.CollectionUtils;
 import org.apache.commons.text.StringSubstitutor;
+import org.jsmart.zerocode.core.di.provider.CsvParserProvider;
 import org.jsmart.zerocode.core.domain.ScenarioSpec;
 import org.jsmart.zerocode.core.utils.TokenUtils;
 import org.slf4j.Logger;
@@ -55,10 +55,10 @@ public class ZeroCodeParameterizedProcessorImpl implements ZeroCodeParameterized
 
     private final ObjectMapper objectMapper;
 
-    private final CsvParser csvParser;
+    private final CsvParserProvider csvParser;
 
     @Inject
-    public ZeroCodeParameterizedProcessorImpl(ObjectMapper objectMapper, CsvParser csvParser) {
+    public ZeroCodeParameterizedProcessorImpl(ObjectMapper objectMapper, CsvParserProvider csvParser) {
         this.objectMapper = objectMapper;
         this.csvParser = csvParser;
     }
diff --git a/core/src/main/java/org/jsmart/zerocode/core/runner/ZeroCodeMultiStepsScenarioRunnerImpl.java b/core/src/main/java/org/jsmart/zerocode/core/runner/ZeroCodeMultiStepsScenarioRunnerImpl.java
@@ -6,11 +6,12 @@
 import com.google.inject.Inject;
 import com.google.inject.Singleton;
 import com.google.inject.name.Named;
-import com.univocity.parsers.csv.CsvParser;
+
 import static java.util.Optional.ofNullable;
 import static org.apache.commons.collections4.CollectionUtils.isEmpty;
 import static org.jsmart.zerocode.core.constants.ZerocodeConstants.KAFKA_TOPIC;
 
+import org.jsmart.zerocode.core.di.provider.CsvParserProvider;
 import org.jsmart.zerocode.core.domain.Parameterized;
 import org.jsmart.zerocode.core.domain.ScenarioSpec;
 import org.jsmart.zerocode.core.domain.Step;
@@ -72,8 +73,7 @@ public class ZeroCodeMultiStepsScenarioRunnerImpl implements ZeroCodeMultiStepsS
     private ApiServiceExecutor apiExecutor;
 
     @Inject
-    private CsvParser csvParser;
-
+    private CsvParserProvider csvParser;
     @Inject
     private ApiTypeUtils apiTypeUtils;
 
diff --git a/core/src/test/java/org/jsmart/zerocode/core/db/DbCsvLoaderTest.java b/core/src/test/java/org/jsmart/zerocode/core/db/DbCsvLoaderTest.java
@@ -9,20 +9,21 @@
 import java.util.List;
 import java.util.Map;
 
+import org.jsmart.zerocode.core.di.provider.CsvParserProvider;
 import org.jukito.JukitoRunner;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 
 import com.google.inject.Inject;
-import com.univocity.parsers.csv.CsvParser;
+
 
 @RunWith(JukitoRunner.class)
 public class DbCsvLoaderTest extends DbTestBase{
 	
 	private DbCsvLoader loader;
 	
 	@Inject
-	CsvParser csvParser;
+	CsvParserProvider csvParser;
 	
 	@Override
 	public void setUp() throws SQLException {
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
@@ -2,8 +2,9 @@
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.google.inject.Inject;
-import com.univocity.parsers.csv.CsvParser;
+
 import org.jsmart.zerocode.core.di.main.ApplicationMainModule;
+import org.jsmart.zerocode.core.di.provider.CsvParserProvider;
 import org.jsmart.zerocode.core.utils.SmartUtils;
 import org.jukito.JukitoRunner;
 import org.jukito.TestModule;
@@ -34,7 +35,7 @@ protected void configureTest() {
     private ObjectMapper mapper;
 
     @Inject
-    private CsvParser csvParser;
+    private CsvParserProvider csvParser;
 
     @Test
     public void testSerDe_valueSource() throws Exception {
diff --git a/core/src/test/java/org/jsmart/zerocode/core/domain/StepTest.java b/core/src/test/java/org/jsmart/zerocode/core/domain/StepTest.java
@@ -4,14 +4,14 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.google.inject.Inject;
 import com.jayway.jsonpath.JsonPath;
-import com.univocity.parsers.csv.CsvParser;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.stream.Collectors;
 import org.jsmart.zerocode.core.di.main.ApplicationMainModule;
+import org.jsmart.zerocode.core.di.provider.CsvParserProvider;
 import org.jsmart.zerocode.core.engine.assertion.FieldAssertionMatcher;
 import org.jsmart.zerocode.core.utils.SmartUtils;
 import org.jukito.JukitoRunner;
@@ -50,7 +50,7 @@ protected void configureTest() {
     private ObjectMapper mapper;
 
     @Inject
-    private CsvParser csvParser;
+    private CsvParserProvider csvParser;
 
     @Test
     public void shouldDeserializeSingleStep() throws Exception {
@@ -108,6 +108,7 @@ public void testParameterized_values() throws Exception {
         assertThat(stepDeserialized.getParameterized().get(2), is(true));
     }
 
+
     @Test
     public void testParameterized_csv() throws Exception {
 
diff --git a/core/src/test/java/org/jsmart/zerocode/core/engine/preprocessor/ZeroCodeParameterizedProcessorImplTest.java b/core/src/test/java/org/jsmart/zerocode/core/engine/preprocessor/ZeroCodeParameterizedProcessorImplTest.java
@@ -2,9 +2,9 @@
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.univocity.parsers.csv.CsvParser;
 import jakarta.inject.Inject;
 import org.jsmart.zerocode.core.di.main.ApplicationMainModule;
+import org.jsmart.zerocode.core.di.provider.CsvParserProvider;
 import org.jsmart.zerocode.core.domain.ScenarioSpec;
 import org.jsmart.zerocode.core.domain.Step;
 import org.jsmart.zerocode.core.utils.SmartUtils;
@@ -40,7 +40,7 @@ protected void configureTest() {
     private ObjectMapper mapper;
 
     @Inject
-    private CsvParser csvParser;
+    private CsvParserProvider csvParser;
 
 
     private ZeroCodeParameterizedProcessorImpl parameterizedProcessor;
diff --git a/pom.xml b/pom.xml
@@ -93,7 +93,6 @@
         <extentreports.version>5.0.9</extentreports.version>
         <version.kafka-clients>3.7.0</version.kafka-clients>
         <version.gson>2.10.1</version.gson>
-        <version.univocity-parsers>2.8.2</version.univocity-parsers>
 
         <!-- Maven plugins, build properties  -->
         <maven-compiler-plugin.version>3.11.0</maven-compiler-plugin.version>
@@ -311,9 +310,9 @@
                 <version>${extentreports.version}</version> <!-- extent community version -->
             </dependency>
             <dependency>
-                <groupId>com.univocity</groupId>
-                <artifactId>univocity-parsers</artifactId>
-                <version>${version.univocity-parsers}</version>
+                <groupId>com.fasterxml.jackson.dataformat</groupId>
+                <artifactId>jackson-dataformat-csv</artifactId>
+                <version>${jackson.version}</version>
             </dependency>
             <!-- https://mvnrepository.com/artifact/com.google.protobuf/protobuf-java -->
 			<dependency>

Original file line number	Diff line number	Diff line change
`@@ -2,15 +2,15 @@`
`2`	`2`
`3`	`3`	`import com.google.inject.Binder;`
`4`	`4`	`import com.google.inject.Module;`
`5`		`-import com.univocity.parsers.csv.CsvParser;`
`6`	`5`	`import jakarta.inject.Singleton;`
	`6`	`+import org.jsmart.zerocode.core.di.provider.CsvParserInterface;`
`7`	`7`	`import org.jsmart.zerocode.core.di.provider.CsvParserProvider;`
`8`	`8`
`9`	`9`	`public class CsvParserModule implements Module {`
`10`	`10`
`11`	`11`	`@Override`
`12`	`12`	`public void configure(Binder binder) {`
`13`		`- binder.bind(CsvParser.class).toProvider(CsvParserProvider.class).in(Singleton.class);`
	`13`	`+ binder.bind(CsvParserInterface.class).toProvider(CsvParserProvider.class).in(Singleton.class);`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`