mixlib-install 1.0.10 → 1.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03929d3bab7753839718857039be870546202ee5
-  data.tar.gz: cc933994d3a8c50a20cf6fcaa328ddf97475e68d
+  metadata.gz: 2b2ddb2bee9fa02b5c0835109b73ee0234a5b69f
+  data.tar.gz: 7b699b07eea1499dff69661e9321ed147eb55312
 SHA512:
-  metadata.gz: d83a3f88f72136251caf55268d7729f02e03ec135963794b29183c5d4d72c1439a8d7e06939a9447a41cea18dffb39da42f8ffbeca3ed85945edcefd06fd7690
-  data.tar.gz: 1a1af862a6b4f89e22c58102abc504f3ce2852b41203edee62e35a8f0d729d8ea11eeda662e4e59c2842327f02825e5d1988ba0b57a76482836433376d5c2c5f
+  metadata.gz: 5e659140f51abfdb1c348cb15adacb514bf2aafcfad2d80de79b701fb026fa41a8206b63b48f28c038b51a7f59edcb7f551ea741b00de1cf7a6e38dfee534624
+  data.tar.gz: f10c4a2d8ae90e47a41c3ccafbd48b727ffe6e8fee49b4c92f90e3500fa8f21136750c2b018803e6a5f0a115d52fcc0bc93b26a8c194dd90ae66e5da3c4797de

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+## [1.0.11]
+- Add `platform_version_compatibility_mode` option which makes mixlib-install select an artifact built for an earlier version of a platform when set.
+
 ## [1.0.10]
 - Correctly parse architecture for ppc64el.
 - Return chef.bintray.com based urls for solaris9 and solaris10.

data/README.md

