hem 1.0.1.beta1

data/spec/hem/config/file_spec.rb

@@ -0,0 +1,55 @@
+
+describe Hem::Config::File do
+  before do
+    Hem.project_path = nil
+    FakeFS.activate!
+  end
+
+  after do
+    FakeFS::FileSystem.clear
+    FakeFS.deactivate!
+  end
+
+  def fake_config
+    {
+      :string => "string",
+      :integer => 0,
+      :boolean => true,
+      :hash => { :test => true },
+      :array => [ 1 ]
+    }
+  end
+
+  describe "save" do
+    it "should save config hash to specified file" do
+      Hem::Config::File.save "test.yaml", fake_config
+      File.read("test.yaml").should match /string: string/
+    end
+
+    it "should automatically unwrap deepstruct" do
+      Hem::Config::File.save "test.yaml", DeepStruct.wrap(fake_config)
+      File.read("test.yaml").should match /string: string/
+    end
+  end
+
+  describe "load" do
+    it "should wrap loaded config with DeepStruct::HashWrapper" do
+      Hem::Config::File.save "test.yaml", fake_config
+      Hem::Config::File.load("test.yaml").should be_an_instance_of DeepStruct::HashWrapper
+    end
+
+    it "should load config hash from file" do
+      Hem::Config::File.save "test.yaml", fake_config
+      fake_config().should eq Hem::Config::File.load("test.yaml").unwrap
+    end
+
+    it "should return empty config if file does not exist" do
+      Hem::Config::File.load("test.yaml").unwrap.should eq({})
+    end
+
+    it "should raise error if file can't be parsed" do
+      File.write("test.yaml", "##Invalid yaml file")
+      expect { Hem::Config::File.load("test.yaml") }.to raise_error(RuntimeError, "Invalid hem configuration (test.yaml)")
+    end
+  end
+end

data/spec/hem/error_handlers/debug_spec.rb

@@ -0,0 +1,43 @@
+
+describe Hem::ErrorHandlers::Debug do
+  before do
+    Hem.ui = double(Hem::Ui.new).as_null_object
+  end
+
+  def faked_exception(error_template)
+    error = nil
+    begin
+      raise error_template
+    rescue Exception => error
+    end
+
+    return error
+  end
+
+  describe "handle" do
+    it "should dump the error" do
+      error = nil
+      begin
+        raise Exception.new('error_message')
+      rescue Exception => error
+      end
+
+      Hem.ui.should_receive(:error).with(/\(Exception\).*error_message.*debug_spec.rb.*/m)
+      Hem::ErrorHandlers::Debug.new.handle(error)
+    end
+
+    it "should return exit code according to exit_code_map" do
+      File.write("temp_log", "command output")
+      output = Struct.new(:path).new
+      output.path = "temp_log"
+
+      Hem::ErrorHandlers::Debug.new.handle(faked_exception Interrupt.new).should eq 1
+      Hem::ErrorHandlers::Debug.new.handle(faked_exception Hem::ExternalCommandError.new("command", 128, output)).should eq 3
+      Hem::ErrorHandlers::Debug.new.handle(faked_exception Hem::InvalidCommandOrOpt.new("command")).should eq 4
+      Hem::ErrorHandlers::Debug.new.handle(faked_exception Hem::MissingArgumentsError.new("command", ["arg1"])).should eq 5
+      Hem::ErrorHandlers::Debug.new.handle(faked_exception Hem::UserError.new("user error")).should eq 6
+      Hem::ErrorHandlers::Debug.new.handle(faked_exception Hem::ProjectOnlyError.new).should eq 7
+      Hem::ErrorHandlers::Debug.new.handle(faked_exception Exception.new "general").should eq 128
+    end
+  end
+end

data/spec/hem/error_handlers/friendly_spec.rb

