engineyard 2.2.1 → 2.3.0

data/lib/engineyard/deploy_config.rb

@@ -1,5 +1,7 @@
 module EY
   class DeployConfig
+    MIGRATE = 'rake db:migrate --trace'
+
     def initialize(cli_opts, env_config, repo, ui)
       @cli_opts = cli_opts
       @env_config = env_config
@@ -12,13 +14,26 @@ module EY
     end
 
     def migrate
-      decide_migrate
-      @migrate
+      @migrate ||= @cli_opts.fetch('migrate') do
+        if in_repo?
+          @env_config.migrate
+        else
+          raise RefAndMigrateRequiredOutsideRepo.new(@cli_opts)
+        end
+      end
     end
 
     def migrate_command
-      decide_migrate
-      @migrate_command
+      return @command if defined? @command
+
+      if migrate
+        @command = migrate.respond_to?(:to_str) && migrate.to_str
+        @command ||= in_repo? ? @env_config.migration_command : MIGRATE
+      else
+        @command = nil
+      end
+
+      @command
     end
 
     def verbose
@@ -44,19 +59,7 @@ module EY
         ref_decider.when_outside_repo
       end
     end
-
-    def decide_migrate
-      return if @migrate_decider
-      @migrate_decider = EY::DeployConfig::Migrate.new(@cli_opts, @env_config, @ui)
-      @migrate, @migrate_command =
-        if in_repo?
-          @migrate_decider.when_inside_repo
-        else
-          @migrate_decider.when_outside_repo
-        end
-    end
   end
 end
 
-require 'engineyard/deploy_config/migrate'
 require 'engineyard/deploy_config/ref'

data/lib/engineyard/error.rb

@@ -4,7 +4,7 @@ module EY
 
   class NoCommandError < EY::Error
     def initialize
-      super "Must specify a command to run via ssh"
+      super "Specify a command to run via ssh or use --each to cycle through each server one at a time."
     end
   end
 

data/lib/engineyard/serverside_runner.rb

@@ -52,7 +52,7 @@ module EY
       EY::Serverside::Adapter.new("/usr/local/ey_resin/ruby/bin") do |args|
         args.serverside_version = serverside_version
         args.app              = app.name
-        args.repo             = app.repository_uri
+        args.git              = app.repository_uri
         args.instances        = instances_data(environment.deploy_to_instances, bridge)
         args.stack            = environment.app_server_stack_name
         args.framework_env    = environment.framework_env

data/lib/engineyard/templates.rb

@@ -0,0 +1,6 @@
+module EY
+  module Templates
+  end
+end
+
+require 'engineyard/templates/ey_yml'

data/lib/engineyard/templates/ey.yml.erb