@@ -49,6 +49,24 @@ artifact.platform # => "mac_os_x"
 artifact.platform_version # => "10.10"
 ```
 
+### Use an artifact released for an earlier version of the platform
+```ruby
+options = {
+  channel: :current,
+  product_name: 'chef',
+  product_version: :latest,
+  platform: 'ubuntu',
+  platform_version: '15.04',
+  architecture: 'x86_64',
+  platform_version_compatibility_mode: true
+}
+
+artifact = Mixlib::Install.new(options).artifact_info
+
+artifact.platform # => "ubuntu"
+artifact.platform_version # => "14.04"
+```
+
 ## Unstable channel
 The `:unstable` channel is currently only available when connected to Chef's internal network.
 

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

@@ -42,25 +42,12 @@ module Mixlib
         #
         # @return [Array<ArtifactInfo>] list of artifacts for the configured
         # channel, product name, and product version.
-        # @return [ArtifactInfo] arifact info for the configured
-        # channel, product name, product version and platform info
-        #
-        def info
-          artifacts = if options.latest_version?
-                        artifactory_latest
-                      else
-                        artifactory_artifacts(options.product_version)
-                      end
-
-          if options.platform
-            artifacts.select! do |a|
-              a.platform == options.platform &&
-                a.platform_version == options.platform_version &&
-                a.architecture == options.architecture
-            end
+        def available_artifacts
+          if options.latest_version?
+            artifactory_latest
+          else
+            artifactory_artifacts(options.product_version)
           end
-
-          artifacts.length == 1 ? artifacts.first : artifacts
         end
 
         #

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

@@ -26,13 +26,86 @@ module Mixlib
           @options = options
         end
 
+        #
+        # Returns the list of artifacts from the configured backend based on the
+        # configured product_name, product_version and channel.
+        #
+        # @abstract Subclasses should define this method.
+        #
+        # @return Array<ArtifactInfo>
+        #   List of ArtifactInfo objects for the available artifacts.
+        def available_artifacts
+          raise "Must implement available_artifacts method that returns Array<ArtifactInfo>"
+        end
+
+        #
+        # See #filter_artifacts
         def info
-          raise "Must implement info method that returns ArtifactInfo or Array<ArtifactInfo>"
+          filter_artifacts(available_artifacts)
+        end
+
+        #
+        # Returns true if platform filters are available, false otherwise.
+        #
+        # Note that we assume #set_platform_info method is used on the Options
+        # class to set the platform options.
+        #
+        # @return TrueClass, FalseClass
+        def platform_filters_available?
+          !options.platform.nil?
         end
 
-        def endpoint
-          raise "Must implement endpoint method that returns endpoint String"
+        #
+        # Filters and returns the available artifacts based on the configured
+        # platform filtering options.
+        #
+        # @return ArtifactInfo, Array<ArtifactInfo>, []
+        #   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 [].
+        def filter_artifacts(artifacts)
+          return artifacts unless platform_filters_available?
+
+          # First filter the artifacts based on the platform and architecture
+          artifacts.select! do |a|
+            a.platform == options.platform && a.architecture == options.architecture
+          end
+
+          # Now we are going to filter based on platform_version.
+          # We will return the artifact with an exact match if available.
+          # Otherwise we will search for a compatible artifact and return it
+          # if the compat options is set.
+          closest_compatible_artifact = nil
+
+          artifacts.each do |a|
+            return a if a.platform_version == options.platform_version
+
+            # We skip the artifacts produced for windows since their platform
+            # version is always set to 2008r2 which breaks our `to_f` comparison.
+            next if a.platform == "windows"
+
+            # Calculate the closest compatible version.
+            # For an artifact to be compatible it needs to be smaller than the
+            # platform_version specified in options.
+            # To find the closest compatible one we keep a max of the compatible
+            # artifacts.
+            if closest_compatible_artifact.nil? ||
+                (a.platform_version.to_f > closest_compatible_artifact.platform_version.to_f &&
+                  a.platform_version.to_f < options.platform_version.to_f )
+              closest_compatible_artifact = a
+            end
+          end
+
+          # If the compat flag is set and if we have found a compatible artifact
+          # we are going to use it.
+          if options.platform_version_compatibility_mode && closest_compatible_artifact
+            return closest_compatible_artifact
+          end
+
+           # Otherwise, we return an empty array indicating we do not have any matching artifacts
+          return []
         end
+
       end
     end
   end

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

@@ -51,27 +51,6 @@ module Mixlib
           @endpoint ||= ENV.fetch("BINTRAY_ENDPOINT", ENDPOINT)
         end
 
-        # Create filtered list of artifacts
-        #
-        # @return [Array<ArtifactInfo>] list of artifacts for the configured
-        # channel, product name, and product version.
-        # @return [ArtifactInfo] arifact info for the configured
-        # channel, product name, product version and platform info
-        #
-        def info
-          artifacts = bintray_artifacts
-
-          if options.platform
-            artifacts.select! do |a|
-              a.platform == options.platform &&
-                a.platform_version == options.platform_version &&
-                a.architecture == options.architecture
-            end
-          end
-
-          artifacts.length == 1 ? artifacts.first : artifacts
-        end
-
         #
         # Makes a GET request to bintray for the given path.
         #
@@ -111,7 +90,7 @@ module Mixlib
         #
         # @return [Array<ArtifactInfo>] Array of info about found artifacts
         #
-        def bintray_artifacts
+        def available_artifacts
           version = options.latest_version? ? latest_version : options.product_version
           begin
             results = bintray_get("#{options.channel}/#{options.product_name}/versions/#{version}/files")

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

@@ -31,7 +31,7 @@ module Mixlib
           @endpoint ||= ENV.fetch("OMNITRUCK_ENDPOINT", ENDPOINT)
         end
 
-        def info
+        def available_artifacts
           # If we are querying a single platform we need to call metadata
           # endpoint otherwise we need to call versions endpoint in omnitruck
           if options.platform

data/lib/mixlib/install/options.rb

@@ -39,6 +39,7 @@ module Mixlib
         :product_name,
         :product_version,
         :shell_type,
+        :platform_version_compatibility_mode,
       ]
 
       def initialize(options)
@@ -107,6 +108,7 @@ module Mixlib
       def default_options
         {
           shell_type: :sh,
+          platform_version_compatibility_mode: false,
         }
       end
 

data/lib/mixlib/install/version.rb

@@ -1,5 +1,5 @@
 module Mixlib
   class Install
-    VERSION = "1.0.10"
+    VERSION = "1.0.11"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mixlib-install
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 1.0.11
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-26 00:00:00.000000000 Z
+date: 2016-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: artifactory