bosh_cli 1.0.3 → 1.5.0.pre.1113

data/lib/cli/command_handler.rb

@@ -39,25 +39,24 @@ module Bosh::Cli
     # @param [Array] args
     # @return [Integer] Command exit code
     def run(args, extra_options = {})
-      handler = @klass.new(@runner)
+      command = @klass.new(@runner)
 
       @options.each do |(name, arguments)|
         @parser.on(name, *arguments) do |value|
-          handler.add_option(format_option_name(name), value)
+          command.add_option(format_option_name(name), value)
         end
       end
 
       extra_options.each_pair do |name, value|
-        handler.add_option(format_option_name(name), value)
+        command.add_option(format_option_name(name), value)
       end
 
       args = parse_options(args)
 
       begin
-        handler.send(@method.name, *args)
-        handler.exit_code
+        command.send(@method.name, *args)
+        command.exit_code
       rescue ArgumentError => e
-        say(e.message)
         err("Usage: #{usage_with_params}")
       end
     end
@@ -97,7 +96,7 @@ module Bosh::Cli
         desc = desc.select { |word| word.is_a?(String) }
         column_width = terminal_width - padding - margin
 
-        result << name.ljust(margin).yellow + " " +
+        result << name.ljust(margin).make_yellow + " " +
           desc.join(" ").columnize(
             column_width, [margin + 1, name.size + 1].max)
       end

data/lib/cli/commands/backup.rb

@@ -0,0 +1,39 @@
+module Bosh::Cli::Command
+  class Backup < Base
+
+    usage 'backup'
+    desc 'Backup BOSH'
+    option '--force', 'Overwrite if the backup file already exists'
+    def backup(path=nil)
+      auth_required
+      path = backup_destination_path(path)
+
+      status, task_id = director.create_backup
+
+      if status == :done
+        tmp_path = director.fetch_backup
+        FileUtils.mv(tmp_path, path)
+        say("Backup of BOSH director was put in `#{path.make_green}'.")
+      else
+        [status, task_id]
+      end
+    end
+
+    private
+
+    def force?
+      !!options[:force]
+    end
+
+    def backup_destination_path(dest_path)
+      path = Bosh::Cli::BackupDestinationPath.new(director).create_from_path(dest_path)
+
+      if File.exists?(path) && !force?
+        err("There is already an existing file at `#{path}'. " +
+              'To overwrite it use the --force option.')
+      end
+
+      path
+    end
+  end
+end

data/lib/cli/commands/biff.rb

@@ -1,6 +1,8 @@
 module Bosh::Cli::Command
   class Biff < Base
 
+    attr_reader :errors
+
     # Takes your current deployment configuration and uses some of its
     # configuration to populate the template file.  The Network information is
     # used and then IPs for each job are automatically set.  Once the template
@@ -18,7 +20,13 @@ module Bosh::Cli::Command
       setup(template)
 
       template_to_fill = ERB.new(File.read(@template_file), 0, "%<>-")
-      @template_output = template_to_fill.result(binding)
+      begin
+        @template_output = template_to_fill.result(binding)
+      rescue ArgumentError => ex
+        say(ex.message)
+        say(ex.backtrace.join("\n"))
+        err("Error rendering ERB")
+      end
 
       if @errors == 0
         print_string_diff(File.read(@deployment_file), @template_output)
@@ -80,9 +88,9 @@ module Bosh::Cli::Command
         removed = line[0..0] == "-"
 
         if added
-          say(line.chomp.green)
+          say(line.chomp.make_green)
         elsif removed
-          say(line.chomp.red)
+          say(line.chomp.make_red)
         else
           say(line)
         end
@@ -116,22 +124,11 @@ module Bosh::Cli::Command
       path_split = path.split(".")
       found_so_far = []
       path_split.each do |path_part|
-        found = false
-        if obj.is_a?(Array)
-          obj.each do |data_val|
-            if data_val["name"] == path_part
-              obj = data_val
-              found = true
-            end
-          end
-        elsif !obj[path_part].nil?
-          obj = obj[path_part]
-          found = true
-        end
+        obj = lookup(path_part, obj)
 
-        unless found
+        unless obj
           @errors += 1
-          say("Could not find #{path.red}.")
+          say("Could not find #{path.make_red}.")
           say("'#{@template_file}' has it but '#{@deployment_file}' does not.")
           #say("\nIt should exist in \n#{obj.to_yaml}\n")
           if starting_obj == @deployment_obj
