Allow to extend the supported products of mixlib-install

Signed-off-by: Tensibai <tensibai@iabis.net>

Author: Tensibai

README.md

@@ -254,6 +254,25 @@ Bourne install script (`install.sh`) supports `http_proxy`, `https_proxy`, `ftp_
 
 Powershell install script (`install.ps1`) supports `http_proxy` passed as a key to `install_command_options`.
 
+
+### Extending for other products
+
+Create a ruby file in your application and use the product DSL like this (see [product.rb](lib/mixlib/install/product.rb) for available properties):
+
+```
+product "cinc" do
+  product_name "Cinc Infra Client"
+  package_name "cinc-client"
+  api_url "https://packages.cinc.sh"
+end
+```
+
+Then set an environment variable to load them like this on linux:
+
+`export EXTRA_PRODUCTS_FILE=/path/to/your/file.rb`
+
+Calls to mixlib-install now allow to target your new product, assuming the api_url match pacakges api for `/<channel>/<product>/versions` and `/<channel>/<product>/<version>/artifacts` endpoints.
+
 ## 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.
 

lib/mixlib/install/backend/package_router.rb

@@ -30,7 +30,6 @@ module Mixlib
   class Install
     class Backend
       class PackageRouter < Base
-        ENDPOINT = Mixlib::Install::Dist::PRODUCT_ENDPOINT.freeze
 
         COMPAT_DOWNLOAD_URL_ENDPOINT = "http://packages.chef.io".freeze
 
@@ -269,7 +268,7 @@ def generate_chef_standard_path(channel, project, version, platform, platform_ve
         end
 
         def endpoint
-          @endpoint ||= ENV.fetch("PACKAGE_ROUTER_ENDPOINT", ENDPOINT)
+          @endpoint ||= PRODUCT_MATRIX.lookup(options.product_name, options.product_version).api_url
         end
 
         def omnibus_project

lib/mixlib/install/options.rb

@@ -26,7 +26,7 @@ class Install
     class Options
       class InvalidOptions < ArgumentError; end
 
-      attr_reader :options, :errors, :original_platform_version
+      attr_reader :options, :errors, :original_platform_version, :supported_product_names
 
       SUPPORTED_ARCHITECTURES = %w{
         aarch64
@@ -46,8 +46,6 @@ class InvalidOptions < ArgumentError; end
         :unstable,
       ]
 
-      SUPPORTED_PRODUCT_NAMES = PRODUCT_MATRIX.products
-
       SUPPORTED_SHELL_TYPES = [
         :ps1,
         :sh,
@@ -77,6 +75,15 @@ def initialize(options)
         # Store original options in cases where we must remap
         @original_platform_version = options[:platform_version]
 
+        # Eval extra products definition
+        extra_products = ENV.fetch("EXTRA_PRODUCTS_FILE", nil)
+        unless extra_products.nil?
+          PRODUCT_MATRIX.instance_eval(::File.read(extra_products), extra_products)
+        end
+
+        # Store supported product names
+        @supported_product_names = PRODUCT_MATRIX.products
+
         resolve_platform_version_compatibility_mode!
 
         map_windows_versions!
@@ -189,10 +196,10 @@ def validate_architecture
       end
 
       def validate_product_names
-        unless SUPPORTED_PRODUCT_NAMES.include? product_name
+        unless @supported_product_names.include? product_name
           errors << <<-EOS
 Unknown product name #{product_name}.
-Must be one of: #{SUPPORTED_PRODUCT_NAMES.join(", ")}
+Must be one of: #{@supported_product_names.join(", ")}
           EOS
         end
       end

lib/mixlib/install/product.rb

@@ -36,6 +36,7 @@ def initialize(key, &block)
         :omnibus_project,
         :github_repo,
         :downloads_product_page_url,
+        :api_url,
       ]
 
       #
@@ -86,6 +87,8 @@ def default_value_for(prop)
           "#{Mixlib::Install::Dist::DOWNLOADS_PAGE}/#{product_key}"
         when :github_repo
           "#{Mixlib::Install::Dist::GITHUB_ORG}/#{product_key}"
+        when :api_url
+          ENV.fetch("PACKAGE_ROUTER_ENDPOINT", Mixlib::Install::Dist::PRODUCT_ENDPOINT)
         else
           nil
         end

spec/fixtures/extra/extra_distributions.rb

@@ -0,0 +1,5 @@
+product "cinc" do
+  product_name "Cinc Infra Client"
+  package_name "cinc-client"
+  api_url "https://packages.cinc.sh"
+end