ruby_yacht 0.1.1 → 0.2.0

data/lib/ruby_yacht/dsl/project.rb

@@ -7,6 +7,8 @@ module RubyYacht
   #
   # A project is a family of apps that communicate with each other and
   # share a database.
+  #
+  # You can configure this with RubyYacht::Project::DSL
   class Project
     # The name of the project.
     attr_accessor :name
@@ -21,12 +23,6 @@ module RubyYacht
     # The hostname for the repository that contains the code for the apps.
     attr_accessor :repository
     
-    # The secret key that the apps should use for signing cookies.
-    attr_accessor :secret_key_base
-    
-    # The environment that the apps should run in.
-    attr_accessor :rails_environment
-    
     # Whether we should check out the code on the host machine, rather than
     # keeping it entirely inside the container.
     attr_accessor :check_out_locally
@@ -59,6 +55,8 @@ module RubyYacht
       # * *name: String* The name of the project
       def initialize(name)
         @name = name.to_sym
+        load_custom_attributes
+        load_app_initializers
       end
       
       add_attribute :name
@@ -75,27 +73,12 @@ module RubyYacht
       # test.com
       add_attribute :domain
       
-      ##
-      # :method: secret_key_base
-      # You can call `secret_key_base '1234kj1234k;lj1234jklh'` to set the
-      # project's `secret_key_base` to `1234kj1234k;lj1234jklh`.
-      add_attribute :secret_key_base
-      
       ##
       # :method: repository
       # You can call `repository 'github.com'` to set the project's `repository`
       # to `github.com`
       add_attribute :repository
       
-      ##
-      # :method: rails_environment
-      #
-      # You can call `rails_environment 'staging'` to set the project's 
-      # `rails_environment` to  `staging`.
-      #
-      # The default is `development`.
-      add_attribute :rails_environment, 'development'
-      
       ##
       # :method: check_out_locally
       #
@@ -139,6 +122,19 @@ module RubyYacht
       add_object :dns_server, RubyYacht::DnsServer::DSL, required: false
       
       creates_object Project
+
+      # This method loads the special DSL methods for defining apps of a certain
+      # type.
+      #
+      # For the app type with the name `foo`, this will create a `foo_app`
+      # method on the DSL that builds an app with the type `foo`.
+      def load_app_initializers
+        RubyYacht.configuration.app_types.each do |app_type|
+          define_singleton_method "#{app_type.name}_app" do |name, &block|
+            app name, app_type.name, &block
+          end
+        end
+      end
     end
   end
 end

data/lib/ruby_yacht/dsl.rb

@@ -4,3 +4,5 @@ require 'ruby_yacht/dsl/project'
 require 'ruby_yacht/dsl/app'
 require 'ruby_yacht/dsl/database'
 require 'ruby_yacht/dsl/dns_server'
+require 'ruby_yacht/dsl/hook'
+require 'ruby_yacht/dsl/app_type'

data/lib/ruby_yacht/images/app/Dockerfile.erb

@@ -1,32 +1,39 @@
-FROM <%= @project.system_prefix %>-app-dependencies
+FROM <%= @project.system_prefix %>-<%= @app.app_type %>-app-dependencies
 
 ENV DATABASE_HOST <%= @project.database.host %>
 ENV DATABASE_NAME <%= @project.database.name %>
 ENV DATABASE_PASSWORD <%= @project.database.password %>
 ENV DATABASE_USERNAME <%= @project.database.username %>
-ENV RAILS_ENV <%= @project.rails_environment %>
-ENV RAILS_PORT <%= @app.port %>
+ENV APP_PORT <%= @app.port %>
 ENV REPOSITORY_HOST <%= @project.repository %>
-ENV SECRET_KEY_BASE <%= @project.secret_key_base %>
 ENV SYSTEM_PREFIX <%= @project.system_prefix %>
+<% app_type = RubyYacht.configuration.find_app_type(@app.app_type) %>
+<% app_type.environment_variables.select { |variable| variable[:image] == :app }.each do |variable| %>
+ENV <%= variable[:name] %> <%= instance_eval(&variable[:block]) %>
+<% end %>
 
 RUN rm -r /var/code
 RUN mkdir -p /var/code
 