@@ -0,0 +1,97 @@
+
+describe Hem::ErrorHandlers::Friendly do
+  before do
+    Hem.ui = double(Hem::Ui.new).as_null_object
+    FakeFS.activate!
+    FileUtils.mkdir '/tmp'
+  end
+
+  after do
+    FakeFS::FileSystem.clear
+    FakeFS.deactivate!
+  end
+
+  def faked_exception(error_template)
+    error = nil
+    begin
+      raise error_template
+    rescue Exception => error
+    end
+
+    return error
+  end
+
+  describe "handle" do
+    it "should display specialized error for Interrupt" do
+      error = faked_exception(Interrupt.new)
+      Hem.ui.should_receive(:warning).with(/Caught Interrupt/)
+      Hem::ErrorHandlers::Friendly.new.handle(error)
+    end
+
+    it "should display specialized error for an external command error" do
+      File.write("temp_log", "command output")
+      output = Struct.new(:path).new
+      output.path = "temp_log"
+
+      error = faked_exception Hem::ExternalCommandError.new("command", 128, output)
+
+      Hem.ui.should_receive(:error).with(/The following external command appears to have failed \(exit status 128\)/)
+      Hem::ErrorHandlers::Friendly.new.handle(error)
+    end
+
+    it "should write command output to /tmp/hem_error.log for external command error" do
+      File.write("temp_log", "command output")
+      output = Struct.new(:path).new
+      output.path = "temp_log"
+
+      error = faked_exception Hem::ExternalCommandError.new("command", 128, output)
+
+      Hem::ErrorHandlers::Friendly.new.handle(error)
+      File.read(File.join(Dir.tmpdir, 'hem_error.log')).should match "command output"
+    end
+
+    it "should display specialized error for invalid command or opt error" do
+      error = faked_exception Hem::InvalidCommandOrOpt.new("command")
+      Hem.ui.should_receive(:error).with(/Invalid command or option specified: 'command'/)
+      Hem::ErrorHandlers::Friendly.new.handle(error)
+    end
+
+    it "should display specialized error for missing argument error" do
+      error = faked_exception Hem::MissingArgumentsError.new("command", ["arg1"])
+      Hem.ui.should_receive(:error).with(/Not enough arguments for command/)
+      Hem::ErrorHandlers::Friendly.new.handle(error)
+    end
+
+    it "should display specialized error for user error" do
+      error = faked_exception Hem::UserError.new("user error")
+      Hem.ui.should_receive(:error).with(/user error/)
+      Hem::ErrorHandlers::Friendly.new.handle(error)
+    end
+
+    it "should display generic error for other exception" do
+      error = faked_exception Exception.new("general error")
+      Hem.ui.should_receive(:error).with(/An unexpected error has occured/)
+      Hem::ErrorHandlers::Friendly.new.handle(error)
+    end
+
+    it "should write error backtrace to /tmp/hem_error.log for other exception" do
+      error = faked_exception Exception.new("general error")
+      Hem::ErrorHandlers::Friendly.new.handle(error)
+      File.read(File.join(Dir.tmpdir, 'hem_error.log')).should match /\(Exception\) general error/
+    end
+
+    it "should return exit code according to exit_code_map" do
+      File.write("temp_log", "command output")
+      output = Struct.new(:path).new
+      output.path = "temp_log"
+
+      Hem::ErrorHandlers::Friendly.new.handle(faked_exception Interrupt.new).should eq 1
+      Hem::ErrorHandlers::Friendly.new.handle(faked_exception Hem::ExternalCommandError.new("command", 128, output)).should eq 3
+      Hem::ErrorHandlers::Friendly.new.handle(faked_exception Hem::InvalidCommandOrOpt.new("command")).should eq 4
+      Hem::ErrorHandlers::Friendly.new.handle(faked_exception Hem::MissingArgumentsError.new("command", ["arg1"])).should eq 5
+      Hem::ErrorHandlers::Friendly.new.handle(faked_exception Hem::UserError.new("user error")).should eq 6
+      Hem::ErrorHandlers::Friendly.new.handle(faked_exception Hem::ProjectOnlyError.new).should eq 7
+      Hem::ErrorHandlers::Friendly.new.handle(faked_exception Exception.new "general").should eq 128
+    end
+  end
+end

data/spec/hem/help_formatter_spec.rb

