bosh_cli 0.18 → 0.19

data/lib/cli/director_task.rb

@@ -8,10 +8,10 @@ module Bosh
 
       def initialize(director, task_id, log_type = nil)
         @director = director
-        @task_id  = task_id
-        @offset   = 0
+        @task_id = task_id
+        @offset = 0
         @log_type = log_type
-        @buf      = ""
+        @buf = ""
       end
 
       def state
@@ -36,7 +36,7 @@ module Bosh
 
         last_nl = @buf.rindex("\n")
 
-        if !last_nl
+        if last_nl.nil?
           result = nil
         elsif last_nl != @buf.size - 1
           result = @buf[0..last_nl]

data/lib/cli/event_log_renderer.rb

@@ -124,8 +124,12 @@ module Bosh::Cli
       end
     end
 
+    def duration_known?
+      @started_at && @finished_at
+    end
+
     def duration
-      return nil if @started_at.nil? || @finished_at.nil?
+      return unless duration_known?
       @finished_at - @started_at
     end
 

data/lib/cli/null_renderer.rb

@@ -0,0 +1,19 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+module Bosh::Cli
+  class NullRenderer < TaskLogRenderer
+
+    def initialize
+    end
+
+    def add_output(output)
+    end
+
+    def refresh
+    end
+
+    def finish(state)
+    end
+
+  end
+end

data/lib/cli/package_builder.rb

@@ -4,6 +4,37 @@ module Bosh::Cli
   class PackageBuilder
     include PackagingHelper
 
+    class GlobMatch
+      # Helper class encapsulating the data we know about the glob. We need
+      # both directory and file path, as we match the same path in several
+      # directories (src, src_alt, blobs)
+      attr_reader :dir
+      attr_reader :path
+
+      def initialize(dir, path)
+        @dir = dir
+        @path = path
+      end
+
+      def full_path
+        File.join(dir, path)
+      end
+
+      def <=>(other)
+        @path <=> other.path
+      end
+
+      # GlobMatch will be used as Hash key (as implied by using Set),
+      # hence we need to define both eql? and hash
+      def eql?(other)
+        @path == other.path
+      end
+
+      def hash
+        @path.hash
+      end
+    end
+
     attr_reader :name, :globs, :version, :dependencies, :tarball_path
     # We have two ways of getting/storing a package:
     # development versions of packages, kept in release directory
@@ -13,21 +44,28 @@ module Bosh::Cli
     # final builds metadata should be checked in
 
     def initialize(spec, release_dir, final, blobstore,
-        sources_dir = nil, blobs_dir = nil)
+        sources_dir = nil, blobs_dir = nil, alt_src_dir = nil)
       spec = load_yaml_file(spec) if spec.is_a?(String) && File.file?(spec)
 
       @name = spec["name"]
       @globs = spec["files"]
       @dependencies = Array(spec["dependencies"])
+
       @release_dir = release_dir
       @sources_dir = sources_dir || File.join(@release_dir, "src")
+      @alt_sources_dir = alt_src_dir || File.join(@release_dir, "src_alt")
       @blobs_dir = blobs_dir || File.join(@release_dir, "blobs")
+
       @final = final
       @blobstore = blobstore
       @artefact_type = "package"
 
       @metadata_files = %w(packaging pre_packaging)
 
+      if @final && File.exists?(@alt_sources_dir)
+        err("Please remove `#{File.basename(@alt_sources_dir)}' first")
+      end
+
       if @name.blank?
         raise InvalidPackage, "Package name is missing"
       end
@@ -65,22 +103,10 @@ module Bosh::Cli
       @fingerprint ||= make_fingerprint
     end
 
-    def resolved_globs
+    def glob_matches
       @resolved_globs ||= resolve_globs
     end
 
-    def source_files
-      resolved_globs[:source]
-    end
-
-    def blob_files
-      resolved_globs[:blob]
-    end
-
-    def files
-      (resolved_globs[:blob] + resolved_globs[:source]).sort
-    end
-
     def build_dir
       @build_dir ||= Dir.mktmpdir
     end
@@ -92,15 +118,14 @@ module Bosh::Cli
     def copy_files
       copied = 0
 
-      files.each do |filename|
-        file_path = get_file_path(filename)
-        destination = File.join(build_dir, filename)
+      glob_matches.each do |match|
+        destination = File.join(build_dir, match.path)
 
