engineyard 1.4.29 → 1.7.0.pre2

data/lib/engineyard/deploy_config.rb

@@ -0,0 +1,66 @@
+module EY
+  class DeployConfig
+    def initialize(cli_opts, env_config, repo, ui)
+      @cli_opts = cli_opts
+      @env_config = env_config
+      @repo = repo
+      @ui = ui
+    end
+
+    def ref
+      @ref ||= decide_ref
+    end
+
+    def migrate
+      decide_migrate
+      @migrate
+    end
+
+    def migrate_command
+      decide_migrate
+      @migrate_command
+    end
+
+    def verbose
+      @cli_opts.fetch('verbose') { in_repo? && @env_config.verbose }
+    end
+
+    def extra_config
+      extras = @cli_opts.fetch('extra_deploy_hook_options', {})
+      if in_repo?
+        extras = @env_config.merge(extras)
+      end
+      extras
+    end
+
+    private
+
+    # passing an app means we assume PWD is not the app.
+    def in_repo?
+      @cli_opts['app'].nil? || @cli_opts['app'] == ''
+    end
+
+    def decide_ref
+      ref_decider = EY::DeployConfig::Ref.new(@cli_opts, @env_config, @repo, @ui)
+      if in_repo?
+        ref_decider.when_inside_repo
+      else
+        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/deploy_config/migrate.rb

@@ -0,0 +1,125 @@
+module EY
+  class DeployConfig
+    class Migrate
+
+      DEFAULT = 'rake db:migrate'
+
+      def initialize(cli_opts, env_config, ui)
+        @cli_opts = cli_opts
+        @env_config = env_config
+        @ui = ui
+
+        @perform = nil
+        @command = nil
+      end
+
+      # Returns an array of [perform_migration, migrate_command] on success.
+      # Yields the block if no migrate options are set.
+      def when_outside_repo
+        if perform_from_cli_opts
+          if @perform
+            @command ||= command_from_opts || DEFAULT
+          else
+            @command = nil
+          end
+          [@perform, @command]
+        else
+          raise RefAndMigrateRequiredOutsideRepo.new(@cli_opts)
+        end
+      end
+
+      # Returns an array of [perform_migration, migrate_command] on success.
+      # Should always return successfully.
+      def when_inside_repo
+        if perform_from_cli_opts || perform_from_config || perform_from_interaction
+          if @perform
+            @command ||= command_from_opts || command_from_config || DEFAULT
+          else
+            @command = nil
+          end
+          [@perform, @command]
+        else
+          raise MigrateRequired.new(@cli_opts)
+        end
+      end
+
+      private
+
+      attr_reader :cli_opts, :env_config, :ui
+
+      def command_from_opts
+        cli_migrate = cli_opts.fetch('migrate', nil)
+        cli_migrate.respond_to?(:to_str) && cli_migrate.to_str
+      end
+
+      def command_from_config
+        env_config.migrate_command
+      end
+
+      def perform_from_cli_opts
+        @perform = !!cli_opts.fetch('migrate') { return false } # yields on not found
+        true
+      end
+
+      def perform_from_config
+        @perform = !!env_config.migrate { return perform_implied_via_command_in_config }
+        if @perform
+          unless command_from_config
+            env_config.migration_command = DEFAULT
+          end
+        end
+        true
+      end
+
+      # if the command is set in ey.yml and perform isn't explicitly turned off,
+      # then we'll write out the old default of migrating always, since that's
+      # probably what is expected.
+      def perform_implied_via_command_in_config
+        if @perfom.nil? && @command = command_from_config
+          @perform = true
+          env_config.migrate = @perform
+          ui.warn "********************************************************************************"
+          ui.info "#{env_config.path} config for #{env_config.name} has been updated to"
+          ui.info "migrate by default to maintain previous expected default behavior."
+          ui.warn "********************************************************************************"
+          ui.say  "It's a good idea to git commit #{env_config.path} with these new changes."
+          true
+        else
+          false
+        end
+      end
+
+      def perform_from_interaction
+        ui.warn "********************************************************************************"
+        ui.warn "No default migrate choice for environment: #{env_config.name}"
+        ui.warn "Migrate can be toggled per-deploy using --migrate or --no-migrate."
+        ui.warn "Let's set a default migration choice."
+        ui.warn "********************************************************************************"
+        @perform = ui.agree('Migrate every deploy by default? ', true)
+        env_config.migrate = @perform
+        if @perform
+          command_from_interaction
+        end
+        ui.say "#{env_config.path}: migrate settings saved for #{env_config.name}."
+        ui.say  "It's a good idea to git commit #{env_config.path} with these new changes."
+        true
+      rescue Timeout::Error
+        @perform = nil
+        @command = nil
+        ui.error "Timeout when waiting for input. This is not a terminal."
+        ui.error "ey deploy no longer migrates when no default is set in ey.yml."
+        ui.error "Run interactively for step-by-step ey.yml migration setup."
+        return false
+      end
+
+      # only interactively request a command if we interactively requested the perform setting.
+      # don't call this outside of the interactive setting (otherwise, why even have a default?)
+      def command_from_interaction
+        default = env_config.migration_command || DEFAULT
+        @command = ui.ask("Migration command? ", false, default)
+        env_config.migration_command = @command
+        @command
+      end
+    end
+  end
+end

