bosh_cli 1.0.3 → 1.5.0.pre.1113

data/lib/cli/deployment_manifest_compiler.rb

@@ -15,9 +15,6 @@ module Bosh::Cli
     end
 
     def result
-      # TODO: erb is just a fancy eval, so it's not very trustworthy,
-      # consider using more constrained template engine.
-      # Note that we use $SAFE=4 for ERB which is a strawman sandbox.
       ERB.new(@raw_manifest, 4).result(binding.taint)
     rescue SyntaxError => e
       raise MalformedManifest,

data/lib/cli/event_log_renderer.rb

@@ -64,7 +64,7 @@ module Bosh::Cli
         stage_header = event["stage"]
 
         if tags.size > 0
-          stage_header += " " + tags.sort.join(", ").green
+          stage_header += " " + tags.sort.join(", ").make_green
         end
 
         unless @seen_stages.include?(stage_header)
@@ -122,8 +122,7 @@ module Bosh::Cli
       error += " #{code}" if code
       error += ": #{message}" if message
 
-      # TODO: add KB article link and maybe cck reference?
-      @buffer.puts("\n" + error.red)
+      @buffer.puts("\n" + error.make_red)
     end
 
     def refresh
@@ -178,12 +177,12 @@ module Bosh::Cli
 
       case state.to_s
       when "done"
-        progress_bar.title = "Done".green
+        progress_bar.title = "Done".make_green
         progress_bar.finished_steps = progress_bar.total
       when "error"
-        progress_bar.title = "Error".red
+        progress_bar.title = "Error".make_red
       else
-        progress_bar.title = "Not done".yellow
+        progress_bar.title = "Not done".make_yellow
       end
 
       progress_bar.bar_visible = false
@@ -272,11 +271,10 @@ module Bosh::Cli
         end
 
         if event["state"] == "failed"
-          # TODO: truncate?
-          status = [task_name.red, event_data["error"]].compact.join(": ")
+          status = [task_name.make_red, event_data["error"]].compact.join(": ")
           @stage_has_error = true
         else
-          status = task_name.yellow
+          status = task_name.make_yellow
         end
         @buffer.puts("  #{status} (#{format_time(task_time)})")
       when "in_progress"
@@ -376,7 +374,9 @@ module Bosh::Cli
     end
 
     def calculate_terminal_width
-      if !ENV["TERM"].blank?
+      if ENV["COLUMNS"].to_s =~ /^\d+$/
+        ENV["COLUMNS"].to_i
+      elsif !ENV["TERM"].blank?
         width = `tput cols`
         $?.exitstatus == 0 ? [width.to_i, 100].min : 80
       else

data/lib/cli/file_with_progress_bar.rb

@@ -0,0 +1,52 @@
+module Bosh
+  module Cli
+    class FileWithProgressBar < ::File
+
+      def progress_bar
+        return @progress_bar if @progress_bar
+        out = Bosh::Cli::Config.output || StringIO.new
+        @progress_bar = ProgressBar.new(file_name, size, out)
+        @progress_bar.file_transfer_mode
+        @progress_bar
+      end
+
+      def file_name
+        File.basename(self.path)
+      end
+
+      def stop_progress_bar
+        progress_bar.halt unless progress_bar.finished?
+      end
+
+      def size
+        @size || File.size(self.path)
+      end
+
+      def size=(size)
+        @size=size
+      end
+
+      def read(*args)
+        result = super(*args)
+
+        if result && result.size > 0
+          progress_bar.inc(result.size)
+        else
+          progress_bar.finish
+        end
+
+        result
+      end
+
+      def write(*args)
+        count = super(*args)
+        if count
+          progress_bar.inc(count)
+        else
+          progress_bar.finish
+        end
+        count
+      end
+    end
+  end
+end

data/lib/cli/job_builder.rb

@@ -37,7 +37,7 @@ module Bosh::Cli
         end
 
         unless $?.exitstatus == 0
-          raise InvalidJob, "`#{script_path}' script failed"
+          raise InvalidJob, "`#{script_path}' script failed: #{output}"
         end
 
         output

data/lib/cli/job_command_args.rb

