bosh_cli 1.0.3 → 1.5.0.pre.1113

data/lib/cli/deployment_helper.rb

@@ -5,7 +5,6 @@ module Bosh::Cli
     include VersionCalc
 
     def prepare_deployment_manifest(options = {})
-      # TODO: extract to helper class
       deployment_required
       manifest_filename = deployment
 
@@ -16,11 +15,11 @@ module Bosh::Cli
       manifest = load_yaml_file(manifest_filename)
       manifest_yaml = File.read(manifest_filename)
 
-      if manifest["name"].blank?
-        err("Deployment name not found in the deployment manifest")
+      if manifest['name'].blank?
+        err('Deployment name not found in the deployment manifest')
       end
 
-      if manifest["target"]
+      if manifest['target']
         err(manifest_target_upgrade_notice)
       end
 
@@ -29,40 +28,40 @@ module Bosh::Cli
         properties = {}
 
         begin
-          say("Getting deployment properties from director...")
-          properties = director.list_properties(manifest["name"])
+          say('Getting deployment properties from director...')
+          properties = director.list_properties(manifest['name'])
         rescue Bosh::Cli::DirectorError
-          say("Unable to get properties list from director, " +
-              "trying without it...")
+          say('Unable to get properties list from director, ' +
+                'trying without it...')
         end
 
-        say("Compiling deployment manifest...")
+        say('Compiling deployment manifest...')
         compiler.properties = properties.inject({}) do |hash, property|
-          hash[property["name"]] = property["value"]
+          hash[property['name']] = property['value']
           hash
         end
 
-        manifest = YAML.load(compiler.result)
+        manifest = Psych.load(compiler.result)
       end
 
-      if manifest["name"].blank? || manifest["director_uuid"].blank?
+      if manifest['name'].blank? || manifest['director_uuid'].blank?
         err("Invalid manifest `#{File.basename(deployment)}': " +
-            "name and director UUID are required")
+              'name and director UUID are required')
       end
 
-      if director.uuid != manifest["director_uuid"]
+      if director.uuid != manifest['director_uuid']
         err("Target director UUID doesn't match UUID from deployment manifest")
       end
 
-      if manifest["release"].blank? && manifest["releases"].blank?
+      if manifest['release'].blank? && manifest['releases'].blank?
         err("Deployment manifest doesn't have release information: '" +
-            "please add 'release' or 'releases' section")
+              "please add 'release' or 'releases' section")
       end
 
       resolve_release_aliases(manifest)
       resolve_stemcell_aliases(manifest)
 
-      options[:yaml] ? YAML.dump(manifest) : manifest
+      options[:yaml] ? Psych.dump(manifest) : manifest
     end
 
     # Check if the 2 deployments are different.
@@ -91,7 +90,7 @@ module Bosh::Cli
     # if something goes wrong, so it doesn't need to have
     # a meaningful return value.
     # @return Boolean Were there any changes in deployment manifest?
-    def inspect_deployment_changes(manifest, options = { })
+    def inspect_deployment_changes(manifest, options = {})
       show_empty_changeset = true
 
       if options.has_key?(:show_empty_changeset)
@@ -99,27 +98,26 @@ module Bosh::Cli
       end
 
       manifest = manifest.dup
-      current_deployment = director.get_deployment(manifest["name"])
+      current_deployment = director.get_deployment(manifest['name'])
 
       # We cannot retrieve current manifest until there was at least one
       # successful deployment. There used to be a warning about that
       # but it turned out to be confusing to many users and thus has
       # been removed.
-      return if current_deployment["manifest"].nil?
-      current_manifest = YAML.load(current_deployment["manifest"])
+      return if current_deployment['manifest'].nil?
+      current_manifest = Psych.load(current_deployment['manifest'])
 
       unless current_manifest.is_a?(Hash)
-        err("Current deployment manifest format is invalid, " +
-                "check if director works properly")
+        err('Current deployment manifest format is invalid, ' +
+              'check if director works properly')
       end
 
-      # TODO: validate new deployment manifest
       diff = Bosh::Cli::HashChangeset.new
       diff.add_hash(normalize_deployment_manifest(manifest), :new)
       diff.add_hash(normalize_deployment_manifest(current_manifest), :old)
-      @_diff_key_visited = { "name" => 1, "director_uuid" => 1 }
+      @_diff_key_visited = { 'name' => 1, 'director_uuid' => 1 }
 