@@ -0,0 +1,193 @@
+# Engine Yard Cloud Deploy Options
+#
+####################################################################
+#                           IMPORTANT
+#            Commit this file into your git repository.
+#       These options are loaded on the server during deploy.
+####################################################################
+#
+# Valid locations:
+# * REPOSITORY_ROOT/config/ey.yml.
+# * REPOSITORY_ROOT/ey.yml
+#
+# Further information available here:
+# https://support.cloud.engineyard.com/entries/20996661-customize-your-deployment-on-engine-yard-cloud
+#
+# For advanced usage, see the source that loads this configuration:
+# https://github.com/engineyard/engineyard-serverside/blob/master/lib/engineyard-serverside/configuration.rb
+#
+defaults:
+  # Run migrations during deploy by default.
+  #
+  # When set to true, runs the migration_command (below) during deploy.
+  #
+  # This setting can be overridden for individual deployments using
+  # the command line options --migrate or --no-migrate.
+  #
+<%= option 'migrate' %>
+
+  # Default migration command to run when migrations are enabled.
+  #
+<% if existing_config['migration_command'] || config['migrate'] %>
+<%= option 'migration_command' %>
+<% else %>
+<%= commented_option 'migration_command' %>
+<% end %>
+
+  # Enables rails assets precompilation always and halts when the task fails.
+  #
+  # By default, assets are detected using app/assets and config/application.rb.
+  #
+  # If you use rails assets, set this to true.
+  #
+  # For more control over assets, set precompile_assets: false and
+  # run your precompile task in the deploy/before_compile_assets.rb deploy hook.
+  #
+<%= option 'precompile_assets' %>
+
+  # Override the assets:precompile rake task. This option will be used instead
+  # of <%= defaults['precompile_assets_task'] %> in the `rake <%= defaults['precompile_assets_task'] %>` command.
+  #
+<%= option_unless_default 'precompile_assets_task' %>
+
+  # Asset strategies affect the way assets are stored on the server.
+  #
+  # * private
+  #   Store assets directly in public/assets for each deployment.
+  #   Previous assets are symlinked for continuity.
+  #   When assets are reused, they are copied using rsync.
+  #
+  # * shifting
+  #   Assets are kept in a shared directory on each server.
+  #   When new assets are compiled, old assets are shifted to a shared
+  #   last_assets directory. This has always been the default behavior.
+  #
+  # * shared
+  #   Assets are kept in a shared directory on each server.
+  #   When new assets are compiled, the same directory is used.
+  #   Assets will accumulate in this mode if a cleaning script is not run.
+  #   Use this strategy if you want to write your own asset cleaning script.
+  #
+  # * cleaning
+  #   Like shared, but a cleaning script is run before each new compile.
+  #   The script attempts to remove all files not mentioned by the old
+  #   manifest.yml, before it is replaced by the new manifest (leaving 2
+  #   deployments worth of assets in the directory)
+  #
+  # "private" is recommended because it is the least error prone.
+  # If you prefer faster compilation, "shared" can be quicker, but will require
+  # custom scripting and will cause problems when rollbacks are used.
+  # "shifting" is the default behavior.
+  #
+<% if config['asset_strategy'] != defaults['asset_strategy'] %>
+<%= option 'asset_strategy' %>
+<% else %>
+  #asset_strategy: private
+<% end %>
+
+  # This list of repository relative paths is checked for chenges during
+  # each deployment (when change detection is not disabled). If `git diff`
+  # detects changes since the last deployment, fresh assets will be compiled.
+  #
+  # This option overrides the default list, so include the following
+  # defaults if you need them.
+  #
+<% if config['asset_dependencies'] %>
+<%= option 'asset_dependencies' %>
+<% else %><%# better default format than the normal yaml dump %>
+  #asset_dependencies:
+  #- app/assets            # default
+  #- lib/assets            # default
+  #- vendor/assets         # default
+  #- Gemfile.lock          # default
+  #- config/application.rb # default
+  #- config/routes.rb      # default
+  #- config/requirejs.yml  # example of a custom asset dependency
+<% end %>
+
+  # When true, precompiles assets even if no changes would be detected by
+  # running git diff with the asset_dependencies above.
+  #
+  # Default is false (always check git diff before asset compilation)
+  #
+<%= option_unless_default 'precompile_unchanged_assets' %>
+
+  # Choose which servers should compile assets.
+  #
+  # Default behavior is to exclude util instances.
+  # Specify :all to compile on all servers including util servers.
+  #
+<% if config['asset_roles'] %>
+<%= option 'asset_roles' %>
+<% else %>
+  #asset_roles: :all
+<% end %>
+
+  # Bundle without different bundler groups:
+  # Ex: bundle install --without '[bundle_without]'
+  #
+  # Default is "<%= defaults['bundle_without'] %>".
+  # Leave blank to remove --without from the bundle install command.
+  #
+<%= option_unless_default 'bundle_without' %>
+
+  # Add extra options to the bundle install command line.
+  # Does not override bundle_without, if specified.
+  #
+  # If the application's gems are vendored in the
+  # repository, setting --local can speed up bundle.
+  #
+<%= option_unless_default 'bundle_options' %>
+
+  # Enable maintenance page during migrate action (default)
+  # Setting this to false, disables maintenance page during migrations.
+  #
+  # CAUTION! No-downtime migrations requires careful migration
+  # planning. Migrations must be non-destructive. The *previous*
+  # deployment might serve pages during a partially migrated state.
+  # For example, if you rename a column, all traffic served during
+  # that migration will be broken until the new code is deployed.
+  #
+<%= option_unless_default 'maintenance_on_migrate' %>
+
+  # Enable maintanence page during every deploy.
+  # Unicorn and Passenger support no-downtime deploys, so the default
+  # for these servers is false. Mongrel and some other servers default
+  # to true to avoid downtime during server restarting.
+  #
+<%= option_unless_default 'maintenance_on_restart' %>
+
+  # If true, always run deployments in verbose mode.
+  #
+<%= option_unless_default 'verbose' %>
+
+  # Hide the warning shown when the Gemfile does not contain a recognized
+  # database adapter (mongodb for example)
+  #
+  # This warning is here to help new customers that accidentally have no adapter.
+  # You may safely set this to true if you aren't using a common database.
+  #
+<%= option_unless_default 'ignore_database_adapter_warning' %>
+
+  # You can add custom keys that will be available in your deploy hooks.
+  # Custom keys will be available using config.key or config[:key]
+  #
+  #your_own_custom_key: custom info
+
+<%= extra_root_options %>
+
+####################################################################
+# Environment specific options.
+#
+# The options you specify here will only apply to a single environment
+# that exactly matches the environment name key.
+#
+# Environment options will override the default options above.
+#
+environments:
+
+  # These options will only apply to the EXAMPLE_ENVIRONMENT environment.
+  #EXAMPLE_ENVIRONMENT:
+    #precompile_unchanged_assets: true
+
+<%= environment_options %>

