bosh_cli 0.19.1 → 0.19.2

data/lib/cli/event_log_renderer.rb

@@ -14,6 +14,8 @@ module Bosh::Cli
       def initialize(name)
         @name = name
         @progress = 0
+        @start_time = nil
+        @finish_time = nil
       end
     end
 
@@ -28,7 +30,7 @@ module Bosh::Cli
       @out = Bosh::Cli::Config.output || $stdout
       @out.sync = true
       @buffer = StringIO.new
-      @progress_bars = { }
+      @progress_bars = {}
       @pos = 0
       @time_adjustment = 0
     end
@@ -39,10 +41,17 @@ module Bosh::Cli
       end
     end
 
-    def add_event(event)
-      event = parse_event(event)
+    def add_event(event_line)
+      event = parse_event(event_line)
 
       @lock.synchronize do
+        # Handling the special "error" event
+        if event["error"]
+          done_with_stage if @current_stage
+          add_error(event)
+          return
+        end
+
         # One way to handle old stages is to prevent them
         # from appearing on screen altogether. That means
         # that we can always render the current stage only
@@ -53,6 +62,7 @@ module Bosh::Cli
 
         tags = event["tags"].is_a?(Array) ? event["tags"] : []
         stage_header = event["stage"]
+
         if tags.size > 0
           stage_header += " " + tags.sort.join(", ").green
         end
@@ -82,6 +92,7 @@ module Bosh::Cli
       @done_tasks = []
 
       @eta = nil
+      @stage_has_error = false # Error flag
       # Tracks max_in_flight best guess
       @tasks_batch_size = 0
       @batches_count = 0
@@ -102,6 +113,19 @@ module Bosh::Cli
       end
     end
 
+    def add_error(event)
+      error = event["error"] || {}
+      code = error["code"]
+      message = error["message"]
+
+      error = "Error"
+      error += " #{code}" if code
+      error += ": #{message}" if message
+
+      # TODO: add KB article link and maybe cck reference?
+      @buffer.puts("\n" + error.red)
+    end
+
     def refresh
       # This is primarily used to refresh timer
       # without advancing rendering buffer
@@ -139,13 +163,19 @@ module Bosh::Cli
       @buffer.print "\n#{@current_stage}\n"
     end
 
-    def done_with_stage(state = "done")
+    def done_with_stage(state = nil)
+      return unless @in_progress
+
       if @last_event
         completion_time = Time.at(@last_event["time"]) rescue Time.now
       else
         completion_time = Time.now
       end
 
+      if state.nil?
+        state = @stage_has_error ? "error" : "done"
+      end
+
       case state.to_s
       when "done"
         progress_bar.title = "Done".green
@@ -170,6 +200,8 @@ module Bosh::Cli
     # We have to trust the first event in each stage
     # to have correct "total" and "current" fields.
     def append_event(event)
+      validate_event(event)
+
       progress = 0
       total = event["total"].to_i
 
@@ -242,6 +274,7 @@ module Bosh::Cli
         if event["state"] == "failed"
           # TODO: truncate?
           status = [task_name.red, event_data["error"]].compact.join(": ")
+          @stage_has_error = true
         else
           status = task_name.yellow
         end
@@ -259,7 +292,7 @@ module Bosh::Cli
       task.progress = progress
 
       progress_bar.total = total
-      progress_bar.title = @tasks.values.map {|t| t.name }.sort.join(", ")
+      progress_bar.title = @tasks.values.map { |t| t.name }.sort.join(", ")
 
       progress_bar.current += progress_bar_gain
       progress_bar.refresh
@@ -269,19 +302,22 @@ module Bosh::Cli
 
     def parse_event(event_line)
       event = JSON.parse(event_line)
-
-      if event["time"] && event["stage"] && event["task"] &&
-          event["index"] && event["total"] && event["state"]
-        event
-      else
-        raise InvalidEvent, "Invalid event structure: stage, time, task, " +
-            "index, total, state are all required"
+      unless event.kind_of?(Hash)
+        raise InvalidEvent, "Hash expected, #{event.class} given"
       end
-
+      event
     rescue JSON::JSONError
       raise InvalidEvent, "Cannot parse event, invalid JSON"
     end
 
+    def validate_event(event)
+      unless event["time"] && event["stage"] && event["task"] &&
+        event["index"] && event["total"] && event["state"]
+        raise InvalidEvent, "Invalid event structure: stage, time, task, " +
+                            "index, total, state are all required"
+      end
+    end
+
     # Expects time and eta to be adjusted
     def time_with_eta(time, eta)
       time_fmt = format_time(time)

data/lib/cli/release_compiler.rb

@@ -10,13 +10,14 @@ module Bosh::Cli
       new(manifest_file, blobstore).compile
     end
 
