bosh_cli 0.16

data/lib/cli/stemcell.rb

@@ -0,0 +1,83 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+module Bosh::Cli
+  class Stemcell
+    include Validation
+
+    attr_reader :stemcell_file, :manifest
+
+    def initialize(tarball_path, cache)
+      @stemcell_file = File.expand_path(tarball_path, Dir.pwd)
+      @cache = cache
+    end
+
+    def perform_validation(options = {})
+      tmp_dir = Dir.mktmpdir
+
+      step("File exists and readable",
+           "Cannot find stemcell file #{@stemcell_file}", :fatal) do
+        File.exists?(@stemcell_file) && File.readable?(@stemcell_file)
+      end
+
+      cache_key = "%s_%s" % [@stemcell_file, File.mtime(@stemcell_file)]
+
+      manifest_yaml = @cache.read(cache_key)
+
+      if manifest_yaml
+        say("Using cached manifest...")
+      else
+        say("Manifest not found in cache, verifying tarball...")
+
+        step("Extract tarball",
+             "Cannot extract tarball #{@stemcell_file}", :fatal) do
+          `tar -C #{tmp_dir} -xzf #{@stemcell_file} 2>&1`
+          $?.exitstatus == 0
+        end
+
+        manifest_file = File.expand_path("stemcell.MF", tmp_dir)
+
+        step("Manifest exists", "Cannot find stemcell manifest", :fatal) do
+          File.exists?(manifest_file)
+        end
+
+        step("Stemcell image file",
+             "Stemcell image file is missing", :fatal) do
+          File.exists?(File.expand_path("image", tmp_dir))
+        end
+
+        say("Writing manifest to cache...")
+        manifest_yaml = File.read(manifest_file)
+        @cache.write(cache_key, manifest_yaml)
+      end
+
+      manifest = YAML.load(manifest_yaml)
+
+      step("Stemcell properties",
+           "Manifest should contain valid name, " +
+               "version and cloud properties") do
+        manifest.is_a?(Hash) && manifest.has_key?("name") &&
+            manifest.has_key?("version") &&
+            manifest.has_key?("cloud_properties") &&
+            manifest["name"].is_a?(String) &&
+            (manifest["version"].is_a?(String) ||
+                manifest["version"].kind_of?(Numeric)) &&
+            (manifest["cloud_properties"].nil? ||
+                manifest["cloud_properties"].is_a?(Hash))
+      end
+
+      print_info(manifest)
+      @manifest = manifest
+    ensure
+      FileUtils.rm_rf(tmp_dir)
+    end
+
+    def print_info(manifest)
+      say("\nStemcell info")
+      say("-------------")
+
+      say("Name:    %s" % [manifest["name"] || "missing".red])
+      say("Version: %s" % [manifest["version"] || "missing".red])
+    end
+  end
+end
+

data/lib/cli/task_log_renderer.rb

@@ -0,0 +1,40 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+module Bosh::Cli
+  class TaskLogRenderer
+
+    def self.create_for_log_type(log_type)
+      if log_type == "event"
+        EventLogRenderer.new
+      else
+        TaskLogRenderer.new
+      end
+    end
+
+    attr_accessor :time_adjustment
+    attr_accessor :duration
+
+    def initialize
+      @out = Bosh::Cli::Config.output || $stdout
+      @out.sync = true
+      @lock = Mutex.new
+      @output = ""
+      @time_adjustment = 0
+    end
+
+    def add_output(output)
+      @output = output
+    end
+
+    def refresh
+      @out.print(@output)
+      @output = ""
+    end
+
+    def finish(state)
+      refresh
+      @done = true
+    end
+
+  end
+end

data/lib/cli/templates/help_message.erb