@@ -0,0 +1,162 @@
+
+describe Hem::HelpFormatter do
+  help = nil
+  slop = nil
+
+  before do
+    map = {}
+    slop = Slop.new
+    slop.instance_eval do
+      opt "-g", "--global", "Global option"
+
+      map["test"] = command "test" do
+        description "Testing1"
+        opt "-t", "--test", "Test description", :invertable => true
+        opt "-x", "--longer-option", "Longer option"
+
+        map["test:test"] = command "test" do
+         description "Testing2"
+         arg_list [:arg]
+         opt "-a=", "--a-test=", "Arg with value"
+         opt "-b=", "--b-test=", "Arg with optional value", argument: :optional
+        end
+
+        map["test:long_desc"] = command "long_desc" do
+          long_description "This is a long_desc"
+        end
+
+        map["test:desc"] = command "desc" do
+          description "This is a desc"
+        end
+
+        map["test:no_desc"] = command "no_desc" do
+          description nil
+        end
+      end
+    end
+
+    help = Hem::HelpFormatter.new slop
+    help.command_map = map
+    Hem.ui = Hem::Ui.new
+    Hem.ui.use_color false
+  end
+
+  describe "help" do
+
+    it "should return global help if no target passed" do
+      help.help.should match(/test\s+Testing1/)
+    end
+
+    it "should return command help if target passed" do
+      help.help(target: "test").should match /^Testing1$/
+    end
+
+    describe "usage format" do
+      it "should include generic usage for global help" do
+        help.help.should match /Usage:\n\s+rspec \[command\] \[options\]/
+      end
+
+      it "should include command usage for command help" do
+        help.help(target: "test:test").should match /Usage:\n\s+rspec test test <arg> \[options\]/
+      end
+    end
+
+    describe "option format" do
+      it "should include short, long and description" do
+        help.help(target: "test").should match /\s+-t, --test\s+Test description/
+      end
+
+      it "should append token value to options that take an argument" do
+        help.help(target: "test:test").should match /--a-test=A-TEST/
+      end
+
+      it "should surround token value qith square brackets for option with optional argument" do
+        help.help(target: "test:test").should match /--b-test=\[B-TEST\]/
+      end
+
+      it "should have description aligned to longest option or command" do
+        len = "--longer-option".length - "--test".length + 4 # ALIGN_PAD
+        help.help(target: "test").should match /\s+-t, --test\s{#{len}}Test description/
+      end
+
+      it "should include invertable note if option is invertable" do
+        help.help(target: "test").should match /--test.*\(Disable with --no-test\)/
+      end
+    end
+
+    describe "command format" do
+      it "should have name and description" do
+        help.help.should match /\s+test\s+Testing1/
+      end
+    end
+
+    describe "global" do
+      it "should include usage" do
+        help.help.should match /Usage:/
+      end
+
+      it "should include global options" do
+        help.help.should match /Global options:\n\s+-g/
+      end
+
+      it "should include top level command list" do
+        help.help.should match /Commands:\n\s+test/
+      end
+    end
+
+    describe "namespace" do
+      it "should include usage" do
+        help.help(target: "test").should match /Usage:/
+      end
+
+      it "should include global options" do
+        help.help(target: "test").should match /Global options:/
+      end
+
+      it "should include namespace level command list" do
+        help.help(target: "test").should match /Commands:/
+      end
+    end
+
+    describe "command" do
+      it "should include long command description if set" do
+        help.help(target: "test:long_desc").should match /^\s+This is a long_desc/
+      end
+
+      it "should fall back to short command description if long description not set" do
+        help.help(target: "test:desc").should match /^\s+This is a desc/
+      end
+
+      it "should not display extra blank lines if no description set" do
+        help.help(target: "test:no_desc").should match /^Usage/m
+      end
+
+      it "should include usage" do
+        help.help(target: "test:no_desc").should match /Usage:/
+      end
+
+      it "should include global options" do
+        help.help(target: "test:test").should match /^Global options:/
+      end
+
+      it "should include command options" do
+        help.help(target: "test:test").should match /^Command options:/
+      end
+
+      it "should not include -h command option" do
+        help.help(target: "test:test").should_not match /Command options:.*--help/m
+      end
+    end
+
+
+    describe "filtering" do
+      it "should not show commands that do not have descriptions" do
+        help.help(target: "test").should_not match /Commands:.*no_desc/m
+      end
+
+      it "should show commands that do not have descriptions if :all is set" do
+        help.help(target: "test", all: true).should match /Commands:.*no_desc/m
+      end
+    end
+  end
+end

data/spec/hem/helpers/file_locator_spec.rb

@@ -0,0 +1,11 @@
+
+describe Hem::Helper do
+  describe "locate" do
+    it "should yield filename and path for matches"
+    it "should match files in git"
+    it "should fallback to files not in git if no matches from git"
+    it "should chdir to file path before yielding"
+    it "should yield once for each matching file"
+    it "should return path array if block not supplied"
+  end
+end

data/spec/hem/helpers/github_spec.rb

@@ -0,0 +1,31 @@
+
+describe Hem::Helper do
+  describe 'parse_github_url' do
+
+    it 'should return the parts of a git protocol url' do
+      url = 'git://github.com/foo/bar'
+      expect(parse_github_url(url)).to eq({:owner => 'foo', :repo => 'bar'})
+    end
+
+    it 'should return the parts of an https url' do
+      url = 'https://github.com/foo/bar'
+      expect(parse_github_url(url)).to eq({:owner => 'foo', :repo => 'bar'})
+    end
+
+    it 'should return the parts of a git ssh url' do
+      url = 'git@github.com:foo/bar'
+      expect(parse_github_url(url)).to eq({:owner => 'foo', :repo => 'bar'})
+    end
+
+    it 'should trim the .git https url ending if present' do
+      url = 'https://github.com/foo/bar.git'
+      expect(parse_github_url(url)).to eq({:owner => 'foo', :repo => 'bar'})
+    end
+
+    it 'should trim the .git ssh url ending if present' do
+      url = 'git@github.com:foo/bar.git'
+      expect(parse_github_url(url)).to eq({:owner => 'foo', :repo => 'bar'})
+    end
+
+  end
+end

data/spec/hem/helpers/shell_spec.rb

@@ -0,0 +1,22 @@
+
+describe Hem::Helper do
+  describe "bundle_shell" do
+    it "should execute command with bundle exec if bundle present"
+    it "should execte command normally if no bundle present"
+  end
+
+  describe "shell" do
+    it "should run the specified external command"
+    it "should return captured output if :capture specified"
+    it "should display output if :realtime specified"
+    it "should indent output if :realtime and :indent specified"
+    it "should apply block to each line if block passed"
+    it "should not display lines for which the filter block returned nil"
+    it "should buffer all command output in a temporary file"
+    it "should throw Hem::ExternalCommandError on non-zero exit code"
+    it "should colour stderr output with red"
+    it "should set ENV args for command if specified with :env"
+    it "should strip leading and trailing whitespace in captured output"
+    it "should preserve whitespace in captured output if :strip false"
+  end
+end

data/spec/hem/helpers/vm_command_spec.rb

@@ -0,0 +1,96 @@
+
+describe Hem::Helper do
+  before do
+    Hem.project_config = DeepStruct.wrap({
+      :hostname => "test_hostname",
+      :mysql => {
+        :username => "test_user",
+        :password => "test_pass"
+      },
+      :vm => {
+        :project_mount_path => '/'
+      }
+    })
+
+    Hem.ui = Hem::Ui.new
+
+    vmi_double = double(Hem::Lib::Vm::Inspector).as_null_object
+    vmi_double.should_receive(:ssh_config).and_return({
+      :ssh_host => 'fakehost',
+      :ssh_user => 'fakeuser',
+      :ssh_port => '999',
+      :ssh_identity => 'fakeidentity'
+    })
+
+    Hem::Lib::Vm::Command.class_eval do
+      class_variable_set '@@vm_inspector', vmi_double
+    end
+  end
+
+  describe "vm_command" do
+    it "should create a new vm command wrapper with specified command" do
+      vm_command("my_command", :pwd => '/').to_s.should match /-c my_command/
+    end
+
+    it "should default to not using a psuedo tty" do
+      vm_command("my_command", :pwd => '/').to_s.should_not match /\s-t\s/
+    end
+
+    it "should default to ssh_config user" do
+      vm_command("my_command", :pwd => '/').to_s.should match /fakeuser@/
+    end
+
+    it "should default to ssh_config host name" do
+      vm_command("my_command", :pwd => '/').to_s.should match /@fakehost/
+    end
+
+    it "should not wrap piped commands with echo by default" do
+      c = vm_command("my_command", :pwd => '/')
+      c << "test"
+      c.to_s.should_not match /^echo test/
+    end
+  end
+
+  describe "vm_mysql" do
+    it "should use mysql command by default" do
+      vm_mysql(:pwd => '/').to_s.should match /-c mysql/
+    end
+
+    it "should use project config mysql username & password if set" do
+      vm_mysql(:pwd => '/').to_s.should match /-c mysql.*-utest_user.*-ptest_pass/
+    end
+
+    it "should not pass user / pass if project config mysql credentials not set" do
+      Hem.project_config = DeepStruct.wrap({})
+      vm_mysql(:pwd => '/').to_s.should match /-c mysql'/
+    end
+
+    it "should allow specifying the database in options" do
+      vm_mysql(:pwd => '/', :db => "test_db").to_s.should match /-c mysql.*test_db'/
+    end
+
+    it "should enable auto echo of piped commands" do
+      c = vm_mysql(:pwd => '/')
+      c << "SELECT 1"
+      c.to_s.should match /^echo SELECT\\ 1/
+    end
+  end
+
+  describe "vm_shell" do
+    it "should execute the command using the shell helper" do
+      Hem::Helper.class_eval do
+        alias :old_shell :shell
+        def shell command, opts
+          command.to_s.should match /ssh.* -c my_command/
+        end
+      end
+
+      vm_shell "my_command", :pwd => '/'
+
+      Hem::Helper.class_eval do
+        remove_method :shell
+        alias :shell :old_shell
+      end
+    end
+  end
+end

data/spec/hem/lib/github/api_spec.rb

@@ -0,0 +1,92 @@
+
+describe Hem::Lib::Github::Api do
+
+  default_config = {}
+  token = 'abcdabcdabcdabcdabcdabcdabcdabcdabcdabcd'
+
+  before do
+    default_config = {
+      :ui => double(Hem::Ui).as_null_object,
+      :user_config => {},
+      :client => double(Hem::Lib::Github::Client).as_null_object,
+      :config_class => double(Hem::Config::File).as_null_object
+    }
+  end
+
+  describe 'connect' do
+
+    it 'should request credentials if a token is not saved' do
+      expect(default_config[:ui]).to receive(:info).with(kind_of(String))
+      expect(default_config[:ui]).to receive(:ask).with('Github username')
+      expect(default_config[:ui]).to receive(:ask).with('Github password', echo: false)
+
+      api = Hem::Lib::Github::Api.new(default_config)
+      api.connect
+    end
+
+    it 'should use the credentials to request a token' do
+      allow(default_config[:ui]).to receive(:ask).and_return('username', 'password')
+      expect(default_config[:client]).to receive(:get_token_for_credentials).with('username', 'password')
+
+      api = Hem::Lib::Github::Api.new(default_config)
+      api.connect
+    end
+
+    it 'should save a new token to user config' do
+      allow(default_config[:client]).to receive(:get_token_for_credentials).and_return(token)
+      expect(default_config[:config_class]).to receive(:save).with(Hem.user_config_file, {
+        :github => {
+          :token => token
+        }
+      })
+
+      api = Hem::Lib::Github::Api.new(default_config)
+      api.connect
+    end
+
+    it 'should use a stored token if one is found' do
+      default_config[:user_config] = {
+        :github => {
+          :token => token
+        }
+      }
+
+      expect(default_config[:client]).to receive(:authenticate_with_token).with(token)
+
+      api = Hem::Lib::Github::Api.new(default_config)
+      api.connect
+    end
+
+  end
+
+  describe 'create_pull_request' do
+
+    it 'should create a pull request if connected' do
+      default_config[:user_config] = {
+        :github => {
+          :token => token
+        }
+      }
+
+      expect(default_config[:client]).to receive(:create_pull_request).with('repo', 'source', 'target', 'title', 'body')
+
+      api = Hem::Lib::Github::Api.new(default_config)
+      api.create_pull_request('repo', 'source', 'target', 'title', 'body')
+    end
+
+    it 'should return the url to the pull request' do
+      default_config[:user_config] = {
+        :github => {
+          :token => token
+        }
+      }
+
+      allow(default_config[:client]).to receive(:create_pull_request).and_return('url')
+
+      api = Hem::Lib::Github::Api.new(default_config)
+      expect(api.create_pull_request('repo', 'source', 'target', 'title', 'body')).to eq('url')
+    end
+
+  end
+
+end

data/spec/hem/lib/s3/sync_spec.rb

@@ -0,0 +1,16 @@
+
+describe Hem::Lib::S3::Sync do
+  before do
+    AWS.stub!
+  end
+
+  describe "sync" do
+    it "should synchronize s3 files to local"
+    it "should synchronize local files to s3"
+    it "should add files that only exist in source"
+    it "should update files that have changed"
+    it "should remove files that do not exist in source"
+    it "should keep files that do not exist in source if :delete false"
+    it "should update progress as files are transferred"
+  end
+end