data/lib/engineyard/deploy_config/ref.rb

@@ -0,0 +1,56 @@
+require 'engineyard/error'
+
+module EY
+  class DeployConfig
+    class Ref
+
+      def initialize(cli_opts, env_config, repo, ui)
+        @cli_opts  = cli_opts
+        @default   = env_config.branch
+        @repo      = repo
+        @force_ref = @cli_opts.fetch('force_ref', false)
+        @ui        = ui
+
+        if @force_ref.kind_of?(String)
+          @ref, @force_ref = @force_ref, true
+        else
+          @ref = @cli_opts.fetch('ref', nil)
+          @ref = nil if @ref == ''
+        end
+      end
+
+      def when_inside_repo
+        if !@force_ref && @ref && @default && @ref != @default
+          raise BranchMismatchError.new(@default, @ref)
+        elsif @force_ref && @ref && @default
+          @ui.say "Default ref overridden with #{@ref.inspect}."
+        end
+
+        @ref || use_default || use_current_branch || raise(RefRequired.new(@cli_opts))
+      end
+
+      def use_default
+        if @default
+          @ui.say "Using default branch #{@default.inspect} from ey.yml."
+          @default
+        end
+      end
+
+      def use_current_branch
+        if current = @repo.current_branch
+          @ui.say "Using current HEAD branch #{current.inspect}."
+          current
+        end
+      end
+
+      # a.k.a. not in the correct repo
+      #
+      # returns the ref if it was passed in the cli opts.
+      # or raise
+      def when_outside_repo
+        @ref or raise RefAndMigrateRequiredOutsideRepo.new(@cli_opts)
+      end
+
+    end
+  end
+end

data/lib/engineyard/error.rb

@@ -1,78 +1,24 @@
 module EY
   class Error < RuntimeError
-    def ambiguous(type, name, matches, desc="")
-      pretty_names = matches.map {|x| "'#{x}'"}.join(', ')
-      "The name '#{name}' is ambiguous; it matches all of the following #{type} names: #{pretty_names}.\n" +
-      "Please use a longer, unambiguous substring or the entire #{type} name." + desc
-    end
   end
 
-  class ResolveError < EY::Error; end
-  class NoMatchesError < ResolveError; end
-  class MultipleMatchesError < ResolveError; end
-
   class NoCommandError < EY::Error
     def initialize
       super "Must specify a command to run via ssh"
     end
   end
 