-        if File.directory?(file_path)
+        if File.directory?(match.full_path)
           FileUtils.mkdir_p(destination)
         else
           FileUtils.mkdir_p(File.dirname(destination))
-          FileUtils.cp(file_path, destination, :preserve => true)
+          FileUtils.cp(match.full_path, destination, :preserve => true)
           copied += 1
         end
       end
@@ -160,27 +185,18 @@ module Bosh::Cli
 
     private
 
-    def get_file_path(file)
-      file_path = File.join(@sources_dir, file)
-      if !File.exists?(file_path)
-        file_path = File.join(@blobs_dir, file)
-        unless File.exists?(file_path)
-          raise InvalidPackage, "#{file} cannot be found"
-        end
-      end
-      file_path
-    end
-
     def make_fingerprint
       contents = ""
 
-      signatures = files.map do |file|
-        path = get_file_path(file)
-        unless File.directory?(path)
-          file_digest = Digest::SHA1.file(path).hexdigest
+      signatures = glob_matches.map do |match|
+        file_digest = nil
+
+        unless File.directory?(match.full_path)
+          file_digest = Digest::SHA1.file(match.full_path).hexdigest
         end
 
-        "%s%s%s" % [file, file_digest, tracked_permissions(path)]
+        "%s%s%s" % [match.path, file_digest,
+                    tracked_permissions(match.full_path)]
       end
       contents << signatures.join("")
 
@@ -198,49 +214,62 @@ module Bosh::Cli
       Digest::SHA1.hexdigest(contents)
     end
 
+    # @return Array<GlobMatch>
     def resolve_globs
-      glob_map = { :blob => [], :source => [] }
-      blob_list = []
-      source_list = []
+      matches = Set.new
 
       @globs.each do |glob|
-        matching_source = []
-        matching_blob = []
+        # Alternative source dir completely shadows the source dir, there can be
+        # no partial match of a particular glob in both.
+        found = false
+
+        [@alt_sources_dir, @sources_dir].each do |dir|
+          next unless File.directory?(dir)
+
+          Dir.chdir(dir) do
+            dir_matches = resolve_glob_in_cwd(glob)
 
-        in_sources_dir do
-          matching_source = Dir.glob(glob, File::FNM_DOTMATCH).reject do |fn|
-            [".", ".."].include?(File.basename(fn))
+            unless dir_matches.empty?
+              matches += dir_matches.map do |path|
+                GlobMatch.new(dir, path)
+              end
+              found = true
+            end
           end
+
+          break if found
         end
 
-        in_blobs_dir do
-          matching_blob = Dir.glob(glob, File::FNM_DOTMATCH).reject do |fn|
-            [".", ".."].include?(File.basename(fn))
+        # Blobs directory is a little bit different: whatever matches a blob
+        # will complement already found matches, unless this particular path
+        # has already been matched.
+        if File.directory?(File.join(@blobs_dir))
+          Dir.chdir(@blobs_dir) do
+            blob_matches = resolve_glob_in_cwd(glob)
+
+            unless blob_matches.empty?
+              blob_matches.each do |path|
+                matches << GlobMatch.new(@blobs_dir, path)
+              end
+
+              found = true
+            end
           end
         end
 
-        if matching_blob.size == 0 && matching_source.size ==0
+        unless found
           raise InvalidPackage, "`#{name}' has a glob that " +
-              "resolves to an empty file list: #{glob}"
+            "resolves to an empty file list: #{glob}"
         end
-
-        blob_list << matching_blob
-        source_list << matching_source
       end
-      glob_map[:blob] = blob_list.flatten.sort
-      glob_map[:source] = source_list.flatten.sort
-      glob_map
-    end
 
-    def in_blobs_dir(&block)
-      # old release does not have 'blob'
-      if File.directory?(@blobs_dir)
-        Dir.chdir(@blobs_dir) { yield }
-      end
+      matches.sort
     end
 
-    def in_sources_dir(&block)
-      Dir.chdir(@sources_dir) { yield }
+    def resolve_glob_in_cwd(glob)
+      Dir.glob(glob, File::FNM_DOTMATCH).reject do |fn|
+        %w(. ..).include?(File.basename(fn))
+      end
     end
 
     def in_build_dir(&block)

data/lib/cli/packaging_helper.rb

@@ -92,7 +92,7 @@ module Bosh::Cli
       end
 
       if need_fetch
