Merge pull request #1 from EasyPost/bump

bump a whole bunch of dependencies; add features

Author: Roguelazer

CHANGES.md

@@ -0,0 +1,8 @@
+0.2.0
+=====
+- Bump a bunch of dependencies, including `clap` and `mysql`
+- Add some feature flags controlling the `mysql` dependency (documented in [README.md](README.md))
+
+0.1.0
+=====
+- Initial release

Cargo.toml

@@ -1,23 +1,34 @@
 [package]
 name = "rmmm"
-version = "0.1.0"
+version = "0.2.0"
 description = "Rust MySQL Migration Manager"
 repository = "https://github.com/EasyPost/rmmm"
 authors = ["James Brown <[email protected]>"]
 readme = "README.md"
 edition = "2021"
 license = "ISC"
+keywords = ["database", "mysql", "schema"]
+categories = ["command-line-utilities", "database", "development-tools"]
 
 [dependencies]
 anyhow = "1"
 chrono = "0.4"
-clap = "2"
+clap = { version = "3", features=["std", "color", "suggestions", "cargo", "env", "wrap_help"] }
 derive_more = "0.99"
 fern = {version = "0.6", features=["colored"]}
 itertools = "0.10"
 lazy_static = "1"
 log = "0.4"
-mysql = "21"
+mysql = { version = "22", default_features = false }
+# don't pin these; they're pinned by `mysql` and are just here to set features
+flate2 = { version = "*", default_features = false, features = ["zlib"] }
+mysql_common = { version = "*", default_features = false, features = ["time03"]}
 regex = "1"
-tabled = "0.3"
+tabled = "0.4"
 tempfile = "3"
+
+[features]
+default = ["uuid"]
+native-tls = ["mysql/native-tls"]
+rustls-tls = ["mysql/rustls-tls"]
+uuid = ["mysql_common/uuid"]

README.md

@@ -1,6 +1,6 @@
 This is a small Rust application for managing database migrations for MySQL.
 
-![CI](https://github.com/EasyPost/rmmm/workflows/CI/badge.svg?branch=master)
+[![CI](https://github.com/EasyPost/rmmm/workflows/CI/badge.svg?branch=master)](https://github.com/EasyPost/rmmm/actions/workflows/ci.yml)
 
 It compiles into a single binary called `rmmm`.
 
@@ -15,7 +15,9 @@ Basic usage:
  1. `rmmm status` will show all pending migrations
  1. `rmmm upgrade latest` will apply pending migrations. You can also upgrade (or downgrade) to a specific version.
 
-Versions are just incrementing integers for simplicity.
+Modifying actions will only print out what they would do by default and must be run with `--execute` to make changes.
+
+Schema versions are just incrementing integers for simplicity.
 
 Configuration is typically through environment variables:
 
@@ -26,6 +28,17 @@ Configuration is typically through environment variables:
 
 This work is licensed under the ISC license, a copy of which can be found in [LICENSE.txt](LICENSE.txt).
 
+Features
+--------
+RMMM supports the following feature flags:
+
+| Name | Meaning | Enabled by default |
+| `uuid` | Add support for native MySQL UUID types | ✓ |
+| `native-tls` | Use [native-tls](https://crates.io/crates/native-tls) to get SSL support via the local library (OpenSSL, etc) | |
+| `rustls-tls` | Use [rustls](https://crates.io/crates/rustls) to get SSL support | |
+
+You can enable exactly zero or one of `native-tls` or `rustls-tls`.
+
 Why?
 ----
 There are lots of migration management tools. A popular stand-alone choice is

src/main.rs

@@ -1,8 +1,10 @@
+#![forbid(unsafe_code)]
+
 use std::collections::{BTreeMap, BTreeSet};
 use std::env;
 
 use anyhow::Context;
-use clap::{Arg, SubCommand};
+use clap::Arg;
 use derive_more::Display;
 use itertools::Itertools;
 use log::{debug, error, info};
@@ -101,7 +103,7 @@ fn command_status(state: MigrationState) -> anyhow::Result<()> {
             }
         })
         .collect::<Vec<_>>();
-    let table = tabled::Table::new(&data).with(tabled::Style::pseudo_clean());
+    let table = tabled::Table::new(&data).with(tabled::Style::PSEUDO_CLEAN);
     println!("{}", table);
     Ok(())
 }
@@ -144,7 +146,7 @@ fn command_upgrade(matches: &clap::ArgMatches, state: MigrationState) -> anyhow:
         })
         .collect::<Vec<_>>();
     let table = tabled::Table::new(&plan_data)
