mixlib-install 2.1.12 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1a9b21c17652ee75bd5ff49815ec28de675dd2d
-  data.tar.gz: e3a8f6eb46a882f8cd782bbfccf72a2d9fdb4939
+  metadata.gz: 085161439c62c8a919ce8fd06074c085188d9335
+  data.tar.gz: 0f728caf3f8d6c8ce78dea5e8b627acb95febc05
 SHA512:
-  metadata.gz: f8d9f212165f65985b2c6c63c808808cfaccc617c213b0078c621b63834a99ffcf5dd857f0a876a6066f967c4b20e3e6df83f2ea4ad5ac3b5301f790432b1da4
-  data.tar.gz: 9860b66f2d577810d773bf1167ee7177edbd5a7f53f1dacb4addaee51d70ffce4d500ad1314a055f233bb268e49375fba5ff55300121058b8d297c5e73f0e625
+  metadata.gz: ebcdac43be5b9a3b0b335d81b77afd8a442309b6c28f95f7db3a1564e5c810809755dce7f25aeff924cac8e2d575d2c73110006f87a77a77991e4ade20e4645c
+  data.tar.gz: 87e953ca7d176419053774b3f3515c161b786dba36442dcd7b7cdad87fb5e337b11177ae0b208e740d5a3d9980f7672aa09678a181caa7ab85e966a7cb8dad79

data/CHANGELOG.md

@@ -1,9 +1,15 @@
 # Change Log
 
+## [3.0.0]
+- [Breaking API Change] `Options` validation added to ensure that when any platform option is set they are all provided (platform, platform_version, architecture)
+- [Breaking API Change] The `platform_version_compatibility_mode` option will automatically be set to `true` when no platform options are provided
+- [Breaking API Change] Queries for aritfacts that yield no results will raise an exception (`Mixlib::Install::Backend::ArtifactsNotFound`) versus returning an empty array
+- New properties added to `Products`: `github_repo` and `downloads_product_page_url`
+- New method for retrieving products that are available on downloads.chef.io: `PRODUCT_MATRIX.products_available_on_downloads_site`
+
 ## [2.1.12]
 - Force powershell scripts to ASCII encode variables
 
-
 ## [2.1.11]
 - Fix ScriptGenerator install script to use proper platform detection for Windows artifacts
 - Artifact metadata now includes supported Windows Desktop versions

data/README.md

@@ -83,6 +83,21 @@ artifact.platform # => "ubuntu"
 artifact.platform_version # => "14.04"
 ```
 
+`platform_version_compatibility_mode` will automatically be enabled if platform options are not specified.
+
+If running on Ubuntu 15.04...
+```ruby
+options = {
+  channel: :current,
+  product_name: 'chef',
+}
+
+artifact = Mixlib::Install.new(options).artifact_info
+
+artifact.platform # => "ubuntu"
+artifact.platform_version # => "14.04"
+```
+
 ### List the available versions for a product and channel
 #### Instance method
 ```ruby

data/lib/mixlib/install/backend/base.rb

@@ -21,9 +21,9 @@ require "mixlib/install/util"
 module Mixlib
   class Install
     class Backend
-      class Base
-        class UnsupportedVersion < ArgumentError; end
+      class ArtifactsNotFound < StandardError; end
 
+      class Base
         attr_reader :options
 
         SUPPORTED_WINDOWS_DESKTOP_VERSIONS = %w{7 8 8.1 10}
@@ -79,10 +79,10 @@ module Mixlib
         # Filters and returns the available artifacts based on the configured
         # platform filtering options.
         #
-        # @return ArtifactInfo, Array<ArtifactInfo>, []
+        # @return ArtifactInfo, Array<ArtifactInfo>, ArtifactsNotFound
         #   If the result is a single artifact, this returns ArtifactInfo.
         #   If the result is a list of artifacts, this returns Array<ArtifactInfo>.
-        #   If no suitable artifact is found, this returns [].
+        #   If no suitable artifact is found, this returns ArtifactsNotFound exception.
         def filter_artifacts(artifacts)
           return artifacts unless platform_filters_available?
 
@@ -123,8 +123,17 @@ module Mixlib
             return closest_compatible_artifact
           end
 