-    def initialize(manifest_file, blobstore,
-        remote_release = nil, release_dir = nil)
+    def initialize(manifest_file, blobstore, remote_jobs = nil,
+                   remote_packages_sha1 = [], release_dir = nil)
       @build_dir = Dir.mktmpdir
       @jobs_dir = File.join(@build_dir, "jobs")
       @packages_dir = File.join(@build_dir, "packages")
       @blobstore = blobstore
       @release_dir = release_dir || Dir.pwd
+      @remote_packages_sha1 = remote_packages_sha1
 
       at_exit { FileUtils.rm_rf(@build_dir) }
 
@@ -26,15 +27,11 @@ module Bosh::Cli
       @manifest_file = File.expand_path(manifest_file, @release_dir)
       @manifest = load_yaml_file(manifest_file)
 
-      if remote_release
-        @remote_packages = remote_release["packages"].map do |pkg|
-          OpenStruct.new(pkg)
-        end
-        @remote_jobs = remote_release["jobs"].map do |job|
+      if remote_jobs
+        @remote_jobs = remote_jobs.map do |job|
           OpenStruct.new(job)
         end
       else
-        @remote_packages = []
         @remote_jobs = []
       end
 
@@ -56,7 +53,7 @@ module Bosh::Cli
       header("Copying packages")
       @packages.each do |package|
         say("#{package.name} (#{package.version})".ljust(30), " ")
-        if remote_object_exists?(@remote_packages, package)
+        if @remote_packages_sha1.any? { |sha1| sha1 == package.sha1 }
           say("SKIP".yellow)
           next
         end

data/lib/cli/release_tarball.rb

@@ -24,11 +24,19 @@ module Bosh::Cli
       File.exists?(@tarball_path) && File.readable?(@tarball_path)
     end
 
+    def manifest
+      return nil unless valid?
+      unpack
+      File.read(File.join(@unpack_dir, "release.MF"))
+    end
+
     # Repacks tarball according to the structure of remote release
     # Return path to repackaged tarball or nil if repack has failed
-    def repack(remote_release)
+    def repack(remote_jobs = nil, remote_packages_sha1 = nil)
       return nil unless valid?
       unpack
+      remote_jobs ||= []
+      remote_packages_sha1 ||= []
 
       tmpdir = Dir.mktmpdir
       repacked_path = File.join(tmpdir, "release-repack.tgz")
@@ -39,16 +47,13 @@ module Bosh::Cli
 
       local_packages  = manifest["packages"]
       local_jobs = manifest["jobs"]
-      remote_packages = remote_release["packages"]
-      remote_jobs = remote_release["jobs"]
 
       @skipped = 0
 
       Dir.chdir(@unpack_dir) do
         local_packages.each do |package|
           say("#{package['name']} (#{package['version']})".ljust(30), " ")
-          if remote_packages.any? { |rp| package["name"] == rp["name"] &&
-              package["version"].to_s == rp["version"].to_s }
+          if remote_packages_sha1.any? { |sha1| sha1 == package["sha1"] }
             say("SKIP".green)
             @skipped += 1
             FileUtils.rm_rf(File.join("packages", "#{package['name']}.tgz"))

data/lib/cli/runner.rb

@@ -25,7 +25,6 @@ module Bosh::Cli
     end
 
     def initialize(args)