data/lib/engineyard/templates/ey_yml.rb

@@ -0,0 +1,119 @@
+require 'erb'
+
+module EY
+  module Templates
+    class EyYml
+      PATH = Pathname.new(__FILE__).dirname.join('ey.yml.erb').freeze
+
+      attr_reader :existing_config, :existing, :config, :template
+
+      def initialize(existing, template=PATH)
+        @template = template
+
+        @existing        = existing.dup
+        @environments    = @existing.delete('environments') || {}
+        @existing_config = @existing.delete('defaults') || {}
+        @config          = defaults.merge(@existing_config)
+
+        fix_config!
+      end
+
+      def to_str
+        ERB.new(template.read, 0, "<>").result(binding)
+      end
+      alias to_s to_str
+
+      def write(dest)
+        dest = Pathname.new(dest)
+        dir  = dest.dirname
+        temp = dir.join("ey.yml.tmp")
+
+        # generate first so we don't overwrite with a failed generation
+        output = to_str
+        temp.open('w') { |f| f << output }
+
+        FileUtils.mv(dest, dir.join("ey.yml.backup")) if dest.exist?
+        FileUtils.mv(temp, dest)
+      end
+
+      protected
+
+      def fix_config!
+        if config['migrate'] == nil && existing_config['migration_command']
+          config['migrate'] = true
+        end
+      end
+
+      def defaults
+        {
+          "migrate"                         => Pathname.new('db/migrate').exist?,
+          "migration_command"               => "rake db:migrate --trace",
+          "precompile_assets"               => Pathname.new('app/assets').exist?,
+          "precompile_assets_task"          => "assets:precompile",
+          "asset_dependencies"              => nil, # %w[app/assets lib/assets vendor/assets Gemfile.lock config/application.rb config/routes.rb],
+          "asset_strategy"                  => "shifting",
+          "precompile_unchanged_assets"     => false,
+          "bundle_without"                  => nil,
+          "bundle_options"                  => nil,
+          "maintenance_on_migrate"          => true,
+          "maintenance_on_restart"          => nil,
+          "verbose"                         => false,
+          "ignore_database_adapter_warning" => false,
+        }
+      end
+
+      def option_unless_default(key)
+        value = config[key]
+        if value != nil && value != defaults[key]
+          option(key, value)
+        else
+          commented_option key
+        end
+      end
+
+      def option(key, value = nil)
+        value ||= config[key]
+        dump_indented_yaml key => value
+      end
+
+      def commented_option(key)
+        data = {key => defaults[key]}
+        "  ##{dump_indented_yaml(data, 0)}"
+      end
+
+      def extra_root_options
+        out = ""
+
+        extra_defaults = config.reject { |k,v| defaults.key?(k) }
+        extra_defaults.each do |key,val|
+          out << option(key, val) << "\n"
+        end
+
+        unless existing.empty?
+          out << dump_indented_yaml(existing, 0)
+        end
+
+        out
+      end
+
+      def environment_options
+        if @environments && !@environments.empty?
+          dump_indented_yaml(@environments)
+        end
+      end
+
+      def dump_indented_yaml(data, indent=2)
+        YAML.dump(data).sub(/^---/, '').lstrip.gsub(/^/,' '*indent)
+      end
+
+      def string_to_boolean(str)
+        case str
+        when "true"  then true
+        when "false" then false
+        else str
+        end
+      end
+
+    end
+  end
+end

