ruby_yacht 0.1.0

data/spec/runner/run_containers_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+
+describe RubyYacht::Runner::RunContainers do
+  include DockerCommandSpec
+  
+  describe "command information" do
+    specify { expect(described_class.command).to eq 'run_containers' }
+    specify { expect(described_class.description).to eq 'Runs containers for all the apps' }
+  end
+  
+  describe "run behavior" do
+    before do
+      allow(subject).to receive(:remove_container)
+    end
+    
+    it "runs the containers for all the apps" do
+      docker.fail_unexpected_commands!
+      docker.expect 'run -d --net=apollo --net-alias=apollo-mars --name=apollo-mars apollo-mars'
+      docker.expect 'run -d --net=apollo --net-alias=apollo-saturn --name=apollo-saturn apollo-saturn'
+      docker.expect 'run -d -p 80:80 --net=apollo --net-alias=apollo-web --name=apollo-web apollo-web'
+      subject.run
+    end
+    
+    it "tries to remove all the containers" do
+      subject.run
+      expect(subject).to have_received(:remove_container).with('apollo-mars')
+      expect(subject).to have_received(:remove_container).with('apollo-saturn')
+      expect(subject).to have_received(:remove_container).with('apollo-web')
+    end
+    
+    it "returns true" do
+      expect(subject.run).to be_truthy
+    end
+    
+    context "with a deploy container" do
+      before do
+        RubyYacht.configuration.projects.first.create_deploy_container = true
+      end
+      
+      it "runs the deploy container" do
+        docker.expect 'run -d -it --net=apollo --net-alias=apollo-deploy --name=apollo-deploy apollo-deploy'
+        subject.run
+      end
+    
+      it "returns true" do
+        expect(subject.run).to be_truthy
+      end
+    end
+    
+    context "with a local database" do
+      before do
+        RubyYacht.configuration.projects.first.database.host = 'localhost'
+      end
+      
+      it "runs the database container" do
+        docker.expect 'run -d --net=apollo --net-alias=apollo-database --name=apollo-database apollo-database'
+        subject.run
+      end
+    
+      it "returns true" do
+        expect(subject.run).to be_truthy
+      end
+    end
+    
+    context "with multiple projects" do
+      before do
+        RubyYacht.configure_second_test_project
+      end
+      
+      it "runs the containers for both projects" do
+      docker.fail_unexpected_commands!
+      docker.expect 'run -d --net=apollo --net-alias=apollo-mars --name=apollo-mars apollo-mars'
+      docker.expect 'run -d --net=apollo --net-alias=apollo-saturn --name=apollo-saturn apollo-saturn'
+      docker.expect 'run -d --net=apollo --net-alias=jupiter-venus --name=jupiter-venus jupiter-venus'
+      docker.expect 'run -d --net=apollo --net-alias=jupiter-saturn --name=jupiter-saturn jupiter-saturn'
+      docker.expect 'run -d -p 80:80 --net=apollo --net-alias=apollo-web --name=apollo-web apollo-web'
+      subject.run
+      end
+    
+      it "returns true" do
+        expect(subject.run).to be_truthy
+      end
+    end
+    
+    context "with DNS server config" do
+      before do
+        project = RubyYacht.configuration.projects.first
+        project.dns_server = RubyYacht::DnsServer.new
+        project.dns_server.servers = ['8.10.1.1', '8.10.1.2']
+        project.dns_server.search_domains = ['apps.test.com', 'db.test.com']
+      end
+      
+      it "gives the DNS information to the docker container" do
+        docker.expect 'run -d --dns=8.10.1.1 --dns=8.10.1.2 --dns-search=apps.test.com --dns-search=db.test.com --net=apollo --net-alias=apollo-mars --name=apollo-mars apollo-mars'
+        subject.run
+      end
+    
+      it "returns true" do
+        expect(subject.run).to be_truthy
+      end
+    end
+    
+    context "when checking out the code locally" do
+      before do
+        RubyYacht.configuration.projects.first.check_out_locally = true
+      end
+      
+      it "maps the code volume to a local directory" do
+        docker.expect 'run -d -v $PWD/../code/mars:/var/code --net=apollo --net-alias=apollo-mars --name=apollo-mars apollo-mars'
+        docker.expect 'run -d -v $PWD/../code/saturn:/var/code --net=apollo --net-alias=apollo-saturn --name=apollo-saturn apollo-saturn'
+        subject.run
+      end
+    
+      it "returns true" do
+        expect(subject.run).to be_truthy
+      end
+      
+      context "when creating a deploy container" do
+        before do
+          RubyYacht.configuration.projects.first.create_deploy_container = true
+        end
+        it "maps the code volume to a local directory" do
+          docker.expect 'run -d -v $PWD/../code:/var/code -it --net=apollo --net-alias=apollo-deploy --name=apollo-deploy apollo-deploy'
+          subject.run
+        end
+    
+      it "returns true" do
+        expect(subject.run).to be_truthy
+      end
+      end
+    end
+  end
+  
+  describe "remove_container" do
+    it "sends the command to docker" do
+      allow(IO).to receive(:popen)
+      subject.remove_container('apollo-mars')
+      expect(IO).to have_received(:popen).with('docker rm -f apollo-mars', err: :close)
+    end
+  end
+end

