bosh_cli 0.19.6 → 1.0.rc1

data/lib/cli/commands/complete.rb

@@ -0,0 +1,29 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+module Bosh::Cli::Command
+  class Complete < Base
+
+    # bosh complete: Bash-compatible command line completion
+    usage "complete"
+    desc "Command completion options"
+    def complete(*args)
+      unless ENV.has_key?("COMP_LINE")
+        err("COMP_LINE must be set when calling bosh complete")
+      end
+      line = ENV["COMP_LINE"].gsub(/^\S*bosh\s*/, "")
+      say(completions(line).join("\n"))
+    end
+
+    private
+
+    # @param [String] line
+    def completions(line)
+      if runner.nil?
+        err("Command runner is not instantiated")
+      end
+
+      runner.find_completions(line.split(/\s+/))
+    end
+
+  end
+end

data/lib/cli/commands/deployment.rb

@@ -4,17 +4,19 @@ module Bosh::Cli::Command
   class Deployment < Base
     include Bosh::Cli::DeploymentHelper
 
-    def show_current
-      say(deployment ?
-            "Current deployment is `#{deployment.green}'" :
-            "Deployment not set".red)
-    end
+    # bosh deployment
+    usage "deployment"
+    desc "Get/set current deployment"
+    def set_current(filename = nil)
+      if filename.nil?
+        show_current
+        return
+      end
 
-    def set_current(name)
-      manifest_filename = find_deployment(name)
+      manifest_filename = find_deployment(filename)
 
       unless File.exists?(manifest_filename)
-        err("Missing manifest for #{name} (tried `#{manifest_filename}')")
+        err("Missing manifest for `#{filename}'")
       end
 
       manifest = load_yaml_file(manifest_filename)
@@ -45,13 +47,14 @@ module Bosh::Cli::Command
 
         if new_target_url.blank?
           err("This manifest references director with UUID " +
-                "#{new_director_uuid}.\n" +
-                "You've never targeted it before.\n" +
-                "Please find your director IP or hostname and target it first.")
+              "#{new_director_uuid}.\n" +
+              "You've never targeted it before.\n" +
+              "Please find your director IP or hostname and target it first.")
         end
 
-        new_director = Bosh::Cli::Director.new(new_target_url,
-                                               username, password)
+        new_director = Bosh::Cli::Director.new(
+          new_target_url, username, password)
+
         status = new_director.get_status
 
         config.target = new_target_url
@@ -67,21 +70,25 @@ module Bosh::Cli::Command
       config.save
     end
 
+    # bosh edit deployment
+    usage "edit deployment"
+    desc "Edit current deployment manifest"
     def edit
-      unless deployment
-        quit("Deployment not set".red)
-      end
-
+      deployment_required
       editor = ENV['EDITOR'] || "vi"
       system("#{editor} #{deployment}")
     end
 
-    def perform(*options)
+    # bosh deploy
+    usage "deploy"
+    desc "Deploy according to the currently selected deployment manifest"
+    option "--recreate", "recreate all VMs in deployment"
+    def perform
       auth_required
-      recreate = options.include?("--recreate")
+      recreate = !!options[:recreate]
 
-      manifest_yaml =
-        prepare_deployment_manifest(:yaml => true, :resolve_properties => true)
+      manifest_yaml = prepare_deployment_manifest(
+        :yaml => true, :resolve_properties => true)
 
       if interactive?
         inspect_deployment_changes(YAML.load(manifest_yaml))
@@ -99,11 +106,16 @@ module Bosh::Cli::Command
       task_report(status, "Deployed #{desc}")
     end
 
-    def delete(name, *options)
+    # bosh delete deployment
+    usage "delete deployment"
+    desc "Delete deployment"
+    option "--force", "ignore errors while deleting"
+    def delete(name)
       auth_required
-      force = options.include?("--force")
+      force = !!options[:force]
 
-      say("\nYou are going to delete deployment `#{name}'.\n\n")
+      say("\nYou are going to delete deployment `#{name}'.".red)
+      nl
       say("THIS IS A VERY DESTRUCTIVE OPERATION AND IT CANNOT BE UNDONE!\n".red)
 
       unless confirmed?
@@ -116,12 +128,71 @@ module Bosh::Cli::Command
       task_report(status, "Deleted deployment `#{name}'")
     end
 
