mixlib-install 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7dbbaa531b4d85be6a4198ed08627cdc38804b3
-  data.tar.gz: 47b854df4365270e6566bb04ae322d52d10f1abb
+  metadata.gz: d424a33019d3bd912eefa7331d2dd448ae56d648
+  data.tar.gz: b0ea47fa486e2022d427652dd8d5a7540ea614c4
 SHA512:
-  metadata.gz: 9b27240f21cc8480fad46114f6c6a3546b670728a9180f3216e3c8a330488132a83c2ac8bbd6031d6c220fa451dc97e8ed7c18536858c32a74919554d734cba8
-  data.tar.gz: 6414e414b71fabea427c5c4fb75f65e1d62516942ed79a5da8e866c7209f9e5aa291ae8cf0c6871d8ed298682f2f47fb33f20cd9ccdd623c7755852d6124c2b3
+  metadata.gz: 54e75ad628d8ca9b39f2e0e02ef40b25c8eb754bb70c4ce075e610161436bb1a07318307dfb18c50e9412cb035739767e0e222c74f18cfd835283ab404ac06c2
+  data.tar.gz: 19226b6e4115a5c0e8b9c272cfc150281f33528ddd1d3440110ed1d941a4308f559df3b0d16e0a63d9f19d43d522c56e8a1454af0ea1128c690ac18af1246d5d

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+## [2.1.3]
+- Collection of software dependencies and license content is now configurable. Disabled by default.
+
 ## [2.1.2]
 - Add Cumulus Linux and Cumulus Networks platform support
 - Fix Arista EOS platform detection ordering

data/README.md

@@ -103,6 +103,33 @@ Mixlib::Install.available_versions("chef", "stable")
 # => ["12.13.3", "12.13.7"]
 ```
 
+### Collecting Software Dependencies and License Content
+Collecting software dependencies and license content for ArtifactInfo instances
+requires additional requests to the repository server. By default, collection is disabled.
+To return that data for instances methods `software_dependencies` and `license_content`, the `include_metadata` option must be enabled.
+
+```
+options = {
+  channel: :current,
+  product_name: 'chef',
+  product_version: :latest,
+  platform: 'mac_os_x',
+  platform_version: '10.9',
+  architecture: 'x86_64',
+  include_metadata: true,
+}
+
+artifact = Mixlib::Install.new(options).artifact_info
+
+artifact.license_content.class
+# => String
+artifact.software_dependencies.class
+# => Hash
+
+# By default, the instance methods return nil
+
+```
+
 ## Development
 VCR is a tool that helps cache and replay http responses. When these responses change or when you add more tests you might need to update cached responses. Check out [spec_helper.rb](https://github.com/chef/mixlib-install/blob/master/spec/spec_helper.rb) for instructions on how to do this.
 

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

@@ -174,17 +174,21 @@ Can not find any builds for #{options.product_name} in #{endpoint}.
             artifact_map["filename"]
           )
 
-          # retrieve the metadata using the standardized path
-          begin
-            metadata = get("#{chef_standard_path}.metadata.json")
-            license_content = metadata["license_content"]
-            software_dependencies = metadata["version_manifest"]["software"]
-          rescue Net::HTTPServerException => e
-            if e.message =~ /404/
-              license_content, software_dependencies = nil
-            else
-              raise e
+          if options.include_metadata?
+            # retrieve the metadata using the standardized path
+            begin
+              metadata = get("#{chef_standard_path}.metadata.json")
+              license_content = metadata["license_content"]
+              software_dependencies = metadata["version_manifest"]["software"]
+            rescue Net::HTTPServerException => e
+              if e.message =~ /404/
+                license_content, software_dependencies = nil
+              else
+                raise e
+              end
             end
+          else
+            license_content, software_dependencies = nil
           end
 
           # create the download path with the correct endpoint

data/lib/mixlib/install/options.rb

@@ -38,6 +38,7 @@ module Mixlib
         :product_version,
         :shell_type,
         :platform_version_compatibility_mode,
+        :include_metadata,
       ]
 
       def initialize(options)
@@ -76,6 +77,10 @@ module Mixlib
         product_version.to_sym == :latest
       end
 
+      def include_metadata?
+        include_metadata.to_s == "true"
+      end
+
       #
       # Set the platform info on the instance
       # info [Hash]
@@ -96,6 +101,7 @@ module Mixlib
           shell_type: :sh,
           platform_version_compatibility_mode: false,
           product_version: :latest,
+          include_metadata: false,
         }
       end
 

data/lib/mixlib/install/version.rb

@@ -1,5 +1,5 @@
 module Mixlib
   class Install
-    VERSION = "2.1.2"
+    VERSION = "2.1.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mixlib-install
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.3
 platform: ruby
 authors:
 - Thom May