-  class NoRemotesError < EY::Error
-    def initialize(path)
-      super "fatal: No git remotes found in #{path}"
-    end
-  end
-
-  class NoAppError < Error
-    def initialize(repo)
-      super <<-ERROR
-There is no application configured for any of the following remotes:
-\t#{repo ? repo.urls.join("\n\t") : "No remotes found."}
-You can add this application at #{EY.config.endpoint}
-      ERROR
-    end
-  end
-
-  class InvalidAppError < Error
-    def initialize(name)
-      super %|There is no app configured with the name "#{name}"|
-    end
-  end
-
-  class AmbiguousAppNameError < EY::Error
-    def initialize(name, matches, desc="")
-      super ambiguous("app", name, matches, desc)
-    end
-  end
-
-  class NoAppMasterError < EY::Error
-    def initialize(env_name)
-      super "The environment '#{env_name}' does not have a master instance."
-    end
-  end
-
   class NoInstancesError < EY::Error
     def initialize(env_name)
       super "The environment '#{env_name}' does not have any matching instances."
     end
   end
 
-  class BadAppMasterStatusError < EY::Error
-    def initialize(master_status)
-      super "Application master's status is not \"running\" (green); it is \"#{master_status}\"."
-    end
-  end
-
-  class EnvironmentError < EY::Error
-  end
+  class ResolverError        < Error; end
+  class NoMatchesError       < ResolverError; end
+  class MultipleMatchesError < ResolverError; end
 
-  class AmbiguousEnvironmentNameError < EY::EnvironmentError
-    def initialize(name, matches, desc="")
-      super ambiguous("environment", name, matches, desc)
-    end
-  end
-
-  class AmbiguousEnvironmentGitUriError < EY::EnvironmentError
+  class AmbiguousEnvironmentGitUriError < ResolverError
     def initialize(environments)
       message = "The repository url in this directory is ambiguous.\n"
       message << "Please use -e <envname> to specify one of the following environments:\n"
@@ -87,36 +33,50 @@ You can add this application at #{EY.config.endpoint}
     end
   end
 
-  class NoSingleEnvironmentError < EY::EnvironmentError
-    def initialize(app)
-      size = app.environments.size
-      super "Unable to determine a single environment for the current application (found #{size} environments)"
-    end
-  end
 
-  class NoEnvironmentError < EY::EnvironmentError
-    def initialize(env_name=nil)
-      super "No environment named '#{env_name}'\nYou can create one at #{EY.config.endpoint}"
+  class DeployArgumentError < EY::Error; end
+  class BranchMismatchError < DeployArgumentError
+    def initialize(default, ref)
+      super <<-ERR
+Your default branch is set to #{default.inspect} in ey.yml.
+To deploy #{ref.inspect} you can:
+  * Delete the line 'branch: #{default}' in ey.yml
+OR
+  * Use the -R [REF] or --force-ref [REF] options as follows:
+Usage: ey deploy -R #{ref}
+       ey deploy --force-ref #{ref}
+      ERR
     end
   end
 
-  class EnvironmentUnlinkedError < EY::Error
-    def initialize(env_name)
-      super "Environment '#{env_name}' exists but does not run this application."
+  class RefAndMigrateRequiredOutsideRepo < DeployArgumentError
+    def initialize(options)
+      super <<-ERR
+Because defaults are stored in a file in your application dir, when specifying
+--app you must also specify the --ref and the --migrate or --no-migrate options.
+Usage: ey deploy --app #{options[:app]} --ref [ref] --migrate [COMMAND]
+       ey deploy --app #{options[:app]} --ref [branch] --no-migrate
+      ERR
     end
   end
 
-  class BranchMismatchError < EY::Error
-    def initialize(default_branch, branch)
-      super(%|Your deploy branch is set to "#{default_branch}".\n| +
-        %|If you want to deploy branch "#{branch}", use --ignore-default-branch.|)
+  class RefRequired < DeployArgumentError
+    def initialize(options)
+      super <<-ERR
+Unable to determine the branch or ref to deploy
+Usage: ey deploy --ref [ref]
+      ERR
     end
   end
 
-  class DeployArgumentError < EY::Error
-    def initialize
-      super(%("deploy" was called incorrectly. Call as "deploy [--environment <env>] [--ref <branch|tag|ref>]"\n) +
-        %|You can set default environments and branches in ey.yml|)
+  class MigrateRequired < DeployArgumentError
+    def initialize(options)
+      super <<-ERR
+Unable to determine migration choice. ey deploy no longer migrates by default.
+Usage: ey deploy --migrate
+       ey deploy --no-migrate
+      ERR
     end
   end