@@ -0,0 +1,23 @@
+module Bosh::Cli
+  class JobCommandArgs < Struct.new(:job, :index, :args)
+    def initialize(args)
+      job = args.shift
+      err('Please provide job name') if job.nil?
+      job, index = job.split('/', 2)
+
+      if index
+        if index =~ /^\d+$/
+          index = index.to_i
+        else
+          err('Invalid job index, integer number expected')
+        end
+      elsif args[0] =~ /^\d+$/
+        index = args.shift.to_i
+      end
+
+      self.job = job
+      self.index = index
+      self.args = args
+    end
+  end
+end

data/lib/cli/job_property_collection.rb

@@ -1,5 +1,7 @@
 # Copyright (c) 2009-2012 VMware, Inc.
 
+require 'common/deep_copy'
+
 module Bosh::Cli
   class JobPropertyCollection
     include Enumerable
@@ -12,8 +14,8 @@ module Bosh::Cli
     def initialize(job_builder, global_properties, job_properties, mappings)
       @job_builder = job_builder
 
-      @job_properties = deep_copy(job_properties || {})
-      merge(@job_properties, deep_copy(global_properties))
+      @job_properties = Bosh::Common::DeepCopy.copy(job_properties || {})
+      merge(@job_properties, Bosh::Common::DeepCopy.copy(global_properties))
 
       @mappings = mappings || {}
       @properties = []
@@ -64,11 +66,6 @@ module Bosh::Cli
       end
     end
 
-    # @param [Object] object Serializable object
-    # @return [Object] Deep copy of the object
-    def deep_copy(object)
-      Marshal.load(Marshal.dump(object))
-    end
 
     # @param [Hash] base
     # @param [Hash] extras

data/lib/cli/job_property_validator.rb

@@ -2,7 +2,6 @@
 
 module Bosh::Cli
   class JobPropertyValidator
-    # TODO: tests
 
     attr_reader :template_errors
     attr_reader :jobs_without_properties
@@ -49,12 +48,16 @@ module Bosh::Cli
       end
 
       @template_errors = []
-      # TODO: track missing props and show the list to user (super helpful!)
     end
 
     def validate
       @manifest["jobs"].each do |job_spec|
-        validate_templates(job_spec)
+        job_templates = Array(job_spec['template'])
+        job_templates.each do |job_template|
+          job_spec_for_template = job_spec.dup
+          job_spec_for_template['template'] = job_template
+          validate_templates(job_spec_for_template)
+        end
       end
     end
 
@@ -73,24 +76,31 @@ module Bosh::Cli
 
       # Spec is usually more than that but jobs rarely use anything but
       # networks and properties.