-        .with(tabled::Style::pseudo_clean())
+        .with(tabled::Style::PSEUDO_CLEAN)
         .with(tabled::Modify::new(tabled::Column(2..=2)).with(tabled::Alignment::left()));
     println!("Migration plan:");
     println!("{}", table);
@@ -180,79 +182,78 @@ fn command_reset(matches: &clap::ArgMatches) -> anyhow::Result<()> {
 }
 
 fn main() -> anyhow::Result<()> {
-    let matches = clap::App::new(env!("CARGO_PKG_NAME"))
-        .version(env!("CARGO_PKG_VERSION"))
-        .author(env!("CARGO_PKG_AUTHORS"))
-        .about(env!("CARGO_PKG_DESCRIPTION"))
-        .global_settings(&[clap::AppSettings::ColorAuto, clap::AppSettings::ColoredHelp])
+    let matches = clap::App::new(clap::crate_name!())
+        .version(clap::crate_version!())
+        .author(clap::crate_authors!())
+        .about(clap::crate_description!())
         .arg(
-            Arg::with_name("migration_path")
-                .short("p")
+            Arg::new("migration_path")
+                .short('p')
                 .long("migration-path")
                 .takes_value(true)
                 .default_value("db")
                 .env("MIGRATION_PATH")
                 .help("Directory in which state is stored"),
         )
         .arg(
-            Arg::with_name("quiet")
-                .short("q")
+            Arg::new("quiet")
+                .short('q')
                 .long("quiet")
                 .help("Be less noisy when logging"),
         )
         .arg(
-            Arg::with_name("verbose")
-                .short("v")
+            Arg::new("verbose")
+                .short('v')
                 .long("verbose")
-                .multiple(true)
+                .multiple_occurrences(true)
                 .help("Be more noisy when logging"),
         )
-        .subcommand(SubCommand::with_name("status").about("Show the current status of migrations"))
+        .subcommand(clap::App::new("status").about("Show the current status of migrations"))
         .subcommand(
-            SubCommand::with_name("generate")
+            clap::App::new("generate")
                 .about("Generate a new migration")
                 .arg(
-                    Arg::with_name("label")
+                    Arg::new("label")
                         .required(true)
                         .help("Descriptive one-line label for the migration"),
                 ),
         )
         .subcommand(
-            SubCommand::with_name("upgrade")
+            clap::App::new("upgrade")
                 .about("Upgrade to the given revision")
                 .arg(
-                    Arg::with_name("revision")
+                    Arg::new("revision")
                         .required(true)
                         .help("Revision to which to upgrade (or 'latest')"),
                 )
                 .arg(
-                    Arg::with_name("execute")
-                        .short("x")
+                    Arg::new("execute")
+                        .short('x')
                         .long("execute")
                         .help("Actually upgrade (otherwise will just print what will be done"),
                 ),
         )
         .subcommand(
-            SubCommand::with_name("downgrade")
+            clap::App::new("downgrade")
                 .about("Downgrade to the given revision")
                 .arg(
-                    Arg::with_name("revision")
+                    Arg::new("revision")
                         .required(true)
                         .help("Revision to which to downgrade"),
                 )
                 .arg(
-                    Arg::with_name("execute")
-                        .short("x")
+                    Arg::new("execute")
+                        .short('x')
                         .long("execute")
                         .help("Actually upgrade (otherwise will just print what will be done"),
                 ),
         )
         .subcommand(
-            SubCommand::with_name("reset")
+            clap::App::new("reset")
                 .about("Drop all tables and totally reset the database (DANGEROUS)")
                 .arg(
-                    Arg::with_name("execute")
-                        .short("x")
+                    Arg::new("execute")
+                        .short('x')
                         .long("execute")
                         .help("Actually reset"),
                 ),
@@ -264,20 +265,20 @@ fn main() -> anyhow::Result<()> {
     let current_state = MigrationState::load(matches.value_of("migration_path").unwrap())?;
 
     match matches.subcommand() {
-        ("generate", Some(smatches)) => {
+        Some(("generate", smatches)) => {
             current_state.generate(smatches.value_of("label").unwrap())?
         }
-        ("status", _) => {
+        Some(("status", _)) => {
             command_status(current_state)?;
         }
-        ("upgrade", Some(smatches)) => {
+        Some(("upgrade", smatches)) => {
             command_upgrade(smatches, current_state)?;
         }
-        ("downgrade", Some(smatches)) => {
+        Some(("downgrade", smatches)) => {
             command_upgrade(smatches, current_state)?;
         }
-        ("reset", Some(smatches)) => command_reset(smatches)?,
-        (_, _) => {
+        Some(("reset", smatches)) => command_reset(smatches)?,
+        _ => {
             anyhow::bail!("Must pass a command!");
         }
     };