RubyGems - ruby_yacht - Versions diffs - 0.1.0 - Mend

ruby_yacht 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (82) hide show

checksums.yaml +7 -0
data/.codeclimate.yml +27 -0
data/.gitignore +4 -0
data/.rdoc_options +29 -0
data/.rspec +1 -0
data/.rubocop.yml +1156 -0
data/.travis.yml +4 -0
data/Gemfile +3 -0
data/Gemfile.lock +44 -0
data/LICENSE +8 -0
data/README.md +216 -0
data/doc/CONTRIBUTING.md +12 -0
data/doc/TODO.md +28 -0
data/doc/configuration_sample.rb +87 -0
data/lib/ruby_yacht/dsl/app.rb +59 -0
data/lib/ruby_yacht/dsl/configuration.rb +55 -0
data/lib/ruby_yacht/dsl/database.rb +57 -0
data/lib/ruby_yacht/dsl/dns_server.rb +38 -0
data/lib/ruby_yacht/dsl/dsl.rb +252 -0
data/lib/ruby_yacht/dsl/project.rb +140 -0
data/lib/ruby_yacht/dsl.rb +6 -0
data/lib/ruby_yacht/images/app/Dockerfile.erb +32 -0
data/lib/ruby_yacht/images/app/checkout.rb +7 -0
data/lib/ruby_yacht/images/app/startup.rb +17 -0
data/lib/ruby_yacht/images/app/update_database_config.rb +45 -0
data/lib/ruby_yacht/images/app-dependencies/Dockerfile.erb +23 -0
data/lib/ruby_yacht/images/app-dependencies/install_gems.rb +12 -0
data/lib/ruby_yacht/images/database/Dockerfile.erb +26 -0
data/lib/ruby_yacht/images/database/load_seeds.rb +42 -0
data/lib/ruby_yacht/images/database/setup.rb +19 -0
data/lib/ruby_yacht/images/database/setup_database.sql.erb +12 -0
data/lib/ruby_yacht/images/deploy/Dockerfile.erb +2 -0
data/lib/ruby_yacht/images/web/Dockerfile.erb +25 -0
data/lib/ruby_yacht/images/web/add_app.rb +12 -0
data/lib/ruby_yacht/images/web/add_project.rb +14 -0
data/lib/ruby_yacht/images/web/app_config.erb +11 -0
data/lib/ruby_yacht/images/web/index.html.erb +10 -0
data/lib/ruby_yacht/images/web/index_config.erb +12 -0
data/lib/ruby_yacht/images/web/setup.rb +22 -0
data/lib/ruby_yacht/runner/build.rb +21 -0
data/lib/ruby_yacht/runner/build_images.rb +82 -0
data/lib/ruby_yacht/runner/checkout.rb +68 -0
data/lib/ruby_yacht/runner/command.rb +161 -0
data/lib/ruby_yacht/runner/help.rb +55 -0
data/lib/ruby_yacht/runner/implode.rb +33 -0
data/lib/ruby_yacht/runner/run_containers.rb +105 -0
data/lib/ruby_yacht/runner/runner.rb +42 -0
data/lib/ruby_yacht/runner/services.rb +79 -0
data/lib/ruby_yacht/runner/shell.rb +66 -0
data/lib/ruby_yacht/runner/update_hosts.rb +72 -0
data/lib/ruby_yacht/runner.rb +18 -0
data/lib/ruby_yacht.rb +6 -0
data/ruby_yacht.gemspec +18 -0
data/spec/docker/Dockerfile +5 -0
data/spec/docker/build.bash +10 -0
data/spec/dsl/app_spec.rb +47 -0
data/spec/dsl/configuration_spec.rb +64 -0
data/spec/dsl/database_spec.rb +75 -0
data/spec/dsl/dns_server_spec.rb +25 -0
data/spec/dsl/dsl_spec.rb +298 -0
data/spec/dsl/project_spec.rb +266 -0
data/spec/fixtures/app-dependencies-dockerfile +25 -0
data/spec/fixtures/database-dockerfile +31 -0
data/spec/fixtures/deploy-dockerfile +2 -0
data/spec/fixtures/mars-dockerfile +32 -0
data/spec/fixtures/multi-project-web-dockerfile +35 -0
data/spec/fixtures/web-dockerfile +27 -0
data/spec/runner/build_images_spec.rb +164 -0
data/spec/runner/build_spec.rb +86 -0
data/spec/runner/checkout_spec.rb +128 -0
data/spec/runner/command_spec.rb +94 -0
data/spec/runner/help_spec.rb +73 -0
data/spec/runner/implode_spec.rb +62 -0
data/spec/runner/run_containers_spec.rb +141 -0
data/spec/runner/runner_spec.rb +117 -0
data/spec/runner/services_spec.rb +135 -0
data/spec/runner/shell_spec.rb +123 -0
data/spec/runner/update_hosts_spec.rb +163 -0
data/spec/spec_helper.rb +10 -0
data/spec/support/docker_stubbing.rb +93 -0
data/spec/support/test_project.rb +56 -0
metadata +193 -0