-COPY startup.rb /var/docker/startup.rb
-COPY checkout.rb /var/docker/checkout.rb
-COPY update_database_config.rb /var/docker/update_database_config.rb
-
-RUN chmod u+x /var/docker/*.rb
-
 ENV REPOSITORY_NAME <%= @app.repository_name %>
+COPY checkout.bash /var/docker/checkout.bash
+RUN bash /var/docker/checkout.bash
+
+COPY before_startup.bash /var/docker/before_startup.bash
+COPY startup.bash /var/docker/startup.bash
+<% RubyYacht.configuration.fetch_hooks(app_type: @app.app_type).select { |hook| hook.script_name != '' }.each do |hook| %>
+<% next unless [:startup, :build_checkout].include?(hook.event_type) %>
+COPY <%= hook.script_name %> /var/docker/<%= hook.script_name %>
+<% end %>
 
-RUN /var/docker/checkout.rb
+RUN chmod u+x /var/docker/*
 
 WORKDIR /var/code
 
-RUN bundle install && bundle clean --force
+<% RubyYacht.configuration.fetch_hooks(app_type: @app.app_type, event_time: :after, event_type: :build_checkout).each do |hook| %>
+RUN <%= hook.command %>
+<% end %>
 
 EXPOSE <%= @app.port %>
 
-CMD /var/docker/startup.rb
+CMD /var/docker/startup.bash

data/lib/ruby_yacht/images/app/before_startup.bash.erb

@@ -0,0 +1,8 @@
+#! /bin/bash
+
+cd /var/code;
+/var/docker/checkout.bash;
+
+<% RubyYacht.configuration.fetch_hooks(app_type: @app.app_type, event_time: :before, event_type: :startup).each do |hook| %>
+<%= hook.command %>;
+<% end %>

data/lib/ruby_yacht/images/app/checkout.bash

@@ -0,0 +1,6 @@
+#! /bin/bash
+
+if [ ! -d /var/code/.git ]
+then
+  git clone git@$REPOSITORY_HOST:$REPOSITORY_NAME /var/code
+fi

data/lib/ruby_yacht/images/app/startup.bash.erb

@@ -0,0 +1,5 @@
+#! /bin/bash
+/var/docker/before_startup.bash;
+<% RubyYacht.configuration.fetch_hooks(app_type: @app.app_type, event_time: :during, event_type: :startup).each do |hook| %>
+<%= hook.command %>;
+<% end %>

data/lib/ruby_yacht/images/app-dependencies/Dockerfile.erb

@@ -1,23 +1,41 @@
-# This Dockerfile creates an image for installing all of the gem dependencies
+# This Dockerfile creates an image for installing all of the dependencies
 # for all of the apps.
 #
 # This is a slow process, so this should be kept as simple as possible so that
 # it can remain unchanged.
 
-FROM ruby:2.3
+FROM <%= @app_type.baseline_image %>
 
 RUN mkdir -p /root/.ssh
 COPY id_rsa /root/.ssh
 RUN ssh-keyscan <%= @project.repository %> >> /root/.ssh/known_hosts
 
 RUN mkdir -p /var/docker/
-COPY install_gems.rb /var/docker/install_gems.rb
+
+<% library_scripts = RubyYacht.configuration.fetch_hooks(app_type: @app_type.name, event_time: :during, event_type: :install_libraries).select { |hook| hook.script_name != '' } %>
+<% library_scripts.each do |hook |%>
+COPY <%= hook.script_name %> /var/docker/<%= hook.script_name %>
+<% end %>
+
+<% if library_scripts.any? %>
+RUN chmod u+x /var/docker/*
+<% end %>
 
 <% @project.apps.each do |app| %>
-RUN ruby /var/docker/install_gems.rb <%= app.name %> <%= @project.repository %> <%= app.repository_name %>
+<% next unless app.app_type == @app_type.name %>
+
+RUN git clone git@<%= @project.repository %>:<%= app.repository_name %> /var/code/<%= app.name %>
+WORKDIR /var/code/<%= app.name %>
+<% RubyYacht.configuration.fetch_hooks(app_type: @app_type.name, event_time: :during, event_type: :install_libraries).each do |hook |%>
+RUN <%= hook.command %>
+<% end %>
+<% end %>
+
+<% if library_scripts.any? %>
+RUN rm /var/docker/*
 <% end %>
 
-RUN rm /var/docker/install_gems.rb
+WORKDIR /
 
 RUN apt-get update && apt-get upgrade -y
 RUN apt-get install -y mysql-client

data/lib/ruby_yacht/images/database/Dockerfile.erb

@@ -1,26 +1,40 @@
-FROM <%= @project.system_prefix %>-app-dependencies
-
+FROM <%= @project.system_prefix %>-<%= @app_type.name %>-app-dependencies
 <% database = @project.database %>
 
 ENV DEBIAN_FRONTEND noninteractive
 RUN apt-get install -y mysql-server
 
-COPY setup.rb /var/docker/setup.rb
-COPY setup_database.sql.erb /var/docker/setup_database.sql.erb
-COPY load_seeds.rb /var/docker/load_seeds.rb
+ENV DATABASE_USERNAME <%= @project.database.username %>
+ENV DATABASE_PASSWORD <%= @project.database.password %>
+ENV DATABASE_NAME <%= @project.database.name %>
+
+COPY setup.bash /var/docker/setup.bash
+COPY checkout.bash /var/docker/checkout.bash
+<% @project.apps.map(&:app_type).uniq.each do |app_type| %>
+<% RubyYacht.configuration.fetch_hooks(app_type: app_type, event_type: :load_database_seeds).each do |hook| %>
+COPY <%= hook.script_name %> /var/docker/<%= hook.script_name %>
+<% end %>
+<% end %>
+
+RUN chmod u+x /var/docker/*
 
-RUN ruby /var/docker/setup.rb <%= database.name %> <%= database.username %> <%= database.password %> <%= @project.rails_environment %>
+RUN /var/docker/setup.bash <%= database.name %> <%= database.username %> <%= database.password %>
 
-<% initialized = false %>
 <% @project.apps.each do |app| %>
-  <% database_name = database.name %>
-  <% database_name += '_development' if @project.rails_environment == 'development' %>
-RUN ruby /var/docker/load_seeds.rb <%= app.name %> <%= database_name %> <%= database.username %> <%= database.password %> <%= initialized %>
-  <% initialized = true %>
+
+RUN /var/docker/checkout.bash <%= @project.repository %> <%= app.name %> <%= app.repository_name %>
+WORKDIR /var/code/<%= app.name %>
+<% @app_type = RubyYacht.configuration.find_app_type(app.app_type) %>
+<%= include_event :load_database_seeds %>
 <% end %>
+
 RUN rm -r /var/docker
 RUN rm -r /var/code
 
+ENV DATABASE_USERNAME ''
+ENV DATABASE_PASSWORD ''
+ENV DATABASE_NAME ''
+
 EXPOSE 3306
 
 CMD mysqld_safe --bind-address=0.0.0.0

data/lib/ruby_yacht/images/database/checkout.bash

@@ -0,0 +1,10 @@
+#! /bin/bash
+
+REPOSITORY_HOST=$1
+APP_NAME=$2
+REPOSITORY_NAME=$3
+
+if [ ! -d /var/code/$APP_NAME/.git ]
+then
+  git clone git@$REPOSITORY_HOST:$REPOSITORY_NAME /var/code/$APP_NAME
+fi

data/lib/ruby_yacht/images/database/setup.bash

@@ -0,0 +1,15 @@
+#! /bin/bash
+
+DATABASE_NAME=$1
+DATABASE_USER=$2
+DATABASE_PASSWORD=$3
+
+service mysql start;
+COMMAND="CREATE USER '$DATABASE_USER'@'localhost' IDENTIFIED BY '$DATABASE_PASSWORD';";
+COMMAND="$COMMAND CREATE USER '$DATABASE_USER'@'%' IDENTIFIED BY '$DATABASE_PASSWORD';";
+
+COMMAND="$COMMAND GRANT ALL ON $DATABASE_NAME.* to '$DATABASE_USER'@'localhost';";
+COMMAND="$COMMAND GRANT ALL ON $DATABASE_NAME.* to '$DATABASE_USER'@'%';";
+COMMAND="$COMMAND CREATE DATABASE $DATABASE_NAME;";
+
+mysql -uroot -e "$COMMAND";

data/lib/ruby_yacht/images/web/Dockerfile.erb

@@ -13,11 +13,12 @@ COPY index_config.erb /var/docker/index_config.erb
 COPY app_config.erb /var/docker/app_config.erb
 
 <% @projects.each do |project| %>
-  <% app_list = project.apps.map(&:name).join(',') %>
+
+<% app_list = project.apps.map(&:name).join(',') %>
 RUN ruby /var/docker/add_project.rb <%= project.system_prefix %> <%= project.domain %> <%= app_list %>
-  <% project.apps.each do |app| %>
+<% project.apps.each do |app| %>
 RUN ruby /var/docker/add_app.rb <%= project.system_prefix %> <%= project.domain %> <%= app.name %> <%= app.port %>
-  <% end %>
+<% end %>
 <% end %>
 
 RUN rm -r /var/docker

data/lib/ruby_yacht/plugins/rails/scripts/install_gems.rb

@@ -0,0 +1,3 @@
+#! /usr/local/bin/ruby
+
+system "bundle install"

data/lib/ruby_yacht/plugins/rails/scripts/load_seeds.rb

@@ -0,0 +1,34 @@
+#! /usr/local/bin/ruby
+
+require 'yaml'
+require 'fileutils'
+
+puts "Loading seeds"
+
+system "service mysql start"
+
+config_path = "./config/database.yml"
+
+database_config = {
+  'development' => {
+    'adapter' => 'mysql2',
+    'encoding' => 'utf8',
+    'reconnect' => true,
+    'username' => ENV['DATABASE_USERNAME'],
+    'password' => ENV['DATABASE_PASSWORD'],
+    'host' => 'localhost',
+    'database' => ENV['DATABASE_NAME']
+  }
+}
+
+File.open(config_path, "w") do |file|
+  file.write(database_config.to_yaml)
+end
+
+system "bundle install"
+tables = `mysql -uroot -e "SHOW TABLES" #{ENV['DATABASE_NAME']}`
+if tables == ''
+  system "bundle exec rake db:reset"
+else
+  system "bundle exec rake db:migrate; bundle exec rake db:seed"
+end

data/lib/ruby_yacht/{images/app/startup.rb → plugins/rails/scripts/prepare_rails_for_launch.rb}

@@ -1,17 +1,11 @@
 #! /usr/local/bin/ruby
 
 require 'fileutils'
-require_relative 'checkout'
-require_relative 'update_database_config'
-
-FileUtils.cd '/var/code'
 
 system "bundle install"
 system "rake db:migrate"
-
 system "rails r Rails.cache.clear"
+
 if ENV['RAILS_ENV'] != 'development'
   system "rake assets:precompile"
-end
-
-exec "rails s -b 0.0.0.0 -p $RAILS_PORT -e $RAILS_ENV"
+end

data/lib/ruby_yacht/{images/app/update_database_config.rb → plugins/rails/scripts/update_rails_config.rb}

@@ -23,7 +23,6 @@ database_config = {
 if ENV['RAILS_ENV'] == 'development' && local_database
   database_config['test'] = common_config.dup
   database_config['test']['database'] += '_test'
-  database_config['development']['database'] += '_development'
 end
 
 File.open('/var/code/config/database.yml', 'w') do |file|

data/lib/ruby_yacht/plugins/rails.rb

@@ -0,0 +1,40 @@
+module RubyYacht::Plugins
+  # This module provides the plugin for managing Ruby on Rails apps.
+  module Rails
+    # This method loads the configuration for the Rails plugin.
+    def self.load
+      RubyYacht.configure do
+        app_type :rails do
+          baseline_image 'ruby:2.3'
+          project_attribute name: :environment, default: 'development'
+          project_attribute name: :secret_key_base
+
+          environment_variable :app, 'RAILS_ENV' do
+            @project.rails_environment
+          end
+
+          environment_variable :app, 'SECRET_KEY_BASE' do
+            @project.rails_secret_key_base
+          end
+        end
+      end
+
+      RubyYacht.configure do
+        add_hooks(app_type: :rails, folder: File.join(File.dirname(__FILE__), 'rails', 'scripts')) do
+          during(:install_libraries) { run_script 'install_gems.rb' }
+          
+          after(:build_checkout) { command 'bundle install && bundle clean --force' }
+          
+          during(:load_database_seeds) { run_script 'load_seeds.rb' }
+
+          before(:startup) { run_script 'update_rails_config.rb' }
+          before(:startup) { run_script 'prepare_rails_for_launch.rb' }
+
+          during(:startup) { command 'rails s -b 0.0.0.0 -p $APP_PORT -e $RAILS_ENV' }
+        end
+      end
+    end
+  end
+end
+
+RubyYacht::Plugins::Rails.load

data/lib/ruby_yacht/plugins.rb

@@ -0,0 +1,6 @@
+module RubyYacht
+  # This module groups plugins that can customize the build behavior.
+  module Plugins
+  end
+end
+require 'ruby_yacht/plugins/rails'

data/lib/ruby_yacht/runner/build_images.rb

@@ -28,13 +28,19 @@ module RubyYacht::Runner
           FileUtils.cp(id_path, tmp_id_path)
         end
       
-        build_image 'app-dependencies'
+        project.apps.map(&:app_type).uniq.each do |type_name|
+          @app_type = RubyYacht.configuration.find_app_type(type_name)
+          build_image 'app-dependencies', "#{@project.system_prefix}-#{@app_type.name}-app-dependencies"
+        end
+        
         build_image 'database' if project.database.local?
         
         @project.apps.each do |app|
           @app = app
+          @app_type = RubyYacht.configuration.find_app_type(@app.app_type)
           build_image 'app', "#{@project.system_prefix}-#{app.name}"
         end
+        @app = nil
         
         if @project.create_deploy_container
           build_image 'deploy'
@@ -55,6 +61,10 @@ module RubyYacht::Runner
     # current context, and write it to the Dockerfile in the tmp folder. It will
     # then build the image, and clear out the tmp folder.
     #
+    # Depending on the image type, it may also copy and interpret other template
+    # files. For instance, for app containers we also have erb files for the
+    # `startup.bash` and `before_startup.bash` scripts.
+    #
     # ### Parameters
     #
     # * **folder_name: String**   The name of the folder containing the
@@ -65,12 +75,46 @@ module RubyYacht::Runner
     #                             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')
+        FileUtils.cp(path, File.join('tmp', File.basename(path)))
       end
+
+      templates = 
+        case folder_name
+        when 'app' then ['Dockerfile', 'before_startup.bash', 'startup.bash']
+        else ['Dockerfile']
+        end
+
+      hook_events =
+        case folder_name
+        when 'app' then [:startup, :build_checkout]
+        when 'app-dependencies' then [:install_libraries]
+        when 'database' then [:load_database_seeds]
+        else []
+        end
+        
+      app_types =
+        case folder_name
+        when 'database' then @project.apps.map(&:app_type).uniq
+        else [@app_type.name]
+        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)
+      hook_events.each do |event|
+        app_types.each do |app_type|
+          RubyYacht.configuration.fetch_hooks(app_type: app_type, event_type: event).each do |hook|
+            next unless hook.script_path
+            FileUtils.cp hook.script_path, "tmp"
+          end
+        end
+      end
+
+      templates.each do |template_name|
+        File.open(File.join('tmp', template_name), 'w') do |file|
+          template_contents = File.read(File.join('tmp', template_name + '.erb'))
+          file_contents = ERB.new(template_contents, nil, '<>').result(binding)
+          file_contents.gsub!(/\n\n\n+/, "\n\n")
+          file_contents.gsub!(/\n*\Z/, "")
+          file.write(file_contents)
+        end
       end
       
       image_name ||= "#{@project.system_prefix}-#{folder_name}"
@@ -78,5 +122,28 @@ module RubyYacht::Runner
       
       FileUtils.rm(Dir[File.join("tmp", "*")])
     end
+    
+    # This method includes the hooks for an event in a Dockerfile.
+    #
+    # It will run the commands for the before hooks, then the during hooks, then
+    # the after hooks.
+    #
+    # ### Parameters
+    #
+    # * **event_type: Symbol**     The event whose hooks we are running.
+    #
+    # ### Returns
+    #
+    # A String with the contents of the Dockerfile for running the hooks.
+    def include_event(event_type)
+      result = ""
+      [:before, :during, :after].each do |time|
+        before_hooks = RubyYacht.configuration.fetch_hooks(app_type: @app_type.name, event_type: event_type, event_time: time).each do |hook|
+          result += "RUN #{hook.command}\n"
+        end
+      end
+      
+      result
+    end
   end
 end

data/lib/ruby_yacht/runner/checkout.rb

@@ -59,7 +59,7 @@ module RubyYacht::Runner
       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 "exec #{container_name} /var/docker/before_startup.bash"
       docker "restart #{container_name}"
       
       true

data/lib/ruby_yacht.rb

@@ -3,4 +3,5 @@ module RubyYacht
 end
 
 require 'ruby_yacht/dsl'
-require 'ruby_yacht/runner'
+require 'ruby_yacht/runner'
+require 'ruby_yacht/plugins'

data/ruby_yacht.gemspec

@@ -1,7 +1,8 @@
 Gem::Specification.new do |spec|
   spec.name         = 'ruby_yacht'
-  spec.version      = '0.1.1'
+  spec.version      = '0.2.0'
   spec.date         = '2016-04-17'
+  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"]
   spec.email        = 'apps@mail.johnbrownlee.com'

data/spec/docker/Dockerfile

@@ -2,4 +2,4 @@ FROM ruby:2.3
 
 VOLUME /var/code
 WORKDIR /var/code
-CMD bash
+CMD bundle install; bash

data/spec/dsl/app_spec.rb

@@ -5,28 +5,62 @@ RSpec.describe RubyYacht::App do
     let(:name) { :test_app }
     let(:app) { RubyYacht::App::DSL.new(name).run(@builder).create_object }
 
+    before do
+      RubyYacht.configuration.clear
+      RubyYacht.configure do
+        app_type :test do
+          baseline_image 'ubuntu'
+        end
+      end
+    end
+    
     it "creates an app with all fields" do
       @builder = Proc.new do
         repository_name 'brownleej/test-app'
+        app_type :test
         port 3000
       end
       expect(app.name).to eq :test_app
       expect(app.repository_name).to eq 'brownleej/test-app'
+      expect(app.app_type).to eq :test
       expect(app.port).to eq 3000
     end
 
     it "requires the repository name" do
       @builder = Proc.new do
         port 3000
+        app_type :test
       end
       expect do
         self.app
       end.to raise_exception("Missing required attribute repository_name for RubyYacht::App::DSL")
     end
 
+    it "requires the app type" do
+      @builder = Proc.new do
+        repository_name 'brownleej/test-app'
+        port 3000
+      end
+      expect do
+        self.app
+      end.to raise_exception("Missing required attribute app_type for RubyYacht::App::DSL")
+    end
+
+    it "requires a defined app type" do
+      @builder = Proc.new do
+        app_type :invalid
+        repository_name 'brownleej/test-app'
+        port 3000
+      end
+      expect do
+        self.app
+      end.to raise_exception("App has invalid app type `invalid`")
+    end
+
     it "defaults the port to 8080" do
       @builder = Proc.new do
         repository_name 'brownleej/test-app'
+        app_type :test
       end
       expect(app.port).to eq 8080
     end