ruby_yacht 0.5.0 → 0.6.0

data/lib/ruby_yacht/runner/create_new_project.rb

@@ -0,0 +1,91 @@
+require 'fileutils'
+
+module RubyYacht::Runner
+  # This command provides help information about other commands.
+  class CreateNewProject < Command
+    # The name of the command.
+    def self.command; 'new'; end
+
+    # The short description of the command.
+    def self.description
+      'Create a new ruby-yacht project'
+    end
+
+    # The project that we are creating.
+    attr_accessor :project
+
+    # The directory where we should place the config.
+    attr_accessor :directory
+
+    # This method gets the command-line options for the command.
+    def option_parser
+      OptionParser.new do |options|
+        options.banner = "Usage: #{Command.short_script_name} new [PROJECT] [DIRECTORY]\n\n#{self.class.description}"
+      end
+    end
+
+    # This method extracts arguments from the command line.
+    #
+    # ### Parameters
+    #
+    # * **arguments: Array**    The command line arguments.
+    def parse_positional_arguments(arguments)
+      self.project = arguments.shift
+      self.directory = arguments.shift
+    end 
+
+    # This method runs the logic for the command.
+    def run
+      if project.nil?
+        log 'You must provide a project'
+        log "Run #{Command.short_script_name} help new for more information"
+        return false
+      end
+
+      if directory.nil?
+        log 'You must provide a directory'
+        log "Run #{Command.short_script_name} help new for more information"
+        return false
+      end
+
+      FileUtils.mkdir_p(directory)
+      File.open(File.join(directory, 'run.rb'), 'w') do |file|
+        write_config_file(file)
+      end
+      log "Your project has been created in #{directory}/run.rb."
+      log "You can go to #{directory} and run `ruby run.rb build` to create your docker containers."
+      log "Your initial app will be created in the #{project} directory."
+      true
+    end
+
+    private
+
+    # This method writes the config file for the new project to a file.
+    #
+    # ### Parameters
+    #
+    # * **file: IO**    The file to write to.
+    def write_config_file(file)
+      file.puts "require 'ruby_yacht'"
+      file.puts ''
+      file.puts 'RubyYacht.configure do'
+      file.puts "  project :#{project} do"
+      file.puts "    system_prefix           :#{project}"
+      file.puts "    repository              'github.com'"
+      file.puts "    rails_secret_key_base   'testkey'"
+      file.puts "    check_out_locally"
+      file.puts ""
+      file.puts "    rails_app :#{project}"
+      file.puts ""
+      file.puts "    primary_app :#{project}"
+      file.puts ""
+      file.puts "    nginx_web_server do"
+      file.puts "      domain '#{project}.test.com'"
+      file.puts "    end"
+      file.puts "  end"
+      file.puts "end"
+      file.puts ""
+      file.puts "RubyYacht::Runner.run"
+    end
+  end
+end

data/lib/ruby_yacht/runner/help.rb

@@ -45,7 +45,7 @@ module RubyYacht::Runner
 
       log "Available commands: \n\n"
       RubyYacht::Runner.commands.each do |command|
-        log "#{command.name}: #{command.description}"
+        log "#{command.command}: #{command.description}"
       end
 
       log "\nRun #{Command.short_script_name} help [command] for more information on a command"

data/lib/ruby_yacht/runner/run_containers.rb

@@ -17,18 +17,18 @@ module RubyYacht::Runner
         @project = project
         
         project.databases.select(&:local?).each do |database|
-          run_container database.container_label
+          run_container database
         end
         
         project.apps.each do |app|
-          run_container app.name
+          run_container app
+        end
+
+        project.web_servers.each do |web_server|
+          run_container web_server
         end
       end
       
-      @project = projects.first
-      
-      run_container :web
-      
       true
     end
 
@@ -48,11 +48,11 @@ module RubyYacht::Runner
     #
     # ### Parameters
     #
