From bcc5b5066a095b2821329337aea1babf3ab79fe5 Mon Sep 17 00:00:00 2001 From: Forest Anderson Date: Sat, 16 Oct 2021 23:19:48 -0400 Subject: [PATCH 1/4] Changed manual url parsing to use Url crate --- Cargo.toml | 1 + sea-orm-cli/Cargo.toml | 1 + sea-orm-cli/src/main.rs | 76 +++++++++++++++++++---------------- src/database/db_connection.rs | 8 ++-- 4 files changed, 49 insertions(+), 37 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 7dfb7cb8..71690374 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -37,6 +37,7 @@ serde_json = { version = "^1", optional = true } sqlx = { version = "^0.5", optional = true } uuid = { version = "0.8", features = ["serde", "v4"], optional = true } ouroboros = "0.11" +url = "^2.2" [dev-dependencies] smol = { version = "^1.2" } diff --git a/sea-orm-cli/Cargo.toml b/sea-orm-cli/Cargo.toml index 02fddcb1..320b35cf 100644 --- a/sea-orm-cli/Cargo.toml +++ b/sea-orm-cli/Cargo.toml @@ -32,6 +32,7 @@ sea-schema = { version = "^0.2.9", default-features = false, features = [ sqlx = { version = "^0.5", default-features = false, features = [ "mysql", "postgres" ] } env_logger = { version = "^0.9" } log = { version = "^0.4" } +url = "^2.2" [features] default = [ "runtime-async-std-native-tls" ] diff --git a/sea-orm-cli/src/main.rs b/sea-orm-cli/src/main.rs index 528ce5f5..6ce8cc31 100644 --- a/sea-orm-cli/src/main.rs +++ b/sea-orm-cli/src/main.rs @@ -3,6 +3,7 @@ use dotenv::dotenv; use log::LevelFilter; use sea_orm_codegen::{EntityTransformer, OutputFile, WithSerde}; use std::{error::Error, fmt::Display, fs, io::Write, path::Path, process::Command, str::FromStr}; +use url::Url; mod cli; @@ -23,7 +24,8 @@ async fn main() { async fn run_generate_command(matches: &ArgMatches<'_>) -> Result<(), Box> { match matches.subcommand() { ("entity", Some(args)) => { - let url = args.value_of("DATABASE_URL").unwrap(); + // The database should be a valid URL that can be parsed + let url = Url::parse(args.value_of("DATABASE_URL").unwrap())?; let output_dir = args.value_of("OUTPUT_DIR").unwrap(); let include_hidden_tables = args.is_present("INCLUDE_HIDDEN_TABLES"); let tables = args @@ -33,7 +35,7 @@ async fn run_generate_command(matches: &ArgMatches<'_>) -> Result<(), Box bool { - if tables.len() > 0 { + if !tables.is_empty() { return tables.contains(&table); } @@ -43,7 +45,7 @@ async fn run_generate_command(matches: &ArgMatches<'_>) -> Result<(), Box) -> Result<(), Box { + use sea_schema::mysql::discovery::SchemaDiscovery; + use sqlx::MySqlPool; - let url_parts: Vec<&str> = url.split("/").collect(); - let schema = url_parts.last().unwrap(); - let connection = MySqlPool::connect(url).await?; - let schema_discovery = SchemaDiscovery::new(connection, schema); - let schema = schema_discovery.discover().await; - schema - .tables - .into_iter() - .filter(|schema| filter_tables(&schema.info.name)) - .filter(|schema| filter_hidden_tables(&schema.info.name)) - .map(|schema| schema.write()) - .collect() - } else if url.starts_with("postgres://") || url.starts_with("postgresql://") { - use sea_schema::postgres::discovery::SchemaDiscovery; - use sqlx::PgPool; + // TODO: as far as I can tell, this used to be the last + // value of the url, which should have been the database + // name? + let schema = url.path_segments().unwrap().last().unwrap(); + let connection = MySqlPool::connect(url.as_str()).await?; + let schema_discovery = SchemaDiscovery::new(connection, schema); + let schema = schema_discovery.discover().await; + schema + .tables + .into_iter() + .filter(|schema| filter_tables(&schema.info.name)) + .filter(|schema| filter_hidden_tables(&schema.info.name)) + .map(|schema| schema.write()) + .collect() + } + "postgres" | "postgresql" => { + use sea_schema::postgres::discovery::SchemaDiscovery; + use sqlx::PgPool; - let schema = args.value_of("DATABASE_SCHEMA").unwrap_or("public"); - let connection = PgPool::connect(url).await?; - let schema_discovery = SchemaDiscovery::new(connection, schema); - let schema = schema_discovery.discover().await; - schema - .tables - .into_iter() - .filter(|schema| filter_tables(&schema.info.name)) - .filter(|schema| filter_hidden_tables(&schema.info.name)) - .map(|schema| schema.write()) - .collect() - } else { - panic!("This database is not supported ({})", url) + let schema = args.value_of("DATABASE_SCHEMA").unwrap_or("public"); + let connection = PgPool::connect(url.as_str()).await?; + let schema_discovery = SchemaDiscovery::new(connection, schema); + let schema = schema_discovery.discover().await; + schema + .tables + .into_iter() + .filter(|schema| filter_tables(&schema.info.name)) + .filter(|schema| filter_hidden_tables(&schema.info.name)) + .map(|schema| schema.write()) + .collect() + } + _ => unimplemented!("{} is not supported", url.scheme()), }; let output = EntityTransformer::transform(table_stmts)? @@ -99,6 +105,8 @@ async fn run_generate_command(matches: &ArgMatches<'_>) -> Result<(), Box bool { + let base_url_parsed = Url::parse(base_url).unwrap(); match self { Self::Postgres => { - base_url.starts_with("postgres://") || base_url.starts_with("postgresql://") + base_url_parsed.scheme() == "postgres" || base_url_parsed.scheme() == "postgresql" } - Self::MySql => base_url.starts_with("mysql://"), - Self::Sqlite => base_url.starts_with("sqlite:"), + Self::MySql => base_url_parsed.scheme() == "mysql", + Self::Sqlite => base_url_parsed.scheme() == "sqlite", } } From a346b3429921513828eb83d2a49d551a76a8d3c6 Mon Sep 17 00:00:00 2001 From: Forest Anderson Date: Mon, 18 Oct 2021 14:28:36 -0400 Subject: [PATCH 2/4] Improve errors --- sea-orm-cli/src/main.rs | 52 +++++++++++++++++++++++++++++++---------- 1 file changed, 40 insertions(+), 12 deletions(-) diff --git a/sea-orm-cli/src/main.rs b/sea-orm-cli/src/main.rs index 6ce8cc31..f5c59529 100644 --- a/sea-orm-cli/src/main.rs +++ b/sea-orm-cli/src/main.rs @@ -25,7 +25,15 @@ async fn run_generate_command(matches: &ArgMatches<'_>) -> Result<(), Box { // The database should be a valid URL that can be parsed - let url = Url::parse(args.value_of("DATABASE_URL").unwrap())?; + // protocol://username:password@host/database_name + let url = match Url::parse( + args.value_of("DATABASE_URL") + .expect("No database url could be found"), + ) { + Ok(url) => url, + Err(e) => panic!("Invalid database url: {}", e), + }; + let output_dir = args.value_of("OUTPUT_DIR").unwrap(); let include_hidden_tables = args.is_present("INCLUDE_HIDDEN_TABLES"); let tables = args @@ -34,6 +42,36 @@ async fn run_generate_command(matches: &ArgMatches<'_>) -> Result<(), Box>(); let expanded_format = args.is_present("EXPANDED_FORMAT"); let with_serde = args.value_of("WITH_SERDE").unwrap(); + if args.is_present("VERBOSE") { + let _ = ::env_logger::builder() + .filter_level(LevelFilter::Debug) + .is_test(true) + .try_init(); + } + + // The database name should be the first element of the path string + // + // Throwing an error if there is no database name since it might be + // accepted by the database without it, while we're looking to dump + // information from a particular database + let database_name = url + .path_segments() + .expect(&format!( + "There is no database name as part of the url path: {}", + url.as_str() + )) + .next() + .unwrap(); + + // An empty string as the database name is also an error + if database_name.is_empty() { + panic!( + "There is no database name as part of the url path: {}", + url.as_str() + ); + } + + // Closures for filtering tables let filter_tables = |table: &str| -> bool { if !tables.is_empty() { return tables.contains(&table); @@ -48,24 +86,14 @@ async fn run_generate_command(matches: &ArgMatches<'_>) -> Result<(), Box { use sea_schema::mysql::discovery::SchemaDiscovery; use sqlx::MySqlPool; - // TODO: as far as I can tell, this used to be the last - // value of the url, which should have been the database - // name? - let schema = url.path_segments().unwrap().last().unwrap(); let connection = MySqlPool::connect(url.as_str()).await?; - let schema_discovery = SchemaDiscovery::new(connection, schema); + let schema_discovery = SchemaDiscovery::new(connection, database_name); let schema = schema_discovery.discover().await; schema .tables From 8d06aea00b17149cf58e3c0fc459f79429d1815b Mon Sep 17 00:00:00 2001 From: Forest Anderson Date: Tue, 19 Oct 2021 01:11:54 -0400 Subject: [PATCH 3/4] Added tests --- sea-orm-cli/Cargo.toml | 1 + sea-orm-cli/src/main.rs | 169 ++++++++++++++++++++++++++++++++++++---- 2 files changed, 156 insertions(+), 14 deletions(-) diff --git a/sea-orm-cli/Cargo.toml b/sea-orm-cli/Cargo.toml index 320b35cf..aead20df 100644 --- a/sea-orm-cli/Cargo.toml +++ b/sea-orm-cli/Cargo.toml @@ -33,6 +33,7 @@ sqlx = { version = "^0.5", default-features = false, features = [ "mysql", "post env_logger = { version = "^0.9" } log = { version = "^0.4" } url = "^2.2" +smol = "1.2.5" [features] default = [ "runtime-async-std-native-tls" ] diff --git a/sea-orm-cli/src/main.rs b/sea-orm-cli/src/main.rs index f5c59529..2529b0f1 100644 --- a/sea-orm-cli/src/main.rs +++ b/sea-orm-cli/src/main.rs @@ -24,16 +24,6 @@ async fn main() { async fn run_generate_command(matches: &ArgMatches<'_>) -> Result<(), Box> { match matches.subcommand() { ("entity", Some(args)) => { - // The database should be a valid URL that can be parsed - // protocol://username:password@host/database_name - let url = match Url::parse( - args.value_of("DATABASE_URL") - .expect("No database url could be found"), - ) { - Ok(url) => url, - Err(e) => panic!("Invalid database url: {}", e), - }; - let output_dir = args.value_of("OUTPUT_DIR").unwrap(); let include_hidden_tables = args.is_present("INCLUDE_HIDDEN_TABLES"); let tables = args @@ -49,6 +39,33 @@ async fn run_generate_command(matches: &ArgMatches<'_>) -> Result<(), Box) -> Result<(), Box match e.downcast::() { + Ok(_) => (), + Err(e) => panic!("Expected ParseError but got: {:?}", e), + }, + _ => panic!("Should have panicked"), + } + } + + #[test] + #[should_panic] + fn test_generate_entity_no_database_section() { + let matches = cli::build_cli() + .setting(AppSettings::NoBinaryName) + .get_matches_from(vec![ + "generate", + "entity", + "--database-url", + "postgresql://root:root@localhost:3306", + ]); + + smol::block_on(run_generate_command(matches.subcommand().1.unwrap())) + .unwrap_or_else(handle_error); + } + + #[test] + #[should_panic] + fn test_generate_entity_no_database_path() { + let matches = cli::build_cli() + .setting(AppSettings::NoBinaryName) + .get_matches_from(vec![ + "generate", + "entity", + "--database-url", + "mysql://root:root@localhost:3306/", + ]); + + smol::block_on(run_generate_command(matches.subcommand().1.unwrap())) + .unwrap_or_else(handle_error); + } + + #[test] + #[should_panic] + fn test_generate_entity_no_username() { + let matches = cli::build_cli() + .setting(AppSettings::NoBinaryName) + .get_matches_from(vec![ + "generate", + "entity", + "--database-url", + "mysql://:root@localhost:3306/database", + ]); + + smol::block_on(run_generate_command(matches.subcommand().1.unwrap())) + .unwrap_or_else(handle_error); + } + + #[test] + #[should_panic] + fn test_generate_entity_no_password() { + let matches = cli::build_cli() + .setting(AppSettings::NoBinaryName) + .get_matches_from(vec![ + "generate", + "entity", + "--database-url", + "mysql://root:@localhost:3306/database", + ]); + + smol::block_on(run_generate_command(matches.subcommand().1.unwrap())) + .unwrap_or_else(handle_error); + } + + #[async_std::test] + async fn test_generate_entity_no_host() { + let matches = cli::build_cli() + .setting(AppSettings::NoBinaryName) + .get_matches_from(vec![ + "generate", + "entity", + "--database-url", + "postgres://root:root@/database", + ]); + + let result = std::panic::catch_unwind(|| { + smol::block_on(run_generate_command(matches.subcommand().1.unwrap())) + }); + + // Make sure result is a ParseError + match result { + Ok(Err(e)) => match e.downcast::() { + Ok(_) => (), + Err(e) => panic!("Expected ParseError but got: {:?}", e), + }, + _ => panic!("Should have panicked"), + } + } +} From fb1694b09608a5740d323ac1d37bf496c18033fd Mon Sep 17 00:00:00 2001 From: Forest Anderson Date: Tue, 19 Oct 2021 01:27:27 -0400 Subject: [PATCH 4/4] Updated actions with test --- .github/workflows/rust.yml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml index 28e73ad6..c9073f5c 100644 --- a/.github/workflows/rust.yml +++ b/.github/workflows/rust.yml @@ -145,7 +145,7 @@ jobs: with: command: test args: > - --all + --workspace - uses: actions-rs/cargo@v1 with: @@ -153,6 +153,12 @@ jobs: args: > --manifest-path sea-orm-rocket/Cargo.toml + - uses: actions-rs/cargo@v1 + with: + command: test + args: > + --manifest-path sea-orm-cli/Cargo.toml + cli: name: CLI runs-on: ${{ matrix.os }}