data/spec/runner/runner_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+describe RubyYacht::Runner do
+  before do
+    allow(described_class).to receive(:puts)
+    allow(described_class).to receive(:exit)
+  end
+  
+  describe "commands" do
+    it "contains all the defined commands" do
+      commands = ObjectSpace.each_object(Class).select { |klass| klass < RubyYacht::Runner::Command && klass.inspect =~ /^RubyYacht::Runner/ }.uniq
+      expect(described_class.commands.sort_by(&:name)).to eq commands.sort_by(&:name)
+    end
+  end
+  
+  describe "arguments" do
+    it "gets the command-line arguments" do
+      expect(described_class.arguments).to eq ARGV
+    end
+  end
+  
+  describe "run" do
+    let(:command) { RubyYacht::Runner::Checkout.new }
+    before do
+      allow(described_class).to receive(:arguments).and_return %w(checkout -p apollo mars issue1234)
+      allow(command).to receive(:run)
+      allow(RubyYacht::Runner::Checkout).to receive(:new).and_return(command)
+      RubyYacht.configure_test_project
+    end
+    
+    context "with a valid command" do
+      context "with a successful command" do
+        before do
+          allow(command).to receive(:run).and_return(true)
+          described_class.run
+        end
+        
+        it "calls the command" do
+          expect(command.project_name).to eq :apollo
+          expect(command.app).to eq 'mars'
+          expect(command.branch).to eq 'issue1234'
+          expect(command).to have_received(:run)
+        end
+        
+        it "does not exit" do
+          expect(described_class).not_to have_received(:exit)
+        end
+      end
+      
+      context "with a failed command" do
+        before do
+          allow(command).to receive(:run).and_return(false)
+          described_class.run
+        end
+        
+        it "calls the command" do
+          expect(command).to have_received(:run)
+        end
+        
+        it "exits with a failure code" do
+          expect(described_class).to have_received(:exit).with(1)
+        end
+      end
+    end
+    
+    context "with a nil command" do
+      before do
+        allow(described_class).to receive(:arguments).and_return []
+        described_class.run
+      end
+      
+      it "logs a message" do
+        invocation = $0
+        expect(described_class).to have_received(:puts).with("You must provide a command to run")
+        expect(described_class).to have_received(:puts).with("Run `#{invocation} help` for more information")
+      end
+      
+      it "exits with a failure code" do
+        expect(described_class).to have_received(:exit).with(1)
+      end
+    end
+    
+    context "with a blank command" do
+      before do
+        allow(described_class).to receive(:arguments).and_return ['']
+        described_class.run
+      end
+      
+      it "logs a message" do
+        invocation = $0
+        expect(described_class).to have_received(:puts).with("You must provide a command to run")
+        expect(described_class).to have_received(:puts).with("Run `#{invocation} help` for more information")
+      end
+      
+      it "exits with a failure code" do
+        expect(described_class).to have_received(:exit).with(1)
+      end
+    end
+    
+    context "with an invalid command" do
+      before do
+        allow(described_class).to receive(:arguments).and_return %w(foo bar)
+        described_class.run
+      end
+      
+      it "logs a message" do
+        invocation = $0
+        expect(described_class).to have_received(:puts).with("Command not recognized: foo")
+        expect(described_class).to have_received(:puts).with("Run `#{invocation} help` for more information")
+      end
+      
+      it "exits with a failure code" do
+        expect(described_class).to have_received(:exit).with(1)
+      end
+    end
+  end
+end