data/lib/engineyard/version.rb

@@ -1,4 +1,4 @@
 module EY
-  VERSION = '2.2.1'
-  ENGINEYARD_SERVERSIDE_VERSION = ENV['ENGINEYARD_SERVERSIDE_VERSION'] || '2.2.1'
+  VERSION = '2.3.0'
+  ENGINEYARD_SERVERSIDE_VERSION = ENV['ENGINEYARD_SERVERSIDE_VERSION'] || '2.3.1'
 end

data/spec/engineyard/deploy_config_spec.rb

@@ -1,72 +1,38 @@
 require 'spec_helper'
 require 'tempfile'
 
-describe EY::DeployConfig::Migrate do
-  before do
-    @tempfile = Tempfile.new('ey.yml')
-    @parent = EY::Config.new(@tempfile.path)
-    @ui = EY::CLI::UI.new
-    EY::CLI::UI::Prompter.enable_mock!
-    @repo = double('repo')
-  end
+describe EY::DeployConfig do
+  let(:tempfile) { @tempfile = Tempfile.new('ey.yml') }
+  let(:parent)   { EY::Config.new(tempfile.path) }
+  let(:ui)       { EY::CLI::UI.new }
+  let(:repo)     { double('repo') }
+  let(:env)      { env_config(nil) }
 
-  after do
-    @tempfile.unlink
-  end
+  after { @tempfile.unlink if @tempfile }
 
-  def env_config(opts=nil)
-    @env_config ||= EY::Config::EnvironmentConfig.new(opts, 'envname', @parent)
+  def env_config(opts, config = parent)
+    EY::Config::EnvironmentConfig.new(opts, 'envname', config)
   end
 
-  def deploy_config(cli_options)
-    EY::DeployConfig.new(cli_options, env_config, @repo, @ui)
+  def deploy_config(cli_opts, ec = env)
+    EY::DeployConfig.new(cli_opts, ec, repo, ui)
   end
 
   context "inside a repository" do
-    context "no migrate options set (interactive)" do
-      it "prompts migrate and command and adds to defaults section" do
-        EY::CLI::UI::Prompter.add_answer "" # default
-        EY::CLI::UI::Prompter.add_answer ""
-        @parent.should_receive(:set_default_option).with('migrate', true)
-        @parent.should_receive(:set_default_option).with('migration_command', 'rake db:migrate')
-        dc = deploy_config({})
-        out = capture_stdout do
-          dc.migrate.should be_true
-          dc.migrate_command.should == 'rake db:migrate'
-        end
-        out.should =~ /#{@tempfile.path}: migrate settings saved for envname/
-        out.should =~ /You can override this default with --migrate or --no-migrate/
-        out.should =~ /Please git commit #{@tempfile.path} with these new changes./
-      end
-
-      it "prompts migration_command if first answer is yes" do
-        EY::CLI::UI::Prompter.add_answer "yes" # default
-        EY::CLI::UI::Prompter.add_answer "ruby script/migrate"
-        @parent.should_receive(:set_default_option).with('migrate', true)
-        @parent.should_receive(:set_default_option).with('migration_command', 'ruby script/migrate')
-        dc = deploy_config({})
-        capture_stdout do
-          dc.migrate.should be_true
-          dc.migrate_command.should == 'ruby script/migrate'
-        end
-      end
+    context "with no ey.yml file" do
+      let(:env) { env_config(nil, EY::Config.new('noexisto.yml')) }
 
