engineyard 0.4.0 → 0.5.0

data/lib/engineyard.rb

@@ -1,7 +1,7 @@
 module EY
   require 'engineyard/ruby_ext'
 
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 
   autoload :API,        'engineyard/api'
   autoload :Collection, 'engineyard/collection'

data/lib/engineyard/api.rb

@@ -38,6 +38,15 @@ module EY
       app_for_repo(repo) || raise(NoAppError.new(repo))
     end
 
+    def fetch_app(name)
+      apps.find{|a| a.name == name}
+    end
+
+    def fetch_app!(name)
+      return unless name
+      fetch_app(name) || raise(InvalidAppError.new(name))
+    end
+
     class InvalidCredentials < EY::Error; end
     class RequestFailed < EY::Error; end
 
@@ -75,7 +84,7 @@ module EY
 
       if resp.body.empty?
         data = ''
-      else
+      elsif resp.headers[:content_type] =~ /application\/json/
         begin
           data = JSON.parse(resp.body)
           EY.ui.debug("Response", data)
@@ -83,6 +92,8 @@ module EY
           EY.ui.debug("Raw response", resp.body)
           raise RequestFailed, "Response was not valid JSON."
         end
+      else
+        data = resp.body
       end
 
       data

data/lib/engineyard/cli.rb

@@ -7,44 +7,58 @@ module EY
     autoload :API,     'engineyard/cli/api'
     autoload :UI,      'engineyard/cli/ui'
     autoload :Recipes, 'engineyard/cli/recipes'
+    autoload :Web,     'engineyard/cli/web'
 
     include Thor::Actions
 
     def self.start(*)
+      Thor::Base.shell = EY::CLI::UI
       EY.ui = EY::CLI::UI.new
       super
     end
 
-    desc "deploy [ENVIRONMENT] [BRANCH]", "Deploy [BRANCH] of the app in the current directory to [ENVIRONMENT]"
+    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
     method_option :force, :type => :boolean, :aliases => %w(-f),
-      :desc => "Force a deploy of the specified branch"
+      :desc => "Force a deploy of the specified branch even if a default is set"
     method_option :migrate, :type => :string, :aliases => %w(-m),
       :default => 'rake db:migrate',
       :desc => "Run migrations via [MIGRATE], defaults to 'rake db:migrate'; use --no-migrate to avoid running migrations"
-    def deploy(env_name = nil, branch = nil)
-      app           = api.app_for_repo!(repo)
-      environment   = fetch_environment(env_name, app)
-      deploy_branch = environment.resolve_branch(branch, options[:force]) ||
-        repo.current_branch ||
-        raise(DeployArgumentError)
+    method_option :environment, :type => :string, :aliases => %w(-e),
+      :desc => "Environment in which to deploy this application"
+    method_option :ref, :type => :string, :aliases => %w(-r --branch --tag),
+      :desc => "Git ref to deploy. May be a branch, a tag, or a SHA."
+    method_option :app, :type => :string, :aliases => %w(-a),
+      :desc => "Name of the application to deploy"
+    def deploy
+      app         = api.fetch_app!(options[:app]) || api.app_for_repo!(repo)
+      environment = fetch_environment(options[:environment], app)
+      deploy_ref  = if options[:app]
+                      environment.resolve_branch(options[:ref], options[:force]) ||
+                        raise(EY::Error, "When specifying the application, you must also specify the ref to deploy\nUsage: ey deploy --app <app name> --ref <branch|tag|ref>")
+                    else
+                      environment.resolve_branch(options[:ref], options[:force]) ||
+                        repo.current_branch ||
+                        raise(DeployArgumentError)
+                    end
 
       EY.ui.info "Connecting to the server..."
 
-      environment.ensure_eysd_present! do |action|
-        case action
-        when :installing
-          EY.ui.warn "Instance does not have server-side component installed"
-          EY.ui.info "Installing server-side component..."
-        when :upgrading
-          EY.ui.info "Upgrading server-side component..."
-        else
-          # nothing slow is happening, so there's nothing to say
-        end
-      end
+      loudly_check_eysd(environment)
 
       EY.ui.info "Running deploy for '#{environment.name}' on server..."
 
-      if environment.deploy!(app, deploy_branch, options[:migrate])
+      if environment.deploy(app, deploy_ref, options[:migrate])
         EY.ui.info "Deploy complete"
       else
         raise EY::Error, "Deploy failed"