+
 end

data/lib/engineyard/repo.rb

@@ -1,55 +1,103 @@
 require 'engineyard/error'
-require 'escape'
 require 'pathname'
 
 module EY
   class Repo
+    class NotAGitRepository < EY::Error
+      attr_reader :dir
+      def initialize(output)
+        @dir = File.expand_path(ENV['GIT_DIR'] || ENV['GIT_WORK_TREE'] || '.')
+        super("#{output} (#{@dir})")
+      end
+    end
 
-    attr_reader :path
+    class NoRemotesError < EY::Error
+      def initialize(path)
+        super "fatal: No git remotes found in #{path}"
+      end
+    end
 
-    def initialize(repo_path='.')
-      self.path = repo_path
+    def self.exist?
+      system("git rev-parse --git-dir > /dev/null 2>&1")
     end
 
-    def path=(new_path)
-      @path = Pathname.new(new_path).expand_path
+    attr_reader :root
+
+    # $GIT_DIR is what git uses to override the location of the .git dir.
+    # $GIT_WORK_TREE is the working tree for git, which we'll use after $GIT_DIR.
+    #
+    # We use this to specify which repo we should look at, since it would also
+    # specify where any git commands are directed, thus fooling commands we
+    # run anyway.
+    def initialize
     end
 
-    def exist?
-      dotgit.directory?
+    def root
+      @root ||= begin
+                  out = `git rev-parse --show-toplevel 2>&1`.strip
+
+                  if $?.success? && !out.empty?
+                    Pathname.new(out)
+                  else
+                    raise EY::Repo::NotAGitRepository.new(out)
+                  end
+                end
     end
 
-    def current_branch
-      if exist? && (head = dotgit("HEAD").read.chomp) && head.gsub!("ref: refs/heads/", "")
-        head
-      else
-        nil
-      end
+    def ensure_repository!
+      root
     end
 
-    def urls
-      @urls ||= config('remote.*.url').map { |c| c.split.last }
+    def has_committed_file?(file)
+      ensure_repository!
+      `git ls-files --full-name #{file}`.strip == file && $?.success?
     end
 
-    def has_remote?(repository_uri)
-      urls.include?(repository_uri)
+    def has_file?(file)
+      ensure_repository!
+      has_committed_file?(file) || root.join(file).exist?
     end
 
-    def fail_on_no_remotes!
-      if urls.empty?
-        raise NoRemotesError.new(path)
+    # Read the committed version at HEAD (or ref) of a file using the git working tree relative filename.
+    # If the file is not committed, but does exist, a warning will be displayed
+    # and the file will be read anyway.
+    # If the file does not exist, returns nil.
+    #
+    # Example:
+    #
+    #   read_file('config/ey.yml') # will read $GIT_WORK_TREE/config/ey.yml
+    #
+    def read_file(file, ref = 'HEAD')
+      ensure_repository!
+      if has_committed_file?(file)
+        # TODO warn if there are unstaged changes.
+        `git show #{ref}:#{file}`
+      else
+        EY.ui.warn <<-WARN
+Warn: #{file} is not committed to this git repository:
+\t#{root}
+This can prevent ey deploy from loading this file for certain server side
+deploy-time operations. Commit this file to fix this warning.
+        WARN
+        root.join(file).read
       end
     end
 
-    private
+    def current_branch
+      ensure_repository!
+      branch = `git symbolic-ref -q HEAD`.chomp.gsub("refs/heads/", "")
+      branch.empty? ? nil : branch
+    end
 
-    def dotgit(child='')
-      path.join('.git', child)
+    def remotes
+      ensure_repository!
+      @remotes ||= `git remote -v`.scan(/\t[^\s]+\s/).map { |c| c.strip }.uniq
     end
 
-    def config(pattern)
-      config_file = Escape.shell_command([dotgit('config').to_s])
-      `git config -f #{config_file} --get-regexp '#{pattern}'`.split(/\n/)
+    def fail_on_no_remotes!
+      if remotes.empty?
+        raise EY::Repo::NoRemotesError.new(root)
+      end
     end
 
   end # Repo