-    # * **container_name: Symbol**    The name of the container, not including
-    #                                 the system prefix.
-    def volume_flags(container_name)
-      if @project.check_out_locally && ![:database, :web].include?(container_name)
-        return ["-v $PWD/../#{container_name}:/var/code"]
+    # * **server: App/Database/WebServer**    The server we are running a
+    #                                         container for.
+    def volume_flags(server)
+      if @project.check_out_locally && server.is_a?(RubyYacht::App)
+        return ["-v $PWD/../#{server.name}:/var/code"]
       else
         return []
       end
@@ -64,20 +64,16 @@ module RubyYacht::Runner
     #
     # ### Parameters
     #
-    # * **name: Symbol**    The name of the container, not including the system
-    #                       prefix.
-    def run_container(name)
-      if name == @project.system_prefix
-        container_name = name
-      else
-        container_name = "#{@project.system_prefix}-#{name}"
-      end
+    # * **server: App/Database/WebServer**    The server we are running a
+    #                                         container for.
+    def run_container(server)
+      container_name = server.container_name
       remove_container container_name
       
       flags = ["-d"]
       flags += dns_server_flags
-      flags += volume_flags(name)
-      flags << "-p 80:80" if name == :web
+      flags += volume_flags(server)
+      flags << "-p #{server.port}:80" if server.is_a?(RubyYacht::WebServer)
       flags << "--net=#{@network}"
       flags << "--net-alias=#{container_name}"
 

data/lib/ruby_yacht/runner/runner.rb

@@ -1,7 +1,28 @@
 module RubyYacht::Runner
   # This method provides the commands that we can run.
   def self.commands
-    [Help, Build, BuildImages, RunContainers, Services, Checkout, Shell, UpdateHosts, Implode]
+    @commands ||= []
+  end
+
+  # This method clears our list of commands that we can run.
+  def self.clear_commands
+    @commands = []
+  end
+
+  # This method loads the default commands into our command list.
+  #
+  # ### Parameters
+  #
+  # * **in_project* Boolean**     Whether we are running a script in the context
+  #                               of a project, or in the top-level ruby_yacht
+  #                               command.
+  def self.load_default_commands(in_project=true)
+    @commands ||= []
+    if in_project
+      @commands += [Help, Build, BuildImages, RunContainers, Services, Checkout, Shell, UpdateHosts, Implode]
+    else
+      @commands += [Help, CreateNewProject]
+    end
   end
   
   # This method gets the arguments for the current command.
@@ -11,13 +32,14 @@ module RubyYacht::Runner
 
   # This method runs a command based on the command line arguments.
   def self.run
+    load_default_commands if self.commands == []
     arg = arguments[0]
 
     if arg == '' || arg == nil
       puts "You must provide a command to run"
       puts "Run `#{$0} help` for more information"
       exit(1)
-      return
+      return false
     end
 
     command = self.commands.find { |c| c.command == arg }
@@ -32,11 +54,14 @@ module RubyYacht::Runner
       success = instance.run
       unless success
         exit(1)
+      return false
       end
     else
       puts "Command not recognized: #{arg}"
       puts "Run `#{$0} help` for more information"
       exit(1)
+      return false
     end
+    true
   end
 end

data/lib/ruby_yacht/runner/services.rb

@@ -46,32 +46,37 @@ module RubyYacht::Runner
         return false
       end
 
-      if command == 'start' && backtick('which docker-machine') != '' 
+      if command == 'start'
         start_docker_machine
       end
       
       projects.each do |project|
         project.databases.select(&:local?).each do |database|
-          docker "#{command} #{database.container_name(project)}"
+          docker "#{command} #{database.container_name}"
         end
         
         project.apps.each do |app|
-          docker "#{command} #{app.container_name(project)}"
+          docker "#{command} #{app.container_name}"
+        end
+
+        project.web_servers.each do |server|
+          docker "#{command} #{server.container_name}"
         end
       end
-      docker "#{command} #{projects.first.system_prefix}-web"
       
       true
     end
       
     # This method starts the default docker machine.
     def start_docker_machine
