engineyard 0.5.3 → 0.5.4

data/lib/engineyard/cli.rb

@@ -17,17 +17,17 @@ module EY
       super
     end
 
-    desc "deploy [--environment ENVIRONMENT] [--ref GIT-REF]", <<-DESC
-Deploy specified branch/tag/sha to specified environment.
-
-This command must be run with the current directory containing the app to be
-deployed. If ey.yml specifies a default branch then the ref parameter can be
-omitted. Furthermore, if a default branch is specified but a different command
-is supplied the deploy will fail unless --force is used.
-
-Migrations are run by default with 'rake db:migrate'. A different command can be
-specified via --migrate "ruby do_migrations.rb". Migrations can also be skipped
-entirely by using --no-migrate.
+    desc "deploy [--environment ENVIRONMENT] [--ref GIT-REF]",
+      "Deploy specified branch, tag, or sha to specified environment."
+    long_desc <<-DESC
+      This command must be run with the current directory containing the app to be
+      deployed. If ey.yml specifies a default branch then the ref parameter can be
+      omitted. Furthermore, if a default branch is specified but a different command
+      is supplied the deploy will fail unless --force is used.
+
+      Migrations are run by default with 'rake db:migrate'. A different command can be
+      specified via --migrate "ruby do_migrations.rb". Migrations can also be skipped
+      entirely by using --no-migrate.
     DESC
     method_option :force, :type => :boolean, :aliases => %w(-f),
       :desc => "Force a deploy of the specified branch even if a default is set"
@@ -70,11 +70,10 @@ entirely by using --no-migrate.
       raise exists ? EnvironmentUnlinkedError.new(options[:environment]) : e
     end
 
-    desc "environments [--all]", <<-DESC
-List environments.
-
-By default, environments for this app are displayed. If the -all option is
-used, all environments are displayed instead.
+    desc "environments [--all]", "List environments."
+    long_desc <<-DESC
+      By default, environments for this app are displayed. The --all option will
+      display all environments, including those for this app.
     DESC
 
     method_option :all, :type => :boolean, :aliases => %(-a)
@@ -85,16 +84,15 @@ used, all environments are displayed instead.
     end
     map "envs" => :environments
 
-    desc "rebuild [--environment ENVIRONMENT]", <<-DESC
-Rebuild specified environment.
+    desc "rebuild [--environment ENVIRONMENT]", "Rebuild specified environment."
+    long_desc <<-DESC
+      Engine Yard's main configuration run occurs on all servers. Mainly used to fix
+      failed configuration of new or existing servers, or to update servers to latest
+      Engine Yard stack (e.g. to apply an Engine Yard supplied security
+      patch).
 
-Engine Yard's main configuration run occurs on all servers. Mainly used to fix
-failed configuration of new or existing servers, or to update servers to latest
-Engine Yard stack (e.g. to apply an Engine Yard supplied security
-patch).
-
-Note that uploaded recipes are also run after the main configuration run has
-successfully completed.
+      Note that uploaded recipes are also run after the main configuration run has
+      successfully completed.
     DESC
 
     method_option :environment, :type => :string, :aliases => %w(-e),
@@ -105,12 +103,11 @@ successfully completed.
       env.rebuild
     end
 
-    desc "rollback [--environment ENVIRONMENT]", <<-DESC
-Rollback to the previous deploy.
-
-Uses code from previous deploy in the "/data/APP_NAME/releases" directory on
-remote server(s) to restart application servers.
-   DESC
+    desc "rollback [--environment ENVIRONMENT]", "Rollback to the previous deploy."
+    long_desc <<-DESC
+      Uses code from previous deploy in the "/data/APP_NAME/releases" directory on
+      remote server(s) to restart application servers.
+    DESC
     method_option :environment, :type => :string, :aliases => %w(-e),
       :desc => "Environment in which to roll back the current application"
     def rollback
@@ -127,11 +124,10 @@ remote server(s) to restart application servers.
       end
     end
 
