mysql-inspector 0.0.6 → 0.1.0

data/test/helpers/mysql_utils.rb

@@ -0,0 +1,35 @@
+require 'open3'
+require 'tempfile'
+
+module MysqlUtils
+  extend self
+
+  def create_mysql_database(database_name, schema)
+    drop_mysql_database(database_name)
+    syscall "echo 'CREATE DATABASE #{database_name}' | #{mysql_command}"
+    Tempfile.open('schema') do |file|
+      file.puts(schema)
+      file.flush
+      syscall "cat #{file.path} | #{mysql_command} #{database_name}"
+    end
+  end
+
+  def drop_mysql_database(database_name)
+    syscall "echo 'DROP DATABASE IF EXISTS #{database_name}' | #{mysql_command}"
+  end
+
+ protected
+
+  def mysql_command
+    @mysql_command ||= begin
+      path = `which mysql`.chomp
+      raise "mysql is not in your PATH" if path.empty?
+      "#{path} -uroot"
+    end
+  end
+
+  def syscall(command)
+    out, err, status = Open3.capture3(command)
+    raise "FAILED:\n\nstdout:\n#{out}\n\nstderr:\n#{err}" unless status.exitstatus == 0
+  end
+end

data/test/helpers/string_unindented.rb

@@ -0,0 +1,13 @@
+class String
+  # Strip left indentation from a string. Call this on a HEREDOC
+  # string to unindent it.
+  def unindented
+    lines = self.split("\n")
+    indent_level = (lines[0][/^(\s*)/, 1] || "").size
+    lines.map { |line|
+      line.sub(/^\s{#{indent_level}}/, '')
+    }.join("\n") + "\n"
+  end
+end
+
+

data/test/mysql_inspector/cli_basics_test.rb

@@ -0,0 +1,77 @@
+require 'helper'
+
+describe "mysql-inspector -v" do
+
+  subject { mysql_inspector "-v" }
+
+  it "shows the version" do
+    stderr.must_equal ""
+    stdout.must_equal MysqlInspector::VERSION
+    status.must_equal 0
+  end
+end
+
+describe "mysql-inspector -h" do
+
+  subject { mysql_inspector "-h" }
+
+  it "shows the help" do
+    stderr.must_equal ""
+    stdout.must_equal <<-EOL.unindented
+      Usage: mysql-inspector [options] command [command args]
+
+      Options
+
+              --out DIR                    Where to store schemas. Defaults to '.'
+              --rails                      Configure for a Rails project
+          -h, --help                       What you're looking at
+          -v, --version                    Show the version of mysql-inspector
+
+      Commands
+
+        write DATABASE [VERSION]
+        load DATABASE [VERSION]
+        diff
+        diff TO
+        diff FROM TO
+        grep PATTERN [PATTERN]
+
+    EOL
+    status.must_equal 0
+  end
+end
+
+describe "mysql-inspector an unknown command" do
+
+  subject { mysql_inspector "unknown_command" }
+
+  it "fails" do
+    stderr.must_equal "Unknown command \"unknown_command\""
+    stdout.must_equal ""
+    status.must_equal 1
+  end
+end
+
+describe "mysql-inspector error cases" do
+
+  describe "when the database does not exist" do
+    subject { inspect_database "write #{database_name}" }
+    it "fails" do
+      stdout.must_equal ""
+      stderr.must_equal "The database #{database_name} does not exist"
+      status.must_equal 1
+    end
+  end
+
+  describe "when the dump does not exist" do
+    subject { inspect_database "load #{database_name}" }
+    before do
+      create_mysql_database ""
+    end
+    it "fails" do
+      stdout.must_equal ""
+      stderr.must_equal "Dump \"current\" does not exist"
+      status.must_equal 1
+    end
+  end
+end

data/test/mysql_inspector/cli_diff_test.rb

@@ -0,0 +1,60 @@
+require 'helper'
+
+describe "mysql-inspector diff" do
+
+  describe "parsing arguments" do
+
+    subject { parse_command(MysqlInspector::CLI::DiffCommand, args) }
+    let(:args) { [] }
+
+    specify "it compares current to target" do
+      subject.ivar(:version1).must_equal "current"
+      subject.ivar(:version2).must_equal "target"
+    end
+
+    specify "it compares current to something else" do
+      args << "other"
+      subject.ivar(:version1).must_equal "current"
+      subject.ivar(:version2).must_equal "other"
+    end
+
+    specify "it compares two arbitrary versions" do
+      args << "other1"
+      args << "other2"
+      subject.ivar(:version1).must_equal "other1"
+      subject.ivar(:version2).must_equal "other2"
+    end
+  end
+
+  describe "running" do
+
+    subject { inspect_database "diff" }
+
+    before do
+      create_mysql_database schema_a
+      inspect_database "write #{database_name} current"
+      create_mysql_database schema_b
+      inspect_database "write #{database_name} target"
+    end
+
+    specify do
+      stderr.must_equal ""
+      stdout.must_equal <<-EOL.unindented
+        diff current target
+
+        - colors
+        = things
+          COL    - `color` varchar(255) NOT NULL
+                 + `first_name` varchar(255) NOT NULL
+                 + `last_name` varchar(255) NOT NULL
+          IDX    - KEY `color` (`color`)
+                 + KEY `name` (`first_name`,`last_name`)
+          CST    - CONSTRAINT `belongs_to_color` FOREIGN KEY (`color`) REFERENCES `colors` (`name`) ON DELETE NO ACTION ON UPDATE CASCADE
+                 + CONSTRAINT `belongs_to_user` FOREIGN KEY (`first_name`,`last_name`) REFERENCES `users` (`first_name`,`last_name`) ON DELETE NO ACTION ON UPDATE CASCADE
+        + users
+
+      EOL
+      status.must_equal 0
+    end
+  end
+end

data/test/mysql_inspector/cli_grep_test.rb

@@ -0,0 +1,74 @@
+require 'helper'
+
+describe "mysql-inspector grep" do
+
+  describe "parsing arguments" do
+
+    subject { parse_command(MysqlInspector::CLI::GrepCommand, args) }
+    let(:args) { [] }
+
+    specify "it searches current" do
+      args.concat ["a", "^b"]
+      subject.ivar(:version).must_equal "current"
+      subject.ivar(:matchers).must_equal [/a/, /^b/]
+    end
+
+    specify "it searches another version" do
+      skip "not supported. how would the args work?"
+    end
+  end
+
+  describe "running" do
+    before do
+      create_mysql_database [users_schema, things_schema] * ";"
+      inspect_database "write #{database_name}"
+    end
+
+    subject { inspect_database "grep #{matchers * ' '}" }
+    let(:matchers) { [] }
+
+    specify "searching for a single term" do
+      matchers << "name"
+
+      stderr.must_equal ""
+      stdout.must_equal <<-EOL.unindented
+        grep /name/
+
+        things
+        COL    `first_name` varchar(255) NOT NULL
+               `last_name` varchar(255) NOT NULL
+               `name` varchar(255) NOT NULL DEFAULT 'toy'
+        IDX    KEY `name` (`first_name`,`last_name`)
+        CST    CONSTRAINT `belongs_to_user` FOREIGN KEY (`first_name`,`last_name`) REFERENCES `users` (`first_name`,`last_name`) ON DELETE NO ACTION ON UPDATE CASCADE
+
+        users
+        COL    `first_name` varchar(255) NOT NULL
+               `last_name` varchar(255) NOT NULL
+        IDX    KEY `name` (`first_name`,`last_name`)
+
+      EOL
+      status.must_equal 0
+    end
+
+    specify "searching for multiple terms" do
+      matchers << "name"
+      matchers << "first"
+
+      stderr.must_equal ""
+      stdout.must_equal <<-EOL.unindented
+        grep /name/ AND /first/
+
+        things
+        COL    `first_name` varchar(255) NOT NULL
+        IDX    KEY `name` (`first_name`,`last_name`)
+        CST    CONSTRAINT `belongs_to_user` FOREIGN KEY (`first_name`,`last_name`) REFERENCES `users` (`first_name`,`last_name`) ON DELETE NO ACTION ON UPDATE CASCADE
+
+        users
+        COL    `first_name` varchar(255) NOT NULL
+        IDX    KEY `name` (`first_name`,`last_name`)
+
+      EOL
+      status.must_equal 0
+    end
+  end
+end

data/test/mysql_inspector/cli_load_test.rb

@@ -0,0 +1,43 @@
+describe "mysql-inspector load" do
+
+  describe "parsing arguments" do
+
+    subject { parse_command(MysqlInspector::CLI::LoadCommand, args) }
+    let(:args) { [] }
+
+    specify "it fails when you don't specify a database" do
+      stderr.must_equal "Usage: mysql-inspector load DATABASE [VERSION]"
+      stdout.must_equal ""
+    end
+
+    specify "it loads from current" do
+      args.concat ["my_database"]
+      subject.ivar(:database).must_equal "my_database"
+      subject.ivar(:version).must_equal "current"
+    end
+
+    specify "it loads another version" do
+      args.concat ["my_database", "other"]
+      subject.ivar(:database).must_equal "my_database"
+      subject.ivar(:version).must_equal "other"
+    end
+  end
+
+  describe "running" do
+    subject { inspect_database "load #{database_name}" }
+    specify do
+      create_mysql_database schema_b
+      inspect_database "write #{database_name}"
+      create_mysql_database ideas_schema
+      access.table_names.size.must_equal 1
+
+      it "outputs nothing"
+      stdout.must_equal ""
+      stderr.must_equal ""
+      status.must_equal 0
+
+      it "creates all tables"
+      access.table_names.size.must_equal 3
+    end
+  end
+end

data/test/mysql_inspector/cli_write_test.rb

@@ -0,0 +1,58 @@
+require 'helper'
+
+describe "mysql-inspector write" do
+
+  describe "parsing arguments" do
+
+    subject { parse_command(MysqlInspector::CLI::WriteCommand, args) }
+    let(:args) { [] }
+
+    specify "it fails when you don't specify a database" do
+      stderr.must_equal "Usage: mysql-inspector write DATABASE [VERSION]"
+      stdout.must_equal ""
+    end
+
+    specify "it writes to current" do
+      args.concat ["my_database"]
+      subject.ivar(:database).must_equal "my_database"
+      subject.ivar(:version).must_equal "current"
+    end
+
+    specify "it writes to another version" do
+      args.concat ["my_database", "other"]
+      subject.ivar(:database).must_equal "my_database"
+      subject.ivar(:version).must_equal "other"
+    end
+  end
+
+  describe "running" do
+
+    subject { run_command(MysqlInspector::CLI::WriteCommand, args) }
+    let(:args) { [database_name] }
+
+    let(:dirname) { "#{tmpdir}/current" }
+
+    specify "when the database does not exist" do
+      it "fails"
+      stdout.must_equal ""
+      stderr.must_equal "The database mysql_inspector_test does not exist"
+      status.must_equal 1
+
+      it "does not create a directory"
+      File.directory?(dirname).must_equal false
+    end
+
+    specify "when the database exists" do
+      create_mysql_database schema_a
+
+      it "succeeds"
+      stdout.must_equal ""
+      stderr.must_equal ""
+      status.must_equal 0
+
+      it "creates a directory and files"
+      File.directory?(dirname).must_equal true
+      Dir.glob(dirname + "/*.table").size.must_equal 3
+    end
+  end
+end

data/test/mysql_inspector/config_test.rb

@@ -0,0 +1,14 @@
+require 'helper'
+
+describe MysqlInspector::Config do
+
+  it "uses Access" do
+    config.database_name = "test"
+    config.access.must_be_instance_of MysqlInspector::Access
+  end
+
+  it "uses Dump" do
+    config.create_dump("test").must_be_instance_of MysqlInspector::Dump
+  end
+end
+

data/test/mysql_inspector/diff_test.rb

@@ -0,0 +1,82 @@
+require 'helper'
+
+describe MysqlInspector::Diff do
+
+  let(:current_dump) do
+    mock = MiniTest::Mock.new
+    mock.expect :tables, [
+      MysqlInspector::Table.new(ideas_schema),
+      MysqlInspector::Table.new(colors_schema),
+      MysqlInspector::Table.new(things_schema_1)
+    ]
+    mock
+  end
+
+  let(:target_dump) do
+    mock = MiniTest::Mock.new
+    mock.expect :tables, [
+      MysqlInspector::Table.new(users_schema),
+      MysqlInspector::Table.new(ideas_schema),
+      MysqlInspector::Table.new(things_schema_2)
+    ]
+    mock
+  end
+
+  subject do
+    MysqlInspector::Diff.new(current_dump, target_dump)
+  end
+
+  before do
+    subject.execute
+  end
+
+  def table_names(tables)
+    tables.map { |t| t.table_name }
+  end
+
+  def names(items)
+    items.map { |t| t.name }
+  end
+
+  specify "the types of tables" do
+
+    it "finds tables that were added"
+    table_names(subject.added_tables).must_equal ["users"]
+
+    it "finds tables that are missing"
+    table_names(subject.missing_tables).must_equal ["colors"]
+
+    it "finds tables that are equal"
+    table_names(subject.equal_tables).must_equal ["ideas"]
+
+    it "finds tables that differ"
+    table_names(subject.different_tables).must_equal ["things"]
+  end
+
+  describe "a table that differs" do
+
+    let(:table) { subject.different_tables.first }
+
+    specify "the parts of the table" do
+
+      it "finds the columns that are added"
+      names(table.added_columns).must_equal ["first_name", "last_name"]
+
+      it "finds the columns that are missing"
+      names(table.missing_columns).must_equal ["color"]
+
+      it "finds the indices that are added"
+      names(table.added_indices).must_equal ["name"]
+
+      it "finds the indices that are missing"
+      names(table.missing_indices).must_equal ["color"]
+
+      it "finds the constraints that are added"
+      names(table.added_constraints).must_equal ["belongs_to_user"]
+
+      it "finds the constraints that are missing"
+      names(table.missing_constraints).must_equal ["belongs_to_color"]
+    end
+  end
+
+end