-           # Otherwise, we return an empty array indicating we do not have any matching artifacts
-          return []
+           # Return an exception if we get to the end of the method
+          raise ArtifactsNotFound, <<-EOF
+No artifacts found matching criteria.
+  product name: #{options.product_name}
+  channel: #{options.channel}
+  version: #{options.product_version}
+  platform: #{options.platform}
+  platform version: #{options.platform_version}
+  architecture: #{options.architecture}
+  compatibility mode: #{options.platform_version_compatibility_mode}
+EOF
         end
 
         # On windows, if we do not have a native 64-bit package available
@@ -232,10 +241,6 @@ module Mixlib
         # See https://docs.chef.io/platforms.html
         #
         def map_custom_windows_desktop_versions(desktop_version)
-          unless SUPPORTED_WINDOWS_DESKTOP_VERSIONS.include?(desktop_version)
-            raise UnsupportedVersion, "Unsupported Windows desktop version `#{desktop_version}`. Supported versions: #{SUPPORTED_WINDOWS_DESKTOP_VERSIONS.join(", ")}."
-          end
-
           server_version = Util.map_windows_desktop_version(desktop_version)
 
           # Windows desktop 10 officially maps to server 2016.

data/lib/mixlib/install/backend/package_router.rb

@@ -27,8 +27,6 @@ module Mixlib
   class Install
     class Backend
       class PackageRouter < Base
-        class NoArtifactsError < StandardError; end
-
         ENDPOINT = "https://packages.chef.io".freeze
 
         COMPAT_DOWNLOAD_URL_ENDPOINT = "http://packages.chef.io".freeze
@@ -66,6 +64,15 @@ module Mixlib
         def versions
           items = get("/api/v1/#{options.channel}/#{omnibus_project}/versions")["results"]
 
+          # Circumvent early when there are no product artifacts in a specific channel
+          if items.empty?
+            raise ArtifactsNotFound, <<-EOF
+No artifacts found matching criteria.
+  product name: #{options.product_name}
+  channel: #{options.channel}
+EOF
+          end
+
           # Filter out the partial builds if we are in :unstable channel
           # In other channels we do not need to do this since all builds are
           # always complete. Infact we should not do this since for some arcane
@@ -76,6 +83,7 @@ module Mixlib
             # populated with the build record if "artifact.module.build" exists.
             items.reject! { |i| i["artifacts"].nil? }
           end
+
           items
         end
 
@@ -84,21 +92,9 @@ module Mixlib
         #
         # @return [Array<ArtifactInfo>] Array of info about found artifacts
         def latest_version
-          # Get the list of builds from the REST api.
-          # We do this because a user in the readers group does not have
-          # permissions to run aql against builds.
-          builds = versions
-
-          if builds.nil?
-            raise NoArtifactsError, <<-MSG
-Can not find any builds for #{options.product_name} in #{endpoint}.
-            MSG
-          end
-
           # Sort by created data
-          # TODO: Shouldn't we sort by version?
-          builds.sort_by! { |b| b["created"] }.reverse!
-          version = extract_version_from_response(builds.first)
+          sorted_versions = versions.sort_by! { |b| b["created"] }.reverse!
+          version = extract_version_from_response(sorted_versions.first)
           artifacts_for_version(version)
         end
 

data/lib/mixlib/install/cli.rb

@@ -49,32 +49,27 @@ If no earlier version is found the earliest version available will be set.",
         desc: "Print artifact attributes",
         type: :boolean
       def download(product_name)
-        say_status("Warn", "Product key `delivery` will be deprecated in a future release. Please use `automate`") if product_name == "delivery"
         # Set mininum options
         mixlib_install_options = {
           channel: options[:channel].to_sym,
           product_name: product_name,
           product_version: options[:version],
           platform_version_compatibility_mode: options[:platform_version_compat],
-        }
-
-        # Set platform info or auto detect platform
-        if options[:platform]
-          if options[:platform_version].nil? || options[:architecture].nil?
-            abort "Must provide platform version and architecture when specifying a platform"
-          end
-          mixlib_install_options[:platform] = options[:platform]
-          mixlib_install_options[:platform_version] = options[:platform_version]
-          mixlib_install_options[:architecture] = options[:architecture]
-        else
+          architecture: options[:architecture],
+        }.tap do |opt|
+          opt[:platform] = options[:platform] if options[:platform]
+          opt[:platform_version] = options[:platform_version] if options[:platform_version]
+        end
 
+        # auto detect platform options if not configured
+        if options[:platform].nil? && options[:platform_version].nil?
           mixlib_install_options.merge!(Mixlib::Install.detect_platform)
         end
 