-      say("Detecting changes in deployment...".green)
+      say('Detecting changes in deployment...'.make_green)
       nl
 
       if !diff.changed? && !show_empty_changeset
@@ -163,16 +161,16 @@ module Bosh::Cli
       end
 
       if old_stemcells != new_stemcells
-        unless confirmed?("Stemcell update has been detected. " +
-                          "Are you sure you want to update stemcells?")
+        unless confirmed?('Stemcell update has been detected. ' +
+                            'Are you sure you want to update stemcells?')
           cancel_deployment
         end
       end
 
       if old_stemcells.size != new_stemcells.size
-        say("Stemcell update seems to be inconsistent with current ".red +
-            "deployment. Please carefully review changes above.".red)
-        unless confirmed?("Are you sure this configuration is correct?")
+        say('Stemcell update seems to be inconsistent with current '.make_red +
+              'deployment. Please carefully review changes above.'.make_red)
+        unless confirmed?('Are you sure this configuration is correct?')
           cancel_deployment
         end
       end
@@ -194,31 +192,102 @@ module Bosh::Cli
 
       diff.changed?
     rescue Bosh::Cli::ResourceNotFound
-      say("Cannot get current deployment information from director, " +
-          "possibly a new deployment".red)
+      say('Cannot get current deployment information from director, ' +
+            'possibly a new deployment'.make_red)
       true
     end
 
-    private
+    def latest_release_versions
+      @_latest_release_versions ||= begin
+        director.list_releases.inject({}) do |hash, release|
+          name = release['name']
+          versions = release['versions'] || release['release_versions'].map { |release_version| release_version['version'] }
+          latest_version = versions.map { |v| Bosh::Common::VersionNumber.new(v) }.max
+          hash[name] = latest_version.to_s
+          hash
+        end
+      end
+    end
 
-    def find_deployment(name)
-      if File.exists?(name)
-        File.expand_path(name)
-      else
-        File.expand_path(File.join(work_dir, "deployments", "#{name}.yml"))
+    # @param [Hash] manifest Deployment manifest (will be modified)
+    # @return [void]
+    def resolve_release_aliases(manifest)
+      releases = manifest['releases'] || [manifest['release']]
+
+      releases.each do |release|
+        if release['version'] == 'latest'
+          latest_release_version = latest_release_versions[release['name']]
+          unless latest_release_version
+            err("Release '#{release['name']}' not found on director. Unable to resolve 'latest' alias in manifest.")
+          end
+          release['version'] = latest_release_version
+        end
+
+        if release['version'].to_i.to_s == release['version']
+          release['version'] = release['version'].to_i
+        end
+      end
+    end
+
+    def job_unique_in_deployment?(job_name)
+      job = find_job(job_name)
+      job.fetch('instances') == 1 if job
+    end
+
+    def job_exists_in_deployment?(job_name)
+      !!find_job(job_name)
+    end
+
+    def job_must_exist_in_deployment(job)
+      err("Job `#{job}' doesn't exist") unless job_exists_in_deployment?(job)
+    end
+
+    def prompt_for_job_and_index
+      jobs_list = jobs_and_indexes
+
+      return jobs_list.first if jobs_list.size == 1
+
+      choose do |menu|
+        menu.prompt = 'Choose an instance: '
+        jobs_list.each do |job_name, index|
+          menu.choice("#{job_name}/#{index}") { [job_name, index] }
+        end
+      end
+    end
+
+    def jobs_and_indexes
+      jobs = prepare_deployment_manifest.fetch('jobs')
+
+      jobs.inject([]) do |jobs_and_indexes, job|
+        job_name = job.fetch('name')
+        0.upto(job.fetch('instances').to_i - 1) do |index|
+          jobs_and_indexes << [job_name, index]
+        end
+        jobs_and_indexes
       end
     end
 
     def cancel_deployment
-      quit("Deployment canceled".red)
+      quit('Deployment canceled'.make_red)
+    end
+
+    private
+
+    def find_job(job_name)
+      jobs = prepare_deployment_manifest.fetch('jobs')
+      jobs.find { |job| job.fetch('name') == job_name }
     end
 
-    def manifest_error(err)
-      err("Deployment manifest error: #{err}")
+    def find_deployment(name)
+      if File.exists?(name)
+        File.expand_path(name)
+      else
+        File.expand_path(File.join(work_dir, 'deployments', "#{name}.yml"))
+      end
     end
 
     def manifest_target_upgrade_notice
