ardb 0.28.3 → 0.30.0

data/test/unit/cli_tests.rb

@@ -1,12 +1,13 @@
-require 'assert'
-require 'ardb/cli'
+# frozen_string_literal: true
 
-require 'ardb'
-require 'ardb/adapter_spy'
-require 'ardb/migration'
+require "assert"
+require "ardb/cli"
 
-class Ardb::CLI
+require "ardb"
+require "ardb/adapter_spy"
+require "ardb/migration"
 
+class Ardb::CLI
   class UnitTests < Assert::Context
     desc "Ardb::CLI"
     setup do
@@ -26,16 +27,22 @@ class Ardb::CLI
     end
 
     should "know its commands" do
-      assert_equal 5, COMMANDS.size
+      assert_equal 9, COMMANDS.size
 
       assert_instance_of InvalidCommand, COMMANDS[Factory.string]
-      assert_instance_of ConnectCommand,           COMMANDS['connect']
-      assert_instance_of CreateCommand,            COMMANDS['create']
-      assert_instance_of DropCommand,              COMMANDS['drop']
-      assert_instance_of MigrateCommand,           COMMANDS['migrate']
-      assert_instance_of GenerateMigrationCommand, COMMANDS['generate-migration']
+      assert_instance_of ConnectCommand, COMMANDS["connect"]
+      assert_instance_of CreateCommand,  COMMANDS["create"]
+      assert_instance_of DropCommand,    COMMANDS["drop"]
+      assert_instance_of(
+        GenerateMigrationCommand,
+        COMMANDS["generate-migration"],
+      )
+      assert_instance_of MigrateCommand,         COMMANDS["migrate"]
+      assert_instance_of MigrateUpCommand,       COMMANDS["migrate-up"]
+      assert_instance_of MigrateDownCommand,     COMMANDS["migrate-down"]
+      assert_instance_of MigrateForwardCommand,  COMMANDS["migrate-forward"]
+      assert_instance_of MigrateBackwardCommand, COMMANDS["migrate-backward"]
     end
-
   end
 
   class InitTests < UnitTests
@@ -50,25 +57,25 @@ class Ardb::CLI
     subject{ @cli }
 
     should have_imeths :run
-
   end
 
   class RunSetupTests < InitTests
     setup do
       @command_name = Factory.string
-      @argv = [@command_name, Factory.string]
+      @command_class = Class.new{ include ValidCommand }
+      Assert.stub(@command_class, :command_name){ @command_name }
 
-      @command_class = Class.new
-      @command_spy  = CommandSpy.new
+      @command_spy = CommandSpy.new(@command_name)
       Assert.stub(@command_class, :new){ @command_spy }
-      COMMANDS.add(@command_class, @command_name)
+      COMMANDS.add(@command_class)
 
       @invalid_command = InvalidCommand.new(@command_name)
+
+      @argv = [@command_name, Factory.string]
     end
     teardown do
-      COMMANDS.remove(@command_name)
+      COMMANDS.remove(@command_class)
     end
-
   end
 
   class RunTests < RunSetupTests
@@ -88,7 +95,6 @@ class Ardb::CLI
     should "have successfully exited" do
       assert_equal 0, @kernel_spy.exit_status
     end
-
   end
 
   class RunWithNoArgsTests < RunSetupTests
@@ -98,14 +104,13 @@ class Ardb::CLI
     end
 
     should "output the invalid command's help" do
-      assert_equal @invalid_command.help, @stdout.read
+      assert_equal @invalid_command.command_help, @stdout.read
       assert_empty @stderr.read
     end
 
     should "have successfully exited" do
       assert_equal 0, @kernel_spy.exit_status
     end
-
   end
 
   class RunWithInvalidCommandTests < RunSetupTests
@@ -117,15 +122,14 @@ class Ardb::CLI
     end
 
     should "output that it is invalid and output the invalid command's help" do