@@ -52,11 +66,17 @@ module EY
 
     rescue NoEnvironmentError => e
       # Give better feedback about why we couldn't find the environment.
-      exists = api.environments.named(env_name)
-      raise exists ? EnvironmentUnlinkedError.new(env_name) : e
+      exists = api.environments.named(options[:environment])
+      raise exists ? EnvironmentUnlinkedError.new(options[:environment]) : e
     end
 
-    desc "environments [--all]", "List cloud environments for this app, or all environments"
+    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
+
     method_option :all, :type => :boolean, :aliases => %(-a)
     def environments
       apps = get_apps(options[:all])
@@ -65,33 +85,58 @@ module EY
     end
     map "envs" => :environments
 
-    desc "rebuild [ENVIRONMENT]", "Rebuild environment (ensure configuration is up-to-date)"
-    def rebuild(name = nil)
-      env = fetch_environment(name)
+    desc "rebuild [--environment ENVIRONMENT]", <<-DESC
+Rebuild specified environment.
+
+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.
+    DESC
+
+    method_option :environment, :type => :string, :aliases => %w(-e),
+      :desc => "Environment to rebuild"
+    def rebuild
+      env = fetch_environment(options[:environment])
       EY.ui.debug("Rebuilding #{env.name}")
       env.rebuild
     end
 
-    desc "rollback [ENVIRONMENT]", "Rollback to the previous deploy"
-    def rollback(name = nil)
-      app    = api.app_for_repo!(repo)
-      env    = fetch_environment(name)
+    desc "rollback [--environment ENVIRONMENT]", <<-DESC
+Rollback to the previous deploy.
 
-      if env.app_master
-        EY.ui.info("Rolling back #{env.name}")
-        if env.rollback!(app)
-          EY.ui.info "Rollback complete"
-        else
-          raise EY::Error, "Rollback failed"
-        end
+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
+      app = api.app_for_repo!(repo)
+      env = fetch_environment(options[:environment])
+
+      loudly_check_eysd(env)
+
+      EY.ui.info("Rolling back #{env.name}")
+      if env.rollback(app)
+        EY.ui.info "Rollback complete"
       else
-        raise NoAppMaster.new(env.name)
+        raise EY::Error, "Rollback failed"
       end
     end
 
-    desc "ssh [ENVIRONMENT]", "Open an ssh session to the environment's application server"
-    def ssh(name = nil)
-      env = fetch_environment(name)
+    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
+    method_option :environment, :type => :string, :aliases => %w(-e),
+      :desc => "Environment to ssh into"
+    def ssh
+      env = fetch_environment(options[:environment])
 
       if env.app_master
         Kernel.exec "ssh", "#{env.username}@#{env.app_master.public_hostname}"
@@ -100,31 +145,54 @@ module EY
       end
     end
 
-    desc "logs [ENVIRONMENT]", "Retrieve the latest logs for an environment"
-    def logs(name = nil)
-      fetch_environment(name).logs.each do |log|
+    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
+    method_option :environment, :type => :string, :aliases => %w(-e),
+      :desc => "Environment with the interesting logs"
+    def logs
+      env = fetch_environment(options[:environment])
+      env.logs.each do |log|
         EY.ui.info log.instance_name
 
         if log.main
-          EY.ui.info "Main logs:"
+          EY.ui.info "Main logs for #{env.name}:"
           EY.ui.say  log.main
         end
 
         if log.custom
-          EY.ui.info "Custom logs:"
+          EY.ui.info "Custom logs for #{env.name}:"
           EY.ui.say  log.custom
         end
       end
     end
 
-    desc "recipes COMMAND [ARGS]", "Commands related to custom recipes"
+    desc "recipes", "Commands related to chef recipes."
     subcommand "recipes", EY::CLI::Recipes
 
-    desc "version", "Print the version of the engineyard gem"
+    desc "web", "Commands related to maintenance pages."
+    subcommand "web", EY::CLI::Web
+
+    desc "version", "Print version number."
     def version
       EY.ui.say %{engineyard version #{EY::VERSION}}
     end
     map ["-v", "--version"] => :version
 
+    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."
+      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,22 +1,52 @@
 module EY
   class CLI
     class Recipes < EY::Thor
+      desc "recipes apply [ENVIRONMENT]", <<-DESC
+Run uploaded chef recipes on specified environment.
 
-      desc "recipes apply [ENV]", "Apply uploaded chef recipes on ENV"
-      def apply(name = nil)
-        environment = fetch_environment(name)
+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),
+        :desc => "Environment in which to apply recipes"
+      def apply
+        environment = fetch_environment(options[:environment])
         environment.run_custom_recipes
         EY.ui.say "Uploaded recipes started for #{environment.name}"
       end
 