data/lib/ruby_yacht/images/web/add_app.rb ADDED Viewed

@@ -0,0 +1,12 @@
+#! /usr/local/bin/ruby
+require 'erb'
+@project = ARGV.shift
+@domain = ARGV.shift
+@app = ARGV.shift
+@port = ARGV.shift
+@container_name = "#{@project}-#{@app}"
+File.open(File.join("/etc/nginx/conf.d/#{@container_name}.conf"), 'w') do |file|
+  file.write(ERB.new(File.read('/var/docker/app_config.erb')).result(binding))
+end

data/lib/ruby_yacht/images/web/add_project.rb ADDED Viewed

@@ -0,0 +1,14 @@
+#! /usr/local/bin/ruby
+require 'erb'
+@project = ARGV.shift
+@domain = ARGV.shift
+@app_names = ARGV.shift.split(',')
+File.open(File.join("/usr/share/nginx/html/#{@project}.html"), 'w') do |file|
+  file.write(ERB.new(File.read('/var/docker/index.html.erb')).result(binding))
+end
+File.open(File.join("/etc/nginx/conf.d/#{@project}-index.conf"), 'w') do |file|
+  file.write(ERB.new(File.read('/var/docker/index_config.erb')).result(binding))
+end

data/lib/ruby_yacht/images/web/app_config.erb ADDED Viewed

@@ -0,0 +1,11 @@
+server {
+  listen       80;
+  server_name  <%= @app %>.<%= @domain %>;
+  location / {
+    proxy_pass http://<%= @container_name %>:<%= @port %>;
+    proxy_redirect off;
+    proxy_set_header Host $host;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+  }
+}

data/lib/ruby_yacht/images/web/index.html.erb ADDED Viewed

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+  <body>
+    <ul>
+<% @app_names.each do |name| %>
+  <li><a href="http://<%= name %>.<%= @domain %>/"><%= name %></li>
+<% end %>
+    </ul>
+  </body>
+</html>

data/lib/ruby_yacht/images/web/index_config.erb ADDED Viewed

@@ -0,0 +1,12 @@
+server {
+  listen       80;
+  server_name  <%= @domain %>;
+  #charset koi8-r;
+  #access_log  /var/log/nginx/log/host.access.log  main;
+  location / {
+      root   /usr/share/nginx/html;
+      index  <%= @project %>.html ;
+  }
+}

data/lib/ruby_yacht/images/web/setup.rb ADDED Viewed