-      system "docker-machine start default"
-    
-      environment_args = backtick('docker-machine env default').split("\n")
-      environment_args.each do |arg|
-        if arg =~ /export (\w*)=\"(.*)\"/
-          ENV[$1] = $2
+      if docker_machine != ''
+        system "#{docker_machine} start default"
+      
+        environment_args = backtick("#{docker_machine} env default").split("\n")
+        environment_args.each do |arg|
+          if arg =~ /export (\w*)=\"(.*)\"/
+            ENV[$1] = $2
+          end
         end
       end
     end

data/lib/ruby_yacht/runner/shell.rb

@@ -58,7 +58,7 @@ module RubyYacht::Runner
       return false unless project
 
       app = project.apps.find { |a| a.name == app_name.to_sym }
-      container = app.container_name(project)
+      container = app.container_name
       exec("docker exec -it #{container} bash -c 'cd /var/code; TERM=xterm #{command}'")
       true
     end

data/lib/ruby_yacht/runner/update_hosts.rb

@@ -24,7 +24,9 @@ module RubyYacht::Runner
       current_hosts = current_host_contents.split("\n")
       new_hosts = current_hosts.select do |entry|
         projects.none? do |project|
-          entry.include?(project.domain) || entry.include?("#{project.system_prefix} docker containers")
+          project.web_servers.any? do |server|
+            entry.include?(server.domain) || entry.include?("#{project.system_prefix} docker containers")
+          end
         end
       end
       
@@ -39,9 +41,9 @@ module RubyYacht::Runner
       
       timestamp = Time.now.utc.strftime('%Y%m%d%H%M%S')
       log "Please enter your password so that we can update the hosts file"
-      system "sudo cp /etc/hosts /etc/hosts.#{timestamp}.backup"
-      system "sudo mv tmp/hosts /etc/hosts"
-      
+      sudo_command = backtick('which sudo').strip
+      system "#{sudo_command} cp /etc/hosts /etc/hosts.#{timestamp}.backup"
+      system "#{sudo_command} cat tmp/hosts > /etc/hosts"
       true
     end
 
@@ -57,15 +59,18 @@ module RubyYacht::Runner
     # An Array with the new lines for the hosts file.
     def hosts_file_entries(project, ip_address)
       system_prefix = project.system_prefix
-      main_domain = project.domain
-    
-      domains = [main_domain]
-      apps = project.apps.select { |app| app.name != system_prefix }
-      domains += apps.map { |app| "#{app.name}.#{main_domain}" }
-    
       header = "# #{system_prefix} docker containers"
       new_hosts = ["", header]
-      new_hosts += domains.map { |domain| "#{ip_address}    #{domain}" }
+      
+      project.web_servers.each do |web_server|
+        main_domain = web_server.domain
+      
+        domains = [main_domain]
+        apps = project.apps.select { |app| app.name != system_prefix }
+        domains += apps.map { |app| "#{app.name}.#{main_domain}" }
+      
+        new_hosts += domains.map { |domain| "#{ip_address}    #{domain}" }
+      end
       new_hosts
     end
   end

data/lib/ruby_yacht/runner.rb

@@ -15,4 +15,5 @@ require 'ruby_yacht/runner/checkout'
 require 'ruby_yacht/runner/implode'
 require 'ruby_yacht/runner/shell'
 require 'ruby_yacht/runner/update_hosts'
+require 'ruby_yacht/runner/create_new_project'
 require 'ruby_yacht/runner/runner'

data/ruby_yacht.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |spec|
   spec.name         = 'ruby_yacht'
-  spec.version      = '0.5.0'
-  spec.date         = '2016-05-05'
+  spec.version      = '0.6.0'
+  spec.date         = '2016-05-15'
   spec.description  = "A DSL for building docker containers for a family of Rails apps"
   spec.summary      = "A DSL for building docker containers for a family of Rails apps"
   spec.authors      = ["John Brownlee"]
@@ -16,4 +16,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "timecop"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency 'rubocop'
 end

data/spec/docker/Dockerfile

@@ -1,5 +1,21 @@
 FROM ruby:2.3
 
