bosh_cli 0.19.6 → 1.0.rc1

data/lib/cli/commands/job_rename.rb

@@ -4,34 +4,34 @@ module Bosh::Cli::Command
   class JobRename < Base
     include Bosh::Cli::DeploymentHelper
 
-    def rename(*args)
+    # bosh rename
+    usage "rename job"
+    desc "Renames a job. NOTE, your deployment manifest must also be " +
+         "updated to reflect the new job name."
+    option "--force", "Ignore errors"
+    def rename(old_name, new_name)
       auth_required
       manifest_yaml = prepare_deployment_manifest(:yaml => true)
       manifest = YAML.load(manifest_yaml)
 
-      args = args.dup
-      force = args.delete("--force")
-      old_name = args.shift
-      new_name = args.shift
-
-      say("You are about to rename #{old_name.green} to #{new_name.green}")
+      force = options[:force]
+      say("You are about to rename `#{old_name.green}' to `#{new_name.green}'")
 
       unless confirmed?
         nl
         say("Job rename canceled".green)
-        return
+        exit(0)
       end
 
       sanity_check_job_rename(manifest_yaml, old_name, new_name)
 
-      status, _ = director.rename_job(manifest["name"], manifest_yaml,
-                                      old_name, new_name, force)
+      status, _ = director.rename_job(
+        manifest["name"], manifest_yaml, old_name, new_name, force)
 
       task_report(status, "Rename successful")
     end
 
     def sanity_check_job_rename(manifest_yaml, old_name, new_name)
-
       # Makes sure the new deployment manifest contains the renamed job
       manifest = YAML.load(manifest_yaml)
       new_jobs = manifest["jobs"].map { |job| job["name"] }
@@ -87,7 +87,6 @@ module Bosh::Cli::Command
         err("Manifest does not rename old job `#{old_name}'")
       end
 
-
       # Final sanity check, make sure that no
       # other properties or anything other than the names
       # have changed. So update current manifest with new name

data/lib/cli/commands/log_management.rb

@@ -4,55 +4,51 @@ module Bosh::Cli::Command
   class LogManagement < Base
     include Bosh::Cli::DeploymentHelper
 
-    def fetch_logs(*args)
+    # bosh logs
+    usage "logs"
+    desc "Fetch job or agent logs from a BOSH-managed VM"
+    option "--agent", "fetch agent logs"
+    option "--job", "fetch job logs"
+    option "--only filter1,filter2,...", Array,
+           "only fetch logs that satisfy",
+           "given filters (defined in job spec)"
+    option "--all", "fetch all files in the job or agent log directory"
+    def fetch_logs(job, index)
       auth_required
       target_required
 
-      job = args.shift
-      index = args.shift
-      filters = nil
-      log_type = nil
-
-      for_job = args.delete("--job")
-      for_agent = args.delete("--agent")
+      if index !~ /^\d+$/
+        err("Job index is expected to be a positive integer")
+      end
 
-      if for_job && for_agent
-        err("Please specify which logs you want, job or agent")
-      elsif for_agent
+      if options[:agent]
+        if options[:job]
+          err("You can't use --job and --agent together")
+        end
         log_type = "agent"
-      else # default log type is 'job'
+      else
         log_type = "job"
       end
 
-      if args.include?("--only")
-        pos = args.index("--only")
-        filters = args[pos+1]
-        if filters.nil?
-          err("Please provide a list of filters separated by comma")
+      if options[:only]
+        if options[:all]
+          err("You can't use --only and --all together")
         end
-        args.delete("--only")
-        args.delete(filters)
-      elsif args.include?("--all")
-        args.delete("--all")
+        filters = options[:only].join(",")
+      elsif options[:all]
         filters = "all"
+      else
+        filters = nil
       end
 
-      if for_agent && !filters.nil? && filters != "all"
+      if options[:agent] && filters && filters != "all"
         err("Custom filtering is not supported for agent logs")
       end
 
-      if index !~ /^\d+$/
-        err("Job index is expected to be a positive integer")
-      end
-
-      if args.size > 0
-        err("Unknown arguments: #{args.join(", ")}")
-      end
-
       manifest = prepare_deployment_manifest
 
-      resource_id = director.fetch_logs(manifest["name"], job, index,
-                                        log_type, filters)
+      resource_id = director.fetch_logs(
+        manifest["name"], job, index, log_type, filters)
 
       if resource_id.nil?
         err("Error retrieving logs")

data/lib/cli/commands/maintenance.rb

@@ -7,6 +7,9 @@ module Bosh::Cli::Command
     RELEASES_TO_KEEP = 2
     STEMCELLS_TO_KEEP = 2
 
+    # bosh cleanup
+    usage "cleanup"
+    desc  "Cleanup releases and stemcells"
     def cleanup
       target_required
       auth_required
@@ -28,7 +31,9 @@ module Bosh::Cli::Command
         Releases and stemcells that are in use will not be affected.
       EOS
 