data/spec/runner/services_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe RubyYacht::Runner::Services do
+  include DockerCommandSpec
+  
+  describe "command information" do
+    specify { expect(described_class.command).to eq 'services' }
+    specify { expect(described_class.description).to eq 'Start, stop, or restart containers' }
+    
+    it "has a banner with more information about the command" do
+      usage = "Usage: rspec services [COMMAND]"
+      usage += "\n\nStart, stop, or restart containers"
+      usage += "\n\n[COMMAND] is required, and can be start, stop, or restart"
+      expect(subject.option_parser.banner).to eq usage
+    end
+    
+    it "gets the command from position arguments" do
+      subject.parse_positional_arguments(["restart", "foo"])
+      expect(subject.command).to eq 'restart'
+    end
+  end
+  
+  describe "run behavior" do
+    before do
+      subject.command = 'stop'
+    end
+    
+    it "sends the command to each container" do
+      docker.fail_unexpected_commands!
+      docker.expect 'stop apollo-mars'
+      docker.expect 'stop apollo-saturn'
+      docker.expect 'stop apollo-web'
+      subject.run
+    end
+    
+    it "returns true" do
+      expect(subject.run).to be_truthy
+    end
+    
+    context "with a local database" do
+      before do
+        RubyYacht.configuration.projects.first.database.host = 'localhost'
+      end
+      
+      it "stops the database" do
+        docker.expect 'stop apollo-database'
+        subject.run
+      end
+    
+      it "returns true" do
+        expect(subject.run).to be_truthy
+      end
+    end
+    
+    context "with a docker machine" do
+      before do
+        allow(subject).to receive(:backtick).with('which docker-machine').and_return '/usr/bin/docker-machine'
+        allow(subject).to receive(:backtick).with('docker-machine env default').and_return "# Test\nexport TEST_VAL=\"123\""
+        ENV.delete('TEST_VAL')
+      end
+      
+      after do
+        ENV.delete('TEST_VAL')
+      end
+      
+      context "with the start command" do
+        before do
+          subject.command = 'start'
+        end
+        
+        it "starts the docker machine" do
+          subject.run
+          expect(@system_commands).to eq ['docker-machine start default']
+          expect(ENV['TEST_VAL']).to eq '123'
+        end
+    
+        it "returns true" do
+          expect(subject.run).to be_truthy
+        end
+      end
+      
+      context "with the stop command" do
+        before do
+          subject.command = 'stop'
+        end
+        
+        it "does not send a message to docker machine" do
+          subject.run
+          expect(@system_commands).to eq []
+          expect(ENV['TEST_VAL']).to be_nil
+        end
+    
+        it "returns true" do
+          expect(subject.run).to be_truthy
+        end
+      end
+    end
+    
+    context "with no command" do
+      before do
+        subject.command = nil
+      end
+      
+      it "logs error messages" do
+        subject.run
+        expect(@log_entries).to eq [
+          "You must provide a command",
+          "Run rspec help services for more information"
+        ]
+      end
+      
+      it "returns false" do
+        expect(subject.run).to be_falsey
+      end
+    end
+    
+    context "with an invalid command" do
+      before do
+        subject.command = 'foo'
+      end
+      
+      it "logs error messages" do
+        subject.run
+        expect(@log_entries).to eq [
+          "foo is not a valid docker command",
+          "Run rspec help services for more information"
+        ]
+      end
+      
+      it "returns false" do
+        expect(subject.run).to be_falsey
+      end
+    end
+  end
+end

data/spec/runner/shell_spec.rb