+    # bosh validate jobs
+    usage "validate jobs"
+    desc "Validates all jobs in the current release using current " +
+         "deployment manifest as the source of properties"
+    def validate_jobs
+      check_if_release_dir
+      manifest = prepare_deployment_manifest(:resolve_properties => true)
+
+      nl
+      say("Analyzing release directory...".yellow)
+
+      say(" - discovering packages")
+      packages = Bosh::Cli::PackageBuilder.discover(
+        work_dir,
+        :dry_run => true,
+        :final => false
+      )
+
+      say(" - discovering jobs")
+      jobs = Bosh::Cli::JobBuilder.discover(
+        work_dir,
+        :dry_run => true,
+        :final => false,
+        :package_names => packages.map {|package| package.name}
+      )
+
+      say(" - validating properties")
+      validator = Bosh::Cli::JobPropertyValidator.new(jobs, manifest)
+      validator.validate
+
+      unless validator.jobs_without_properties.empty?
+        nl
+        say("Legacy jobs (no properties defined): ".yellow)
+        validator.jobs_without_properties.sort { |a, b|
+          a.name <=> b.name
+        }.each do |job|
+          say(" - #{job.name}")
+        end
+      end
+
+      if validator.template_errors.empty?
+        nl
+        say("No template errors found".green)
+      else
+        nl
+        say("Template errors: ".yellow)
+        validator.template_errors.each do |error|
+          nl
+          path = Pathname.new(error.template_path)
+          rel_path = path.relative_path_from(Pathname.new(release.dir))
+
+          say(" - #{rel_path}:")
+          say("     line #{error.line}:".yellow + " #{error.exception.to_s}")
+        end
+      end
+    end
+
+    # bosh deployments
+    usage "deployments"
+    desc "Show the list of available deployments"
     def list
       auth_required
-
       deployments = director.list_deployments
 
-      err("No deployments") if deployments.size == 0
+      err("No deployments") if deployments.empty?
 
       deployments_table = table do |t|
         t.headings = %w(Name)
@@ -130,10 +201,48 @@ module Bosh::Cli::Command
         end
       end
 
-      say("\n")
+      nl
       say(deployments_table)
-      say("\n")
+      nl
       say("Deployments total: %d" % deployments.size)
     end
+
+    # bosh download manifest
+    usage "download manifest"
+    desc "Download deployment manifest locally"
+    def download_manifest(deployment_name, save_as = nil)
+      auth_required
+
+      if save_as && File.exists?(save_as) &&
+         !confirmed?("Overwrite `#{save_as}'?")
+        err("Please choose another file to save the manifest to")
+      end
+
+      deployment = director.get_deployment(deployment_name)
+
+      if save_as
+        File.open(save_as, "w") do |f|
+          f.write(deployment["manifest"])
+        end
+        say("Deployment manifest saved to `#{save_as}'".green)
+      else
+        say(deployment["manifest"])
+      end
+    end
+
+    private
+
+    def show_current
+      if deployment
+        if interactive?
+          say("Current deployment is `#{deployment.green}'")
+        else
+          say(deployment)
+        end
+      else
+        err("Deployment not set")
+      end
+    end
+
   end
 end

data/lib/cli/commands/help.rb

@@ -0,0 +1,96 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+module Bosh::Cli::Command
+  class Help < Base
+
+    # bosh help: shows either a high level help message or drills down to a
+    # specific area (release, deployment etc)
+    usage "help"
+    desc "Show help message"
+    option "--all", "Show help for all BOSH commands"
+    # @param [Array] keywords What specific kind of help is requested
+    def help(*keywords)
+      if runner.nil?
+        err("Cannot show help message, command runner is not instantiated")
+      end
+
+      keywords = "all" if keywords.empty? && options[:all]
+
+      if keywords.empty?
+        generic_help
+      else
+        keyword_help(keywords)
+      end
+    end
+
+    private
+
+    def generic_help
+      message = <<-HELP.gsub(/^\s*\|/, "")
+        |BOSH CLI helps you manage your BOSH deployments and releases.
+        |
+        |#{runner.usage}
+        |
+        |The most commonly used BOSH commands are:
+        |  target                        Point CLI to BOSH Director
+        |  deployment                    Set deployment
+        |  status                        Current status
+        |  create release                Create new release
+        |  upload release                Upload release
+        |  upload stemcell               Upload stemcell image
+        |  deploy                        Perform deployment
+        |  task <task_id>                Track task / show task log
+        |  tasks                         List running tasks
+        |  tasks recent                  List recent tasks
+        |  cloudcheck                    Find and resolve deployment problems
+        |  deployments                   List deployments
+        |  releases                      List releases
+        |  start,restart,recreate,stop   Job management
+        |  add blob                      Add large binary file to release
+        |
+        |You can run 'bosh help <keywords...>' to see different commands,
+        |i.e. 'bosh help release', 'bosh help cloudcheck'.
+        |Or run 'bosh help --all' to see all available BOSH commands
+      HELP
+
+      say message
+    end
+
+    # @param [Array] keywords
+    def keyword_help(keywords)
+      matches = Bosh::Cli::Config.commands.values
+
+      if keywords == "all"
+        good_matches = matches.sort { |a, b| a.usage <=> b.usage }
+      else
+        good_matches = []
+        matches.each do |command|
+          common_keywords = command.keywords & keywords
+          if common_keywords.size > 0
+            good_matches << command
+          end
+
+          good_matches.sort! do |a, b|
+            cmp = (b.keywords & keywords).size <=> (a.keywords & keywords).size
+            cmp = (a.usage <=> b.usage) if cmp == 0
+            cmp
+          end
+        end
+      end
+
+      help_column_width = terminal_width - 5
+      help_indent = 4
+
+      good_matches.each_with_index do |command, i|
+        nl if i > 0
+        margin = command.usage.size + 1
+        say("#{command.usage_with_params.columnize(70, margin).green}")
+        say(command.desc.columnize(help_column_width).indent(help_indent))
+        if command.has_options?
+          say(command.options_summary.indent(help_indent))
+        end
+      end
+    end
+
+  end
+end