@@ -0,0 +1,22 @@
+#! /usr/local/bin/ruby
+require 'erb'
+require 'fileutils'
+@project = ARGV.shift
+@domain = ARGV.shift
+@app_names = ARGV.shift.split(',')
+@app_ports = ARGV.shift.split(',')
+File.open(File.join("/usr/share/nginx/html/#{@project}.html"), 'w') do |file|
+  file.write(ERB.new(File.read('/var/docker/index.html.erb')).result(binding))
+end
+File.open(File.join("/etc/nginx/conf.d/#{@project}.conf"), 'w') do |file|
+  file.write(ERB.new(File.read('/var/docker/index_config.erb')).result(binding))
+  @app_names.each_with_index do |app, port|
+    @app = app
+    @app_port = port
+    @container_name = @project + '-' + @app
+    file.write(ERB.new(File.read('/var/docker/app_config.erb')).result(binding))
+  end
+end

data/lib/ruby_yacht/runner/build.rb ADDED Viewed

@@ -0,0 +1,21 @@
+module RubyYacht::Runner
+  # This class provides a command for building the system.
+  #
+  # It will build the images, run the containers, and update the hosts file.
+  class Build < Command
+    # The identifier for the command.
+    def self.command; 'build'; end
+    # The description for the command.
+    def self.description
+      "Build images and run containers"
+    end
+    # This method runs the logic for this command.
+    def run
+      return BuildImages.new.run &&
+      RunContainers.new.run &&
+      UpdateHosts.new.run
+    end
+  end
+end

data/lib/ruby_yacht/runner/build_images.rb ADDED Viewed

@@ -0,0 +1,82 @@
+require 'erb'
+module RubyYacht::Runner
+  # This command builds the images for the system.
+  class BuildImages < Command
+    # The identifier for the command.
+    def self.command; 'build_images'; end
+    # The description for the command.
+    def self.description
+      "Build images for your environment"
+    end
+    # This method runs the logic for the command.
+    def run
+      FileUtils.mkdir_p 'tmp'
+      default_system_prefix = projects.first.system_prefix
+      docker "network create #{default_system_prefix} 2> /dev/null"
+      projects.each do |project|
+        log "Building images for #{project.name}"
+        @project = project
+        id_path = File.join(ENV['HOME'], '.ssh', 'id_rsa')
+        tmp_id_path = File.join('tmp', 'id_rsa')
+        if File.exist?(id_path)
+          FileUtils.cp(id_path, tmp_id_path)
+        end
+        build_image 'app-dependencies'
+        build_image 'database' if project.database.local?
+        @project.apps.each do |app|
+          @app = app
+          build_image 'app', "#{@project.system_prefix}-#{app.name}"
+        end
+        if @project.create_deploy_container
+          build_image 'deploy'
+        end
+      end
+      @projects = projects
+      build_image 'web', "#{default_system_prefix}-web"
+      true
+    end
+    # This method builds an image.
+    #
+    # This will copy a Dockerfile template from a folder underneath the `images`
+    # folder, as well as any other files in that folder, into the tmp folder.
+    # It will then evaluate the Dockerfile.erb file, using the binding from the
+    # current context, and write it to the Dockerfile in the tmp folder. It will
+    # then build the image, and clear out the tmp folder.
+    #
+    # ### Parameters
+    #
+    # * **folder_name: String**   The name of the folder containing the
+    #                             Dockerfile and related files.
+    # * **image_name: String**    The name for the new image. If this is not
+    #                             provided, the image name will be the
+    #                             current project's prefix, followed by a
+    #                             dash, followed by the folder name.
+    def build_image(folder_name, image_name = nil)
+      Dir[File.join(File.dirname(File.dirname(__FILE__)), 'images', folder_name, '*')].each do |path|
+        FileUtils.cp(path, 'tmp')
+      end
+      File.open(File.join('tmp', 'Dockerfile'), 'w') do |file|
+        contents = ERB.new(File.read(File.join('tmp', 'Dockerfile.erb'))).result(binding)
+        file.write(contents)
+      end
+      image_name ||= "#{@project.system_prefix}-#{folder_name}"
+      docker "build -t #{image_name} tmp"
+      FileUtils.rm(Dir[File.join("tmp", "*")])
+    end
+  end
+end

data/lib/ruby_yacht/runner/checkout.rb ADDED Viewed