-      exp = "'#{@name}' is not a command.\n\n"
+      exp = "\"#{@name}\" is not a command.\n\n"
       assert_equal exp, @stderr.read
-      assert_equal @invalid_command.help, @stdout.read
+      assert_equal @invalid_command.command_help, @stdout.read
     end
 
     should "have unsuccessfully exited" do
       assert_equal 1, @kernel_spy.exit_status
     end
-
   end
 
   class RunWithCommandExitErrorTests < RunSetupTests
@@ -139,30 +143,28 @@ class Ardb::CLI
       assert_equal 1, @kernel_spy.exit_status
       assert_empty @stderr.read
     end
-
   end
 
   class RunWithHelpTests < RunSetupTests
     desc "and run with the help switch"
     setup do
-      @cli.run([ '--help' ])
+      @cli.run(["--help"])
     end
 
     should "output the invalid command's help" do
-      assert_equal @invalid_command.help, @stdout.read
+      assert_equal @invalid_command.command_help, @stdout.read
       assert_empty @stderr.read
     end
 
     should "have successfully exited" do
       assert_equal 0, @kernel_spy.exit_status
     end
-
   end
 
   class RunWithVersionTests < RunSetupTests
     desc "and run with the version switch"
     setup do
-      @cli.run([ '--version' ])
+      @cli.run(["--version"])
     end
 
     should "output its version" do
@@ -173,7 +175,6 @@ class Ardb::CLI
     should "have successfully exited" do
       assert_equal 0, @kernel_spy.exit_status
     end
-
   end
 
   class RunWithErrorTests < RunSetupTests
@@ -193,7 +194,6 @@ class Ardb::CLI
     should "have unsuccessfully exited" do
       assert_equal 1, @kernel_spy.exit_status
     end
-
   end
 
   class InvalidCommandTests < UnitTests
@@ -206,7 +206,7 @@ class Ardb::CLI
     subject{ @cmd }
 
     should have_readers :name, :clirb
-    should have_imeths :new, :run, :help
+    should have_imeths :new, :run, :command_help
 
     should "know its attrs" do
       assert_equal @name, subject.name
@@ -218,12 +218,12 @@ class Ardb::CLI
     end
 
     should "parse its argv on run" do
-      assert_raises(CLIRB::HelpExit){ subject.new.run([ '--help' ]) }
-      assert_raises(CLIRB::VersionExit){ subject.new.run([ '--version' ]) }
+      assert_raises(CLIRB::HelpExit){ subject.new.run(["--help"]) }
+      assert_raises(CLIRB::VersionExit){ subject.new.run(["--version"]) }
     end
 
     should "raise a help exit if its name is empty" do
-      cmd = @command_class.new([nil, ''].sample)
+      cmd = @command_class.new([nil, ""].sample)
       argv = [Factory.string, Factory.string]
       assert_raises(CLIRB::HelpExit){ cmd.new.run(argv) }
     end
@@ -237,9 +237,8 @@ class Ardb::CLI
             "Options: #{subject.clirb}\n" \
             "Commands:\n" \
             "#{COMMANDS.to_s.split("\n").map{ |l| "  #{l}" }.join("\n")}\n"
-      assert_equal exp, subject.help
+      assert_equal exp, subject.command_help
     end
-
   end
 
   class CommandSetupTests < UnitTests
@@ -253,7 +252,6 @@ class Ardb::CLI
       Assert.stub(Ardb, :adapter){ @adapter_spy }
     end
     subject{ @cmd }
-
   end
 
   class ValidCommandTests < CommandSetupTests
@@ -263,7 +261,10 @@ class Ardb::CLI
       @cmd = @command_class.new
     end
 
-    should have_imeths :clirb, :run, :summary
+    should have_cmeths :command_name, :command_summary
+
+    should have_imeths :clirb, :run
+    should have_imeths :command_name, :command_summary, :command_help
 
     should "know its CLI.RB" do
       assert_instance_of CLIRB, subject.clirb