@@ -0,0 +1,75 @@
+<%= basic_usage %>
+Currently available bosh commands are:
+
+Deployment
+<%= command_usage(:deployment) %>
+<%= command_usage(:delete_deployment) %>
+<%= command_usage(:list_deployments) %>
+<%= command_usage(:deploy) %>
+<%= command_usage(:diff) %>
+
+Release management
+<%= command_usage(:create_release) %>
+<%= command_usage(:delete_release) %>
+<%= command_usage(:verify_release) %>
+<%= command_usage(:upload_release) %>
+<%= command_usage(:list_releases) %>
+<%= command_usage(:reset_release) %>
+
+<%= command_usage(:init_release) %>
+<%= command_usage(:generate_package) %>
+<%= command_usage(:generate_job) %>
+
+Stemcells
+<%= command_usage(:upload_stemcell) %>
+<%= command_usage(:verify_stemcell) %>
+<%= command_usage(:list_stemcells) %>
+<%= command_usage(:delete_stemcell) %>
+<%= command_usage(:list_public_stemcells) %>
+<%= command_usage(:download_public_stemcell) %>
+
+User management
+<%= command_usage(:create_user) %>
+
+Job management
+<%= command_usage(:start_job) %>
+<%= command_usage(:stop_job) %>
+<%= command_usage(:restart_job) %>
+<%= command_usage(:recreate_job) %>
+
+Log management
+<%= command_usage(:fetch_logs) %>
+
+Task management
+<%= command_usage(:list_running_tasks) %>
+<%= command_usage(:list_recent_tasks) %>
+<%= command_usage(:track_task) %>
+<%= command_usage(:cancel_task) %>
+
+Property management
+<%= command_usage(:set_property) %>
+<%= command_usage(:get_property) %>
+<%= command_usage(:unset_property) %>
+<%= command_usage(:list_properties) %>
+
+Maintenance
+<%= command_usage(:cleanup) %>
+<%= command_usage(:cloudcheck) %>
+
+Misc
+<%= command_usage(:status) %>
+<%= command_usage(:list_vms) %>
+<%= command_usage(:target) %>
+<%= command_usage(:login) %>
+<%= command_usage(:logout) %>
+<%= command_usage(:purge) %>
+
+Remote access
+<%= command_usage(:ssh) %>
+<%= command_usage(:scp) %>
+<%= command_usage(:ssh_cleanup) %>
+
+Blob
+<%= command_usage(:upload_blob) %>
+<%= command_usage(:sync_blobs) %>
+<%= command_usage(:blobs) %>

data/lib/cli/validation.rb

@@ -0,0 +1,42 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+module Bosh::Cli
+  class ValidationHalted < StandardError; end
+
+  module Validation
+
+    def errors
+      @errors ||= []
+    end
+
+    def valid?(options = {})
+      validate(options) unless @validated
+      errors.empty?
+    end
+
+    def validate(options = {})
+      perform_validation(options)
+    rescue ValidationHalted
+    ensure
+      @validated = true
+    end
+
+    def reset_validation
+      @validated = nil
+      @errors = []
+    end
+
+    private
+
+    def step(name, error_message, kind = :non_fatal, &block)
+      passed = yield
+
+      say("%-60s %s" % [name, passed ? "OK".green : "FAILED".red])
+
+      unless passed
+        errors << error_message
+        raise ValidationHalted if kind == :fatal
+      end
+    end
+  end
+end

data/lib/cli/version.rb

@@ -0,0 +1,7 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+module Bosh
+  module Cli
+    VERSION = "0.16"
+  end
+end

data/lib/cli/version_calc.rb

@@ -0,0 +1,48 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+module Bosh::Cli
+  module VersionCalc
+
+    # Returns 0 if two versions are the same,
+    # 1 if v1 > v2
+    # -1 if v1 < v2
+    def version_cmp(v1 = "0", v2 = "0")
+      vp1 = components(v1)
+      vp2 = components(v2)
+
+      [vp1.size, vp2.size].max.times do |i|
+        result = vp1[i].to_i <=> vp2[i].to_i
+        return result unless result == 0
+      end
+
+      0
+    end
+
+    def version_greater(v1, v2)
+      version_cmp(v1, v2) > 0
+    end
+
+    def version_less(v1, v2)
+      version_cmp(v1, v2) < 0
+    end
+
+    def version_same(v1, v2)
+      version_cmp(v1, v2) == 0
+    end
+
+    def major_version(v)
+      components(v)[0].to_i
+    end
+
+    def minor_version(v)
+      components(v)[1].to_i
+    end
+
+    private
+
+    def components(v)
+      v.to_s.split(".")
+    end
+
+  end
+end

data/lib/cli/versions_index.rb

