ruby_yacht 0.1.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    ruby_yacht (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    codeclimate-test-reporter (0.5.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    json (1.8.3)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    timecop (0.8.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codeclimate-test-reporter
+  rspec
+  ruby_yacht!
+  timecop
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,8 @@
+Copyright (c) 2016 John Brownlee
+
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,216 @@
+This gem provides a DSL for creating docker containers for running a family of
+Rails apps.
+
+[![Code Climate](https://codeclimate.com/github/brownleej/ruby-yacht/badges/gpa.svg)](https://codeclimate.com/github/brownleej/ruby-yacht)
+[![Test Coverage](https://codeclimate.com/github/brownleej/ruby-yacht/badges/coverage.svg)](https://codeclimate.com/github/brownleej/ruby-yacht/coverage)
+
+# Prerequisites
+
+1.  Install [Docker](https://www.docker.com/products/docker-toolbox)
+2.  Install ruby and the ruby_yacht gem.
+
+# Usage
+
+Create a file called `run.rb`, which will be the main file for your docker
+scripts. This file can be called anything, but we will use that name here so we
+have a consistent reference.
+
+Enter this in the file:
+
+        require 'ruby_yacht'
+        
+        RubyYacht.configure do
+        end
+        
+        RubyYacht::Runner.run
+        
+Your `run.rb` file will have two parts: A configuration block and the `Runner`
+command. The configuration block defines your projects and your apps. You can
+read [configuration_sample.rb](https://github.com/brownleej/ruby-yacht/blob/master/doc/configuration_sample.rb)
+for more information on how the configuration DSL.
+
+The runner command invokes a RubyYacht script based on the command information.
+
+# RubyYacht Scripts
+
+RubyYacht provides several scripts to build and manage your application
+environment. You can invoke these scripts by calling `ruby run.rb [command]`.
+
+The examples below describe the results for the projects in the configuration
+sample file, which contains the following projects:
+
+* Project: apollo
+    * apps: mars, saturn
+    * database: localhost
+    * domain: apollo.docker.local
+  
+* Project: jupiter
+     * apps: venus, saturn
+     * database: db.test.com
+     * domain: jupiter.docker.local
+
+### help
+
+This command lists available commands, and provides information on the
+syntax and options for each command.
+
+### build
+
+This command builds images for your projects, runs the containers, and updates
+your hosts file to add entries that point your app's domains toward the local
+docker address. This is a combination of `build_images`, `run_containers`, and
+`update_hosts`, so you can run those commands individually, and in different
+combinations, if you prefer.
+
+### build_images
+
+This command builds all of the images for your project. For the example above,
+it will build the following images:
+
+<table>
+  <tr>
+    <td>apollo-app-dependencies</td>
+    <td>
+      An image with mars and saturn checked out, and all of their dependencies
+      installed
+    </td>
+  </tr>
+  <tr>
+    <td>apollo-database</td>
+    <td>
+      An image with mysql installed and a database set up with the schema and
+      seeds from mars and saturn
+    </td>
+  </tr>
+  <tr>
+    <td>apollo-mars</td>
+    <td>
+      An image with the mars app installed, and the dependencies for mars
+      installed, set up to point to the apollo-database database.
+    </td>
+  </tr>
+  <tr>
+    <td>apollo-saturn</td>
+    <td>
+      An image with the saturn app installed, and the dependencies for saturn
+      installed, set up to point to the apollo-database database.
+    </td>
+  </tr>
+  <tr>
+    <td>jupiter-app-dependencies</td>
+    <td>
+      An image with venus and saturn checked out, and all of their dependencies
+      installed
+    </td>
+  </tr>
+  <tr>
+    <td>jupiter-venus</td>
+    <td>
+      An image with the venus app installed, and the dependencies for mars
+      installed, set up to point to the db.test.com database.
+    </td>
+  </tr>
+  <tr>
+    <td>jupiter-saturn</td>
+    <td>
+      An image with the saturn app installed, and the dependencies for saturn
+      installed, set up to point to the db.test.com database.
+    </td>
+  </tr>
+  <tr>
+    <td>apollo-web</td>
+    <td>
+      An image with nginx installed, and set up to proxy the app containers for
+      apollo-mars, apollo-saturn, jupiter-venus, and jupiter-saturn. Each app
+      will get a subdomain of the project's main domain, with the subdomain named
+      after the app.
+    </td>
+  </tr>
+</table>
+
+### run_containers
+
+This command runs all of the containers for the images described above. Each
+container will have the same name as its image. Each container will be on a
+docker network called `apollo`, and will have network aliases corresponding to
+the container names. For instance, the `apollo-web` container will be able to
+access the `apollo-mars` container under the hostname `apollo-mars`. The apps
+will also be able to talk to each other using these network aliases.
+
+It will not run a container for the `app-dependencies` images. Those images are
+intended to use as a baseline for the app and database images, to reduce their
+build times.
+
+All of the containers will be run as daemons.
+
+### update_hosts
+
+This command updates your hosts file to add entries for your containers. This
+is intended to help with development environments, where you won't have a real
+domain that resolves to your local machine.
+
+For the examples above, it will add entries for these domains:
+
+* apollo.docker.local
+* mars.apollo.docker.local
+* saturn.apollo.docker.local
+* jupiter.docker.local
+* venus.jupiter.docker.local
+* saturn.jupiter.docker.local
+
+This will allow you to access your local version of the apps in the web browser
+on your local machine without any additional DNS setup.
+
+Before overwriting the hosts file, it will save a copy of the existing hosts
+file to `/etc/hosts.{timestamp}.backup`.
+
+This will prompt you for your password, because it needs root privileges to
+update the hosts file. It will only use that privilege to run the commands:
+
+        sudo cp /etc/hosts /ect/hosts.{timestamp}.backup
+        sudo cp tmp/hosts /etc/hosts
+        
+The `tmp/hosts` file is populated prior to the privilege escalation with the
+updated hosts file contents.
+
+### implode
+
+This will remove all of the containers and images for your projects, and also
+remove any dangling docker images. After this is done, you can run the `build`
+command to rebuild your environment from scratch.
+
+This will not ruby the `ruby` and `nginx` images. Those are downloaded as
+part of the build process, and are provided by third parties as official docker
+images for those ruby and nginx.
+
+### services
+
+This allows you to start, stop, or restart containers. If you run it with the
+`start` sub-command, it will also start docker-machine, if necessary. The most
+common use case for this is to run `ruby run.rb services start` after you reboot
+your machine, to get your docker environment up and running again.
+
+### shell
+
+This opens a shell in an app container. By default, this opens a bash shell, but
+any additional commands you pass it will be forwarded to the container and run.
+
+For instance, you can run `ruby run.rb shell mars` to open a bash shell in the
+mars app container, or `ruby run.rb shell mars rails c` to open a
+rails console, or `ruby run.rb shell mars tail -f log/development.log` to start
+reading all the content printed to the development log file.
+
+### checkout
+
+This checks out a new branch inside an app container, and restarts the app
+container. It will also immediately run any database migrations from the new
+branch.
+
+If you run it for a branch that you already have checked out, it will pull down
+the latest changes from the repository.
+
+# Additional Information
+
+If you're interested in contributing to the project, you can find more
+information in [CONTRIBUTING.md](https://github.com/brownleej/ruby-yacht/blob/master/doc/CONTRIBUTING.md).
+You can also reach out to me on Twitter [@brownleej](https://twitter.com/brownleej)

data/doc/CONTRIBUTING.md

@@ -0,0 +1,12 @@
+I'm eager to accept contributions to ruby_yacht to fix bugs and empower it to
+handle more people's workflows. I'm preparing a plugin engine as part of the 1.0
+release, and that will likely shape decisions about what gets accepted into the
+core and what should remain in individual's projects. You can start by opening
+a pull request with a fix, or an issue with a suggestion for a new feature.
+
+All pull requests must contain test coverage. The nature of this project
+requires caution when developing and running tests. The tests contain extensive
+stubs to prevent them from interacting with a real docker environment, and you
+should use the same techniques in your own tests. I would also recommend that
+you run the tests within their own docker container. You can find tools for
+building such a container in [spec/docker](../spec/docker)

data/doc/TODO.md

@@ -0,0 +1,28 @@
+# General
+
+* Testing behavior of the scripts that run on the image.
+* Do more testing with remote databases and non-development environments
+* Consider whether deploy containers are worth including
+* Consider whether using the same web server for multiple projects is the best
+  approach
+
+# Transitioning to Gem
+
+* Publish gem
+
+# More Command Line Options
+
+* Getting status of containers
+* Starting / stopping individual containers
+* Clearing backups of the hosts file
+
+# More customization
+
+* Add customizations for installation
+* Add customization for post-checkout hooks
+* HTTPS access for apps
+* Distinguishing whether we should use local or remote connections for other
+  services
+* Different types of app servers, i.e. non-rails apps
+* Using one of the apps for the bare domain
+* Defining custom commands

data/doc/configuration_sample.rb

@@ -0,0 +1,87 @@
+require 'ruby_yacht'
+
+RubyYacht.configure do
+  project :apollo do
+    # All the images and containers for this project will be prefixed with
+    # 'apollo-'
+    system_prefix :apollo
+    
+    # The web server will place the apps under 'apollo.docker.local'
+    #
+    # apollo.docker.local will point to a landing page with links to the apps,
+    # and individual apps will be available at mars.apollo.docker.local and
+    # saturn.apollo.docker.local
+    domain "apollo.docker.local"
+    
+    # The repositories for the apps in this project will all be available at the
+    # domain github.com.
+    #
+    # All repositories will be checked out over SSH, so you need to make sure
+    # that the containers have SSH keys that can access the repository server.
+    #
+    # When the images are built, it will automatically copy the SSH key from
+    # ~/.ssh/id_rsa into the containers.
+    repository "github.com"
+    
+    # The configuration for the database the app uses.
+    database do
+      # A database host of localhost tells ruby-yacht to build a database
+      # container for the apps' local database.
+      host "localhost"
+      
+      # The apps will share a database called apollo
+      name "apollo"
+      
+      # The credentials for accessing the database.
+      username "apollo"
+      password "test"
+    end
+    
+    app :mars do
+      # This app's repository is at github.com/brownleej/mars
+      repository_name 'brownleej/mars'
+    end
+    
+    app :saturn do
+      # This app's repository is at github.com/brownleej/saturn
+      repository_name 'brownleej/saturn'
+    end
+    
+    # The secret key that we use for session information in the Rails apps.
+    secret_key_base 'abc'
+  end
+
+  # This is a second project that runs a different set of apps, with different
+  # domains and a separate database.
+  project :jupiter do
+    system_prefix :jupiter
+    domain "jupiter.docker.local"
+    repository "github.com"
+    
+    database do
+      # Because this host has a real domain, we will not build a database
+      # container. The database at this host must be set up in advance with
+      # the database and the credentials in this file.
+      #
+      # When the apps start, they will automatically run database migrations
+      # against this database.
+      host "db.test.com"
+      name "jupiter"
+      username "jupiter"
+      password "test"
+    end
+    
+    app :venus do
+      repository_name 'brownleej/venus'
+    end
+    
+    app :saturn do
+      repository_name 'brownleej/saturn'
+    end
+    
+    secret_key_base 'abc'
+  end
+end
+
+RubyYacht::Runner.run
+

data/lib/ruby_yacht/dsl/app.rb

@@ -0,0 +1,59 @@
+module RubyYacht
+  # This class models an app that's part of the local system.
+  #
+  # See RubyYacht::App::DSL for information on configuring the app.
+  class App
+    # The name of the app
+    attr_accessor :name
+    
+    # The name of the repository where the app's code is stored, relative
+    # To the project's repository domain.
+    attr_accessor :repository_name
+    
+    # The port that the app listens on.
+    attr_accessor :port
+
+    # This method gets the name of the image / container that this app will run
+    # in.
+    #
+    # ### Parameters
+    #
+    # * *project: RubyYacht::Project*  The project the app is running in.
+    def container_name(project)
+      return "#{project.system_prefix}-#{self.name}"
+    end
+    
+    # This class provide's the DSL for configuring an app.
+    #
+    # Inside of the project configuration, you can call `app [name]` to add an
+    # app, and then pass it a block to configure the app, which will allow you
+    # to call these DSL methods.
+    class DSL
+      include RubyYacht::DSL::Base
+      extend RubyYacht::DSL::Base::ClassMethods
+      
+      # This initializer starts the DSL for the app.
+      #
+      # ### Parameters
+      #
+      # * *name: String* The name of the app.
+      def initialize(name)
+        @name = name.to_sym
+      end
+      
+      add_attribute :name
+      
+      ##
+      # :method: repository_name
+      # You can call `repository_name 'foo/bar'` to set the app's `repository_name`.
+      add_attribute :repository_name
+      
+      ##
+      # :method: port
+      # You can call `port 3000` to set the app's `port`. It defaults to 8080.
+      add_attribute :port, 8080
+
+      creates_object App
+    end
+  end
+end

data/lib/ruby_yacht/dsl/configuration.rb

@@ -0,0 +1,55 @@
+module RubyYacht
+  # This class stores the configuration for the system.
+  #
+  # For more information on the configuration DSL, see RubyYacht::Configuration::DSL.
+  class Configuration
+    # This initializer creates an empty configuration.
+    def initialize
+      self.clear
+    end
+
+    # This method erases all the configuration.
+    def clear
+      @projects = []
+    end
+    
+    # The projects that are part of this system.
+    # Each entry is a RubyYacht::Project
+    attr_accessor :projects
+    
+    # This method provides a DSL for top-level configuration.
+    class DSL
+      include RubyYacht::DSL::Base
+      extend RubyYacht::DSL::Base::ClassMethods
+      
+      ##
+      # :method: project
+      #
+      # This method adds a project to the configuration.
+      #
+      # This takes the project name as its first argument. It also takes a block
+      # which you can use to configure the project, using
+      # RubyYacht::Project::DSL.
+      add_object_list :project, 'RubyYacht::Project::DSL'
+      
+      creates_object Configuration
+    end
+  end
+  
+  # This method adds configuration for the system.
+  #
+  # If you pass a block to this method, it will be evaluated using the methods
+  # in RubyYacht::Configuration::DSL.
+  #
+  # Any projects you define in that block will be added to the current list
+  # of projects.
+  def self.configure(&block)
+    new_configuration = Configuration::DSL.new.run(block).create_object
+    self.configuration.projects += new_configuration.projects
+  end
+  
+  # This method gets the current configuration for the system.
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+end

data/lib/ruby_yacht/dsl/database.rb

@@ -0,0 +1,57 @@
+module RubyYacht
+  # This class stores the configuration for a project's database server.
+  #
+  # You can configure a database with RubyYacht::Database::DSL
+  class Database
+    # The host that the database server is accessed on.
+    attr_accessor :host
+    
+    # The name of the database
+    attr_accessor :name
+    
+    # The username we use to connect to the database
+    attr_accessor :username
+    
+    # The password we use to connect to the database
+    attr_accessor :password
+    
+    # Whether the database is running on the same machine as the app servers.
+    def local?
+      host == 'localhost'
+    end
+
+    # This class provides a DSL for configuring a database.
+    #
+    # You can access this DSL by calling `database` within `RubyYacht::Project::DSL`.
+    # It will create a RubyYacht::Database
+    class DSL
+      include RubyYacht::DSL::Base
+      extend RubyYacht::DSL::Base::ClassMethods
+      
+      ##
+      # :method: host
+      # You can call `host 'db.test.com'` to set the database's host.
+      add_attribute :host
+      
+      #
+      # :method: name
+      # You can call `name` 'my_database'` to tell the apps to use the database
+      # named `my_database`.
+      add_attribute :name
+      
+      ##
+      # :method: username
+      # You can call `username 'db-user'` to tell the apps to connect to the
+      # database under the name `db-user`.
+      add_attribute :username
+      
+      ##
+      # :method: password
+      # You can call `password 'testpass'` to tell the apps to connect to the
+      # password `testpass`.
+      add_attribute :password
+      
+      creates_object Database
+    end
+  end
+end

data/lib/ruby_yacht/dsl/dns_server.rb

@@ -0,0 +1,38 @@
+module RubyYacht
+  # This class provides configuration for DNS servers for your apps.
+  #
+  # This is optional. If you don't provide any DNS server configuration, we will
+  # use docker's default DNS configuration.
+  #
+  # You can configure this with RubyYacht::DnsServer::DSL
+  class DnsServer
+    # The servers that we use for DNS. Each entry is a String.
+    attr_accessor :servers
+    
+    # The domains that we use for default DNS lookup. Each entry is a String.
+    attr_accessor :search_domains
+    
+    # This class provides a DSL for configuring DNS server options.
+    #
+    # You can access this by calling `dns_server` within RubyYacht::Project::DSL.
+    # It will create a RubyYacht::DnsServer.
+    class DSL
+      include RubyYacht::DSL::Base
+      extend RubyYacht::DSL::Base::ClassMethods
+      
+      ##
+      # :method: server
+      # You can call `server '1.2.3.4'` to add `1.2.3.4` to the project's list of
+      # DNS servers.
+      add_list :server
+      
+      ##
+      # :method: search_domain
+      # You can call `search_domain 'apps.test.com'` to add `apps.test.com` to
+      # the list of domains that we automatically search for in the DNS.
+      add_list :search_domain
+      
+      creates_object DnsServer
+    end
+  end
+end