-      <<-EOS.gsub(/^\s*/, "").gsub(/\n$/, "")
+      <<-EOS.gsub(/^\s*/, '').gsub(/\n$/, '')
         Please upgrade your deployment manifest to use director UUID instead
         of target. Just replace 'target' key with 'director_uuid' key in your
         manifest. You can get your director UUID by targeting your director
@@ -227,130 +296,53 @@ module Bosh::Cli
     end
 
     def print_summary(diff, key, title = nil)
-      title ||= key.to_s.gsub(/[-_]/, " ").capitalize
+      title ||= key.to_s.gsub(/[-_]/, ' ').capitalize
 
-      say(title.green)
+      say(title.make_green)
       summary = diff[key].summary
       if summary.empty?
-        say("No changes")
+        say('No changes')
       else
         say(summary.join("\n"))
       end
       @_diff_key_visited[key.to_s] = 1
     end
 
-    def normalize_deployment_manifest(manifest)
-      normalized = manifest.dup
-
-      %w(releases networks jobs resource_pools).each do |section|
-        normalized[section] ||= []
-
-        unless normalized[section].kind_of?(Array)
-          manifest_error("#{section} is expected to be an array")
-        end
-
-        normalized[section] = normalized[section].inject({}) do |acc, e|
-          if e["name"].blank?
-            manifest_error("missing name for one of entries in '#{section}'")
-          end
-          if acc.has_key?(e["name"])
-            manifest_error("duplicate entry '#{e['name']}' in '#{section}'")
-          end
-          acc[e["name"]] = e
-          acc
-        end
-      end
-
-      normalized["networks"].each do |network_name, network|
-        # VIP and dynamic networks do not require subnet,
-        # but if it's there we can run some sanity checks
-        next unless network.has_key?("subnets")
-
-        unless network["subnets"].kind_of?(Array)
-          manifest_error("network subnets is expected to be an array")
-        end
-
-        subnets = network["subnets"].inject({}) do |acc, e|
-          if e["range"].blank?
-            manifest_error("missing range for one of subnets " +
-                               "in '#{network_name}'")
-          end
-          if acc.has_key?(e["range"])
-            manifest_error("duplicate network range '#{e['range']}' " +
-                               "in '#{network}'")
-          end
-          acc[e["range"]] = e
-          acc
-        end
-
-        normalized["networks"][network_name]["subnets"] = subnets
-      end
-
-      normalized
+    def normalize_deployment_manifest(manifest_hash)
+      DeploymentManifest.new(manifest_hash).normalize
     end
 
     def warn_about_release_changes(release_diff)
       if release_diff[:name].changed?