data/lib/cli/commands/job.rb

@@ -3,11 +3,14 @@
 module Bosh::Cli::Command
   class Job < Base
 
+    # bosh generate job
+    usage "generate job"
+    desc "Generate job template"
     def generate(name)
       check_if_release_dir
 
       unless name.bosh_valid_id?
-        err("`#{name}' is not a vaild BOSH id")
+        err("`#{name}' is not a valid BOSH id")
       end
 
       job_dir = File.join("jobs", name)

data/lib/cli/commands/job_management.rb

@@ -4,23 +4,43 @@ module Bosh::Cli::Command
   class JobManagement < Base
     include Bosh::Cli::DeploymentHelper
 
-    def start_job(*args)
-      change_job_state(:start, *args)
+    FORCE = "Proceed even when there are other manifest changes"
+
+    # bosh start
+    usage "start"
+    desc "Start job/instance"
+    option "--force", FORCE
+    def start_job(job, index = nil)
+      change_job_state(:start, job, index)
     end
 
-    def stop_job(*args)
-      change_job_state(:stop, *args)
+    # bosh stop
+    usage "stop"
+    desc "Stop job/instance"
+    option "--soft", "Stop process only"
+    option "--hard", "Power off VM"
+    option "--force", FORCE
+    def stop_job(job, index = nil)
+      change_job_state(:stop, job, index)
     end
 
-    def restart_job(*args)
-      change_job_state(:restart, *args)
+    # bosh restart
+    usage "restart"
+    desc "Restart job/instance (soft stop + start)"
+    option "--force", FORCE
+    def restart_job(job, index = nil)
+      change_job_state(:restart, job, index)
     end
 
-    def recreate_job(*args)
-      change_job_state(:recreate, *args)
+    # bosh recreate
+    usage "recreate"
+    desc "Recreate job/instance (hard stop + start)"
+    option "--force", FORCE
+    def recreate_job(job, index = nil)
+      change_job_state(:recreate, job, index)
     end
 
-    def change_job_state(operation, *args)
+    def change_job_state(operation, job, index)
       auth_required
       manifest_yaml = prepare_deployment_manifest(:yaml => true)
       manifest = YAML.load(manifest_yaml)
@@ -30,10 +50,9 @@ module Bosh::Cli::Command
             "`start', `stop', `restart', `recreate'")
       end
 
-      args  = args.dup
-      hard  = args.delete("--hard")
-      soft  = args.delete("--soft")
-      force = args.delete("--force")
+      hard = options[:hard]
+      soft = options[:soft]
+      force = options[:force]
 
       if hard && soft
         err("Cannot handle both --hard and --soft options, please choose one")
@@ -43,9 +62,7 @@ module Bosh::Cli::Command
         err("--hard and --soft options only make sense for `stop' operation")
       end
 
-      job = args.shift
-      index = args.shift
-      job_desc = index ? "#{job}(#{index})" : "#{job}"
+      job_desc = index ? "#{job}/#{index}" : "#{job}"
 
       op_desc = nil
       new_state = nil
@@ -83,8 +100,6 @@ module Bosh::Cli::Command
       say("You are about to #{op_desc.green}")
 
       if interactive?
-        # TODO: refactor inspect_deployment_changes
-        # to decouple changeset structure and rendering
         other_changes_present = inspect_deployment_changes(
             manifest, :show_empty_changeset => false)
 
@@ -96,14 +111,12 @@ module Bosh::Cli::Command
           cancel_deployment
         end
       end
-      nl
 
+      nl
       say("Performing `#{op_desc}'...")
 
-      status, _ =
-        director.change_job_state(manifest["name"],
-                                  manifest_yaml,
-                                  job, index, new_state)
+      status, _ = director.change_job_state(
+        manifest["name"], manifest_yaml, job, index, new_state)
 
       task_report(status, completion_desc)
     end