ruby_yacht 0.1.0

data/lib/ruby_yacht/runner/services.rb

@@ -0,0 +1,79 @@
+module RubyYacht::Runner
+  # This class provides a command for starting, stopping, and restarting
+  # containers.
+  class Services < Command
+    # The name of the command.
+    def self.command; 'services'; end
+
+    # The description for the command.
+    def self.description; 'Start, stop, or restart containers'; end
+
+    # This method gets the command-line flags for this command.
+    def option_parser
+      OptionParser.new do |options|
+        usage = "Usage: #{Command.short_script_name} #{self.class.command} [COMMAND]"
+        usage += "\n\n#{self.class.description}"
+        usage += "\n\n[COMMAND] is required, and can be start, stop, or restart"
+        options.banner = usage
+      end
+    end
+
+    # The name of the docker command that we are running.
+    #
+    # This can be `start`, `stop`, or `restart`.
+    attr_accessor :command
+
+    # This method extracts the arguments from the command line.
+    #
+    # ### Parameters
+    #
+    # * **arguments: Array**    The command-line arguments.
+    def parse_positional_arguments(arguments)
+      self.command = arguments.shift
+    end
+    
+    # This method runs the logic for the command.
+    def run
+      if self.command == nil
+        log "You must provide a command"
+        log "Run #{Command.short_script_name} help services for more information"
+        return false
+      end
+
+      unless %w(start stop restart).include?(command)
+        log "#{command} is not a valid docker command"
+        log "Run #{Command.short_script_name} help services for more information"
+        return false
+      end
+
+      if command == 'start' && backtick('which docker-machine') != '' 
+        start_docker_machine
+      end
+      
+      projects.each do |project|
+        if project.database.local?
+          docker "#{command} #{project.system_prefix}-database"
+        end
+        
+        project.apps.each do |app|
+          docker "#{command} #{app.container_name(project)}"
+        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
+        end
+      end
+    end
+  end
+end

data/lib/ruby_yacht/runner/shell.rb

@@ -0,0 +1,66 @@
+module RubyYacht::Runner
+  # This class provides a command for opening a shell in an app container.
+  class Shell < Command
+    # The name of the command.
+    def self.command; 'shell'; end
+
+    # The description of the command.
+    def self.description
+      "Open a shell in a container"
+    end
+
+    # The name of the project that the app is in.
+    attr_accessor :project_name
+
+    # The name of the app that we are opening a shell in.
+    attr_accessor :app
+
+    # The name of the command that we are invoking in the shell.
+    attr_accessor :command
+
+    # This method gets the command-line options for the command.
+    def option_parser
+      OptionParser.new do |options|
+        options.banner = "Usage: #{Command.short_script_name} shell [options] [APP] [command]"
+        options.separator ""
+        options.separator "The command is optional. If you omit it, this will open a bash shell"
+        options.separator ""
+        options.separator "Options:"
+
+        options.on('-p', '--project PROJECT', "The project with the app we are opening the sell in. Default: #{default_project.name}") do |name|
+          self.project_name = name.to_sym
+        end
+      end
+    end
+
+    # This method extracts the arguments from the command line.
+    #
+    # ### Parameters
+    #
+    # * **arguments: Array**    The command-line arguments.
+    def parse_positional_arguments(arguments)
+      self.app = arguments.shift
+      self.command = arguments.join(' ')
+      if self.command == ''
+        self.command = 'bash'
+      end
+    end
+
+    # This method runs the logic for the command.
+    def run
+      if app.nil?
+        log "You must provide an app name"
+        log "Run #{Command.short_script_name} help shell for more information"
+        return false
+      end
+
+      project = self.project_named(project_name)
+      return false unless project
+
+      container = "#{project.system_prefix}-#{app}"
+      exec("docker exec -it #{container} bash -c 'cd /var/code; TERM=xterm #{command}'")
+      true
+    end
+  end
+end
+

data/lib/ruby_yacht/runner/update_hosts.rb