-      define_commands
       @args = args
       @options = {
         :director_checks => true,
@@ -68,9 +67,18 @@ module Bosh::Cli
         end
 
         runner.send(@action.to_sym, *@args)
+        exit(runner.exit_code)
       elsif @args.empty? || @args == %w(help)
         say(help_message)
         say(plugin_help_message) if @plugins
+      elsif @args[0] == "complete"
+        unless ENV.has_key?('COMP_LINE')
+          $stderr.puts "COMP_LINE must be set when calling bosh complete"
+          exit(1)
+        end
+        line = ENV['COMP_LINE'].gsub(/^\S*bosh\s*/, '')
+        puts complete(line).join("\n")
+        exit(0)
       elsif @args[0] == "help"
         cmd_args = @args[1..-1]
         suggestions = command_suggestions(cmd_args).map do |cmd|
@@ -116,6 +124,33 @@ module Bosh::Cli
       end
     end
 
+    # looks for command completion in the parse tree
+    def parse_tree_completion(node, words, index)
+      word = words[index]
+
+      # exact match and not on the last word
+      if node[word] && words.length != index
+        parse_tree_completion(node[word], words, index + 1)
+
+      # exact match at the last word
+      elsif node[word]
+        node[word].values
+
+      # find all partial matches
+      else
+        node.keys.grep(/^#{word}/)
+      end
+    end
+
+    # for use with:
+    # complete -C 'bosh complete' bosh
+    # @param [String] command line (minus "bosh")
+    # @return [Array]
+    def complete(line)
+      words = line.split(/\s+/)
+      parse_tree_completion(@parse_tree, words, 0)
+    end
+
     def command(name, &block)
       cmd_def = CommandDefinition.new
       cmd_def.instance_eval(&block)

data/lib/cli/task_log_renderer.rb

@@ -6,7 +6,7 @@ module Bosh::Cli
     def self.create_for_log_type(log_type)
       if log_type == "event"
         EventLogRenderer.new
-      elsif log_type == "result"
+      elsif log_type == "result" || log_type == "none"
         # Null renderer doesn't output anything to screen, so it fits well
         # in case we need to fetch task result log only, without rendering it
         NullRenderer.new

data/lib/cli/task_tracker.rb

@@ -18,7 +18,10 @@ module Bosh
         @task_id = task_id
         @options = options
 
-        @log_type = options[:log_type] || "event"
+        @quiet = !!options[:quiet]
+        default_log_type = @quiet ? "none" : "event"
+
+        @log_type = options[:log_type] || default_log_type
         @use_cache = options.key?(:use_cache) ? @options[:use_cache] : true
 
         @output = nil
@@ -51,11 +54,7 @@ module Bosh
           task_status = poll
         end
 
-        if task_status == :error && interactive? && @log_type != "debug"
-          prompt_for_debug_log
-        else
-          print_task_summary(task_status)
-        end
+        print_task_summary(task_status)
 
         save_task_output unless cached_output
         task_status
@@ -133,6 +132,14 @@ module Bosh
 
       private
 
+      def nl
+        super unless @quiet
+      end
+
+      def say(*args)
+        super unless @quiet
+      end
+
       # @param [String] output Output received from director task
       def output_received(output)
         return if output.nil?

data/lib/cli/version.rb

@@ -2,6 +2,6 @@
 
 module Bosh
   module Cli
-    VERSION = "0.19.1"
+    VERSION = "0.19.2"
   end
 end

data/spec/unit/core_ext_spec.rb

@@ -24,7 +24,7 @@ describe String do
     end
   end
 
-  it "has colorization helpers" do
+  it "has colorization helpers (but only if tty)" do
     Bosh::Cli::Config.colorize = false
     "string".red.should   == "string"
     "string".green.should == "string"
@@ -32,10 +32,14 @@ describe String do
     "string".colorize(:green).should == "string"
 
     Bosh::Cli::Config.colorize = true
+    Bosh::Cli::Config.output.stub(:tty?).and_return(true)
     "string".red.should == "\e[0m\e[31mstring\e[0m"
     "string".green.should == "\e[0m\e[32mstring\e[0m"
     "string".colorize("a").should == "string"
     "string".colorize(:green).should == "\e[0m\e[32mstring\e[0m"
+
+    Bosh::Cli::Config.output.stub(:tty?).and_return(false)
+    "string".green.should == "string"
   end
 end
 

data/spec/unit/director_spec.rb

@@ -61,7 +61,8 @@ describe Bosh::Cli::Director do
 
     it "uploads stemcell" do
       @director.should_receive(:upload_and_track).
-        with("/stemcells", "application/x-compressed", "/path").
+        with(:post, "/stemcells", "/path",
+             {:content_type => "application/x-compressed"}).
         and_return(true)
       @director.upload_stemcell("/path")
     end
@@ -117,7 +118,8 @@ describe Bosh::Cli::Director do
 
     it "uploads release" do
       @director.should_receive(:upload_and_track).
-        with("/releases", "application/x-compressed", "/path").
+        with(:post, "/releases", "/path",
+             {:content_type => "application/x-compressed"}).
         and_return(true)
       @director.upload_release("/path")
     end
@@ -138,45 +140,49 @@ describe Bosh::Cli::Director do
 
     it "deletes stemcell" do
       @director.should_receive(:request_and_track).
-        with(:delete, "/stemcells/ubuntu/123").and_return(true)
+        with(:delete, "/stemcells/ubuntu/123", {}).and_return(true)
       @director.delete_stemcell("ubuntu", "123")
     end
 
     it "deletes deployment" do
       @director.should_receive(:request_and_track).
-        with(:delete, "/deployments/foo").and_return(true)
+        with(:delete, "/deployments/foo", {}).and_return(true)
       @director.delete_deployment("foo")
     end
 
     it "deletes release (non-force)" do
       @director.should_receive(:request_and_track).
-        with(:delete, "/releases/za").and_return(true)
+        with(:delete, "/releases/za", {}).and_return(true)
       @director.delete_release("za")
     end
 
     it "deletes release (force)" do
       @director.should_receive(:request_and_track).
-        with(:delete, "/releases/zb?force=true").and_return(true)
+        with(:delete, "/releases/zb?force=true", {}).and_return(true)
       @director.delete_release("zb", :force => true)
     end
 
     it "deploys" do
       @director.should_receive(:request_and_track).
-        with(:post, "/deployments", "text/yaml", "manifest").and_return(true)
+        with(:post, "/deployments",
+             {:content_type => "text/yaml", :payload => "manifest"}).
+        and_return(true)
       @director.deploy("manifest")
     end
 
     it "changes job state" do
       @director.should_receive(:request_and_track).
         with(:put, "/deployments/foo/jobs/dea?state=stopped",
-             "text/yaml", "manifest").and_return(true)
+             {:content_type => "text/yaml", :payload =>"manifest"}).
+        and_return(true)
       @director.change_job_state("foo", "manifest", "dea", nil, "stopped")
     end
 
     it "changes job instance state" do
       @director.should_receive(:request_and_track).
         with(:put, "/deployments/foo/jobs/dea/0?state=detached",
-             "text/yaml", "manifest").and_return(true)
+             {:content_type => "text/yaml", :payload => "manifest"}).
+        and_return(true)
       @director.change_job_state("foo", "manifest", "dea", 0, "detached")
     end
 