@@ -0,0 +1,126 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+module Bosh::Cli
+  class VersionsIndex
+    include VersionCalc
+
+    def initialize(storage_dir, name_prefix = nil)
+      @storage_dir = File.expand_path(storage_dir)
+      @index_file  = File.join(@storage_dir, "index.yml")
+      @name_prefix = name_prefix
+
+      if File.file?(@index_file)
+        init_index(load_yaml_file(@index_file, nil))
+      else
+        init_index({})
+      end
+    end
+
+    def find_by_checksum(checksum)
+      @data["builds"].each_pair do |fingerprint, build_data|
+        return build_data if build_data["sha1"] == checksum
+      end
+      nil
+    end
+
+    def [](fingerprint)
+      @data["builds"][fingerprint]
+    end
+
+    def latest_version(major = nil)
+      builds = @data["builds"].values
+
+      if major
+        builds = builds.select do |build|
+          major_version(build["version"]) == major
+        end
+      end
+
+      return nil if builds.empty?
+
+      sorted = builds.sort { |build1, build2|
+        cmp = version_cmp(build2["version"], build1["version"])
+        if cmp == 0
+          raise "There is a duplicate version `#{build1["version"]}' " +
+                    "in index `#{@index_file}'"
+        end
+        cmp
+      }
+
+      sorted[0]["version"]
+    end
+
+    def version_exists?(version)
+      File.exists?(filename(version))
+    end
+
+    def add_version(fingerprint, item, payload = nil)
+      version = item["version"]
+
+      if version.blank?
+        raise InvalidIndex,
+              "Cannot save index entry without knowing its version"
+      end
+
+      create_directories
+
+      if payload
+        File.open(filename(version), "w") do |f|
+          f.write(payload)
+        end
+      end
+
+      @data["builds"].each_pair do |fp, build|
+        if version_cmp(build["version"], version) == 0 && fp != fingerprint
+          raise "Trying to add duplicate version `#{version}' " +
+                    "into index `#{@index_file}'"
+        end
+      end
+
+      @data["builds"][fingerprint] = item
+      if payload
+        @data["builds"][fingerprint]["sha1"] = Digest::SHA1.hexdigest(payload)
+      end
+
+      File.open(@index_file, "w") do |f|
+        f.write(YAML.dump(@data))
+      end
+
+      File.expand_path(filename(version))
+    end
+
+    def filename(version)
+      name = @name_prefix.blank? ?
+          "#{version}.tgz" : "#{@name_prefix}-#{version}.tgz"
+      File.join(@storage_dir, name)
+    end
+
+    private
+
+    def create_directories
+      begin
+        FileUtils.mkdir_p(@storage_dir)
+      rescue SystemCallError => e
+        raise InvalidIndex, "Cannot create index storage directory: #{e}"
+      end
+
+      begin
+        FileUtils.touch(@index_file)
+      rescue SystemCallError => e
+        raise InvalidIndex, "Cannot create index file: #{e}"
+      end
+    end
+
+    def init_index(data)
+      data ||= {}
+
+      unless data.kind_of?(Hash)
+        raise InvalidIndex, "Invalid versions index data type, " +
+            "#{data.class} given, Hash expected"
+      end
+      @data = data
+      @data.delete("latest_version") # Indices used to track latest versions
+      @data["builds"] ||= {}
+    end
+  end
+end

data/lib/cli/yaml_helper.rb

@@ -0,0 +1,62 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+module Bosh::Cli
+  class YamlHelper
+    class << self
+      private
+      def process_object(o)
+        case o
+        when @syck_class::Map
+          process_map(o)
+        when @syck_class::Seq
+          process_seq(o)
+        when @syck_class::Scalar
+        else
+          err("Unhandled class #{o.class}, fix yaml duplicate check")
+        end
+      end
+
+      def process_seq(s)
+        s.value.each do |v|
+          process_object(v)
+        end
+      end
+
+      def process_map(m)
+        return if m.class != @syck_class::Map
+        s = Set.new
+        m.value.each_key do  |k|
+          raise "Found dup key #{k.value}" if s.include?(k.value)
+          s.add(k.value)
+        end
+
+        m.value.each_value do |v|
+          process_object(v)
+        end
+      end
+
+      public
+      def check_duplicate_keys(path)
+        # Some Ruby builds on Ubuntu seem to expose a bug
+        # with the opposite order of Syck check, so we first
+        # check for Syck and then for YAML::Syck
+        if defined?(Syck)
+          @syck_class = Syck
+        elsif defined?(YAML::Syck)
+          @syck_class = YAML::Syck
+        else
+          raise "Cannot find Syck parser for YAML, " +
+                    "please check your Ruby installation"
+        end
+
+        File.open(path) do |f|
+          begin
+            process_map(YAML.parse(f))
+          rescue => e
+            raise "Bad yaml file #{path}, " + e.message
+          end
+        end
+      end
+    end
+  end
+end