Add json output

.github/workflows/build.yml

@@ -24,4 +24,5 @@ jobs:
     - name: Generate all formats all options
       run: |
         target/release/fakelake generate tests/csv_all_options.yaml
+        target/release/fakelake generate tests/json_all_options.yaml
         target/release/fakelake generate tests/parquet_all_options.yaml

.gitignore

@@ -4,9 +4,9 @@
 
 # Generated
 /target
-*.parquet
-*.csv
 /site
+output.csv
+output.json
 
 # Coverage
 *.profraw

Cargo.toml

@@ -19,6 +19,7 @@ log = "0.4"
 once_cell = "1.8"
 parquet = "50.0.0"
 rayon = "1.8.0"
+serde_json = "1.0.114"
 yaml-rust = "0.4"
 
 [dev-dependencies]

docs/output/parameters.md

@@ -24,6 +24,16 @@ info:
 ```
 Default delimiter is ',' but you can specify any character.
 
+##### JSON
+```yaml
+info:
+ output_format: json
+ wrap_up: false
+```
+By default, wrap_up is set to false.  
+When wrap_up is set to false, each line into the result file is a json object but the whole file is not a valid json.  
+When wrap_up is set to true, the whole file is a valid json, rows are wrapped up into an array.
+
 ### Rows
 To choose the number of rows in the generated file, use rows.
 ```yaml

src/config.rs

@@ -126,6 +126,7 @@ impl Column {
 pub enum OutputType {
     Parquet(),
     Csv(u8),
+    Json(bool),
 }
 
 #[derive(Debug)]
@@ -173,6 +174,17 @@ impl Info {
                 };
                 Some(OutputType::Csv(delimiter))
             }
+            Some(value) if value == "json" => {
+                let wrap_up = match section_info["wrap_up"] {
+                    Yaml::Boolean(value) => value,
+                    Yaml::BadValue => false,
+                    _ => {
+                        warn!("Wrap up should be a bool. Default value 'false' is taken.");
+                        false
+                    }
+                };
+                Some(OutputType::Json(wrap_up))
+            }
             _ => None,
         };
 
@@ -507,6 +519,50 @@ mod tests {
         assert_eq!(info.rows, None);
     }
 
+    #[test]
+    fn given_json_format_should_use_default_wrap_up() {
+        let yaml = "
+        info:
+            output_format: json
+        ";
+        let info = generate_info_from_yaml(yaml);
+        expecting_ok(&info);
+        let info = &info.unwrap();
+        assert_eq!(info.output_name, None);
+        assert_eq!(info.output_format, Some(OutputType::Json(false)));
+        assert_eq!(info.rows, None);
+    }
+
+    #[test]
+    fn given_json_format_with_custom_wrap_up_should_use_custom_wrap_up() {
+        let yaml = "
+        info:
+            output_format: json
+            wrap_up: true
+        ";
+        let info = generate_info_from_yaml(yaml);
+        expecting_ok(&info);
+        let info = &info.unwrap();
+        assert_eq!(info.output_name, None);
+        assert_eq!(info.output_format, Some(OutputType::Json(true)));
+        assert_eq!(info.rows, None);
+    }
+
+    #[test]
+    fn given_json_format_with_invalid_wrap_up_should_default_wrap_up() {
+        let yaml = "
+        info:
+            output_format: json
+            wrap_up: invalid
+        ";
+        let info = generate_info_from_yaml(yaml);
+        expecting_ok(&info);
+        let info = &info.unwrap();
+        assert_eq!(info.output_name, None);
+        assert_eq!(info.output_format, Some(OutputType::Json(false)));
+        assert_eq!(info.rows, None);
+    }
+
     #[test]
     fn given_rows_int_should_config_return_in_rows() {
         let yaml = "

src/errors.rs

@@ -6,6 +6,7 @@ pub enum FakeLakeError {
     BadYAMLFormat(String),
     IOError(io::Error),
     CSVError(csv::Error),
+    JSONError(serde_json::Error),
 }
 
 #[cfg(not(tarpaulin_include))]

src/generate/csv/mod.rs

@@ -143,7 +143,7 @@ mod tests {
 
     #[test]
     fn given_config_should_write_file() {
-        let config = get_config(1, Some("output_name".to_string()), Some(1000));
+        let config = get_config(1, Some("target/output_name".to_string()), Some(1000));
         let output = OutputCsv { delimiter: 5 };
         match output.generate_from_config(&config) {
             Ok(_) => (),
@@ -212,7 +212,7 @@ mod tests {
         let config = Config {
             columns,
             info: Some(Info {
-                output_name: Some("output_name".to_string()),
+                output_name: Some("target/output_name".to_string()),
                 output_format: Some(OutputType::Csv(5)),
                 rows: Some(1000),
             }),