-      desc "recipes upload [ENV]", "Upload custom chef recipes from the current directory to ENV"
-      def upload(name = nil)
-        environment = fetch_environment(name)
+      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
+
+      method_option :environment, :type => :string, :aliases => %w(-e),
+        :desc => "Environment that will receive the recipes"
+      def upload
+        environment = fetch_environment(options[:environment])
         environment.upload_recipes
         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.
+
+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
+      method_option :environment, :type => :string, :aliases => %w(-e),
+        :desc => "Environment for which to download the recipes"
+      def download
+        environment = fetch_environment(options[:environment])
+        environment.download_recipes
+        EY.ui.say "Recipes downloaded successfully for #{environment.name}"
+      end
+
     end
   end
-
 end

data/lib/engineyard/cli/ui.rb

@@ -43,6 +43,14 @@ 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'

data/lib/engineyard/cli/web.rb

@@ -0,0 +1,41 @@
+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
+      method_option :environment, :type => :string, :aliases => %w(-e),
+        :desc => "Environment on which to put up the maintenance page"
+      def enable
+        app         = api.app_for_repo!(repo)
+        environment = fetch_environment(options[:environment], app)
+        loudly_check_eysd(environment)
+        EY.ui.info "Taking down maintenance page for #{environment.name}"
+        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.
+
+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
+      method_option :environment, :type => :string, :aliases => %w(-e),
+        :desc => "Environment on which to take down the maintenance page"
+      def disable
+        app         = api.app_for_repo!(repo)
+        environment = fetch_environment(options[:environment], app)
+        loudly_check_eysd(environment)
+        EY.ui.info "Putting up maintenance page for #{environment.name}"
+        environment.put_up_maintenance_page(app)
+      end
+    end
+  end
+end

data/lib/engineyard/error.rb

@@ -16,6 +16,13 @@ module EY
     end
   end
 
+  class InvalidAppError < Error
+    def initialize(name)
+      error = %|There is no app configured with the name "#{name}"|
+        super error
+    end
+  end
+
   class NoAppMaster < EY::Error
     def initialize(env_name)
       super "The environment '#{env_name}' does not have a master instance."
@@ -67,7 +74,7 @@ module EY
 
   class DeployArgumentError < EY::Error
     def initialize
-      super %|"deploy" was called incorrectly. Call as "deploy [ENVIRONMENT] [BRANCH]"\n| +
+      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|
     end
   end

data/lib/engineyard/model/environment.rb

@@ -31,16 +31,24 @@ module EY
         master
       end
 
-      def ensure_eysd_present!(&blk)
-        app_master!.ensure_eysd_present!(&blk)
+      def ensure_eysd_present(&blk)
+        app_master!.ensure_eysd_present(&blk)
       end
 
-      def deploy!(app, ref, migration_command=nil)
-        app_master!.deploy!(app, ref, migration_command, config)
+      def deploy(app, ref, migration_command=nil)
+        app_master!.deploy(app, ref, migration_command, config)
       end
 
-      def rollback!(app)
-        app_master!.rollback!(app, config)
+      def rollback(app)
+        app_master!.rollback(app, config)
+      end
+
+      def take_down_maintenance_page(app)
+        app_master!.take_down_maintenance_page(app)
+      end
+
+      def put_up_maintenance_page(app)
+        app_master!.put_up_maintenance_page(app)
       end
 
       def rebuild
@@ -51,6 +59,23 @@ module EY
         api.request("/environments/#{id}/run_custom_recipes", :method => :put)
       end
 
+      def download_recipes
+        if File.exist?('cookbooks')
+          raise EY::Error, "Could not download, cookbooks already exists"
+        end
+
+        require 'tempfile'
+        tmp = Tempfile.new("recipes")
+        tmp.write(api.request("/environments/#{id}/recipes"))
+        tmp.flush
+
+        cmd = "tar xzf '#{tmp.path}' cookbooks"
+
+        unless system(cmd)
+          raise EY::Error, "Could not unarchive recipes.\nCommand `#{cmd}` exited with an error."
+        end
+      end
+
       def upload_recipes(file_to_upload = recipe_file)
         api.request("/environments/#{id}/recipes",
           :method => :post,
@@ -95,4 +120,5 @@ module EY
       end
     end
   end
+
 end