Merge pull request #2 from chef-cookbooks/jtimberman/product-names

Use product keys as the name attribute

Author: jtimberman

PRODUCT_MATRIX.md

@@ -0,0 +1,18 @@
+Update this in lockstep with `#product_matrix` in `libraries/helpers.rb`
+
+| Product | Product Key  | Package Name |
+| ---------- | ------------------ | -------------------- |
+| Chef Client | chef | chef |
+| Chef Development Kit | chefdk| chefdk |
+| Enterprise Chef (legacy) | private-chef | private-chef |
+| Chef Server | chef-server | chef-server (versions < 12.0.0) <br/> chef-server-core (versions >= 12.0.0) |
+| Chef Server High Availability addon | chef-ha | chef-ha |
+| Chef Server Replication addon | chef-sync | chef-sync |
+| Chef Server Reporting addon | reporting | opscode-reporting |
+| Management Console | manage | opscode-manage (versions < 2.0.0) <br/> chef-manage (versions >= 2.0.0) |
+| Push Jobs Server | chef-push-server | opscode-push-jobs-server |
+| Push Jobs Client | chef-push-client | opscode-push-jobs-client (versions < 2.0.0) <br/> chef-push-client (versions >= 2.0.0)  |
+| Analytics Platform | analytics | opscode-analytics |
+| Delivery | delivery | delivery |
+| Delivery CLI | delivery-cli | delivery-cli |
+| Supermarket | supermarket | supermarket |

README.md

@@ -9,6 +9,8 @@ This cookbook provides primitives - helpers and resources - to manage Chef Softw
 
 It will perform component installation and configuration. It provides no recipes. Instead, wrapper cookbooks should be created using the resources that this cookbook provides.
 