-        say "Querying for artifact with options:\n#{JSON.pretty_generate(mixlib_install_options)}"
-        artifact = Mixlib::Install.new(mixlib_install_options).artifact_info
-        if artifact.nil? || artifact.is_a?(Array)
-          abort "No results found."
+        begin
+          artifact = Mixlib::Install.new(mixlib_install_options).artifact_info
+        rescue Mixlib::Install::Backend::ArtifactsNotFound => e
+          abort e.message
         end
 
         if options[:url]

data/lib/mixlib/install/options.rb

@@ -25,7 +25,7 @@ module Mixlib
     class Options
       class InvalidOptions < ArgumentError; end
 
-      attr_reader :options
+      attr_reader :options, :errors
 
       SUPPORTED_ARCHITECTURES = %w{
         i386
@@ -36,12 +36,15 @@ module Mixlib
         sparc
         x86_64
       }
+
       SUPPORTED_CHANNELS = [
         :stable,
         :current,
         :unstable,
       ]
+
       SUPPORTED_PRODUCT_NAMES = PRODUCT_MATRIX.products
+
       SUPPORTED_SHELL_TYPES = [
         :ps1,
         :sh,
@@ -61,34 +64,34 @@ module Mixlib
 
       def initialize(options)
         @options = options
+        @errors = []
+
+        resolve_platform_version_compatibility_mode!
 
         map_windows_desktop_versions! if for_windows?
 
         validate!
       end
 
+      SUPPORTED_OPTIONS.each do |option|
+        define_method option do
+          options[option] || options[option.to_s] || default_options[option]
+        end
+      end
+
       def validate!
         validate_options!
       end
 
       def validate_options!
-        errors = []
-
-        errors << validate_architecture
-        errors << validate_product_names
-        errors << validate_channels
-        errors << validate_shell_type
-        errors << validate_user_agent_headers
-
-        unless errors.compact.empty?
-          raise InvalidOptions, errors.join("\n")
-        end
-      end
-
-      SUPPORTED_OPTIONS.each do |option|
-        define_method option do
-          options[option] || options[option.to_s] || default_options[option]
-        end
+        validate_architecture
+        validate_product_names
+        validate_channels
+        validate_shell_type
+        validate_user_agent_headers
+        validate_platform_options
+
+        raise InvalidOptions, errors.join("\n") unless errors.empty?
       end
 
       def for_ps1?
@@ -117,6 +120,29 @@ module Mixlib
         validate_options!
       end
 
+      def platform_info
+        {
+          platform: options[:platform],
+          platform_version: options[:platform_version],
+          architecture: options[:architecture],
+        }
+      end
+
+      #
+      # Calling this method will give queries more of an opportunity to collect
+      # compatible artifacts where there may not always be an exact match.
+      #
+      # This option is set to false by default.
+      # - In cases where no platform options are configured it will set this option to true.
+      # - In cases where all platform options are configured it will remain false UNLESS the option
+      #   has been configured to be true.
+      #
+      def resolve_platform_version_compatibility_mode!
+        unless options[:platform_version_compatibility_mode]
+          options[:platform_version_compatibility_mode] = true if platform_info.values.none?
+        end
+      end
+
       private
 
       def default_options
@@ -130,7 +156,7 @@ module Mixlib
 
       def validate_architecture
         unless architecture.nil? || SUPPORTED_ARCHITECTURES.include?(architecture)
-          <<-EOS
+          errors << <<-EOS
 Unknown architecture #{architecture}.
 Must be one of: #{SUPPORTED_ARCHITECTURES.join(", ")}
           EOS
@@ -139,7 +165,7 @@ Must be one of: #{SUPPORTED_ARCHITECTURES.join(", ")}
 
       def validate_product_names
         unless SUPPORTED_PRODUCT_NAMES.include? product_name
-          <<-EOS
+          errors << <<-EOS
 Unknown product name #{product_name}.
 Must be one of: #{SUPPORTED_PRODUCT_NAMES.join(", ")}
           EOS
@@ -148,7 +174,7 @@ Must be one of: #{SUPPORTED_PRODUCT_NAMES.join(", ")}
 
       def validate_channels
         unless SUPPORTED_CHANNELS.include? channel
-          <<-EOS
+          errors << <<-EOS
 Unknown channel #{channel}.
 Must be one of: #{SUPPORTED_CHANNELS.join(", ")}
           EOS
@@ -157,7 +183,7 @@ Must be one of: #{SUPPORTED_CHANNELS.join(", ")}
 
       def validate_shell_type
         unless SUPPORTED_SHELL_TYPES.include? shell_type
-          <<-EOS
+          errors << <<-EOS
 Unknown shell type.
 Must be one of: #{SUPPORTED_SHELL_TYPES.join(", ")}
           EOS
@@ -176,12 +202,24 @@ Must be one of: #{SUPPORTED_SHELL_TYPES.join(", ")}
           end
         end
 
-        error
+        errors << error if error
+      end
+
+      def validate_platform_options
+        unless all_or_none?(platform_info.values)
+          errors << <<-EOS
+Must provide platform, platform version and architecture when specifying any platform details
+          EOS
+        end
       end
 
       def map_windows_desktop_versions!
         options[:platform_version] = Util.map_windows_desktop_version(platform_version)
       end
+
+      def all_or_none?(items)
+        items.all? || items.compact.empty?
+      end
     end
   end
 end

data/lib/mixlib/install/product.rb

@@ -20,17 +20,21 @@ require "mixlib/versioning"
 module Mixlib
   class Install
     class Product
-      def initialize(&block)
+      def initialize(key, &block)
+        @product_key = key
         instance_eval(&block)
       end
 
       DSL_PROPERTIES = [
         :config_file,
         :ctl_command,
+        :product_key,
         :package_name,
         :product_name,
         :install_path,
         :omnibus_project,
+        :github_repo,
+        :downloads_product_page_url,
       ]
 
       #
@@ -53,7 +57,7 @@ module Mixlib
               value = instance_variable_get("@#{prop}".to_sym)
               return default_value_for(prop) if value.nil?
 
-              if value.is_a? String
+              if value.is_a?(String) || value.is_a?(Symbol)
                 value
               else
                 value.call(version_for(version))
@@ -77,6 +81,10 @@ module Mixlib
           "/opt/#{package_name}"
         when :omnibus_project
           package_name
+        when :downloads_product_page_url
+          "https://downloads.chef.io/#{product_key}"
+        when :github_repo
+          "chef/#{product_key}"
         else
           nil
         end
@@ -132,7 +140,7 @@ module Mixlib
       # `key` and stores it.
       #
       def product(key, &block)
-        @product_map[key] = Product.new(&block)
+        @product_map[key] = Product.new(key, &block)
       end
 
       #
@@ -162,6 +170,18 @@ module Mixlib
         product.version(version)
         product
       end
+
+      #
+      # Looks up all products that are available on downloads.chef.io
+      #
+      # @return Hash{String => Product}
+      #   :key => product_key
+      #   :value => Mixlib::Install::Product instance
+      def products_available_on_downloads_site
+        @product_map.delete_if do |product_key, product|
+          product.downloads_product_page_url == :not_available
+        end
+      end
     end
   end
 end
@@ -179,16 +199,21 @@ PRODUCT_MATRIX = Mixlib::Install::ProductMatrix.new do
     package_name "opscode-analytics"
     ctl_command "opscode-analytics-ctl"
     config_file "/etc/opscode-analytics/opscode-analytics.rb"
+    downloads_product_page_url :not_available
   end
 
   product "angry-omnibus-toolchain" do
     product_name "Angry Omnibus Toolchain"
     package_name "angry-omnibus-toolchain"
+    github_repo "chef/omnibus-toolchain"
+    downloads_product_page_url :not_available
   end
 
   product "angrychef" do
     product_name "Angry Chef Client"
     package_name "angrychef"
+    github_repo "chef/chef"
+    downloads_product_page_url :not_available
   end
 
   product "automate" do
@@ -245,11 +270,13 @@ PRODUCT_MATRIX = Mixlib::Install::ProductMatrix.new do
   product "chef-server-ha-provisioning" do
     product_name "Chef Server HA Provisioning for AWS"
     package_name "chef-server-ha-provisioning"
+    downloads_product_page_url :not_available
   end
 
   product "chefdk" do
     product_name "Chef Development Kit"
     package_name "chefdk"
+    github_repo "chef/chef-dk"
   end
 
   product "compliance" do
@@ -269,17 +296,23 @@ PRODUCT_MATRIX = Mixlib::Install::ProductMatrix.new do
       v < version_for("0.7.0") ? "delivery-ctl" : "automate-ctl"
     end
     config_file "/etc/delivery/delivery.rb"
+    github_repo "chef/automate"
+    downloads_product_page_url "https://downloads.chef.io/automate"
   end
 
   product "ha" do
     product_name "Chef Server High Availability addon"
     package_name "chef-ha"
     config_file "/etc/opscode/chef-server.rb"
+    github_repo "chef/chef-ha"
+    downloads_product_page_url :not_available
   end
 
   product "harmony" do
     product_name "Harmony - Omnibus Integration Internal Test Project"
     package_name "harmony"
+    github_repo "chef/omnibus-harmony"
+    downloads_product_page_url :not_available
   end
 
   product "inspec" do
@@ -302,6 +335,7 @@ PRODUCT_MATRIX = Mixlib::Install::ProductMatrix.new do
         "/etc/chef-manage/manage.rb"
       end
     end
+    github_repo "chef/chef-manage"
   end
 
   product "marketplace" do
@@ -309,11 +343,14 @@ PRODUCT_MATRIX = Mixlib::Install::ProductMatrix.new do
     package_name "chef-marketplace"
     ctl_command "chef-marketplace-ctl"
     config_file "/etc/chef-marketplace/marketplace.rb"
+    github_repo "chef-partners/omnibus-marketplace"
+    downloads_product_page_url :not_available
   end
 
   product "omnibus-toolchain" do
     product_name "Omnibus Toolchain"
     package_name "omnibus-toolchain"
+    downloads_product_page_url :not_available
   end
 
   product "private-chef" do
@@ -322,6 +359,7 @@ PRODUCT_MATRIX = Mixlib::Install::ProductMatrix.new do
     ctl_command "private-chef-ctl"
     config_file "/etc/opscode/private-chef.rb"
     install_path "/opt/opscode"
+    github_repo "chef/opscode-chef"
   end
 
   product "push-jobs-client" do
@@ -329,6 +367,7 @@ PRODUCT_MATRIX = Mixlib::Install::ProductMatrix.new do
     package_name do |v|
       v < version_for("1.3.0") ? "opscode-push-jobs-client" : "push-jobs-client"
     end
+    github_repo "chef/opscode-pushy-client"
   end
 
   product "push-jobs-server" do
@@ -336,6 +375,7 @@ PRODUCT_MATRIX = Mixlib::Install::ProductMatrix.new do
     package_name "opscode-push-jobs-server"
     ctl_command "opscode-push-jobs-server-ctl"
     config_file "/etc/opscode-push-jobs-server/opscode-push-jobs-server.rb"
+    github_repo "chef/opscode-pushy-server"
   end
 
   product "reporting" do
@@ -343,6 +383,7 @@ PRODUCT_MATRIX = Mixlib::Install::ProductMatrix.new do
     package_name "opscode-reporting"
     ctl_command "opscode-reporting-ctl"
     config_file "/etc/opscode-reporting/opscode-reporting.rb"
+    github_repo "chef/oc_reporting"
   end
 
   product "supermarket" do
@@ -357,5 +398,7 @@ PRODUCT_MATRIX = Mixlib::Install::ProductMatrix.new do
     package_name "chef-sync"
     ctl_command "chef-sync-ctl"
     config_file "/etc/chef-sync/chef-sync.rb"
+    github_repo "chef/omnibus-sync"
+    downloads_product_page_url :not_available
   end
 end

data/lib/mixlib/install/version.rb

@@ -1,5 +1,5 @@
 module Mixlib
   class Install
-    VERSION = "2.1.12"
+    VERSION = "3.0.0"
   end
 end

data/mixlib-install.gemspec

@@ -10,14 +10,13 @@ Gem::Specification.new do |spec|
   spec.email         = ["thom@chef.io", "patrick@chef.io"]
   spec.license       = "Apache-2.0"
 
-  spec.summary       = "A mixin to help with omnitruck installs"
+  spec.summary       = "A library for interacting with Chef Software Inc's software distribution systems."
   spec.homepage      = "https://chef.io"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.executables   = ["mixlib-install"]
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "artifactory"
   spec.add_dependency "mixlib-shellout"
   spec.add_dependency "mixlib-versioning"
   spec.add_dependency "thor"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mixlib-install
 version: !ruby/object:Gem::Version
-  version: 2.1.12
+  version: 3.0.0
 platform: ruby
 authors:
 - Thom May
@@ -9,22 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-02 00:00:00.000000000 Z
+date: 2017-03-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: artifactory
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
   requirement: !ruby/object:Gem::Requirement
@@ -309,8 +295,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
-summary: A mixin to help with omnitruck installs
+summary: A library for interacting with Chef Software Inc's software distribution
+  systems.
 test_files: []