-        say("Release name has changed: %s -> %s".red % [
+        say('Release name has changed: %s -> %s'.make_red % [
           release_diff[:name].old, release_diff[:name].new])
-        unless confirmed?("This is very serious and potentially destructive " +
-                            "change. ARE YOU SURE YOU WANT TO DO IT?")
+        unless confirmed?('This is very serious and potentially destructive ' +
+                            'change. ARE YOU SURE YOU WANT TO DO IT?')
           cancel_deployment
         end
       elsif release_diff[:version].changed?
-        say("Release version has changed: %s -> %s".yellow % [
+        say('Release version has changed: %s -> %s'.make_yellow % [
           release_diff[:version].old, release_diff[:version].new])
-        unless confirmed?("Are you sure you want to deploy this version?")
+        unless confirmed?('Are you sure you want to deploy this version?')
           cancel_deployment
         end
       end
     end
 
-    # @param [Hash] manifest Deployment manifest (will be modified)
-    # @return [void]
-    def resolve_release_aliases(manifest)
-      if manifest["release"]
-        if manifest["releases"]
-          err("Manifest has both `release' and `releases', please fix it")
-        end
-        releases = [manifest["release"]]
-      else
-        releases = manifest["releases"]
-      end
-
-      unless releases.is_a?(Array)
-        err("Invalid release spec in the deployment manifest")
-      end
-
-      releases.each do |release|
-        if release["version"] == "latest"
-          latest_version = latest_releases[release["name"]]
-          if latest_version.nil?
-            err("Latest version for release `#{release["name"]}' is unknown")
-          end
-          # Avoiding Fixnum -> String noise in diff
-          if latest_version.to_s == latest_version.to_i.to_s
-            latest_version = latest_version.to_i
-          end
-          release["version"] = latest_version
-        end
-      end
-    end
-
     # @param [Hash] manifest Deployment manifest (will be modified)
     # @return [void]
     def resolve_stemcell_aliases(manifest)
-      return if manifest["resource_pools"].nil?
+      return if manifest['resource_pools'].nil?
 
-      manifest["resource_pools"].each do |rp|
-        stemcell = rp["stemcell"]
+      manifest['resource_pools'].each do |rp|
+        stemcell = rp['stemcell']
         unless stemcell.is_a?(Hash)
-          err("Invalid stemcell spec in the deployment manifest")
+          err('Invalid stemcell spec in the deployment manifest')
         end
-        if stemcell["version"] == "latest"
-          latest_version = latest_stemcells[stemcell["name"]]
+        if stemcell['version'] == 'latest'
+          latest_version = latest_stemcells[stemcell['name']]
           if latest_version.nil?
-            err("Latest version for stemcell `#{stemcell["name"]}' is unknown")
+            err("Latest version for stemcell `#{stemcell['name']}' is unknown")
           end
           # Avoiding {Float,Fixnum} -> String noise in diff
           if latest_version.to_s == latest_version.to_f.to_s
@@ -358,7 +350,7 @@ module Bosh::Cli
           elsif latest_version.to_s == latest_version.to_i.to_s
             latest_version = latest_version.to_i
           end
-          stemcell["version"] = latest_version
+          stemcell['version'] = latest_version
         end
       end
     end
@@ -367,11 +359,11 @@ module Bosh::Cli
     def latest_stemcells
       @_latest_stemcells ||= begin
         stemcells = director.list_stemcells.inject({}) do |hash, stemcell|
-          unless stemcell.is_a?(Hash) && stemcell["name"] && stemcell["version"]
-            err("Invalid director stemcell list format")
+          unless stemcell.is_a?(Hash) && stemcell['name'] && stemcell['version']
+            err('Invalid director stemcell list format')
           end
-          hash[stemcell["name"]] ||= []
-          hash[stemcell["name"]] << stemcell["version"]
+          hash[stemcell['name']] ||= []
+          hash[stemcell['name']] << stemcell['version']
           hash
         end
 
@@ -381,22 +373,5 @@ module Bosh::Cli
         end
       end
     end
-
-    # @return [Array]
-    def latest_releases
-      @_latest_releases ||= begin
-        director.list_releases.inject({}) do |hash, release|
-          unless release["name"].is_a?(String) &&
-            release["versions"].is_a?(Array)
-            err("Invalid director release list format")
-          end
-          hash[release["name"]] = release["versions"].sort { |v1, v2|
-            version_cmp(v2, v1)
-          }.first
-          hash
-        end
-      end
-    end
-
   end
 end

data/lib/cli/deployment_manifest.rb

@@ -0,0 +1,66 @@
+require 'common/deep_copy'
+
+module Bosh::Cli
+  class DeploymentManifest
+    def initialize(manifest_hash)
+      @manifest_hash = manifest_hash
+    end
+
+    def normalize
+      normalized = Bosh::Common::DeepCopy.copy(manifest_hash)
+
+      %w(releases networks jobs resource_pools).each do |section|
+        normalized[section] ||= []
+
+        unless normalized[section].kind_of?(Array)
+          manifest_error("#{section} is expected to be an array")
+        end
+
+        normalized[section] = normalized[section].inject({}) do |acc, e|
+          if e["name"].blank?
+            manifest_error("missing name for one of entries in '#{section}'")
+          end
+          if acc.has_key?(e["name"])
+            manifest_error("duplicate entry '#{e['name']}' in '#{section}'")
+          end
+          acc[e["name"]] = e
+          acc
+        end
+      end
+
+      normalized["networks"].each do |network_name, network|
+        # VIP and dynamic networks do not require subnet,
+        # but if it's there we can run some sanity checks
+        next unless network.has_key?("subnets")
+
+        unless network["subnets"].kind_of?(Array)
+          manifest_error("network subnets is expected to be an array")
+        end
+
+        subnets = network["subnets"].inject({}) do |acc, e|
+          if e["range"].blank?
+            manifest_error("missing range for one of subnets " +
+                             "in '#{network_name}'")
+          end
+          if acc.has_key?(e["range"])
+            manifest_error("duplicate network range '#{e['range']}' " +
+                             "in '#{network}'")
+          end
+          acc[e["range"]] = e
+          acc
+        end
+
+        normalized["networks"][network_name]["subnets"] = subnets
+      end
+
+      normalized
+    end
+
+    private
+    attr_reader :manifest_hash
+
+    def manifest_error(err)
+      err("Deployment manifest error: #{err}")
+    end
+  end
+end