@@ -276,17 +277,34 @@ class Ardb::CLI
     end
 
     should "take custom CLIRB build procs" do
-      cmd = @command_class.new do
-        option 'test', 'testing', :abbrev => 't'
+      cmd =
+        @command_class.new do
+          option "test", "testing", abbrev: "t"
+        end
+      cmd.run(["-t"], @stdout, @stderr)
+      assert_true cmd.clirb.opts["test"]
+    end
+
+    should "not implement its command name" do
+      assert_raises NotImplementedError do
+        subject.command_name
       end
-      cmd.run(['-t'], @stdout, @stderr)
-      assert_true cmd.clirb.opts['test']
     end
 
-    should "default its summary" do
-      assert_equal '', subject.summary
+    should "default its command summary" do
+      assert_equal "", subject.command_summary
     end
 
+    should "know its command help" do
+      Assert.stub(subject, :command_name){ "some-command" }
+      Assert.stub(subject, :command_summary){ "some-summary" }
+
+      exp = "Usage: ardb #{subject.command_name} [options]\n\n" \
+            "Options: #{subject.clirb}\n" \
+            "Description:\n" \
+            "  #{subject.command_summary}"
+      assert_equal exp, subject.command_help
+    end
   end
 
   class ConnectCommandTests < CommandSetupTests
@@ -300,17 +318,12 @@ class Ardb::CLI
       assert_kind_of ValidCommand, subject
     end
 
-    should "know its summary" do
-      exp = "Connect to the configured DB"
-      assert_equal exp, subject.summary
-    end
+    should "know its command name and summary" do
+      exp = "connect"
+      assert_equal exp, subject.command_name
 
-    should "know its help" do
-      exp = "Usage: ardb connect [options]\n\n" \
-            "Options: #{subject.clirb}\n" \
-            "Description:\n" \
-            "  #{subject.summary}"
-      assert_equal exp, subject.help
+      exp = "Connect to the configured DB"
+      assert_equal exp, subject.command_summary
     end
 
     should "init ardb and connect to the db when run" do
@@ -319,7 +332,9 @@ class Ardb::CLI
       assert_equal [false], @ardb_init_called_with
       assert_true @adapter_spy.connect_db_called?
 
-      exp = "connected to #{Ardb.config.adapter} db `#{Ardb.config.database}`\n"
+      exp =
+        "connected to #{Ardb.config.adapter} "\
+        "db #{Ardb.config.database.inspect}\n"
       assert_equal exp, @stdout.read
     end
 
@@ -338,7 +353,6 @@ class Ardb::CLI
             "with #{Ardb.config.activerecord_connect_hash.inspect}"
       assert_includes exp, err_output
     end
-
   end
 
   class CreateCommandTests < CommandSetupTests
@@ -352,17 +366,12 @@ class Ardb::CLI
       assert_kind_of ValidCommand, subject
     end
 
-    should "know its summary" do
-      exp = "Create the configured DB"
-      assert_equal exp, subject.summary
-    end
+    should "know its command name and summary" do
+      exp = "create"
+      assert_equal exp, subject.command_name
 
-    should "know its help" do
-      exp = "Usage: ardb create [options]\n\n" \
-            "Options: #{subject.clirb}\n" \
-            "Description:\n" \
-            "  #{subject.summary}"
-      assert_equal exp, subject.help
+      exp = "Create the configured DB"
+      assert_equal exp, subject.command_summary
     end
 
     should "init ardb and create the db when run" do
@@ -371,7 +380,8 @@ class Ardb::CLI
       assert_equal [false], @ardb_init_called_with
       assert_true @adapter_spy.create_db_called?
 
-      exp = "created #{Ardb.config.adapter} db `#{Ardb.config.database}`\n"
+      exp =
+        "created #{Ardb.config.adapter} db #{Ardb.config.database.inspect}\n"
       assert_equal exp, @stdout.read
     end
 