@@ -150,6 +147,15 @@ module Bosh::Cli::Command
       obj
     end
 
+    def lookup(path, obj)
+      case obj
+        when Array
+          obj.find { |value| path == value['name'] }
+        when Hash
+          obj[path] if obj.has_key?(path)
+      end
+    end
+
     # Used by print_the_template_path so that it can prettily print just the
     # section of the template that the user is missing.  E.x. if the user is
     # missing the job 'ccdb' then we want to not just print out 'ccdb' and
@@ -193,7 +199,7 @@ module Bosh::Cli::Command
       path = users_farthest_found_path.join('.')
       what_we_need = find(path, @template_obj)
       what_we_need = delete_all_except(what_we_need, delete_all_except_name)
-      say("Add this to '#{path}':".red + "\n#{what_we_need.to_yaml}\n\n")
+      say("Add this to '#{path}':".make_red + "\n#{what_we_need.to_yaml}\n\n")
     end
 
     # Loads the template file as YAML.  First, it replaces all of the ruby
@@ -204,7 +210,7 @@ module Bosh::Cli::Command
       temp_data = File.read(@template_file)
       temp_data.gsub!(/<%=.*%>/, "INSERT_DATA_HERE")
       temp_data.gsub!(/[ ]*<%.*%>[ ]*\n/, "")
-      YAML::load(temp_data)
+      Psych::load(temp_data)
     end
 
     # Gets the network's network/mask for configuring things such as the
@@ -366,17 +372,32 @@ module Bosh::Cli::Command
     # @param [String] template The string path to the template that should be
     #     used.
     def setup(template)
+      @errors = 0
       @template_file = template
       @deployment_file = deployment
       err("Deployment not set.") if @deployment_file.nil?
-      @deployment_obj = load_yaml_file(@deployment_file)
+      @deployment_obj = load_yaml_file(deployment)
       @template_obj = load_template_as_yaml
       @ip_helper = create_ip_helper
-      @errors = 0
       @dir_name = Dir.mktmpdir
       @temp_file_path_1 = "#{@dir_name}/bosh_biff_1"
       @temp_file_path_2 = "#{@dir_name}/bosh_biff_2"
     end
 
+    # Generate a random string for passwords and tokens.
+    # Length is the length of the string.
+    # name is an optional name of a previously generated string. This is used
+    # to allow setting the same password for different components.
+    def random_string(length, name=nil)
+      random_string = SecureRandom.hex(length)[0...length]
+
+      @random_cache ||= {}
+      if name
+        @random_cache[name] ||= random_string
+      else
+        random_string
+      end
+    end
+
   end
 end

data/lib/cli/commands/blob_management.rb

@@ -37,7 +37,7 @@ module Bosh::Cli::Command
 
       blob_manager.blobs_to_upload.each do |blob|
         nl
-        if confirmed?("Upload blob #{blob.yellow}?")
+        if confirmed?("Upload blob #{blob.make_yellow}?")
           blob_manager.upload_blob(blob)
         end
       end

data/lib/cli/commands/cloudcheck.rb

@@ -2,8 +2,6 @@
 
 module Bosh::Cli::Command
   class CloudCheck < Base
-    include Bosh::Cli::DeploymentHelper
-
     # bosh cloudcheck
     usage "cloudcheck"
     desc "Cloud consistency check and interactive repair"
@@ -19,9 +17,10 @@ module Bosh::Cli::Command
       @auto_mode = options[:auto]
       @report_mode = options[:report]
 
-      if non_interactive? && !@report_mode
+      if non_interactive? && !(@report_mode || @auto_mode)
         err ("Cloudcheck cannot be run in non-interactive mode\n" +
-             "Please use `--auto' flag if you want automated resolutions")
+             "Please use `--auto' flag if you want automated resolutions " +
+             "or `--report' if you just want a report of the errors")
       end
 
       if @auto_mode && @report_mode
@@ -44,14 +43,14 @@ module Bosh::Cli::Command
 
       verify_problems
       nl
-      say("Found #{pluralize(@problems.size, "problem")}".yellow)
+      say("Found #{pluralize(@problems.size, "problem")}".make_yellow)
       nl
 
       @resolutions = {}
 
       @problems.each_with_index do |problem, index|
         description = problem["description"].to_s.chomp(".") + "."