-    desc "ssh [--environment ENVIRONMENT]", <<-DESC
-Open an ssh session.
-
-If the environment contains just one server, a session to it will be opened. For
-environments with clusters, a session will be opened to the application master.
+    desc "ssh [--environment ENVIRONMENT]", "Open an ssh session."
+    long_desc <<-DESC
+      If the environment contains just one server, a session to it will be opened. For
+      environments with clusters, a session will be opened to the application master.
     DESC
     method_option :environment, :type => :string, :aliases => %w(-e),
       :desc => "Environment to ssh into"
@@ -145,12 +141,11 @@ environments with clusters, a session will be opened to the application master.
       end
     end
 
-    desc "logs [--environment ENVIRONMENT]", <<-DESC
-Retrieve the latest logs for an environment.
-
-Displays Engine Yard configuration logs for all servers in the environment. If
-recipes were uploaded to the environment & run, their logs will also be
-displayed beneath the main configuration logs.
+    desc "logs [--environment ENVIRONMENT]", "Retrieve the latest logs for an environment."
+    long_desc <<-DESC
+      Displays Engine Yard configuration logs for all servers in the environment. If
+      recipes were uploaded to the environment & run, their logs will also be
+      displayed beneath the main configuration logs.
     DESC
     method_option :environment, :type => :string, :aliases => %w(-e),
       :desc => "Environment with the interesting logs"
@@ -186,13 +181,45 @@ displayed beneath the main configuration logs.
     desc "help [COMMAND]", "Describe all commands or one specific command."
     def help(*cmds)
       if cmds.empty?