@@ -386,7 +396,6 @@ class Ardb::CLI
       exp = "error creating #{Ardb.config.database.inspect} database"
       assert_includes exp, err_output
     end
-
   end
 
   class DropCommandTests < CommandSetupTests
@@ -400,17 +409,12 @@ class Ardb::CLI
       assert_kind_of ValidCommand, subject
     end
 
-    should "know its summary" do
-      exp = "Drop the configured DB"
-      assert_equal exp, subject.summary
-    end
+    should "know its command name and summary" do
+      exp = "drop"
+      assert_equal exp, subject.command_name
 
-    should "know its help" do
-      exp = "Usage: ardb drop [options]\n\n" \
-            "Options: #{subject.clirb}\n" \
-            "Description:\n" \
-            "  #{subject.summary}"
-      assert_equal exp, subject.help
+      exp = "Drop the configured DB"
+      assert_equal exp, subject.command_summary
     end
 
     should "init ardb and drop the db when run" do
@@ -419,7 +423,8 @@ class Ardb::CLI
       assert_equal [true], @ardb_init_called_with
       assert_true @adapter_spy.drop_db_called?
 
-      exp = "dropped #{Ardb.config.adapter} db `#{Ardb.config.database}`\n"
+      exp =
+        "dropped #{Ardb.config.adapter} db #{Ardb.config.database.inspect}\n"
       assert_equal exp, @stdout.read
     end
 
@@ -434,35 +439,102 @@ class Ardb::CLI
       exp = "error dropping #{Ardb.config.database.inspect} database"
       assert_includes exp, err_output
     end
+  end
+
+  class GenerateMigrationCommandTests < CommandSetupTests
+    desc "GenerateMigrationCommand"
+    setup do
+      @identifier = Factory.migration_id
+
+      @migration_spy   = nil
+      @migration_class = Ardb::Migration
+      Assert.stub(@migration_class, :new) do |*args|
+        @migration_spy = MigrationSpy.new(*args)
+      end
+
+      @command_class = GenerateMigrationCommand
+      @cmd = @command_class.new
+    end
 
+    should "be a valid command" do
+      assert_kind_of ValidCommand, subject
+    end
+
+    should "know its command name and summary" do
+      exp = "generate-migration"
+      assert_equal exp, subject.command_name
+
+      exp = "Generate a MIGRATION-NAME migration file"
+      assert_equal exp, subject.command_summary
+    end
+
+    should "init ardb and save a migration for the identifier when run" do
+      subject.run([@identifier], @stdout, @stderr)
+
+      assert_equal [false],     @ardb_init_called_with
+      assert_equal Ardb.config, @migration_spy.ardb_config
+      assert_equal @identifier, @migration_spy.identifier
+      assert_true @migration_spy.save_called
+
+      exp = "generated #{@migration_spy.file_path}\n"
+      assert_equal exp, @stdout.read
+    end
+
+    should "re-raise a specific argument error on "\
+           "migration \"no identifer\" errors" do
+      Assert.stub(@migration_class, :new) do
+        raise Ardb::Migration::NoIdentifierError
+      end
+
+      ex =
+        assert_that{
+          cmd = @command_class.new
+          cmd.run([])
+        }.raises(ArgumentError)
+      exp = "MIGRATION-NAME must be provided"
+      assert_equal exp, ex.message
+      assert_not_empty ex.backtrace
+    end
+
+    should "output any errors and raise an exit error when run" do
+      err = StandardError.new(Factory.string)
+      err.set_backtrace(Factory.integer(3).times.map{ Factory.path })
+      Assert.stub(@migration_class, :new){ raise err }
+
+      assert_raises(CommandExitError) do
+        subject.run([@identifier], @stdout, @stderr)
+      end
+      err_output = @stderr.read
+
+      assert_includes err.to_s,                 err_output
+      assert_includes err.backtrace.join("\n"), err_output
+
+      exp = "error generating migration"
+      assert_includes exp, err_output
+    end
   end
 
   class MigrateCommandTests < CommandSetupTests
     desc "MigrateCommand"
     setup do