-      say("\n#{desc}\n")
+      nl
+      say(desc)
+      nl
 
       err("Cleanup canceled") unless confirmed?
 

data/lib/cli/commands/misc.rb

@@ -4,12 +4,18 @@ module Bosh::Cli::Command
   class Misc < Base
     DEFAULT_STATUS_TIMEOUT = 3 # seconds
 
+    # bosh version
+    usage "version"
+    desc  "Show version"
     def version
       say("BOSH %s" % [Bosh::Cli::VERSION])
     end
 
+    # bosh status
+    usage "status"
+    desc  "Show current status (current target, user, deployment info etc)"
     def status
-      if config.target && options[:director_checks]
+      if config.target
         say("Updating director data...", " ")
 
         begin
@@ -26,58 +32,59 @@ module Bosh::Cli::Command
         rescue TimeoutError
           say("timed out".red)
         rescue => e
-          say("error".red)
+          say("error: #{e.message}")
         end
         nl
       end
 
-      target_name = full_target_name ? full_target_name.green : "not set".red
-      target_uuid = config.target_uuid ? config.target_uuid.green : "n/a".red
-      user = logged_in? ? username.green : "not set".red
-      deployment = config.deployment ? config.deployment.green : "not set".red
+      say("Director".green)
+      if target_url.nil?
+        say("  not set".yellow)
+      else
+        print_value("Name", config.target_name)
+        print_value("URL", target_url)
+        print_value("Version", config.target_version)
+        print_value("User", username, "not logged in")
+        print_value("UUID", config.target_uuid)
+      end
+
+      nl
+      say("Deployment".green)
 
-      say("Target".ljust(15) + target_name)
-      say("UUID".ljust(15) + target_uuid)
-      say("User".ljust(15) + user)
-      say("Deployment".ljust(15) + deployment)
+      if deployment
+        print_value("Manifest", deployment)
+      else
+        say("  not set".yellow)
+      end
 
       if in_release_dir?
-        header("You are in release directory")
+        nl
+        say("Release".green)
 
-        dev_name = release.dev_name
         dev_version = Bosh::Cli::VersionsIndex.new(
-            File.join(work_dir, "dev_releases")).latest_version
+          File.join(work_dir, "dev_releases")).latest_version
 
-        final_name = release.final_name
         final_version = Bosh::Cli::VersionsIndex.new(
-            File.join(work_dir, "releases")).latest_version
-
-        say("Dev name:      %s" % [dev_name ? dev_name.green : "not set".red])
-        say("Dev version:   %s" % [dev_version ?
-                                     dev_version.to_s.green :
-                                     "no versions yet".red])
-        say("\n")
-        say("Final name:    %s" % [final_name ?
-                                       final_name.green :
-                                       "not set".red])
-        say("Final version: %s" % [final_version ?
-                                     final_version.to_s.green :
-                                     "no versions yet".red])
-
-        say("\n")
-        say("Packages")
-        print_specs("package", "packages")
-
-        say("\n")
-        say("Jobs")
-        print_specs("job", "jobs")
+          File.join(work_dir, "releases")).latest_version
+
+        dev = release.dev_name
+        dev += "/#{dev_version}" if dev && dev_version
+
+        final = release.final_name
+        final += "/#{final_version}" if final && final_version
+
+        print_value("dev", dev)
+        print_value("final", final)
       end
     end
 
+    # bosh login
+    usage "login"
+    desc  "Log in to currently targeted director"
     def login(username = nil, password = nil)
       target_required
 
-      unless options[:non_interactive]
+      if interactive?
         username = ask("Your username: ").to_s if username.blank?
 
         password_retries = 0
@@ -92,50 +99,57 @@ module Bosh::Cli::Command
       end
       logged_in = false
 
-      if options[:director_checks]
-        director = Bosh::Cli::Director.new(target, username, password)
+      director.user = username
+      director.password = password
 
-        if director.authenticated?
-          say("Logged in as `#{username}'")
-          logged_in = true
-        else
-          say("Cannot log in as `#{username}', please try again")
-          unless options[:non_interactive]
-            redirect(:misc, :login, username, nil)
-          end
-        end
+      if director.authenticated?
+        say("Logged in as `#{username}'".green)
+        logged_in = true
+      elsif non_interactive?
+        err("Cannot log in as `#{username}'".red)
+      else
+        say("Cannot log in as `#{username}', please try again".red)
+        login(username)
       end
 
-      if logged_in || !options[:director_checks]
+      if logged_in
         config.set_credentials(target, username, password)
         config.save
       end
     end
 
+    # bosh logout
+    usage "logout"
+    desc  "Forget saved credentials for targeted director"
     def logout
       target_required
       config.set_credentials(target, nil, nil)
       config.save
-      say("You are no longer logged in to '#{target}'")
+      say("You are no longer logged in to `#{target}'".yellow)
     end
 
+    # bosh purge
+    usage "purge"
+    desc  "Purge local manifest cache"
     def purge_cache
       if cache.cache_dir != Bosh::Cli::DEFAULT_CACHE_DIR