-        super
-        EY.ui.say "See '#{self.class.send(:banner_base)} help [COMMAND]' for more information on a specific command."
+        base = self.class.send(:banner_base)
+        list = self.class.printable_tasks
+
+        EY.ui.say "Usage:"
+        EY.ui.say "  #{base} [--help] [--version] COMMAND [ARGS]"
+        EY.ui.say
+
+        EY.ui.say "Deploy commands:"
+        deploy_cmds = %w(deploy environments logs rebuild rollback)
+        deploy_cmds.map! do |name|
+          list.find{|task| task[0] =~ /^#{base} #{name}/ }
+        end
+        list -= deploy_cmds
+        EY.ui.print_help(deploy_cmds)
+        EY.ui.say
+
+        EY::Thor.subcommands.each do |name, klass|
+          list.reject!{|cmd| cmd[0] =~ /^#{base} #{name}/}
+          EY.ui.say "#{name.capitalize} commands:"
+          tasks = klass.printable_tasks.reject{|t| t[0] =~ /help$/ }
+          EY.ui.print_help(tasks)
+          EY.ui.say
+        end
+
+        %w(help version).each{|n| list.reject!{|c| c[0] =~ /^#{base} #{n}/ } }
+        if list.any?
+          EY.ui.say "Other commands:"
+          EY.ui.print_help(list)
+          EY.ui.say
+        end
+
+        self.class.send(:class_options_help, shell)
+        EY.ui.say "See '#{base} help COMMAND' for more information on a specific command."
       elsif klass = EY::Thor.subcommands[cmds.first]
         klass.new.help(*cmds[1..-1])
       else
         super
       end
     end
+
   end # CLI
 end # EY

data/lib/engineyard/cli/recipes.rb

@@ -1,11 +1,11 @@
 module EY
   class CLI
     class Recipes < EY::Thor
-      desc "recipes apply [ENVIRONMENT]", <<-DESC
-Run uploaded chef recipes on specified environment.
-
-This is similar to '#{banner_base} rebuild' except Engine Yard's main
-configuration step is skipped.
+      desc "apply [--environment ENVIRONMENT]",
+        "Run uploaded chef recipes on specified environment."
+      long_desc <<-DESC
+        This is similar to '#{banner_base} rebuild' except Engine Yard's main
+        configuration step is skipped.
       DESC
 
       method_option :environment, :type => :string, :aliases => %w(-e),
@@ -16,11 +16,11 @@ configuration step is skipped.
         EY.ui.say "Uploaded recipes started for #{environment.name}"
       end
 
-      desc "recipes upload [ENVIRONMENT]", <<-DESC
-Upload custom chef recipes to specified environment.
-
-The current directory should contain a subdirectory named "cookbooks" to be
-uploaded.
+      desc "upload [--environment ENVIRONMENT]",
+        "Upload custom chef recipes to specified environment."
+      long_desc <<-DESC
+        The current directory should contain a subdirectory named "cookbooks" to be
+        uploaded.
       DESC
 
       method_option :environment, :type => :string, :aliases => %w(-e),
@@ -31,14 +31,14 @@ uploaded.
         EY.ui.say "Recipes uploaded successfully for #{environment.name}"
       end
 
-      desc "recipes download [--environment ENVIRONMENT]", <<-DESC
-Download custom chef recipes from ENVIRONMENT into the current directory.
+      desc "download [--environment ENVIRONMENT]",
+        "Download custom chef recipes from ENVIRONMENT into the current directory."
+      long_desc <<-DESC
+        The recipes will be unpacked into a directory called "cookbooks" in the
+        current directory.
 
-The recipes will be unpacked into a directory called "cookbooks" in the
-current directory.
-
-If the cookbooks directory already exists, an error will be raised.
-DESC
+        If the cookbooks directory already exists, an error will be raised.
+      DESC
       method_option :environment, :type => :string, :aliases => %w(-e),
         :desc => "Environment for which to download the recipes"
       def download

data/lib/engineyard/cli/ui.rb

@@ -43,14 +43,6 @@ module EY
         end
       end
 
-      def say(*args)
-        if args.first == "Tasks:"
-          super "Commands:"
-        else
-          super
-        end
-      end
-
       def ask(message, password = false)
         begin
           require 'highline'
@@ -104,6 +96,10 @@ module EY
         end
       end
 
+      def print_help(table)
+        print_table(table, :ident => 2, :truncate => true, :colwidth => 20)
+      end
+
       def set_color(string, color, bold=false)
         $stdout.tty? ? super : string
       end

data/lib/engineyard/cli/web.rb

@@ -1,9 +1,8 @@
 module EY
   class CLI
     class Web < EY::Thor
-      desc "web enable [ENVIRONMENT]", <<-HELP
-Take down the maintenance page for the current application in the specified environment.
-      HELP
+      desc "enable [--environment/-e ENVIRONMENT]",
+        "Remove the maintenance page for this application in the given environment."
       method_option :environment, :type => :string, :aliases => %w(-e),
         :desc => "Environment on which to put up the maintenance page"
       def enable
@@ -14,19 +13,19 @@ Take down the maintenance page for the current application in the specified envi
         environment.take_down_maintenance_page(app)
       end
 
-      desc "web disable [ENVIRONMENT]", <<-HELP
-Put up the maintenance page for the current application in the specified environment.
+      desc "disable [--environment/-e ENVIRONMENT]",
+        "Put up the maintenance page for this application in the given environment."
+      long_desc <<-DESC
+        The maintenance page is taken from the app currently being deployed. This means
+        that you can customize maintenance pages to tell users the reason for downtime
+        on every particular deploy.
 
-The maintenance page is taken from the app currently being deployed. This means
-that you can customize maintenance pages to tell users the reason for downtime
-on every particular deploy.
-
-Maintenance pages searched for in order of decreasing priority:
-* public/maintenance.html.custom
-* public/maintenance.html.tmp
-* public/maintenance.html
-* public/system/maintenance.html.default
-      HELP
+        Maintenance pages searched for in order of decreasing priority:
+        * public/maintenance.html.custom
+        * public/maintenance.html.tmp
+        * public/maintenance.html
+        * public/system/maintenance.html.default
+      DESC
       method_option :environment, :type => :string, :aliases => %w(-e),
         :desc => "Environment on which to take down the maintenance page"
       def disable

data/lib/engineyard/model/environment.rb

@@ -1,6 +1,6 @@
 module EY
   module Model
-    class Environment < ApiStruct.new(:id, :name, :instances, :instances_count, :apps, :app_master, :username, :api)
+    class Environment < ApiStruct.new(:id, :name, :instances, :instances_count, :apps, :app_master, :username, :stack_name, :api)
       def self.from_hash(hash)
         super.tap do |env|
           env.username = hash['ssh_username']

data/lib/engineyard/model/instance.rb

@@ -32,8 +32,9 @@ exit(17) # required_version < current_version
 
       def deploy(app, ref, migration_command=nil, extra_configuration=nil)
         deploy_args = [
-          '--app', app.name,
-          '--repo', app.repository_uri,
+          '--app',    app.name,
+          '--repo',   app.repository_uri,
+          '--stack',  environment.stack_name,
           '--branch', ref,
         ]
 
@@ -49,7 +50,10 @@ exit(17) # required_version < current_version
       end
 
       def rollback(app, extra_configuration=nil)
-        deploy_args = ['rollback', '--app', app.name]
+        deploy_args = ['rollback',
+          '--app',   app.name,
+          '--stack', environment.stack_name,
+        ]
 
         if extra_configuration
           deploy_args << '--config' << extra_configuration.to_json
@@ -99,7 +103,15 @@ exit(17) # required_version < current_version
       end
 
       def install_ey_deploy
-        ssh(Escape.shell_command(['sudo', gem_path, 'install', 'ey-deploy', '--no-rdoc', '--no-ri', '-v', EYSD_VERSION]))
+        ssh(Escape.shell_command([
+              'sudo', 'sh', '-c',
+              # rubygems looks at *.gem in its current directory for
+              # installation candidates, so we have to make sure it
+              # runs from a directory with no gem files in it.
+              #
+              # rubygems help suggests that --remote will disable this
+              # behavior, but it doesn't.
+              "cd `mktemp -d` && #{gem_path} install ey-deploy --no-rdoc --no-ri -v '#{EYSD_VERSION}'"]))
       end
 
       def upgrade_ey_deploy

data/lib/engineyard/thor.rb

@@ -1,5 +1,5 @@
+$LOAD_PATH.unshift File.expand_path("../vendor", __FILE__)
 require 'thor'
-require 'engineyard/cli/thor_fixes'
 
 module EY
   class Thor < ::Thor
@@ -21,17 +21,22 @@ module EY
       end
 
       def self.subcommand_help(cmd)
-        desc "help #{cmd} [SUBCOMMAND]", "Describe all subcommands or one specific subcommand."
-
+        desc "#{cmd} help [COMMAND]", "Describe all subcommands or one specific subcommand."
         class_eval <<-RUBY
-def help(*args)
-  super
-  if args.empty?
-    banner = "See '" + self.class.send(:banner_base) + " help #{cmd} [SUBCOMMAND]' "
-    text = "for more information on a specific subcommand."
-    EY.ui.say  banner + text
-  end
-end
+          def help(*args)
+            if args.empty?
+              EY.ui.say "usage: #{banner_base} #{cmd} COMMAND"
+              EY.ui.say
+              subcommands = self.class.printable_tasks.sort_by{|s| s[0] }
+              subcommands.reject!{|t| t[0] =~ /#{cmd} help$/}
+              EY.ui.print_help(subcommands)
+              EY.ui.say self.class.send(:class_options_help, EY.ui)
+              EY.ui.say "See #{banner_base} #{cmd} help COMMAND" +
+                " for more information on a specific subcommand." if args.empty?
+            else
+              super
+            end
+          end
         RUBY
       end
 
@@ -39,13 +44,14 @@ end
         @@original_args[1..-1]
       end
 
-      def self.printable_tasks(all=true)
-        (all ? all_tasks : tasks).map do |_, task|
-          item = []
-          item << banner(task)
-          item << (task.description ? "# #{task.description.gsub(/\n.*/,'')}" : "")
-          item
-        end
+      def self.banner_base
+        "ey"
+      end
+
+      def self.banner(task, task_help = false)
+        scmd = EY::Thor.subcommands.invert[self]
+        task = (task_help ? task.formatted_usage(self, false) : task.name)
+        [banner_base, scmd, task].compact.join(" ")
       end
     end
 

data/lib/engineyard/vendor/thor.rb

@@ -0,0 +1,270 @@
+require 'thor/base'
+
+# TODO: Update thor to allow for git-style CLI (git bisect run)
+class Thor
+  class << self
+    # Sets the default task when thor is executed without an explicit task to be called.
+    #
+    # ==== Parameters
+    # meth<Symbol>:: name of the defaut task
+    #
+    def default_task(meth=nil)
+      case meth
+        when :none
+          @default_task = 'help'
+        when nil
+          @default_task ||= from_superclass(:default_task, 'help')
+        else
+          @default_task = meth.to_s
+      end
+    end
+
+    # Defines the usage and the description of the next task.
+    #
+    # ==== Parameters
+    # usage<String>
+    # description<String>
+    #
+    def desc(usage, description, options={})
+      if options[:for]
+        task = find_and_refresh_task(options[:for])
+        task.usage = usage             if usage
+        task.description = description if description
+      else
+        @usage, @desc = usage, description
+      end
+    end
+
+    # Defines the long description of the next task.
+    #
+    # ==== Parameters
+    # long description<String>
+    #
+    def long_desc(long_description, options={})
+      if options[:for]
+        task = find_and_refresh_task(options[:for])
+        task.long_description = long_description if long_description
+      else
+        @long_desc = long_description
+      end
+    end
+
+    # Maps an input to a task. If you define:
+    #
+    #   map "-T" => "list"
+    #
+    # Running:
+    #
+    #   thor -T
+    #
+    # Will invoke the list task.
+    #
+    # ==== Parameters
+    # Hash[String|Array => Symbol]:: Maps the string or the strings in the array to the given task.
+    #
+    def map(mappings=nil)
+      @map ||= from_superclass(:map, {})
+
+      if mappings
+        mappings.each do |key, value|
+          if key.respond_to?(:each)
+            key.each {|subkey| @map[subkey] = value}
+          else
+            @map[key] = value
+          end
+        end
+      end
+
+      @map
+    end
+
+    # Declares the options for the next task to be declared.
+    #
+    # ==== Parameters
+    # Hash[Symbol => Object]:: The hash key is the name of the option and the value
+    # is the type of the option. Can be :string, :array, :hash, :boolean, :numeric
+    # or :required (string). If you give a value, the type of the value is used.
+    #
+    def method_options(options=nil)
+      @method_options ||= {}
+      build_options(options, @method_options) if options
+      @method_options
+    end
+
+    # Adds an option to the set of method options. If :for is given as option,
+    # it allows you to change the options from a previous defined task.
+    #
+    #   def previous_task
+    #     # magic
+    #   end
+    #
+    #   method_option :foo => :bar, :for => :previous_task
+    #
+    #   def next_task
+    #     # magic
+    #   end
+    #
+    # ==== Parameters
+    # name<Symbol>:: The name of the argument.
+    # options<Hash>:: Described below.
+    #
+    # ==== Options
+    # :desc     - Description for the argument.
+    # :required - If the argument is required or not.
+    # :default  - Default value for this argument. It cannot be required and have default values.
+    # :aliases  - Aliases for this option.
+    # :type     - The type of the argument, can be :string, :hash, :array, :numeric or :boolean.
+    # :banner   - String to show on usage notes.
+    #
+    def method_option(name, options={})
+      scope = if options[:for]
+        find_and_refresh_task(options[:for]).options
+      else
+        method_options
+      end
+
+      build_option(name, options, scope)
+    end
+
+    # Parses the task and options from the given args, instantiate the class
+    # and invoke the task. This method is used when the arguments must be parsed
+    # from an array. If you are inside Ruby and want to use a Thor class, you
+    # can simply initialize it:
+    #
+    #   script = MyScript.new(args, options, config)
+    #   script.invoke(:task, first_arg, second_arg, third_arg)
+    #
+    def start(original_args=ARGV, config={})
+      super do |given_args|
+        meth = given_args.first.to_s
+
+        if !meth.empty? && (map[meth] || meth !~ /^\-/)
+          given_args.shift
+        else
+          meth = nil
+        end
+
+        meth = normalize_task_name(meth)
+        task = all_tasks[meth]
+
+        if task
+          args, opts = Thor::Options.split(given_args)
+          config.merge!(:task_options => task.options)
+        else
+          args, opts = given_args, {}
+        end
+
+        task ||= Thor::Task::Dynamic.new(meth)
+        trailing = args[Range.new(arguments.size, -1)]
+        new(args, opts, config).invoke(task, trailing || [])
+      end
+    end
+
+    # Prints help information for the given task.
+    #
+    # ==== Parameters
+    # shell<Thor::Shell>
+    # task_name<String>
+    #
+    def task_help(shell, task_name)
+      meth = normalize_task_name(task_name)
+      task = all_tasks[meth]
+      handle_no_task_error(meth) unless task
+
+      shell.say "Usage:"
+      shell.say "  #{banner(task, true)}"
+      shell.say
+      class_options_help(shell, nil => task.options.map { |_, o| o })
+      if task.long_description
+        shell.say "Description:"
+        shell.print_wrapped(task.long_description, :ident => 2)
+      else
+        shell.say task.description
+      end
+    end
+
+    # Prints help information for this class.
+    #
+    # ==== Parameters
+    # shell<Thor::Shell>
+    #
+    def help(shell)
+      list = printable_tasks
+      Thor::Util.thor_classes_in(self).each do |klass|
+        list += klass.printable_tasks(false)
+      end
+      list.sort!{ |a,b| a[0] <=> b[0] }
+
+      shell.say "Tasks:"
+      shell.print_table(list, :ident => 2, :truncate => true)
+      shell.say
+      class_options_help(shell)
+    end
+
+    # Returns tasks ready to be printed.
+    def printable_tasks(all=true)
+      (all ? all_tasks : tasks).map do |_, task|
+        item = []
+        item << banner(task)
+        item << (task.description ? "# #{task.description.gsub(/\s+/m,' ')}" : "")
+        item
+      end
+    end
+
+    def handle_argument_error(task, error) #:nodoc:
+      raise InvocationError, "#{task.name.inspect} was called incorrectly. Call as #{task.formatted_usage(self, banner_base == "thor").inspect}."
+    end
+
+    protected
+
+      # The banner for this class. You can customize it if you are invoking the
+      # thor class by another ways which is not the Thor::Runner. It receives
+      # the task that is going to be invoked and a boolean which indicates if
+      # the namespace should be displayed as arguments.
+      #
+      def banner(task, task_help = false)
+        "#{banner_base} #{task.formatted_usage(self, banner_base == "thor")}"
+      end
+
+      def baseclass #:nodoc:
+        Thor
+      end
+
+      def create_task(meth) #:nodoc:
+        if @usage && @desc
+          tasks[meth.to_s] = Thor::Task.new(meth, @desc, @long_desc, @usage, method_options)
+          @usage, @desc, @long_desc, @method_options = nil
+          true
+        elsif self.all_tasks[meth.to_s] || meth.to_sym == :method_missing
+          true
+        else
+          puts "[WARNING] Attempted to create task #{meth.inspect} without usage or description. " <<
+               "Call desc if you want this method to be available as task or declare it inside a " <<
+               "no_tasks{} block. Invoked from #{caller[1].inspect}."
+          false
+        end
+      end
+
+      def initialize_added #:nodoc:
+        class_options.merge!(method_options)
+        @method_options = nil
+      end
+
+      # Receives a task name (can be nil), and try to get a map from it.
+      # If a map can't be found use the sent name or the default task.
+      #
+      def normalize_task_name(meth) #:nodoc:
+        meth = map[meth.to_s] || meth || default_task
+        meth.to_s.gsub('-','_') # treat foo-bar > foo_bar
+      end
+  end
+
+  include Thor::Base
+
+  map HELP_MAPPINGS => :help
+
+  desc "help [TASK]", "Describe available tasks or one specific task"
+  def help(task=nil)
+    task ? self.class.task_help(shell, task) : self.class.help(shell)
+  end
+end