add a test for --generate-path= (#115)

* wip: adding generate_path tests

* tests: fixing

* chore: fixed compilation

* fix: generate path lifetime

* chore: adding generate path test

* chore: change test name

* fix

src/common/config.rs

@@ -327,10 +327,7 @@ impl Config {
     pub fn get_log_level(file_config_path: &PathBuf) -> LogLevel {
         let file_based_config = fs::read_to_string(file_config_path);
         let file_based_config = &file_based_config.map(|f| serde_json::from_str::<SqlxConfig>(f.as_str()).unwrap());
-        let log_level_from_file = file_based_config
-            .as_ref()
-            .ok()
-            .and_then(|config| config.log_level);
+        let log_level_from_file = file_based_config.as_ref().ok().and_then(|config| config.log_level);
 
         CLI_ARGS.log_level.or(log_level_from_file).unwrap_or(LogLevel::Info)
     }

src/common/logger.rs

@@ -74,4 +74,3 @@ macro_rules! error {
         }
     });
 }
-

src/main.rs

@@ -44,8 +44,8 @@ async fn main() -> Result<()> {
     let ext = &CLI_ARGS.ext;
 
     info!("Scanning {:?} for SQLs with extension {:?}", source_folder, ext);
-    
-    // If CLI_ARGS.generate_types is true, it will clear the single TS file so `execute` will generate a new one from scratch    
+
+    // If CLI_ARGS.generate_types is true, it will clear the single TS file so `execute` will generate a new one from scratch
     clear_single_ts_file_if_exists()?;
 
     let files = scan_folder(source_folder, ext);

src/parser/tag.rs

@@ -1,8 +1,6 @@
 use crate::common::SQL;
 use swc_common::MultiSpan;
-use swc_ecma_ast::{
-    BlockStmt, ClassMember, Expr, OptChainBase, Pat, Prop, PropOrSpread, SuperProp, VarDeclarator,
-};
+use swc_ecma_ast::{BlockStmt, ClassMember, Expr, OptChainBase, Pat, Prop, PropOrSpread, SuperProp, VarDeclarator};
 
 use super::{get_var_decl_name_from_key, recurse_and_find_sql};
 

src/ts_generator/generator.rs

@@ -83,7 +83,6 @@ pub fn write_single_ts_file(sqls_to_write: String) -> Result<()> {
     let mut file_to_write = OpenOptions::new()
         .create(true)
         .read(true)
-
         .append(true)
         .open(&output)?;
 

test-utils/src/sandbox.rs

@@ -1,3 +1,5 @@
+use std::path::PathBuf;
+
 use serde;
 use serde::{Deserialize, Serialize};
 
@@ -21,12 +23,14 @@ pub struct TestConfig {
     pub db_user: String,
     pub db_pass: Option<String>,
     pub db_name: String,
+    pub generate_path: Option<PathBuf>,
     pub generate_types: bool,
     pub config_file_name: Option<String>,
 }
 
 impl TestConfig {
-    pub fn new(db_type: &str, generate_types: bool, config_file_name: Option<String>) -> Self {
+    pub fn new(db_type: &str, generate_types: bool, generate_path: Option<PathBuf>, config_file_name: Option<String>) -> Self {
+        let generate_path = generate_path.clone();
         if db_type == "mysql" {
             return TestConfig {
                 db_type: "mysql".into(),
@@ -36,6 +40,7 @@ impl TestConfig {
                 db_user: "root".to_string(),
                 db_pass: None,
                 db_name: "sqlx-ts".to_string(),
+                generate_path,
                 generate_types,
                 config_file_name,
             }
@@ -48,6 +53,7 @@ impl TestConfig {
             db_user: "postgres".to_string(),
             db_pass: Some("postgres".to_string()),
             db_name: "postgres".to_string(),
+            generate_path,
             generate_types,
             config_file_name,
         }
@@ -107,6 +113,7 @@ $(
       let db_pass = test_config.db_pass;
       let db_name = test_config.db_name;
       let config_file_name = test_config.config_file_name;
+      let generate_path = test_config.generate_path;
 
       // SETUP
       let dir = tempdir()?;
@@ -128,7 +135,15 @@ $(
           .arg(format!("--db-user={db_user}"))
           .arg(format!("--db-name={db_name}"));
 
-      println!("checking generate types {:?}", test_config.generate_types);
+      if &generate_path.is_some() == &true {
+        let generate_path = generate_path.clone();
+        let generate_path = generate_path.unwrap();
+        let generate_path = generate_path.as_path();
+        let generate_path = parent_path.join(generate_path);
+        let generate_path = generate_path.display();
+        cmd.arg(format!("--generate-path={generate_path}"));
+      }
+
       if (test_config.generate_types) {
         cmd.arg("-g");
       }
@@ -152,6 +167,18 @@ $(
 
       let generated_types: &str = $generated_types.clone();
 
+      if generate_path.is_some() {
+        let generate_path = parent_path.join(generate_path.unwrap().as_path());
+        let type_file = fs::read_to_string(generate_path);
+        let type_file = type_file.unwrap();
+
+        assert_eq!(
+            generated_types.trim().to_string().flatten(),
+            type_file.trim().to_string().flatten()
+        );
+        return Ok(());
+      }
+
       let type_file = fs::read_to_string(parent_path.join("index.queries.ts"));
       if type_file.is_ok() {
         let type_file = type_file.unwrap().clone();

tests/covert_to_camelcase.rs

@@ -1,7 +1,7 @@
 /// Test suites for converting any case to camelCase if generateTypes.convertToCamelCase is true
 ///
 #[cfg(test)]
-mod string_functions_tests {
+mod convert_camelcase_tests {
     use assert_cmd::prelude::*;
     use predicates::prelude::*;
     use std::env;
@@ -15,7 +15,7 @@ mod string_functions_tests {
     use test_utils::{run_test, sandbox::TestConfig};
 
     #[rustfmt::skip]
-run_test!(retain_original, TestConfig::new("postgres", true, Some(".sqlxrc.camelcase1.json".to_string())),
+run_test!(retain_original, TestConfig::new("postgres", true, None, Some(".sqlxrc.camelcase1.json".to_string())),
 //// TS query ////
 r#"
 const someQuery = sql`
@@ -45,7 +45,7 @@ export interface ISomeQueryQuery {
 );
 
     #[rustfmt::skip]
-run_test!(convert_camelcase, TestConfig::new("postgres", true, Some(".sqlxrc.camelcase2.json".to_string())),
+run_test!(convert_camelcase, TestConfig::new("postgres", true, None, Some(".sqlxrc.camelcase2.json".to_string())),
 
 //// TS query ////
 r#"
@@ -76,7 +76,7 @@ export interface ISomeQueryQuery {
 );
 
     #[rustfmt::skip]
-run_test!(retain_original_on_missing_config, TestConfig::new("postgres", true, Some(".sqlxrc.camelcase3.json".to_string())),
+run_test!(retain_original_on_missing_config, TestConfig::new("postgres", true, None, Some(".sqlxrc.camelcase3.json".to_string())),
 
 //// TS query ////
 r#"

tests/generate_path.rs

@@ -0,0 +1,48 @@
+/// Test suites for converting any case to camelCase if generateTypes.convertToCamelCase is true
+///
+#[cfg(test)]
+mod generate_path_tests {
+    use assert_cmd::prelude::*;
+    use predicates::prelude::*;
+    use std::env;
+    use std::fs;
+    use std::io::Write;
+    use std::process::Command;
+    use std::path::PathBuf;
+    use tempfile::tempdir;
+
+    use pretty_assertions::assert_eq;
+    use test_utils::test_utils::TSString;
+    use test_utils::{run_test, sandbox::TestConfig};
+
+    #[rustfmt::skip]
+run_test!(should_generate_path, TestConfig::new("postgres", true, Some(PathBuf::from("types/types.ts")), Some(".sqlxrc.camelcase1.json".to_string())),
+//// TS query ////
+r#"
+const someQuery = sql`
+SELECT
+    food_type,
+    id AS HelloWorld,
+    id AS hello_world
+FROM items;
+`
+"#,
+
+//// Generated TS interfaces ////
+r#"
+export type SomeQueryParams = [];
+
+export interface ISomeQueryResult {
+    HelloWorld: number;
+    food_type: string;
+    hello_world: number;
+};
+
+export interface ISomeQueryQuery {
+    params: SomeQueryParams;
+    result: ISomeQueryResult;
+};
+"#
+);
+
+}

tests/mysql_delete_query_parameters.rs

@@ -13,7 +13,7 @@ mod mysql_delete_query_parameters {
     use test_utils::{run_test, sandbox::TestConfig};
 
     #[rustfmt::skip]
-run_test!(should_pick_query_params_from_binary_ops, TestConfig::new("mysql", true, None),
+run_test!(should_pick_query_params_from_binary_ops, TestConfig::new("mysql", true, None, None),
 
 //// TS query ////
 r#"
@@ -40,7 +40,7 @@ export interface ISomeDeleteQueryQuery {
 "#);
 
     #[rustfmt::skip]
-run_test!(should_pick_query_params_from_subquery, TestConfig::new("mysql", true, None),
+run_test!(should_pick_query_params_from_subquery, TestConfig::new("mysql", true, None, None),
 
 //// TS query ////
 r#"

tests/mysql_insert_query_parameters.rs

@@ -13,7 +13,7 @@ mod mysql_insert_query_parameters {
     use test_utils::{run_test, sandbox::TestConfig};
 
     #[rustfmt::skip]
-run_test!(should_pick_query_params_from_single_row_of_values, TestConfig::new("mysql", true, None),
+run_test!(should_pick_query_params_from_single_row_of_values, TestConfig::new("mysql", true, None, None),
 
 //// TS query ////
 r#"
@@ -39,7 +39,7 @@ export interface ISomeInputQueryQuery {
 "#);
 
     #[rustfmt::skip]
-run_test!(should_pick_query_params_from_multiple_rows_of_values, TestConfig::new("mysql", true, None),
+run_test!(should_pick_query_params_from_multiple_rows_of_values, TestConfig::new("mysql", true, None, None),
 
 //// TS query ////
 r#"

tests/mysql_query_parameters.rs

@@ -13,7 +13,7 @@ mod mysql_query_parameters_tests {
     use test_utils::{run_test, sandbox::TestConfig};
 
     #[rustfmt::skip]
-run_test!(should_pick_query_params_from_flat_list_of_binary_ops, TestConfig::new("mysql", true, None),
+run_test!(should_pick_query_params_from_flat_list_of_binary_ops, TestConfig::new("mysql", true, None, None),
 
 //// TS query ////
 r#"
@@ -45,7 +45,7 @@ export interface ISomeQueryQuery {
 "#);
 
     #[rustfmt::skip]
-run_test!(should_pick_query_params_from_in_list, TestConfig::new("mysql", true, None),
+run_test!(should_pick_query_params_from_in_list, TestConfig::new("mysql", true, None, None),
 
 //// TS query ////
 r#"
@@ -75,7 +75,7 @@ export interface ISomeQueryQuery {
 "#);
 
     #[rustfmt::skip]
-run_test!(should_pick_query_params_from_in_subqueries, TestConfig::new("mysql", true, None),
+run_test!(should_pick_query_params_from_in_subqueries, TestConfig::new("mysql", true,  None, None),
 
 //// TS query ////
 r#"
@@ -114,7 +114,7 @@ export interface ISomeQueryQuery {
 "#);
 
     #[rustfmt::skip]
-run_test!(should_pick_query_params_from_subqueries, TestConfig::new("mysql", true, None),
+run_test!(should_pick_query_params_from_subqueries, TestConfig::new("mysql", true, None, None),
 
 //// TS query ////
 r#"

tests/mysql_update_query_parameters.rs

@@ -13,7 +13,7 @@ mod mysql_update_query_parameters {
     use test_utils::{run_test, sandbox::TestConfig};
 
     #[rustfmt::skip]
-run_test!(should_pick_query_params_from_single_row_of_values, TestConfig::new("mysql", true, None),
+run_test!(should_pick_query_params_from_single_row_of_values, TestConfig::new("mysql", true, None, None),
 
 //// TS query ////
 r#"
@@ -40,7 +40,7 @@ export interface ISomeUpdateQueryQuery {
 "#);
 
     #[rustfmt::skip]
-run_test!(should_pick_query_params_from_multiple_rows_of_values, TestConfig::new("mysql", true, None),
+run_test!(should_pick_query_params_from_multiple_rows_of_values, TestConfig::new("mysql", true, None, None),
 
 //// TS query ////
 r#"

tests/postgres_delete_query_parameters.rs

@@ -13,7 +13,7 @@ mod mysql_delete_query_parameters {
     use test_utils::{run_test, sandbox::TestConfig};
 
     #[rustfmt::skip]
-run_test!(should_pick_query_params_from_binary_ops, TestConfig::new("postgres", true, None),
+run_test!(should_pick_query_params_from_binary_ops, TestConfig::new("postgres", true, None, None),
 
 //// TS query ////
 r#"
@@ -40,7 +40,7 @@ export interface ISomeDeleteQueryQuery {
 "#);
 
     #[rustfmt::skip]
-run_test!(should_pick_query_params_from_subquery, TestConfig::new("postgres", true, None),
+run_test!(should_pick_query_params_from_subquery, TestConfig::new("postgres", true, None, None),
 
 //// TS query ////
 r#"

tests/postgres_insert_query_parameters.rs

@@ -13,7 +13,7 @@ mod postgres_insert_query_parameters {
     use test_utils::{run_test, sandbox::TestConfig};
 
     #[rustfmt::skip]
-run_test!(should_pick_query_params_from_single_row_of_values, TestConfig::new("postgres", true, None),
+run_test!(should_pick_query_params_from_single_row_of_values, TestConfig::new("postgres", true, None, None),
 
 //// TS query ////
 r#"
@@ -39,7 +39,7 @@ export interface ISomeInputQueryQuery {
 "#);
 
     #[rustfmt::skip]
-run_test!(should_pick_query_params_from_multiple_rows_of_values, TestConfig::new("postgres", true, None),
+run_test!(should_pick_query_params_from_multiple_rows_of_values, TestConfig::new("postgres", true, None, None),
 
 //// TS query ////
 r#"

tests/postgres_query_parameters.rs

@@ -13,7 +13,7 @@ mod postgres_query_parameters_tests {
     use test_utils::{run_test, sandbox::TestConfig};
 
     #[rustfmt::skip]
-run_test!(should_pick_query_params_from_flat_list_of_binary_ops, TestConfig::new("postgres", true, None),
+run_test!(should_pick_query_params_from_flat_list_of_binary_ops, TestConfig::new("postgres", true, None, None),
 
 //// TS query ////
 r#"

tests/postgres_update_query_parameters.rs

@@ -13,7 +13,7 @@ mod postgres_update_query_parameters {
     use test_utils::{run_test, sandbox::TestConfig};
 
     #[rustfmt::skip]
-run_test!(should_pick_query_params_from_single_row_of_values, TestConfig::new("postgres", true, None),
+run_test!(should_pick_query_params_from_single_row_of_values, TestConfig::new("postgres", true, None, None),
 
 //// TS query ////
 r#"