@@ -0,0 +1,72 @@
+module RubyYacht::Runner
+  # This class provides a command for updating the hosts file.
+  class UpdateHosts < Command
+    # The name of the command.
+    def self.command; 'update_hosts'; end
+
+    # The description of the command.
+    def self.description
+      "Add entries for your app domains to your hosts file"
+    end
+    
+    # The current contents of the hosts file.
+    def current_host_contents
+      File.read('/etc/hosts')
+    end
+
+    # This method runs the logic of the command.
+    def run
+      ip_address = get_machine_info('.Driver.IPAddress')
+      if ip_address == ""
+        ip_address = "127.0.0.1"
+      end
+      
+      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")
+        end
+      end
+      
+      new_hosts.pop while new_hosts.any? && new_hosts.last.length == 0
+      
+      new_hosts += projects.map { |p| self.hosts_file_entries(p, ip_address) }.flatten
+      
+      FileUtils.mkdir_p('tmp')
+      File.open(File.join('tmp', 'hosts'), 'w') do |file|
+        file.write(new_hosts.join("\n"))
+      end
+      
+      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"
+      
+      true
+    end
+
+    # This method gets the contents of the hosts file for a project.
+    #
+    # ### Parameters
+    #
+    # * **project: RubyYacht::Project**     The project we are working on.
+    # * **ip_address: String**              The IP address that docker listens
+    #                                       on.
+    #
+    # ### Returns
+    # 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]
+      domains += project.apps.map { |app| "#{app.name}.#{main_domain}" }
+    
+      header = "# #{system_prefix} docker containers"
+      new_hosts = ["", header]
+      new_hosts += domains.map { |domain| "#{ip_address}    #{domain}" }
+      new_hosts
+    end
+  end
+end
+

data/lib/ruby_yacht/runner.rb

@@ -0,0 +1,18 @@
+require 'fileutils'
+
+# This module groups together classes for running commands for managing the
+# docker environment.
+module RubyYacht::Runner
+end
+
+require 'ruby_yacht/runner/command'
+require 'ruby_yacht/runner/help'
+require 'ruby_yacht/runner/build_images'
+require 'ruby_yacht/runner/run_containers'
+require 'ruby_yacht/runner/build'
+require 'ruby_yacht/runner/services'
+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/runner'

data/lib/ruby_yacht.rb

@@ -0,0 +1,6 @@
+# This module groups together all the libraries for this gem.
+module RubyYacht
+end
+
+require 'ruby_yacht/dsl'
+require 'ruby_yacht/runner'

data/ruby_yacht.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |spec|
+  spec.name         = 'ruby_yacht'
+  spec.version      = '0.1.0'
+  spec.date         = '2016-04-10'
+  spec.summary      = "A DSL for building docker containers for a family of Rails apps"
+  spec.authors      = ["John Brownlee"]
+  spec.email        = 'apps@mail.johnbrownlee.com'
+  spec.homepage     = 'https://github.com/brownleej/ruby-yacht'
+  spec.license      = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "timecop"
+end

data/spec/docker/Dockerfile

@@ -0,0 +1,5 @@
+FROM ruby:2.3
+
+VOLUME /var/code
+WORKDIR /var/code
+CMD bash

data/spec/docker/build.bash

@@ -0,0 +1,10 @@
+#! /bin/bash
+
+# This script builds a docker container for running tests.
+#
+# This keeps the development dependencies isolated from other parts of the
+# system.
+
+docker build -t ruby-yacht-tests spec/docker
+docker rm -f ruby-yacht-tests 2> /dev/null
+docker run -dit --name=ruby-yacht-tests -v $PWD:/var/code ruby-yacht-tests 

data/spec/dsl/app_spec.rb

@@ -0,0 +1,47 @@
+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 }
+
+    it "creates an app with all fields" do
+      @builder = Proc.new do
+        repository_name 'brownleej/test-app'
+        port 3000
+      end
+      expect(app.name).to eq :test_app
+      expect(app.repository_name).to eq 'brownleej/test-app'
+      expect(app.port).to eq 3000
+    end
+
+    it "requires the repository name" do
+      @builder = Proc.new do
+        port 3000
+      end
+      expect do
+        self.app
+      end.to raise_exception("Missing required attribute repository_name for RubyYacht::App::DSL")
+    end
+
+    it "defaults the port to 8080" do
+      @builder = Proc.new do
+        repository_name 'brownleej/test-app'
+      end
+      expect(app.port).to eq 8080
+    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
+
+      app = RubyYacht::App.new
+      app.name = 'app1'
+
+      expect(app.container_name(project)).to eq 'tests-app1'
+    end
+  end
+end