-        say("Cache directory `#{@cache.cache_dir}' differs from default, " +
-            "please remove manually")
+        err("Cache directory overriden, please remove manually")
       else
         FileUtils.rm_rf(cache.cache_dir)
-        say("Purged cache")
+        say("Purged cache".green)
       end
     end
 
-    def show_target
-      say(target ?
-              "Current target is `#{full_target_name.green}'" :
-              "Target not set".red)
-    end
+    # bosh target
+    usage "target"
+    desc  "Choose director to talk to (optionally creating an alias). " +
+          "If no arguments given, show currently targeted director"
+    def set_target(director_url = nil, name = nil)
+      if director_url.nil?
+        show_target
+        return
+      end
 
-    def set_target(director_url, name = nil)
       if name.nil?
         director_url =
           config.resolve_alias(:target, director_url) || director_url
@@ -147,23 +161,19 @@ module Bosh::Cli::Command
 
       director_url = normalize_url(director_url)
       if target && director_url == normalize_url(target)
-        say("Target already set to `#{full_target_name.green}'")
+        say("Target already set to `#{target_name.green}'")
         return
       end
 
       director = Bosh::Cli::Director.new(director_url)
 
-      if options[:director_checks]
-        begin
-          status = director.get_status
-        rescue Bosh::Cli::AuthError
-          status = {}
-        rescue Bosh::Cli::DirectorError
-          err("Cannot talk to director at `#{director_url}', " +
-              "please set correct target")
-        end
-      else
-        status = {"name" => "Unknown Director", "version" => "n/a"}
+      begin
+        status = director.get_status
+      rescue Bosh::Cli::AuthError
+        status = {}
+      rescue Bosh::Cli::DirectorError
+        err("Cannot talk to director at `#{director_url}', " +
+            "please set correct target")
       end
 
       config.target = director_url
@@ -180,56 +190,88 @@ module Bosh::Cli::Command
       end
 
       config.save
-      say("Target set to `#{full_target_name.green}'")
+      say("Target set to `#{target_name.green}'")
 
       if interactive? && !logged_in?
-        redirect(:misc, :login)
+        redirect("login")
       end
     end
 
+    # bosh targets
+    usage "targets"
+    desc  "Show the list of available targets"
     def list_targets
-      # TODO: Bonus point will be checking each director status
-      # (maybe an --status option?)
       targets = config.aliases(:target) || {}
 
-      err("No targets found") if targets.size == 0
+      err("No targets found") if targets.empty?
 
       targets_table = table do |t|
         t.headings = [ "Name", "Director URL" ]
         targets.each { |row| t << [row[0], row[1]] }
       end
 
-      say("\n")
+      nl
       say(targets_table)
-      say("\n")
+      nl
       say("Targets total: %d" % targets.size)
     end
 
-    def set_alias(name, value)
-      config.set_alias(:cli, name, value.to_s.strip)
+    # bosh alias
+    usage "alias"
+    desc  "Create an alias <name> for command <command>"
+    def set_alias(name, command)
+      config.set_alias(:cli, name, command.to_s.strip)
       config.save
-      say("Alias `#{name.green}' created for command `#{value.green}'")
+      say("Alias `#{name.green}' created for command `#{command.green}'")
     end
 
+    # bosh aliases
+    usage "aliases"
+    desc  "Show the list of available command aliases"
     def list_aliases
       aliases = config.aliases(:cli) || {}
+      err("No aliases found") if aliases.empty?
 
-      err("No aliases found") if aliases.size == 0
-
-      sorted = aliases.sort_by { |name, value| name }
+      sorted = aliases.sort_by { |name, _| name }
       aliases_table = table do |t|
-        t.headings = [ "Alias", "Command" ]
+        t.headings = %w(Alias Command)
         sorted.each { |row| t << [row[0], row[1]] }
       end
 
-      say("\n")
+      nl
       say(aliases_table)
-      say("\n")
+      nl
       say("Aliases total: %d" % aliases.size)
     end
 
     private
 
+    def print_value(label, value, if_none = nil)
+      if value
+        message = label.ljust(10) + value.yellow
+      else
+        message = label.ljust(10) + (if_none || "n/a").yellow
+      end
+      say(message.indent(2))
+    end
+
+    def show_target
+      if config.target
+        if interactive?
+          if config.target_name
+            name = "#{config.target} (#{config.target_name})"
+          else
+            name = config.target
+          end
+          say("Current target is #{name.green}")
+        else
+          say(config.target)
+        end
+      else
+        err("Target not set")
+      end
+    end
+
     def print_specs(entity, dir)
       specs = Dir[File.join(work_dir, dir, "*", "spec")]
 
@@ -237,7 +279,7 @@ module Bosh::Cli::Command
         say("No #{entity} specs found")
       end
 
-      t = table ["Name", "Dev", "Final"]
+      t = table %w(Name Dev Final)
 
       specs.each do |spec_file|
         if spec_file.is_a?(String) && File.file?(spec_file)