-        say("Problem #{index+1} of #{@problems.size}: #{description}".yellow)
+        say("Problem #{index+1} of #{@problems.size}: #{description}".make_yellow)
         next if @report_mode
         if @auto_mode
           @resolutions[problem["id"]] = {
@@ -83,7 +82,7 @@ module Bosh::Cli::Command
         exit(1)
       end
 
-      say("Cloudcheck is finished".green)
+      say("Cloudcheck is finished".make_green)
     end
 
     private
@@ -92,7 +91,7 @@ module Bosh::Cli::Command
       err("Invalid problem list format") unless @problems.kind_of?(Enumerable)
 
       if @problems.empty?
-        say("No problems found".green)
+        say("No problems found".make_green)
         exit(0)
       end
 
@@ -126,26 +125,25 @@ module Bosh::Cli::Command
             choice.to_i <= resolutions.size
           break
         end
-        say("Please enter a number between 1 and #{resolutions.size}".red)
+        say("Please enter a number between 1 and #{resolutions.size}".make_red)
       end
 
       resolutions[choice.to_i-1] # -1 accounts for 0-based indexing
     end
 
     def confirm_resolutions
-      say("Below is the list of resolutions you've provided".yellow)
-      say("Please make sure everything is fine and confirm your changes".yellow)
+      say("Below is the list of resolutions you've provided".make_yellow)
+      say("Please make sure everything is fine and confirm your changes".make_yellow)
       nl
 
       @problems.each_with_index do |problem, index|
         plan = @resolutions[problem["id"]]["plan"]
         padding = " " * ((index+1).to_s.size + 4)
         say("  #{index+1}. #{problem["description"]}")
-        say("#{padding}#{plan.to_s.yellow}")
+        say("#{padding}#{plan.to_s.make_yellow}")
         nl
       end
 
-      # TODO: allow editing resolutions?
       cancel unless confirmed?("Apply resolutions?")
     end
 

data/lib/cli/commands/deployment.rb

@@ -2,8 +2,6 @@
 
 module Bosh::Cli::Command
   class Deployment < Base
-    include Bosh::Cli::DeploymentHelper
-
     # bosh deployment
     usage "deployment"
     desc "Get/set current deployment"
@@ -34,7 +32,7 @@ module Bosh::Cli::Command
       end
 
       if target
-        old_director = Bosh::Cli::Director.new(target, username, password)
+        old_director = Bosh::Cli::Client::Director.new(target, username, password)
         old_director_uuid = old_director.get_status["uuid"] rescue nil
       else
         old_director_uuid = nil
@@ -52,7 +50,7 @@ module Bosh::Cli::Command
               "Please find your director IP or hostname and target it first.")
         end
 
-        new_director = Bosh::Cli::Director.new(
+        new_director = Bosh::Cli::Client::Director.new(
           new_target_url, username, password)
 
         status = new_director.get_status
@@ -61,11 +59,11 @@ module Bosh::Cli::Command
         config.target_name = status["name"]
         config.target_version = status["version"]
         config.target_uuid = status["uuid"]
-        say("#{"WARNING!".red} Your target has been " +
-            "changed to `#{target.red}'!")
+        say("#{"WARNING!".make_red} Your target has been " +
+            "changed to `#{target.make_red}'!")
       end
 
-      say("Deployment set to `#{manifest_filename.green}'")
+      say("Deployment set to `#{manifest_filename.make_green}'")
       config.set_deployment(manifest_filename)
       config.save
     end
@@ -91,11 +89,11 @@ module Bosh::Cli::Command
         :yaml => true, :resolve_properties => true)
 
       if interactive?
-        inspect_deployment_changes(YAML.load(manifest_yaml))
-        say("Please review all changes carefully".yellow)
+        inspect_deployment_changes(Psych.load(manifest_yaml))
+        say("Please review all changes carefully".make_yellow)
       end
 
-      desc = "`#{File.basename(deployment).green}' to `#{target_name.green}'"
+      desc = "`#{File.basename(deployment).make_green}' to `#{target_name.make_green}'"
 
       unless confirmed?("Deploying #{desc}")
         cancel_deployment
@@ -114,12 +112,12 @@ module Bosh::Cli::Command
       auth_required
       force = !!options[:force]
 
-      say("\nYou are going to delete deployment `#{name}'.".red)
+      say("\nYou are going to delete deployment `#{name}'.".make_red)
       nl