-      @orig_env_var_migrate_no_schema = ENV['ARDB_MIGRATE_NO_SCHEMA']
+      @orig_env_var_migrate_no_schema = ENV["ARDB_MIGRATE_NO_SCHEMA"]
       @command_class = MigrateCommand
       @cmd = @command_class.new
     end
     teardown do
-      ENV['ARDB_MIGRATE_NO_SCHEMA'] = @orig_env_var_migrate_no_schema
+      ENV["ARDB_MIGRATE_NO_SCHEMA"] = @orig_env_var_migrate_no_schema
     end
 
-    should "be a valid command" do
-      assert_kind_of ValidCommand, subject
+    should "be a migrate command" do
+      assert_kind_of MigrateCommandBehaviors, subject
     end
 
-    should "know its summary" do
-      exp = "Migrate the configured DB"
-      assert_equal exp, subject.summary
-    end
+    should "know its command name and summary" do
+      exp = "migrate"
+      assert_equal exp, subject.command_name
 
-    should "know its help" do
-      exp = "Usage: ardb migrate [options]\n\n" \
-            "Options: #{subject.clirb}\n" \
-            "Description:\n" \
-            "  #{subject.summary}"
-      assert_equal exp, subject.help
+      exp = "Migrate the configured DB"
+      assert_equal exp, subject.command_summary
     end
 
     should "init ardb, migrate the db and dump the schema when run" do
@@ -473,8 +545,9 @@ class Ardb::CLI
       assert_true @adapter_spy.dump_schema_called?
     end
 
-    should "only init ardb and migrate when run with no schema dump env var set" do
-      ENV['ARDB_MIGRATE_NO_SCHEMA'] = 'yes'
+    should "only init ardb and migrate when run with no schema dump "\
+           "env var set" do
+      ENV["ARDB_MIGRATE_NO_SCHEMA"] = "yes"
       subject.run([], @stdout, @stderr)
 
       assert_equal [true], @ardb_init_called_with
@@ -496,83 +569,86 @@ class Ardb::CLI
       exp = "error migrating #{Ardb.config.database.inspect} database"
       assert_includes exp, err_output
     end
-
   end
 
-  class GenerateMigrationCommandTests < CommandSetupTests
-    desc "GenerateMigrationCommand"
+  class MigrateUpCommandTests < CommandSetupTests
+    desc "MigrateUpCommand"
     setup do
-      @identifier = Factory.migration_id
-
-      @migration_spy   = nil
-      @migration_class = Ardb::Migration
-      Assert.stub(@migration_class, :new) do |*args|
-        @migration_spy = MigrationSpy.new(*args)
-      end
-
-      @command_class = GenerateMigrationCommand
+      @command_class = MigrateUpCommand
       @cmd = @command_class.new
     end
 
-    should "be a valid command" do
-      assert_kind_of ValidCommand, subject
+    should "be a migrate command" do
+      assert_kind_of MigrateCommandBehaviors, subject
     end
 
-    should "know its summary" do
-      exp = "Generate a migration file given a MIGRATION-NAME"
-      assert_equal exp, subject.summary
+    should "know its command name and summary" do
+      exp = "migrate-up"
+      assert_equal exp, subject.command_name
+
+      exp = "Migrate the configured DB up"
+      assert_equal exp, subject.command_summary
     end
+  end
 
-    should "know its help" do
-      exp = "Usage: ardb generate-migration [options] MIGRATION-NAME\n\n" \
-            "Options: #{subject.clirb}\n" \
-            "Description:\n" \
-            "  #{subject.summary}"
-      assert_equal exp, subject.help
+  class MigrateDownCommandTests < CommandSetupTests
+    desc "MigrateDownCommand"
+    setup do
+      @command_class = MigrateDownCommand
+      @cmd = @command_class.new
     end
 