-        say("Downloading `#{name} (#{version})' (#{blobstore_id})".green)
+        say("Downloading `#{name} (#{version})'...".green)
         payload = @blobstore.get(blobstore_id)
         if Digest::SHA1.hexdigest(payload) == item["sha1"]
           @tarball_path = @final_index.add_version(fingerprint, item, payload)

data/lib/cli/release_builder.rb

@@ -3,34 +3,47 @@
 module Bosh::Cli
   class ReleaseBuilder
     include Bosh::Cli::DependencyHelper
+    include Bosh::Cli::VersionCalc
 
     DEFAULT_RELEASE_NAME = "bosh_release"
 
-    attr_reader :release, :packages, :jobs, :changed_jobs
+    attr_reader :release, :packages, :jobs, :version
 
+    # @param [Bosh::Cli::Release] release Current release
+    # @param [Array<Bosh::Cli::PackageBuilder>] packages Built packages
+    # @param [Array<Bosh::Cli::JobBuilder>] jobs Built jobs
+    # @param [Hash] options Release build options
     def initialize(release, packages, jobs, options = { })
-      @release  = release
-      @final    = options.has_key?(:final) ? !!options[:final] : false
+      @release = release
+      @final = options.has_key?(:final) ? !!options[:final] : false
       @packages = packages
-      @jobs     = jobs
+      @jobs = jobs
+
+      @final_index = VersionsIndex.new(final_releases_dir, release_name)
+      @dev_index = VersionsIndex.new(dev_releases_dir, release_name)
+      @index = @final ? @final_index : @dev_index
 
-      @index = VersionsIndex.new(releases_dir, release_name)
       create_release_build_dir
     end
 
+    # @return [String] Release name
     def release_name
       name = @final ? @release.final_name : @release.dev_name
       name.blank? ? DEFAULT_RELEASE_NAME : name
     end
 
+    # @return [String] Release version
     def version
       @version ||= assign_version
     end
 
+    # @return [Boolean] Is release final?
     def final?
       @final
     end
 
+    # @return [Array] List of jobs affected by this release compared
+    #   to the previous one.
     def affected_jobs
       result = Set.new(@jobs.select { |job| job.new_version? })
       return result if @packages.empty?
@@ -47,6 +60,8 @@ module Bosh::Cli
       result.to_a
     end
 
+    # Builds release
+    # @param [Hash] options Release build options
     def build(options = {})
       options = { :generate_tarball => true }.merge(options)
 
@@ -59,6 +74,7 @@ module Bosh::Cli
       @build_complete = true
     end
 