@@ -0,0 +1,68 @@
+module RubyYacht::Runner
+  # This class provides a command for checking out a new branch for an app.
+  class Checkout < Command
+    # The name of the command.
+    def self.command; 'checkout'; end
+    # The short description for the command.
+    def self.description
+      "Check out a new branch for an app"
+    end
+    # The name of the project that the app is in.
+    attr_accessor :project_name
+    # The name of the app.
+    attr_accessor :app
+    # The branch that we are checking out.
+    attr_accessor :branch
+    # This OptionParser for parsing command-line flags.
+    #
+    # This command accepts the project name as an optional flag.
+    def option_parser
+      OptionParser.new do |options|
+        options.banner = "Usage: #{Command.short_script_name} checkout [options] [APP] [BRANCH]"
+        options.separator "Options:"
+        options.on('-p', '--project PROJECT', "The project with the app we are checking out the branch in. Default: #{default_project.name}") do |name|
+          self.project_name = name.to_sym
+        end
+      end
+    end
+    # This method extracts the positional arguments from the command line.
+    #
+    # This will take the app name and branch from the command line.
+    def parse_positional_arguments(arguments)
+      self.app = arguments.shift
+      self.branch = arguments.shift
+    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 checkout for more information"
+        return false
+      end
+      if branch.nil?
+        log "You must provide a branch"
+        log "Run #{Command.short_script_name} help checkout for more information"
+        return false
+      end
+      project = self.project_named(self.project_name)
+      return false unless project
+      container_name = "#{project.system_prefix}-#{app}"
+      docker "exec #{container_name} bash -c 'cd /var/code; git fetch; git checkout .; git checkout #{branch}; git pull'"
+      docker "exec #{container_name} bash -c '/var/docker/update_database_config.rb; rake db:migrate'"
+      docker "restart #{container_name}"
+      true
+    end
+  end
+end

data/lib/ruby_yacht/runner/command.rb ADDED Viewed