@@ -0,0 +1,123 @@
+require 'spec_helper'
+
+describe RubyYacht::Runner::Shell do
+  include DockerCommandSpec
+  
+  describe "command information" do
+    specify { expect(described_class.command).to eq 'shell' }
+    specify { expect(described_class.description).to eq 'Open a shell in a container' }
+    
+    describe "option parser" do
+      it "has the usage banner" do
+        expect(subject.option_parser.banner).to eq "Usage: rspec shell [options] [APP] [command]"
+      end
+      
+      it "has the usage summary" do
+        usage = ["\n"]
+        usage << "The command is optional. If you omit it, this will open a bash shell\n"
+        usage << "\n"
+        usage << "Options:\n"
+        usage << "    -p, --project PROJECT            The project with the app we are opening the sell in. Default: apollo\n"
+        expect(subject.option_parser.summarize).to eq usage
+      end
+      
+      it "takes the project from the command line" do
+        arguments = ["-p", "jupiter", "venus"]
+        subject.option_parser.parse!(arguments)
+        expect(subject.project_name).to eq :jupiter
+        expect(arguments).to eq ["venus"]
+      end
+    end
+    
+    describe "parse_positional_arguments" do
+      it "takes the app from the command line" do
+        subject.parse_positional_arguments(["venus", "rails", "c"])
+        expect(subject.app).to eq "venus"
+      end
+      
+      it "takes the command from the command line" do
+        subject.parse_positional_arguments(["venus", "rails", "c"])
+        expect(subject.command).to eq "rails c"
+      end
+      
+      it "defaults the command to bash" do
+        subject.parse_positional_arguments(["venus"])
+        expect(subject.command).to eq "bash"
+      end
+    end
+  end
+  
+  describe "run behavior" do
+    before do
+      subject.app = 'saturn'
+      subject.command = 'rails c'
+      RubyYacht.configure_second_test_project
+      allow(subject).to receive :exec
+    end
+    
+    describe "default_project" do
+      it "is the first project defined" do
+        expect(subject.default_project.name).to eq :apollo
+      end
+    end
+    
+    it "opens the shell in docker" do
+      subject.run
+      expect(subject).to have_received(:exec).with("docker exec -it apollo-saturn bash -c 'cd /var/code; TERM=xterm rails c'")
+    end
+    
+    it "returns true" do
+      expect(subject.run).to be_truthy
+    end
+    
+    context "with no app" do
+      before do
+        subject.app = nil
+      end
+      
+      it "logs an error" do
+        subject.run
+        expect(@log_entries).to eq [
+          "You must provide an app name",
+          "Run rspec help shell for more information"
+        ]
+      end
+      
+      it "returns false" do
+        expect(subject.run).to be_falsey
+      end
+    end
+    
+    context "with a specific project" do
+      before do
+        subject.project_name = :jupiter
+      end
+      
+      it "opens the shell in that project" do
+        subject.run
+        expect(subject).to have_received(:exec).with("docker exec -it jupiter-saturn bash -c 'cd /var/code; TERM=xterm rails c'")
+      end
+    
+      it "returns true" do
+        expect(subject.run).to be_truthy
+      end
+    end
+    
+    context "with an invalid project name" do
+      before do
+        subject.project_name = 'foo'
+      end
+      
+      it "logs an error" do
+        subject.run
+        expect(@log_entries).to eq [
+          "There is no project named foo"
+        ]
+      end
+      
+      it "returns false" do
+        expect(subject.run).to be_falsey
+      end
+    end
+  end
+end

data/spec/runner/update_hosts_spec.rb