+    # Copies packages into release
     def copy_packages
       packages.each do |package|
         say("%-40s %s" % [package.name.green,
@@ -70,6 +86,7 @@ module Bosh::Cli
       @packages_copied = true
     end
 
+    # Copies jobs into release
     def copy_jobs
       jobs.each do |job|
         say("%-40s %s" % [job.name.green, pretty_size(job.tarball_path)])
@@ -80,24 +97,25 @@ module Bosh::Cli
       @jobs_copied = true
     end
 
+    # Generates release manifest
     def generate_manifest
       manifest = {}
       manifest["packages"] = []
 
       manifest["packages"] = packages.map do |package|
         {
-          "name"         => package.name,
-          "version"      => package.version,
-          "sha1"         => package.checksum,
+          "name" => package.name,
+          "version" => package.version,
+          "sha1" => package.checksum,
           "dependencies" => package.dependencies
         }
       end
 
       manifest["jobs"] = jobs.map do |job|
         {
-          "name"    => job.name,
+          "name" => job.name,
           "version" => job.version,
-          "sha1"    => job.checksum,
+          "sha1" => job.checksum,
         }
       end
 
@@ -161,7 +179,15 @@ module Bosh::Cli
     end
 
     def releases_dir
-       File.join(@release.dir, final? ? "releases" : "dev_releases")
+      @final ? final_releases_dir : dev_releases_dir
+    end
+
+    def final_releases_dir
+      File.join(@release.dir, "releases")
+    end
+
+    def dev_releases_dir
+      File.join(@release.dir, "dev_releases")
     end
 
     def tarball_path
@@ -191,8 +217,16 @@ module Bosh::Cli
     end
 
     def assign_version
-      current_version = @index.latest_version.to_i
-      current_version + 1
+      latest_final_version = @final_index.latest_version.to_i
+      latest_dev_version = @dev_index.latest_version(latest_final_version)
+
+      if @final
+        latest_final_version + 1
+      else
+        major = latest_final_version
+        minor = minor_version(latest_dev_version).to_i + 1
+        "#{major}.#{minor}-dev"
+      end
     end
 
     def build_dir

data/lib/cli/runner.rb

@@ -25,43 +25,14 @@ module Bosh::Cli
     end
 
     def initialize(args)
-      trap("SIGINT") {
-        handle_ctrl_c
-      }
       define_commands
       @args = args
       @options = {
-          :director_checks => true,
-          :colorize => true,
+        :director_checks => true,
+        :colorize => true,
       }
     end
 
-    ##
-    # When user issues ctrl-c it asks if they really want to quit. If so
-    # then it will cancel the current running task if it exists.
-    def handle_ctrl_c
-      if !@runner.task_running?
-        exit(1)
-      elsif kill_current_task?
-        @runner.cancel_current_task
-        exit(1)
-      end
-    end
-
-    ##
-    # Asks user if they really want to quit and returns the boolean answer.
-    #
-    # @return [Boolean] Whether the user wants to quit or not.
-    def kill_current_task?
-      # Use say and stdin.gets instead of ask because of 2 bugs in Highline.
-      # The bug makes it so that if something else has called ask and was in
-      # the middle of waiting for a response then ctrl-c is issued and it
-      # calls ask again then highline will re-issue the first question again.
-      # If the input is a newline character then highline will choke.
-      say("\nAre you sure you'd like to cancel running tasks? [yN]")
-      $stdin.gets.chomp.downcase == "y"
-    end
-
     def prepare
       define_commands
       define_plugin_commands
@@ -70,8 +41,10 @@ module Bosh::Cli
       parse_options!
 
       Config.interactive = !@options[:non_interactive]
-      Config.colorize    = @options.delete(:colorize)
-      Config.output    ||= STDOUT unless @options[:quiet]
+      Config.colorize = @options.delete(:colorize)
+      Config.output ||= STDOUT unless @options[:quiet]
+      Config.cache = Bosh::Cli::Cache.new(@options[:cache_dir] ||
+                                            Bosh::Cli::DEFAULT_CACHE_DIR)
     end
 
     def run
@@ -81,10 +54,10 @@ module Bosh::Cli
       if @namespace && @action
         ns_class_name = @namespace.to_s.gsub(/(?:_|^)(.)/) { $1.upcase }
         klass = eval("Bosh::Cli::Command::#{ns_class_name}")
-        @runner = klass.new(@options)
-        @runner.usage = @usage
+        runner = klass.new(@options)
+        runner.usage = @usage
 
-        action_arity = @runner.method(@action.to_sym).arity
+        action_arity = runner.method(@action.to_sym).arity
         n_required_args = action_arity >= 0 ? action_arity : -action_arity - 1
 
         if n_required_args > @args.size
@@ -94,8 +67,8 @@ module Bosh::Cli
           err("Too many arguments, correct usage is: bosh #{@usage}")
         end
 
-        @runner.send(@action.to_sym, *@args)
-      elsif @args.empty? || @args == ["help"]
+        runner.send(@action.to_sym, *@args)
+      elsif @args.empty? || @args == %w(help)
         say(help_message)
         say(plugin_help_message) if @plugins
       elsif @args[0] == "help"
@@ -246,7 +219,7 @@ module Bosh::Cli
         usage "scp <job> <--upload | --download> [options] " +
                   "/path/to/source /path/to/destination"
         desc  "upload/download the source file to the given job. " +
-                  "Note: for dowload /path/to/destination is a directory"
+                  "Note: for download /path/to/destination is a directory"
         option "--index <job_index>"
         option "--public_key <file>"
         option "--gateway_host <host>"
@@ -340,6 +313,15 @@ module Bosh::Cli
         power_option "--force"
       end
 
+      command :rename_job do
+        usage "rename <old_job_name> <new_job_name>"
+        desc  "renames a job. NOTE, your deployment manifest must also be " +
+              "updated to reflect the new job name."
+        power_option "--force"
+
+        route :job_rename, :rename
+      end
+
       command :fetch_logs do
         usage  "logs <job> <index>"
         desc   "Fetch job (default) or agent (if option provided) logs"