+For a product to package matrix, see [PRODUCT_MATRIX.md](https://github.com/chef-cookbooks/chef-ingredient/blob/master/PRODUCT_MATRIX.md)
+
 ## Requirements
 
 - apt
@@ -37,7 +39,8 @@ A "chef ingredient" is the core package itself, or products or add-on components
 - `reconfigure` - Performs the `ctl reconfigure` command for the package.
 
 #### Properties
-- `package_name`: (name attribute) The name of the package. Should correspond to the published package names (chef-server-core, opscode-manage, etc).
+- `product_name`: (name attribute) The product name. See the [PRODUCT_MATRIX.md](https://github.com/chef-cookbooks/chef-ingredient/blob/master/PRODUCT_MATRIX.md). For example, `chef-server`, `analytics`, `delivery`, `manage`, etc.
+- `package_name`: The name of the package in the repository. Should correspond to the published package names (`chef-server-core`, `opscode-manage`, etc).
 - `ctl_command`: The "ctl" command, e.g., `chef-server-ctl`. This should be automatically detected by the library helper method `chef_ctl_command`, but may need to be specified if something changes, like a new add-on is made available.
 - `options`: Options passed to the `package` resource used for installation.
 - `version`: Package version, e.g., `12.0.4`. Do not use if specifying `package_source`. Default `nil`.
@@ -55,7 +58,7 @@ This delegates to the ctl command the service management command specified in th
 #### Properties
 
 - `ctl_command`: The "ctl" command, e.g. `chef-server-ctl`. This should be automatically detected by the library helper method `chef_ctl_command`, but may need to be specified if something changes, like a  new add-on is made available.
-- `service_name`: (name attribute) The name of the service to manage. Specify this like `package_name/service`, for example, `chef-server-core/rabbitmq`.
+- `service_name`: (name attribute) The name of the service to manage. Specify this like `product_name/service`, for example, `chef-server/rabbitmq`.
 
 #### Examples
 

libraries/chef_ingredient_provider.rb

@@ -34,25 +34,30 @@ def whyrun_supported?
       end
 
       action :install do
-        if new_resource.version
-          # We need Mixlib::Versioning in the library helpers for
-          # parsing the version string. But only if the version is
-          # specified!
-          chef_gem 'mixlib-versioning' do
-            compile_time true
-          end
-
-          require 'mixlib/versioning'
+        # We need Mixlib::Versioning in the library helpers for
+        # parsing the version string.
+        chef_gem "#{new_resource.product_name}-mixlib-versioning" do
+          package_name 'mixlib-versioning'
+          compile_time true
         end
 
+        require 'mixlib/versioning'
+
         cleanup_old_repo_config if ::File.exist?(old_ingredient_repo_file)
         include_recipe "#{package_repo_type}-chef" if new_resource.package_source.nil?
 
         package_resource = new_resource.package_source.nil? ? :package : local_package_resource
 
-        declare_resource package_resource, new_resource.package_name do
+        pkg_name = if new_resource.package_name
+                     new_resource.package_name
+                   else
+                     product_lookup(new_resource.product_name, new_resource.version)['package-name']
+                   end
+
+        declare_resource package_resource, new_resource.product_name do
+          package_name pkg_name
           options new_resource.options
-          version install_version if new_resource.version
+          version install_version if Mixlib::Versioning.parse(new_resource.version) > '0.0.0'
           source new_resource.package_source
           timeout new_resource.timeout
         end

libraries/chef_ingredient_resource.rb

@@ -23,20 +23,21 @@ class ChefIngredient < Chef::Resource::LWRPBase
       default_action :install
       state_attrs :installed
 
-      attribute :package_name, kind_of: String, name_attribute: true
+      attribute :product_name, kind_of: String, name_attribute: true
+      attribute :package_name, kind_of: String
       attribute :installed, kind_of: [TrueClass, FalseClass, NilClass], default: false
       attribute :reconfigure, kind_of: [TrueClass, FalseClass], default: false
       attribute :config, kind_of: [Hash, Mash], default: {}
 
-      # Attributes to install package from local file
+      # Attribute to install package from local file
       attribute :package_source, kind_of: String, default: nil
 
       # Attributes for reconfigure step
       attribute :ctl_command, kind_of: String
 
       # Attributes for package
       attribute :options, kind_of: String
-      attribute :version, kind_of: String, default: nil
+      attribute :version, kind_of: String, default: '0.0.0'
       attribute :timeout, kind_of: [Integer, String, NilClass], default: nil
     end
   end

libraries/helpers.rb

@@ -17,20 +17,12 @@
 
 module ChefIngredientCookbook
   module Helpers
-    # FIXME: (jtimberman) make this data we can change / use without
-    # having to update the library code (e.g., if we create new
-    # add-ons, or change any of these in the future).
-    def chef_ctl_command(pkg)
-      ctl_cmds = {
-        'chef-server-core' => 'chef-server-ctl',
-        'opscode-manage' => 'opscode-manage-ctl',
-        'opscode-push-jobs-server' => 'opscode-push-jobs-server-ctl',
-        'opscode-reporting' => 'opscode-reporting-ctl',
-        'opscode-analytics' => 'opscode-analytics-ctl',
-        'chef-sync' => 'chef-sync-ctl',
-        'supermarket' => 'supermarket-ctl'
-      }
-      ctl_cmds[pkg]
+    def chef_ctl_command(product)
+      if new_resource.respond_to?(:version)
+        product_lookup(product, new_resource.version)['ctl-command']
+      else
+        product_lookup(product)['ctl-command']
+      end
     end
 
     def local_package_resource
@@ -86,6 +78,67 @@ def reconfigure
         command "#{ctl_cmd} reconfigure"
       end
     end
+
+    # When updating this, also update PRODUCT_MATRIX.md
+    def product_matrix
+      {
+        'analytics'    => {'package-name' => 'opscode-analytics', 'ctl-command' => 'opscode-analytics-ctl' },
+        'chef'         => {'package-name' => 'chef',              'ctl-command' => nil                     },
+        'chef-ha'      => {'package-name' => 'chef-ha',           'ctl-command' => nil                     },
+        'chef-server'  => {'package-name' => 'chef-server-core',  'ctl-command' => 'chef-server-ctl'       },
+        'chef-sync'    => {'package-name' => 'chef-sync',         'ctl-command' => 'chef-sync-ctl'         },
+        'chefdk'       => {'package-name' => 'chefdk',            'ctl-command' => nil                     },
+        'delivery'     => {'package-name' => 'delivery',          'ctl-command' => 'delivery-ctl'          },
+        'delivery-cli' => {'package-name' => 'delivery-cli',      'ctl-command' => nil                     },
+        'manage'       => {'package-name' => 'chef-manage',       'ctl-command' => 'chef-manage-ctl'       },
+        'private-chef' => {'package-name' => 'private-chef',      'ctl-command' => 'private-chef-ctl'      },
+        'push-client'  => {'package-name' => 'chef-push-client',  'ctl-command' => nil                     },
+        'push-server'  => {'package-name' => 'chef-push-server',  'ctl-command' => 'chef-push-ctl'         },
+        'reporting'    => {'package-name' => 'opscode-reporting', 'ctl-command' => 'opscode-reporting-ctl' },
+        'supermarket'  => {'package-name' => 'supermarket',       'ctl-command' => 'supermarket-ctl'       },
+      }
+    end
+
+    # Version has a default value of 0.0.0 so that it is a valid
+    # string for the Mixlib::Versioning.parse method. This implies
+    # "latest", but "latest" is not a value that is valid for
+    # mixlib/versioning.
+    def product_lookup(product, version = '0.0.0')
+      unless product_matrix.has_key?(product)
+        Chef::Log.fatal("We don't have a product, '#{product}'. Please specify a valid product name:")
+        Chef::Log.fatal(product_matrix.keys.join(' '))
+        fail
+      end
+
+      require 'mixlib/versioning'
+      v = Mixlib::Versioning.parse(version)
+
+      data = product_matrix[product]
+
+      # We want to validate that we're getting a version that is valid
+      # for the Chef Server. However, since the default is 0.0.0,
+      # implying latest, we need to additionally ensure that the
+      # bottom version is something valid. If we don't have the check
+      # in the elsif, it will say that 0.0.0 is not a valid version.
+      if (product == 'chef-server')
+        if (v < Mixlib::Versioning.parse('12.0.0') && v > Mixlib::Versioning.parse('11.0.0'))
+          data['package-name'] = 'chef-server'
+        elsif (v < Mixlib::Versioning.parse('11.0.0')) && (v > Mixlib::Versioning.parse('1.0.0'))
+          Chef::Log.fatal("Invalid version specified, '#{version}' for #{product}!")
+          fail
+        end
+      elsif (product == 'manage') && (v < Mixlib::Versioning.parse('2.0.0'))
+        data['package-name'] = 'opscode-manage'
+        data['ctl-command'] = 'opscode-manage-ctl'
+      elsif (product == 'push-server') && (v < Mixlib::Versioning.parse('2.0.0'))
+        data['package-name'] = 'chef-push-server'
+        data['ctl-command'] = 'chef-push-ctl'
+      elsif (product == 'push-client') && (v < Mixlib::Versioning.parse('2.0.0'))
+        data['package-name'] = 'chef-push-client'
+      end
+
+      data
+    end
   end
 end
 

spec/centos_65_spec.rb

@@ -12,20 +12,20 @@
       end.converge('test::repo')
     end
 
-    it 'installs chef_ingredient[chef-server-core]' do
-      expect(centos_65).to install_chef_ingredient('chef-server-core')
+    it 'installs chef_ingredient[chef-server]' do
+      expect(centos_65).to install_chef_ingredient('chef-server')
     end
 
-    it 'installs yum_package[chef-server-core]' do
+    it 'installs yum_package[chef-server]' do
       expect(centos_65).to install_yum_package('chef-server-core')
     end
 
     it 'creates file[/tmp/chef-server-core.firstrun]' do
       expect(centos_65).to create_file('/tmp/chef-server-core.firstrun')
     end
 
-    it 'installs chef_server_ingredient[opscode-manage]' do
-      expect(centos_65).to install_chef_server_ingredient('opscode-manage')
+    it 'installs chef_server_ingredient[manage]' do
+      expect(centos_65).to install_chef_server_ingredient('manage')
     end
 
     it 'installs yum_package[opscode-manage]' do
@@ -60,23 +60,23 @@
   end
 
   context 'package iteration version specified' do
-    cached(:ubuntu_1404) do
+    cached(:centos_65) do
       ChefSpec::SoloRunner.new(
-        platform: 'ubuntu',
-        version: '14.04',
+        platform: 'centos',
+        version: '6.5',
         step_into: ['chef_ingredient']
       ) do |node|
         node.set['test']['chef-server-core']['version'] = '12.0.4-1'
       end.converge('test::repo')
     end
 
     it 'installs the mixlib-versioning gem' do
-      expect(ubuntu_1404).to install_chef_gem('mixlib-versioning')
+      expect(centos_65).to install_chef_gem('mixlib-versioning')
     end
 
     it 'installs the package with the release version string' do
-      expect(ubuntu_1404).to install_apt_package('chef-server-core').with(
-        version: '12.0.4-1'
+      expect(centos_65).to install_yum_package('chef-server-core').with(
+        version: '12.0.4-1.el6'
       )
     end
   end
@@ -117,7 +117,7 @@
     end
 
     it 'installs chef_ingredient[chef-server-core]' do
-      expect(centos_65).to install_chef_ingredient('chef-server-core')
+      expect(centos_65).to install_chef_ingredient('chef-server')
     end
 
     it 'uses the rpm_package provider instead of yum_package' do

spec/omnibus_service_spec.rb

@@ -10,15 +10,15 @@
   let(:log_message) { chef_run.log('I tell nginx to stop')}
 
   it 'allows the chef-server-core/rabbitmq service to restart' do
-    expect(chef_run).to restart_omnibus_service('chef-server-core/rabbitmq')
+    expect(chef_run).to restart_omnibus_service('chef-server/rabbitmq')
   end
 
   it 'restarts the rabbitmq service' do
     expect(chef_run).to run_execute('chef-server-ctl restart rabbitmq')
   end
 
   it 'has a log service that notifies the chef server nginx' do
-    expect(log_message).to notify('omnibus_service[chef-server-core/nginx]').to(:stop)
+    expect(log_message).to notify('omnibus_service[chef-server/nginx]').to(:stop)
   end
 
   it 'starts with a made up service' do

spec/ubuntu_1404_spec.rb

@@ -13,7 +13,7 @@
     end
 
     it 'installs chef_ingredient[chef-server-core]' do
-      expect(ubuntu_1404).to install_chef_ingredient('chef-server-core')
+      expect(ubuntu_1404).to install_chef_ingredient('chef-server')
     end
 
     it 'installs apt_package[chef-server-core]' do
@@ -24,8 +24,8 @@
       expect(ubuntu_1404).to create_file('/tmp/chef-server-core.firstrun')
     end
 
-    it 'installs chef_server_ingredient[opscode-manage]' do
-      expect(ubuntu_1404).to install_chef_server_ingredient('opscode-manage')
+    it 'installs chef_server_ingredient[manage]' do
+      expect(ubuntu_1404).to install_chef_server_ingredient('manage')
     end
 
     it 'installs apt_package[opscode-manage]' do
@@ -116,8 +116,8 @@
       end.converge('test::local')
     end
 
-    it 'installs chef_ingredient[chef-server-core]' do
-      expect(ubuntu_1404).to install_chef_ingredient('chef-server-core')
+    it 'installs chef_ingredient[chef-server]' do
+      expect(ubuntu_1404).to install_chef_ingredient('chef-server')
     end
 
     it 'uses the dpkg_package provider instead of apt_package' do

test/fixtures/cookbooks/test/recipes/local.rb

@@ -9,13 +9,13 @@
   mode '0644'
 end
 
-chef_ingredient 'chef-server-core' do
+chef_ingredient 'chef-server' do
   package_source "#{cache_path}/#{pkgname}"
   action :install
 end
 
 file '/tmp/chef-server-core.firstrun' do
   content 'ilovechef\n'
-  notifies :reconfigure, 'chef_ingredient[chef-server-core]'
+  notifies :reconfigure, 'chef_ingredient[chef-server]'
   action :create
 end

test/fixtures/cookbooks/test/recipes/omnibus_service.rb

@@ -1,15 +1,15 @@
 # we probably don't need/want to add this to a test kitchen suite.
 # This here so we can test with chefspec, really.
-omnibus_service 'chef-server-core/rabbitmq' do
+omnibus_service 'chef-server/rabbitmq' do
   action :restart
 end
 
-omnibus_service 'chef-server-core/nginx' do
+omnibus_service 'chef-server/nginx' do
   action :nothing
 end
 
 log 'I tell nginx to stop' do
-  notifies :stop, 'omnibus_service[chef-server-core/nginx]'
+  notifies :stop, 'omnibus_service[chef-server/nginx]'
 end
 
 omnibus_service 'never-never/land' do

test/fixtures/cookbooks/test/recipes/repo.rb

@@ -1,22 +1,22 @@
 # Chef Server Core
-chef_ingredient 'chef-server-core' do
+chef_ingredient 'chef-server' do
   version node['test']['chef-server-core']['version']
   action :install
 end
 
 file '/tmp/chef-server-core.firstrun' do
   content 'ilovechef\n'
-  notifies :reconfigure, 'chef_ingredient[chef-server-core]'
+  notifies :reconfigure, 'chef_ingredient[chef-server]'
   action :create
 end
 
 # Management Console - using the compat shim resource
-chef_server_ingredient 'opscode-manage' do
+chef_server_ingredient 'manage' do
   action :install
 end
 
 file '/tmp/opscode-manage.firstrun' do
   content 'ilovechef\n'
-  notifies :reconfigure, 'chef_server_ingredient[opscode-manage]'
+  notifies :reconfigure, 'chef_server_ingredient[manage]'
   action :create
 end