-      it "doesn't prompt migration_command if first answer is no" do
-        EY::CLI::UI::Prompter.add_answer "no" # default
-        @parent.should_receive(:set_default_option).with('migrate', false)
-        dc = deploy_config({})
-        capture_stdout do
-          dc.migrate.should be_false
-          dc.migrate_command.should be_nil
-        end
+      it "tells you to initialize a new repository with ey init" do
+        dc = deploy_config({}, env)
+        expect { dc.migrate }.to raise_error(EY::Error, /Please initialize this application with the following command:/)
       end
     end
 
     context "with the migrate cli option" do
-      it "returns the default migration command when is true" do
+      it "returns default command when true" do
         dc = deploy_config({'migrate' => true})
         dc.migrate.should be_true
-        dc.migrate_command.should == 'rake db:migrate'
+        expect { dc.migrate_command }.to raise_error(EY::Error, /'migration_command' not found/)
       end
 
       it "returns false when nil" do
@@ -83,30 +49,30 @@ describe EY::DeployConfig::Migrate do
     end
 
     context "with the migrate option in the global configuration" do
-      it "return the default migration command when the option is true" do
-        env_config('migrate' => true, 'migration_command' => 'bar migrate')
-        dc = deploy_config({})
+      it "return the migration command when the option is true" do
+        env = env_config('migrate' => true, 'migration_command' => 'bar migrate')
+        dc = deploy_config({}, env)
         dc.migrate.should be_true
         dc.migrate_command.should == 'bar migrate'
       end
 
       it "return the false when migrate is false" do
-        env_config('migrate' => false, 'migration_command' => 'bar migrate')
-        dc = deploy_config({})
+        env = env_config('migrate' => false, 'migration_command' => 'bar migrate')
+        dc = deploy_config({}, env)
         dc.migrate.should be_false
         dc.migrate_command.should be_nil
       end
 
-      it "return the default migration command when the option is true" do
-        env_config('migrate' => true)
-        dc = deploy_config({})
-        dc.migrate.should be_true
-        dc.migrate_command.should == 'rake db:migrate'
+      it "tells you to run ey init" do
+        env = env_config('migrate' => true)
+        dc = deploy_config({}, env)
+        expect(dc.migrate).to be_true
+        expect { dc.migrate_command }.to raise_error(EY::Error, /'migration_command' not found/)
       end
 
       it "return the ey.yml migration_command when command line option --migrate is passed" do
-        env_config('migrate' => false, 'migration_command' => 'bar migrate')
-        dc = deploy_config({'migrate' => true})
+        env = env_config('migrate' => false, 'migration_command' => 'bar migrate')
+        dc = deploy_config({'migrate' => true}, env)
         dc.migrate.should be_true
         dc.migrate_command.should == 'bar migrate'
       end
@@ -130,7 +96,7 @@ describe EY::DeployConfig::Migrate do
       end
 
       context "with a default branch" do
-        before { env_config('branch' => 'default') }
+        let(:env) { env_config('branch' => 'default') }
 
         it "uses the configured default if ref is not passed" do
           out = capture_stdout do
@@ -164,7 +130,7 @@ describe EY::DeployConfig::Migrate do
 
       context "no options, no default" do
         it "uses the repo's current branch" do
-          @repo.should_receive(:current_branch).and_return('current')
+          repo.should_receive(:current_branch).and_return('current')
           out = capture_stdout do
             deploy_config({}).ref.should == 'current'
           end
@@ -179,7 +145,7 @@ describe EY::DeployConfig::Migrate do
       it "returns the default migration command when migrate is true" do
         dc = deploy_config({'app' => 'app', 'migrate' => true})
         dc.migrate.should be_true
-        dc.migrate_command.should == 'rake db:migrate'
+        dc.migrate_command.should == 'rake db:migrate --trace'
       end
 
       it "returns false when nil" do