-      # TODO: provide all keys in the spec?
       spec = {
-        "job" => {
-          "name" => job_spec["name"]
-        },
-        "networks" => {
-          "default" => {"ip" => "10.0.0.1"}
+        'job' => {
+            'name' => job_spec['name']
         },
-        "properties" => collection.to_hash,
-        "index" => 0
+        'index' => 0,
+        'networks' => job_network_spec(job_spec),
+        'properties' => collection.to_hash
       }
 
       built_job.all_templates.each do |template_path|
-        # TODO: add progress bar?
         evaluate_template(built_job, template_path, spec)
       end
     end
 
+    def job_network_spec(job_spec)
+      job_spec['networks'].reduce({}) do |networks, network|
+        networks[network['name']] = {
+            'ip' => '127.0.0.1', # faking the IP since it shouldn't affect logic
+            'netmask' => '255.255.255.0',
+            'gateway' => '127.0.0.2'
+        }
+        networks
+      end
+    end
+
     private
 
     # @param [JobBuilder] job Job builder

data/lib/cli/job_state.rb

@@ -0,0 +1,54 @@
+module Bosh::Cli
+  class JobState
+    OPERATION_DESCRIPTIONS = {
+        start: 'start %s',
+        stop: 'stop %s',
+        detach: 'stop %s and power off its VM(s)',
+        restart: 'restart %s',
+        recreate: 'recreate %s'
+    }
+
+    NEW_STATES = {
+        start: 'started',
+        stop: 'stopped',
+        detach: 'detached',
+        restart: 'restart',
+        recreate: 'recreate'
+    }
+
+    COMPLETION_DESCRIPTIONS = {
+        start: '%s has been started',
+        stop: '%s has been stopped, VM(s) still running',
+        detach: '%s has been detached, VM(s) powered off',
+        restart: '%s has been restarted',
+        recreate: '%s has been recreated'
+    }
+
+    def initialize(command, vm_state)
+      @command = command
+      @vm_state = vm_state
+    end
+
+    def change(state, job, index)
+      job_desc = job_description(job, index)
+      op_desc = OPERATION_DESCRIPTIONS.fetch(state) % job_desc
+      new_state = NEW_STATES.fetch(state)
+      completion_desc = COMPLETION_DESCRIPTIONS.fetch(state) % job_desc.make_green
+
+      status, task_id = perform_vm_state_change(job, index, new_state, op_desc)
+
+      [status, task_id, completion_desc]
+    end
+
+    private
+    attr_reader :command, :vm_state
+
+    def job_description(job, index)
+      index ? "#{job}/#{index}" : "#{job}"
+    end
+
+    def perform_vm_state_change(job, index, new_state, operation_desc)
+      vm_state.change(job, index, new_state, operation_desc)
+    end
+  end
+end

data/lib/cli/line_wrap.rb

@@ -0,0 +1,54 @@
+module Bosh::Cli
+  class LineWrap
+    def initialize(width, left_margin = 0)
+      @width = width
+      @left_margin = left_margin
+    end
+
+    def wrap(string)
+      paragraphs = string.split("\n")
+
+      wrapped_paragraphs = paragraphs.map do |paragraph|
+        lines = wrapped_lines(paragraph)
+        lines = indent_lines(lines)
+
+        paragraph_indentation(paragraph) + lines.join("\n")
+      end
+
+      wrapped_paragraphs.join("\n")
+    end
+
+    private
+
+    attr_reader :width
+    attr_reader :left_margin
+
+    def paragraph_indentation(paragraph)
+      paragraph.start_with?('      ') ? '  ' : ''
+    end
+
+    def wrapped_lines(string)
+      result = []
+      buffer = ''
+
+      string.split(' ').each do |word|
+        if new_line_needed?(buffer, word)
+          result << buffer
+          buffer = word
+        else
+          buffer << ' ' unless buffer.empty?
+          buffer << word
+        end
+      end
+      result << buffer
+    end
+
+    def new_line_needed?(buffer, word)
+      buffer.size + word.size > width
+    end
+
+    def indent_lines(lines)
+      lines.map { |line| (' ' * left_margin) + line }
+    end
+  end
+end

data/lib/cli/packaging_helper.rb

@@ -65,7 +65,7 @@ module Bosh::Cli
       item = @final_index[fingerprint]
 
       if item.nil?
-        say("NOT FOUND".red)
+        say("NOT FOUND".make_red)
         return nil
       end
 
@@ -73,7 +73,7 @@ module Bosh::Cli
       version      = item["version"]
 
       if blobstore_id.nil?
-        say("No blobstore id".red)
+        say("No blobstore id".make_red)
         return nil
       end
 
@@ -81,18 +81,18 @@ module Bosh::Cli
       need_fetch = true
 
       if File.exists?(filename)
-        say("FOUND LOCAL".green)
+        say("FOUND LOCAL".make_green)
         if file_checksum(filename) == item["sha1"]
           @tarball_path = filename
           need_fetch = false
         else
-          say("LOCAL CHECKSUM MISMATCH".red)
+          say("LOCAL CHECKSUM MISMATCH".make_red)
           need_fetch = true
         end
       end
 
       if need_fetch
-        say("Downloading `#{name} (#{version})'...".green)
+        say("Downloading `#{name} (#{version})'...".make_green)
         tmp_file = File.open(File.join(Dir.mktmpdir, name), "w")
         @blobstore.get(blobstore_id, tmp_file)
         tmp_file.close
@@ -121,7 +121,7 @@ module Bosh::Cli
       item = @dev_index[fingerprint]
 
       if item.nil?
-        say("NOT FOUND".red)
+        say("NOT FOUND".make_red)
         return nil
       end
 
@@ -129,9 +129,9 @@ module Bosh::Cli
       filename = @dev_index.filename(version)
 
       if File.exists?(filename)
-        say("FOUND LOCAL".green)
+        say("FOUND LOCAL".make_green)
       else
-        say("TARBALL MISSING".red)
+        say("TARBALL MISSING".make_red)
         return nil
       end
 
@@ -140,7 +140,7 @@ module Bosh::Cli
         @version = version
         @used_dev_version = true
       else
-        say("`#{name} (#{version})' tarball corrupted".red)
+        say("`#{name} (#{version})' tarball corrupted".make_red)
         return nil
       end
     end
@@ -182,7 +182,7 @@ module Bosh::Cli
 
       @version = version
       @tarball_generated = true
-      say("Generated version #{version}".green)
+      say("Generated version #{version}".make_green)
       true
     end
 

data/lib/cli/release.rb

@@ -66,6 +66,7 @@ module Bosh::Cli
         has_blobstore_secrets?(bs, "simple", "user", "password") ||
         has_blobstore_secrets?(bs, "swift", "rackspace") ||
         has_blobstore_secrets?(bs, "swift", "hp") ||
+        has_blobstore_secrets?(bs, "swift", "openstack") ||
         has_blobstore_secrets?(bs, "s3", "access_key_id", "secret_access_key")
     end
 
@@ -111,14 +112,8 @@ module Bosh::Cli
     end
 
     def save_config
-      # TODO: introduce write_yaml helper
-      File.open(@dev_config_file, "w") do |f|
-        YAML.dump(@dev_config, f)
-      end
-
-      File.open(@final_config_file, "w") do |f|
-        YAML.dump(@final_config, f)
-      end
+      write_yaml(@dev_config_file, @dev_config)
+      write_yaml(@final_config_file, @final_config)
     end
 
     private
@@ -146,7 +141,7 @@ module Bosh::Cli
 
     # stores blobstore_secret as blobstore.atmos.secret
     def deprecate_blobstore_secret
-      say("WARNING:".red + " use of blobstore_secret is deprecated")
+      say("WARNING:".make_red + " use of blobstore_secret is deprecated")
 
       @private_config["blobstore"] ||= {}
       bs = @private_config["blobstore"]
@@ -168,7 +163,7 @@ module Bosh::Cli
       # to migrate while the old one tells you to upgrade.
       if @dev_config.has_key?("blobstore_options") &&
           @dev_config["blobstore_options"] != "deprecated"
-        say("Found legacy dev config file `#{@dev_config_file}'".yellow)
+        say("Found legacy dev config file `#{@dev_config_file}'".make_yellow)
 
         new_dev_config = {
           "dev_name" => @dev_config["name"],
@@ -184,14 +179,14 @@ module Bosh::Cli
         @dev_config = new_dev_config
 
         File.open(@dev_config_file, "w") do |f|
-          YAML.dump(@dev_config, f)
+          Psych.dump(@dev_config, f)
         end
-        say("Migrated dev config file format".green)
+        say("Migrated dev config file format".make_green)
       end
 
       if @final_config.has_key?("blobstore_options") &&
           @final_config["blobstore_options"] != "deprecated"
-        say("Found legacy config file `#{@final_config_file}'".yellow)
+        say("Found legacy config file `#{@final_config_file}'".make_yellow)
 
         unless @final_config["blobstore_options"]["provider"] == "atmos" &&
             @final_config["blobstore_options"].has_key?("atmos_options")
@@ -211,8 +206,8 @@ module Bosh::Cli
 
         @final_config = new_final_config
 
-        File.open(@final_config_file, "w") { |f| YAML.dump(@final_config, f) }
-        say("Migrated final config file format".green)
+        File.open(@final_config_file, "w") { |f| Psych.dump(@final_config, f) }
+        say("Migrated final config file format".make_green)
       end
     end
 
@@ -224,6 +219,14 @@ module Bosh::Cli
       end
     end
 
+    def write_yaml(file, hash)
+      unless hash == load_config(file)
+        File.open(file, "w+") do |f|
+          Psych.dump(hash, f)
+        end
+      end
+    end
+
   end
 
 end