-VOLUME /var/code
-WORKDIR /var/code
-CMD bundle install; bash
+RUN apt-get update
+RUN curl -fsSL https://get.docker.com/ | sh
+
+RUN mkdir -p /var/docker
+
+COPY startup.bash /var/docker/
+COPY install_gems.bash /var/docker/
+RUN chmod u+x /var/docker/*.bash
+
+RUN /var/docker/install_gems.bash
+
+RUN mkdir -p /root/.ssh
+COPY id_rsa /root/.ssh
+
+VOLUME /var/lib/docker
+VOLUME /var/code/ruby-yacht
+WORKDIR /var/code/ruby-yacht
+
+CMD /var/docker/startup.bash

data/spec/docker/install_gems.bash

@@ -0,0 +1,5 @@
+gem install rspec
+gem install codeclimate-test-reporter
+gem install timecop
+gem install byebug
+gem install rubocop

data/spec/docker/run.bash

@@ -0,0 +1,44 @@
+#! /bin/bash
+
+# This script runs our tests in a docker container.
+#
+# This keeps the development dependencies isolated from other parts of the
+# system.
+
+EXISTING_IMAGE=`docker images | grep ruby-yacht-tests`
+if [ -z "$EXISTING_IMAGE" ]; then
+  if [ -f ~/.ssh/id_rsa ]; then
+    cp ~/.ssh/id_rsa spec/docker
+  else
+    touch spec/docker/id_rsa
+  fi
+  docker build -t ruby-yacht-tests spec/docker
+  rm spec/docker/id_rsa
+fi
+
+if [ -z $PRESERVE_IMAGES ]; then
+  PRESERVE_IMAGES='0'
+fi
+
+EXTRA_FLAGS="$EXTRA_FLAGS -e PRESERVE_IMAGES=$PRESERVE_IMAGES"
+
+if [ $PRESERVE_IMAGES -eq 1 ]; then
+  EXTRA_FLAGS="$EXTRA_FLAGS -d"
+  EXISTING_CONTAINER=`docker ps | grep ruby-yacht-tests`
+else
+  docker rm -f ruby-yacht-tests 1> /dev/null 2> /dev/null
+  EXTRA_FLAGS="$EXTRA_FLAGS --rm"
+  EXISTING_CONTAINER=""
+fi
+
+if [ -z "$EXISTING_CONTAINER" ]; then
+  docker run -it $EXTRA_FLAGS --privileged --name=ruby-yacht-tests -v $PWD:/var/code/ruby-yacht ruby-yacht-tests /var/docker/startup.bash $*
+  RESULT=$?
+fi
+
+if [ $PRESERVE_IMAGES -eq 1 ]; then
+  docker exec -it ruby-yacht-tests bash -c "bundle install --quiet; rspec $*"
+  RESULT=$?
+fi
+
+exit $RESULT

data/spec/docker/startup.bash

@@ -0,0 +1,10 @@
+#! /bin/bash
+
+/etc/init.d/docker start
+bundle install --quiet
+if [ $PRESERVE_IMAGES -eq 1 ]
+then
+  bash
+else
+  rspec $*
+fi

data/spec/dsl/app_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 RSpec.describe RubyYacht::App do
   describe "DSL" do
     let(:name) { :test_app }
-    let(:app) { RubyYacht::App::DSL.new(name).run(@builder).create_object }
+    let(:app) { RubyYacht::App::DSL.new(:test, name).run(@builder).create_object }
 
     before do
       RubyYacht.configuration.clear
@@ -19,7 +19,6 @@ RSpec.describe RubyYacht::App do
       @builder = Proc.new do
         repository_name 'brownleej/test-app'
         database_name :database
-        server_type :test
         port 3000
       end
       expect(app.name).to eq :test_app
@@ -29,32 +28,17 @@ RSpec.describe RubyYacht::App do
       expect(app.port).to eq 3000
     end
 
-    it "requires the repository name" do
+    it "defaults the repository name to nil" do
       @builder = Proc.new do
         port 3000
-        server_type :test
         database_name :database
       end
-      expect do
-        self.app
-      end.to raise_exception("Missing required attribute repository_name for RubyYacht::App::DSL")
-    end
-
-    it "requires the server type" do
-      @builder = Proc.new do
-        repository_name 'brownleej/test-app'
-        port 3000
-        database_name :database
-      end
-      expect do
-        self.app
-      end.to raise_exception("Missing required attribute server_type for RubyYacht::App::DSL")
+      expect(self.app.repository_name).to be_nil
     end
 
     it "does not require the database name" do
       @builder = Proc.new do
         repository_name 'brownleej/test-app'
-        server_type :test
         port 3000
       end
       expect(app.database_name).to be_nil
@@ -69,7 +53,7 @@ RSpec.describe RubyYacht::App do
       end
       expect do
         self.app
-      end.to raise_exception("App has invalid server type `invalid`")
+      end.to raise_exception("RubyYacht::App::DSL has invalid app server type `invalid`")
     end
 
     it "requires a defined server type for apps" do
@@ -88,41 +72,82 @@ RSpec.describe RubyYacht::App do
       end
       expect do
         self.app
-      end.to raise_exception("App has invalid server type `sqlite`")
+      end.to raise_exception("RubyYacht::App::DSL has invalid app server type `sqlite`")
     end
 
     it "defaults the port to 8080" do
       @builder = Proc.new do
         repository_name 'brownleej/test-app'
-        server_type :test
         database_name :database
       end
       expect(app.port).to eq 8080
     end
   end
 
+  describe 'project' do
+    before do
+      RubyYacht.configuration.clear
+      RubyYacht.configure do
+        server_type :test do
+          container_type :app
+          baseline_image 'ubuntu'
+        end
+      end
+      RubyYacht.configure do
+        project :project1 do
+          repository 'github.com'
+          system_prefix :project1
+
+          test_app :app1 do
+            repository_name 'app1'
+          end
+
+          test_app :app2 do
+            repository_name 'app2'
+          end
+        end
+        
+        project :project2 do
+          repository 'github.com'
+          system_prefix :project2
+
+          test_app :app3 do
+            repository_name 'app3'
+          end
+        end
+      end
+    end
+
+    it 'finds the project that contains the app' do
+      app2 = RubyYacht.configuration.projects[0].apps[1]
+      expect(app2.project.name).to eq :project1
+
+      app3 = RubyYacht.configuration.projects[1].apps[0]
+      expect(app3.project.name).to eq :project2
+    end
+  end
+
   describe "container_name" do
-    it "combines the project's prefix with the app's name" do
-      project = RubyYacht::Project.new
-      project.name = :test_project
-      project.system_prefix = :tests
+    before do
+      @project = RubyYacht::Project.new
+      @project.name = :test_project
+      @project.system_prefix = :tests
 
-      app = RubyYacht::App.new
-      app.name = 'app1'
+      @app = RubyYacht::App.new
+      @app.name = 'app1'
+      @project.apps = [@app]
+      RubyYacht.configuration.projects << @project
+    end
 
-      expect(app.container_name(project)).to eq 'tests-app1'
+    it "combines the project's prefix with the app's name" do
+      expect(@app.container_name).to eq 'tests-app1'
     end
 
     context "with the same name as the project's system_prefix" do
       it "is just the project's system prefix" do
-        project = RubyYacht::Project.new
-        project.name = :test_project
-        project.system_prefix = :tests
+        @app.name = :tests
 
-        app = RubyYacht::App.new
-        app.name = :tests
-
-        expect(app.container_name(project)).to eq 'tests'
+        expect(@app.container_name).to eq 'tests'
       end
     end
   end
@@ -146,10 +171,13 @@ RSpec.describe RubyYacht::App do
       @app = RubyYacht::App.new
       @app.name = 'app1'
       @app.database_name = 'second_db'
+
+      @project.apps = [@app]
+      RubyYacht.configuration.projects << @project
     end
 
     it "is the database with the app's database_name" do
-      database = @app.database(@project)
+      database = @app.database
       expect(database).not_to be_nil
       expect(database.host).to eq 'db2.test.com'
     end
@@ -160,7 +188,7 @@ RSpec.describe RubyYacht::App do
       end
 
       it "is nil" do
-        expect(@app.database(@project)).to be_nil
+        expect(@app.database).to be_nil
       end
     end
   end