-      say("THIS IS A VERY DESTRUCTIVE OPERATION AND IT CANNOT BE UNDONE!\n".red)
+      say("THIS IS A VERY DESTRUCTIVE OPERATION AND IT CANNOT BE UNDONE!\n".make_red)
 
       unless confirmed?
-        say("Canceled deleting deployment".green)
+        say("Canceled deleting deployment".make_green)
         return
       end
 
@@ -145,7 +143,7 @@ module Bosh::Cli::Command
       end
       if release_name == release.dev_name || release_name == release.final_name
         nl
-        say("Analyzing release directory...".yellow)
+        say("Analyzing release directory...".make_yellow)
       else
         err("This release was not found in deployment manifest")
       end
@@ -171,7 +169,7 @@ module Bosh::Cli::Command
 
       unless validator.jobs_without_properties.empty?
         nl
-        say("Legacy jobs (no properties defined): ".yellow)
+        say("Legacy jobs (no properties defined): ".make_yellow)
         validator.jobs_without_properties.sort { |a, b|
           a.name <=> b.name
         }.each do |job|
@@ -181,17 +179,17 @@ module Bosh::Cli::Command
 
       if validator.template_errors.empty?
         nl
-        say("No template errors found".green)
+        say("No template errors found".make_green)
       else
         nl
-        say("Template errors: ".yellow)
+        say("Template errors: ".make_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}")
+          say("     line #{error.line}:".make_yellow + " #{error.exception.to_s}")
         end
       end
     end
@@ -208,23 +206,12 @@ module Bosh::Cli::Command
       deployments_table = table do |t|
         t.headings = %w(Name Release(s) Stemcell(s))
         deployments.each do |d|
-          deployment = director.get_deployment(d["name"])
-
-          row = if (deployment["manifest"])
-            manifest = YAML.load(deployment["manifest"])
-
-            stemcells = manifest["resource_pools"].map { |rp|
-              rp["stemcell"].values_at("name", "version").join("/")
-            }.sort.uniq
-
-            releases = manifest["releases"] || [manifest["release"]]
-            releases = releases.map { |rl|
-              rl.values_at("name", "version").join("/")
-            }.sort
-
-            [manifest["name"], releases.join("\n"), stemcells.join("\n")]
+          row = if (d.has_key?("releases") && d.has_key?("stemcells"))
+            row_for_deployments_table(d)
           else
-            [d["name"], "n/a", "n/a"]
+            # backwards compatible but slow: pull down each deployment
+            # manifest to get releases and stemcells in use
+            row_for_deployments_table_by_manifest(d["name"])
           end
 
           t.add_row(row)
@@ -255,18 +242,17 @@ module Bosh::Cli::Command
         File.open(save_as, "w") do |f|
           f.write(deployment["manifest"])
         end
-        say("Deployment manifest saved to `#{save_as}'".green)
+        say("Deployment manifest saved to `#{save_as}'".make_green)
       else
         say(deployment["manifest"])
       end
     end
 
     private
-
     def show_current
       if deployment
         if interactive?
-          say("Current deployment is `#{deployment.green}'")
+          say("Current deployment is `#{deployment.make_green}'")
         else
           say(deployment)
         end
@@ -275,5 +261,35 @@ module Bosh::Cli::Command
       end
     end
 
+    def row_for_deployments_table(deployment)
+      stemcells = names_and_versions_from(deployment["stemcells"])
+      releases  = names_and_versions_from(deployment["releases"])
+
+      [deployment["name"], releases.join("\n"), stemcells.join("\n")]
+    end
+
+    def row_for_deployments_table_by_manifest(deployment_name)
+      raw_manifest = director.get_deployment(deployment_name)
+      if (raw_manifest.has_key?("manifest"))
+        manifest = Psych.load(raw_manifest["manifest"])
+
+        stemcells = manifest["resource_pools"].map { |rp|
+          rp["stemcell"].values_at("name", "version").join("/")
+        }.sort.uniq
+
+        releases = manifest["releases"] || [manifest["release"]]
+        releases = names_and_versions_from(releases)
+
+        [manifest["name"], releases.join("\n"), stemcells.join("\n")]
+      else
+        [deployment_name, "n/a", "n/a"]
+      end
+    end
+
+    def names_and_versions_from(arr)
+      arr.map { |hash|
+        hash.values_at("name", "version").join("/")
+      }.sort
+    end
   end
 end