@@ -255,9 +261,12 @@ describe Bosh::Cli::Director do
         with(@director, "502", options).
         and_return(tracker)
 
-      @director.request_and_track(:get, "/stuff", "text/plain",
-                                  "abc", options).
-        should == ["polling result", "502", "foo"]
+      @director.request_and_track(:get, "/stuff",
+                                  {:content_type => "text/plain",
+                                   :payload => "abc",
+                                   :arg1 => 1, :arg2 => 2
+                                  }).
+        should == ["polling result", "502"]
     end
 
     it "considers all responses but 302 a failure" do
@@ -265,9 +274,12 @@ describe Bosh::Cli::Director do
         @director.should_receive(:request).
           with(:get, "/stuff", "text/plain", "abc").
           and_return([code, "body", {}])
-        @director.request_and_track(:get, "/stuff", "text/plain",
-                                    "abc", :arg1 => 1, :arg2 => 2).
-          should == [:failed, nil, nil]
+        @director.request_and_track(:get, "/stuff",
+                                    {:content_type => "text/plain",
+                                     :payload => "abc",
+                                     :arg1 => 1, :arg2 => 2
+                                    }).
+          should == [:failed, nil]
       end
     end
 
@@ -275,9 +287,12 @@ describe Bosh::Cli::Director do
       @director.should_receive(:request).
         with(:get, "/stuff", "text/plain", "abc").
         and_return([302, "body", { :location => "/track-task/502" }])
-      @director.request_and_track(:get, "/stuff", "text/plain",
-                                  "abc", :arg1 => 1, :arg2 => 2).
-        should == [:non_trackable, nil, nil]
+      @director.request_and_track(:get, "/stuff",
+                                  {:content_type => "text/plain",
+                                   :payload => "abc",
+                                   :arg1 => 1, :arg2 => 2
+                                  }).
+        should == [:non_trackable, nil]
     end
 
     it "supports uploading with progress bar" do
@@ -286,8 +301,10 @@ describe Bosh::Cli::Director do
 
       Bosh::Cli::FileWithProgressBar.stub!(:open).with(file, "r").and_return(f)
       @director.should_receive(:request_and_track).
-        with(:post, "/stuff", "application/x-compressed", f, { })
-      @director.upload_and_track("/stuff", "application/x-compressed", file)
+        with(:put, "/stuff", {:content_type => "application/x-compressed",
+                               :payload => f})
+      @director.upload_and_track(:put, "/stuff", file,
+                                 :content_type => "application/x-compressed")
       f.progress_bar.finished?.should be_true
     end
   end
@@ -348,7 +365,7 @@ describe Bosh::Cli::Director do
           @director.request(:get, "/stuff", "application/octet-stream",
                             "payload", { :hdr1 => "a", :hdr2 => "b"})
         }.should raise_error(Bosh::Cli::DirectorError,
-                             "Director error 40422: Weird stuff happened")
+                             "Error 40422: Weird stuff happened")
 
         lambda {
           # Not JSON
@@ -360,7 +377,7 @@ describe Bosh::Cli::Director do
           @director.request(:get, "/stuff", "application/octet-stream",
                             "payload", { :hdr1 => "a", :hdr2 => "b"})
         }.should raise_error(Bosh::Cli::DirectorError,
-                             "Director error (HTTP #{code}): " +
+                             "HTTP #{code}: " +
                              "error message goes here")
 
         lambda {
@@ -373,7 +390,7 @@ describe Bosh::Cli::Director do
           @director.request(:get, "/stuff", "application/octet-stream",
                             "payload", { :hdr1 => "a", :hdr2 => "b"})
         }.should raise_error(Bosh::Cli::DirectorError,
-                             "Director error (HTTP #{code}): " +
+                             "HTTP #{code}: " +
                              %Q[{"c":"d","a":"b"}])
       end
     end