@@ -0,0 +1,161 @@
+require 'optparse'
+module RubyYacht::Runner
+  # This class is the base class for the commands that users can run for
+  # managing their system.
+  class Command
+    # Command information
+    # The name of the command that users run to trigger this command.
+    # This implementation raises an error. Subclasses must implement it to
+    # provide the command name.
+    def self.command
+      raise "Command not defined for #{self}"
+    end
+    # This class gets a short description of the command.
+    # This implementation raises an error. Subclasses must implement it to
+    # provide the command description.
+    def self.description
+      raise "Description not defined for #{self}"
+    end
+    # This method gets the command-line options for invoking this script.
+    #
+    # This must return an OptionParser.
+    #
+    # The default implementation returns an OptionParser with the command name
+    # and description. Subclasses should implement this if they want to accept
+    # other command-line options.
+    def option_parser
+      OptionParser.new do |options|
+        options.banner = "Usage: #{Command.short_script_name} #{self.class.command}\n\n#{self.class.description}"
+      end
+    end
+    # This method extracts the positional arguments from the command line.
+    #
+    # This will be called after all the flags have been consumed by the
+    # OptionParser.
+    #
+    # The default implementation does nothing. Subclasses should implement this
+    # if they want to extract arguments from the command line.
+    #
+    # ### Parameters
+    #
+    # * **arguments: Array**     The remaining arguments from the command line.
+    def parse_positional_arguments(arguments)
+    end
+    # This method runs the logic for the command.
+    #
+    # The default implementation raises an exception. Subclasses must implement
+    # this with their command-specific logic.
+    #
+    # ### Returns
+    #
+    # This must return a Boolean indicating whether the command succeeded or
+    # not.
+    def run
+      raise "Run method not defined for #{self}"
+    end
+    # Helpers
+    # This method gets the name of the script that was invoked to run the
+    # commands.
+    #
+    # This will just be the filename of the script.
+    def self.short_script_name
+      return File.basename($0)
+    end
+    # This method gets the projects that have been configured.
+    def projects
+      RubyYacht.configuration.projects
+    end
+    # The project that we will use if they do not provide one from the command
+    # line.
+    def default_project
+      projects.first
+    end
+    # This method finds a project by name.
+    #
+    # If the name is nil, this will use the default project. If the name is
+    # provided, but does not match any project, this will log an error and
+    # return nil.
+    #
+    # ### Parameters
+    #
+    # * **name: Symbol**        The name of the project.
+    def project_named(name)
+      if self.project_name
+        project = projects.find { |p| p.name == name }
+        unless project
+          log "There is no project named #{name}"
+        end
+        project
+      else
+        self.default_project
+      end
+    end
+    # This method gets a property from the default docker machine.
+    #
+    # ### Parameters
+    #
+    # * **property: String**    The docker machine property to fetch.
+    #
+    # ### Returns
+    # The response from docker-machine.
+    def get_machine_info(property)
+      backtick("docker-machine inspect default -f {{#{property}}}").strip
+    end
+    # Stubbing
+    # This method logs a message to standard out. It allows us to stub out and
+    # test the logging behavior of the commands.
+    def log(message)
+      $stdout.puts message
+    end
+    # This method sends a command to docker.
+    #
+    # This should start with exec, run, build, etc.
+    #
+    # This allows us to stub out and test the docker commands that get sent.
+    #
+    # ### Parameters
+    # * **command: String**     The command to execute.
+    def docker(command)
+      system "docker #{command}"
+    end
+    # This method sends a command to the system.
+    #
+    # This is a proxy for Kernel.system that allows us to stub out and test the
+    # system interaction.
+    #
+    # ### Parameters
+    # * **command: String**     The command to execute.
+    def system(command)
+      Kernel.system(command)
+    end
+    # This method runs a command using the backtick operator.
+    #
+    # This allows us to stub and and test the system interaction.
+    #
+    # ### Parameters
+    # * **command: String**     The command to execute.
+    #
+    # ### Returns
+    # This returns the output from the command.
+    def backtick(command)
+      `#{command}`
+    end
+  end
+end

data/lib/ruby_yacht/runner/help.rb ADDED Viewed

@@ -0,0 +1,55 @@
+module RubyYacht::Runner
+  # This command provides help information about other commands.
+  class Help < Command
+    # The name of the command.
+    def self.command; 'help'; end
+    # The short description of the command.
+    def self.description
+      "Get information on available commands"
+    end
+    # The command that we are getting help in.
+    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} help [command]\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.command = arguments.shift
+    end
+    # This method runs the logic for the command.
+    def run
+      if self.command
+        RubyYacht::Runner.commands.each do |command|
+          if command.command == self.command
+            log command.new.option_parser.to_s
+            return true
+          end
+        end
+        log "Command not available: #{self.command}"
+        log "Run #{Command.short_script_name} help for more options"
+        return false
+      end
+      log "Available commands: \n\n"
+      RubyYacht::Runner.commands.each do |command|
+        log "#{command.name}: #{command.description}"
+      end
+      log "\nRun #{Command.short_script_name} help [command] for more information on a command"
+      true
+    end
+  end
+end

data/lib/ruby_yacht/runner/implode.rb ADDED Viewed

@@ -0,0 +1,33 @@
+module RubyYacht::Runner
+  # This class provides a command for destroying the local docker environment.
+  class Implode < Command
+    # The name of the command.
+    def self.command; 'implode'; end
+    # The description of the command.
+    def self.description
+      "Destroy your local environment"
+    end
+    # This method runs the logic of the command.
+    def run
+      projects.each do |project|
+        system_prefix = project.system_prefix
+        machines = backtick("docker ps -a | grep #{system_prefix}").split("\n").map { |line| line.split(/\s+/)[0] }
+        machines.each do |machine|
+          docker "rm -f #{machine}"
+        end
+        images = backtick("docker images | grep #{system_prefix}").split("\n").map { |line| line.split(/\s+/)[0] }
+        images.each do |image|
+          docker "rmi #{image}"
+        end
+      end
+      backtick("docker images -q --filter dangling=true").split("\n").each do |image|
+        docker "rmi #{image}"
+      end
+    end
+  end
+end