data/spec/dsl/configuration_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'ruby_yacht'
+
+describe RubyYacht::Configuration do
+  before do
+    RubyYacht.configuration.clear
+  end
+
+  describe "dsl" do
+    let(:project_creation_block) do
+      Proc.new do
+        project :project1 do
+          system_prefix :a
+          domain "a.test.com"
+          secret_key_base "a"
+          repository "github.com"
+
+          database do
+            host "localhost"
+            name "project1"
+            username "test"
+            password "test"
+          end
+        end
+
+        project :project2 do
+          system_prefix :b
+          domain "b.test.com"
+          secret_key_base "b"
+          repository "github.com"
+
+          database do
+            host "localhost"
+            name "project2"
+            username "test"
+            password "test"
+          end
+        end
+      end
+    end
+
+    it "can add projects" do
+      configuration = RubyYacht::Configuration::DSL.new.run(project_creation_block).create_object
+      expect(configuration.projects.count).to eq 2
+      expect(configuration.projects[0].name).to eq :project1
+      expect(configuration.projects[1].name).to eq :project2
+    end
+
+    describe "configure method" do
+      it "adds to the list of projects" do
+        project = RubyYacht::Project.new
+        project.name = :initial_project
+        RubyYacht.configuration.projects << project
+        RubyYacht.configure(&project_creation_block)
+
+        configuration = RubyYacht.configuration
+        expect(configuration.projects.count).to eq 3
+        expect(configuration.projects[0].name).to eq :initial_project
+        expect(configuration.projects[1].name).to eq :project1
+        expect(configuration.projects[2].name).to eq :project2
+      end
+    end
+  end
+end

data/spec/dsl/database_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe RubyYacht::Database do
+  describe "dsl" do
+    let(:database) { RubyYacht::Database::DSL.new.run(@builder).create_object }
+
+    it "creates a database with all the fields" do
+      @builder = Proc.new do
+        host 'db1.test.com'
+        name 'apps'
+        username 'test-user'
+        password 'test-pass'
+      end
+
+      expect(database.host).to eq 'db1.test.com'
+      expect(database.name).to eq 'apps'
+      expect(database.username).to eq 'test-user'
+      expect(database.password).to eq 'test-pass'
+    end
+
+    it "requires the host" do
+      @builder = Proc.new do
+        name 'apps'
+        username 'test-user'
+        password 'test-pass'
+      end
+
+      expect { database }.to raise_exception "Missing required attribute host for RubyYacht::Database::DSL"
+    end
+
+    it "requires the name" do
+      @builder = Proc.new do
+        host 'db1.test.com'
+        username 'test-user'
+        password 'test-pass'
+      end
+
+      expect { database }.to raise_exception "Missing required attribute name for RubyYacht::Database::DSL"
+    end
+
+    it "requires the username" do
+      @builder = Proc.new do
+        host 'db1.test.com'
+        name 'apps'
+        password 'test-pass'
+      end
+
+      expect { database }.to raise_exception "Missing required attribute username for RubyYacht::Database::DSL"
+    end
+
+    it "requires the password" do
+      @builder = Proc.new do
+        host 'db1.test.com'
+        name 'apps'
+        username 'test-user'
+      end
+
+      expect { database }.to raise_exception "Missing required attribute password for RubyYacht::Database::DSL"
+    end
+  end
+
+  describe "local?" do
+    it "is true when the host is localhost" do
+      database = RubyYacht::Database.new
+      database.host = 'localhost'
+      expect(database).to be_local
+    end
+
+    it "is false when the host is not localhost" do
+      database = RubyYacht::Database.new
+      database.host = 'db1.test.com'
+      expect(database).not_to be_local
+    end
+  end
+end

data/spec/dsl/dns_server_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe RubyYacht::DnsServer do
+  describe "dsl" do
+    let(:config) { RubyYacht::DnsServer::DSL.new.run(@builder).create_object }
+
+    it "can add servers" do
+      @builder = Proc.new do
+        server '8.10.1.1'
+        server '8.10.1.2'
+      end
+
+      expect(config.servers).to eq ['8.10.1.1', '8.10.1.2']
+    end
+
+    it "can add search domains" do
+      @builder = Proc.new do
+        search_domain 'apps.admin.test.com'
+        search_domain 'web.admin.test.com'
+      end
+      
+      expect(config.search_domains).to eq ['apps.admin.test.com', 'web.admin.test.com']
+    end
+  end
+end