@@ -0,0 +1,163 @@
+require 'spec_helper'
+require 'timecop'
+
+describe RubyYacht::Runner::UpdateHosts do
+  include DockerCommandSpec
+  
+  describe "command information" do
+    specify { expect(described_class.command).to eq 'update_hosts' }
+    specify { expect(described_class.description).to eq 'Add entries for your app domains to your hosts file' }
+  end
+  
+  describe "current_host_contents" do
+    it "is the contents of the hosts file" do
+      expect(subject.current_host_contents).to eq File.read('/etc/hosts')
+    end
+  end
+  
+  describe "run behavior" do
+    before do
+      allow(subject).to receive("current_host_contents").and_return(<<-EOS.gsub(/^ +/, '')
+      # Local information
+      127.0.0.1 localhost
+      
+      # Database server
+      
+      40.1.30.10 db1.test.com
+      EOS
+      )
+      
+      allow(subject).to receive("get_machine_info").with('.Driver.IPAddress').and_return('192.168.1.27')
+      Timecop.freeze
+    end
+    
+    after do
+      FileUtils.rm(File.join('tmp', 'hosts'))
+      Timecop.return
+    end
+    
+    it "adds the entries to the hosts file in the tmp folder" do
+      subject.run
+      expect(File.exist?(File.join('tmp', 'hosts'))).to be_truthy
+      
+      contents = File.read(File.join('tmp', 'hosts'))
+      expect(contents).to eq <<-EOS.gsub(/^ +/, '').strip
+      # Local information
+      127.0.0.1 localhost
+      
+      # Database server
+      
+      40.1.30.10 db1.test.com
+      
+      # apollo docker containers
+      192.168.1.27    apollo.test.com
+      192.168.1.27    mars.apollo.test.com
+      192.168.1.27    saturn.apollo.test.com
+      EOS
+      
+    end
+    
+    it "copies the hosts file to a backup, and the tmp hosts file to the hosts file" do
+      timestamp = Time.now.utc.strftime('%Y%m%d%H%M%S')
+      subject.run
+      expect(@system_commands).to eq ["sudo cp /etc/hosts /etc/hosts.#{timestamp}.backup", "sudo mv tmp/hosts /etc/hosts"]
+    end
+    
+    it "returns true" do
+      expect(subject.run).to be_truthy
+    end
+    
+    context "with existing entries in the hosts file" do
+      before do        
+        allow(subject).to receive("current_host_contents").and_return(<<-EOS.gsub(/^ +/, '')
+        # Local information
+        127.0.0.1 localhost
+        
+        # Database server
+        
+        40.1.30.10 db1.test.com
+        
+        # apollo docker containers
+        192.168.1.24 apollo.test.com
+        192.168.1.24 mars.apollo.test.com
+        192.168.1.24 venus.apollo.test.com
+        EOS
+        )
+      end
+      
+      it "replaces the existing entries with the correct entries" do
+        subject.run
+        
+        contents = File.read(File.join('tmp', 'hosts'))
+        expect(contents).to eq <<-EOS.gsub(/^ +/, '').strip
+        # Local information
+        127.0.0.1 localhost
+        
+        # Database server
+        
+        40.1.30.10 db1.test.com
+        
+        # apollo docker containers
+        192.168.1.27    apollo.test.com
+        192.168.1.27    mars.apollo.test.com
+        192.168.1.27    saturn.apollo.test.com
+        EOS
+      end
+    end
+    
+    context "with no address from docker machine" do
+      before do
+        allow(subject).to receive("get_machine_info").with('.Driver.IPAddress').and_return('')
+      end
+      
+      it "points the domains to localhost" do
+        subject.run
+        
+        contents = File.read(File.join('tmp', 'hosts'))
+        expect(contents).to eq <<-EOS.gsub(/^ +/, '').strip
+        # Local information
+        127.0.0.1 localhost
+        
+        # Database server
+        
+        40.1.30.10 db1.test.com
+        
+        # apollo docker containers
+        127.0.0.1    apollo.test.com
+        127.0.0.1    mars.apollo.test.com
+        127.0.0.1    saturn.apollo.test.com
+        EOS
+      end
+    end
+    
+    context "with multiple projects" do
+      before do
+        RubyYacht.configure_second_test_project
+      end
+      
+      it "creates entries for both projects" do
+        subject.run
+        
+        contents = File.read(File.join('tmp', 'hosts'))
+        expect(contents).to eq <<-EOS.gsub(/^ +/, '').strip
+        # Local information
+        127.0.0.1 localhost
+        
+        # Database server
+        
+        40.1.30.10 db1.test.com
+        
+        # apollo docker containers
+        192.168.1.27    apollo.test.com
+        192.168.1.27    mars.apollo.test.com
+        192.168.1.27    saturn.apollo.test.com
+        
+        # jupiter docker containers
+        192.168.1.27    jupiter.test.com
+        192.168.1.27    venus.jupiter.test.com
+        192.168.1.27    saturn.jupiter.test.com
+        EOS
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+SimpleCov.start do
+  coverage_dir 'doc/coverage'
+  add_filter './spec'
+end
+
+require 'ruby_yacht'
+
+Dir[File.join('.', 'spec', 'support', '**', '*.rb')].each { |f| require f }