-    should "init ardb and save a migration for the identifier when run" do
-      subject.run([@identifier], @stdout, @stderr)
+    should "be a migrate command" do
+      assert_kind_of MigrateCommandBehaviors, subject
+    end
 
-      assert_equal [false],     @ardb_init_called_with
-      assert_equal Ardb.config, @migration_spy.ardb_config
-      assert_equal @identifier, @migration_spy.identifier
-      assert_true @migration_spy.save_called
+    should "know its command name and summary" do
+      exp = "migrate-down"
+      assert_equal exp, subject.command_name
 
-      exp = "generated #{@migration_spy.file_path}\n"
-      assert_equal exp, @stdout.read
+      exp = "Migrate the configured DB down"
+      assert_equal exp, subject.command_summary
     end
+  end
 
-    should "re-raise a specific argument error on migration 'no identifer' errors" do
-      Assert.stub(@migration_class, :new){ raise Ardb::Migration::NoIdentifierError }
-      err = nil
-      begin
-        cmd = @command_class.new
-        cmd.run([])
-      rescue ArgumentError => err
-      end
+  class MigrateForwardCommandTests < CommandSetupTests
+    desc "MigrateForwardCommand"
+    setup do
+      @command_class = MigrateForwardCommand
+      @cmd = @command_class.new
+    end
 
-      assert_not_nil err
-      exp = "MIGRATION-NAME must be provided"
-      assert_equal exp, err.message
-      assert_not_empty err.backtrace
+    should "be a migrate command" do
+      assert_kind_of MigrateCommandBehaviors, subject
     end
 
-    should "output any errors and raise an exit error when run" do
-      err = StandardError.new(Factory.string)
-      err.set_backtrace(Factory.integer(3).times.map{ Factory.path })
-      Assert.stub(@migration_class, :new){ raise err }
+    should "know its command name and summary" do
+      exp = "migrate-forward"
+      assert_equal exp, subject.command_name
 
-      assert_raises(CommandExitError){ subject.run([@identifier], @stdout, @stderr) }
-      err_output = @stderr.read
+      exp = "Migrate the configured DB forward"
+      assert_equal exp, subject.command_summary
+    end
+  end
 
-      assert_includes err.to_s,                 err_output
-      assert_includes err.backtrace.join("\n"), err_output
+  class MigrateBackwardCommandTests < CommandSetupTests
+    desc "MigrateBackwardCommand"
+    setup do
+      @command_class = MigrateBackwardCommand
+      @cmd = @command_class.new
+    end
 
-      exp = "error generating migration"
-      assert_includes exp, err_output
+    should "be a migrate command" do
+      assert_kind_of MigrateCommandBehaviors, subject
     end
 
+    should "know its command name and summary" do
+      exp = "migrate-backward"
+      assert_equal exp, subject.command_name
+
+      exp = "Migrate the configured DB backward"
+      assert_equal exp, subject.command_summary
+    end
   end
 
   class CLISpy
@@ -588,9 +664,10 @@ class Ardb::CLI
   end
 
   class CommandSpy
-    attr_reader :argv, :stdout, :stderr, :run_called
+    attr_reader :command_name, :argv, :stdout, :stderr, :run_called
 
-    def initialize
+    def initialize(command_name)
+      @command_name = command_name
       @argv = nil
       @stdout, @stderr = nil, nil
       @run_called = false
@@ -602,12 +679,12 @@ class Ardb::CLI
       @run_called = true
     end
 
-    def summary
-      @summary ||= Factory.string
+    def command_summary
+      @command_summary ||= Factory.string
     end
 
-    def help
-      @help ||= Factory.text
+    def command_help
+      @command_help ||= Factory.text
     end
   end
 
@@ -653,5 +730,4 @@ class Ardb::CLI
       self
     end
   end
-
 end