data/lib/ruby_yacht/runner/run_containers.rb ADDED Viewed

@@ -0,0 +1,105 @@
+module RubyYacht::Runner
+  # This class provides a command for running all the images in new containers.
+  #
+  # It will also remove any existing containers with conflicting names.
+  class RunContainers < Command
+    # THe name of the command.
+    def self.command; 'run_containers'; end
+    # The short description of the command.
+    def self.description; 'Runs containers for all the apps'; end
+    # This method runs the logic of the command.
+    def run
+      @network = projects.first.system_prefix
+      projects.each do |project|
+        @project = project
+        if @project.check_out_locally
+          FileUtils.mkdir_p File.join(ENV["PWD"], '..', 'code')
+        end
+        if project.database.local?
+          run_container :database
+        end
+        project.apps.each do |app|
+          run_container app.name
+        end
+        if @project.create_deploy_container
+          run_container :deploy
+        end
+      end
+      @project = projects.first
+      run_container :web
+      true
+    end
+    # This method gets the flags for defining DNS server config when running
+    # a container.
+    def dns_server_flags
+      flags = []
+      if @project.dns_server
+        flags += @project.dns_server.servers.map { |server| "--dns=#{server}" }
+        flags += @project.dns_server.search_domains.map { |domain| "--dns-search=#{domain}" }
+      end
+      flags
+    end
+    # This method gets the flags for mapping the code volume to a local path for
+    # a container.
+    #
+    # ### 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)
+        if container_name == :deploy
+          return ["-v $PWD/../code:/var/code"]
+        else
+          return ["-v $PWD/../code/#{container_name}:/var/code"]
+        end
+      else
+        return []
+      end
+    end
+    # This method runs a container.
+    #
+    # It will also remove any existing containers with conflicting names.
+    #
+    # ### Parameters
+    #
+    # * **name: Symbol**    The name of the container, not including the system
+    #                       prefix.
+    def run_container(name)
+      container_name = "#{@project.system_prefix}-#{name}"
+      remove_container container_name
+      flags = ["-d"]
+      flags += dns_server_flags
+      flags += volume_flags(name)
+      flags << "-it" if name == :deploy
+      flags << "-p 80:80" if name == :web
+      flags << "--net=#{@network}"
+      flags << "--net-alias=#{container_name}"
+      flag_text = flags.join(' ')
+      docker "run #{flag_text} --name=#{container_name} #{container_name}"
+    end
+    # This method removes a container.
+    #
+    # ### Parameters
+    #
+    # * **container_name: String**    The full name of the container.
+    def remove_container(container_name)
+      IO.popen("docker rm -f #{container_name}", err: :close) {}
+    end
+  end
+end

data/lib/ruby_yacht/runner/runner.rb ADDED Viewed

@@ -0,0 +1,42 @@
+module RubyYacht::Runner
+  # This method provides the commands that we can run.
+  def self.commands
+    [Help, Build, BuildImages, RunContainers, Services, Checkout, Shell, UpdateHosts, Implode]
+  end
+  # This method gets the arguments for the current command.
+  def self.arguments
+    ARGV
+  end
+  # This method runs a command based on the command line arguments.
+  def self.run
+    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
+    end
+    command = self.commands.find { |c| c.command == arg }
+    if command
+      command_arguments = arguments
+      command_arguments.shift
+      instance = command.new
+      instance.option_parser.parse! command_arguments
+      instance.parse_positional_arguments command_arguments
+      success = instance.run
+      unless success
+        exit(1)
+      end
+    else
+      puts "Command not recognized: #{arg}"
+      puts "Run `#{$0} help` for more information"
+      exit(1)
+    end
+  end
+end