[reports] make gem provider configurable at the datadog-agent class level. (DataDog#486)

* [reports] make gem provider configurable at the datadog-agent class level.

* Add default value for gem provider in report class

* [reports] adding spec test for alternative gem providers + fix

* [docs] adding note regarding gem provider for dogapi

Author: remicalixte

.gitignore

@@ -9,3 +9,6 @@ Gemfile.lock
 .ruby-version
 
 tests/.vagrant
+
+# mac stuff
+.DS_Store

README.md

@@ -123,6 +123,7 @@ Once the `datadog_agent` module is installed on your `puppetserver`/`puppetmaste
       - If you are on Puppet Enterprise or POSS (ie. >=3.7.0), there is a soft dependency for reporting on the `puppetserver_gem` module. Install with `puppet module install puppetlabs-puppetserver_gem` - installing manually with `gem` does *not* work.
       - You may install `dogapi-rb` with `gem` as the system-level Ruby is used.
       - The gem provider is configurable by setting it to `puppetserver_gem` (set by default on PE/POSS (>=3.7.0)) or `gem` if on older versions of Puppet.
+        - For users running puppet in standalone/masterless mode you will need to set the `puppet_gem_provider` to `puppet_gem` (or `gem` depending on versions) to ensure the `dogapi-rb` is available.
 
 3. Include any other integrations you want the agent to use, for example:
 

manifests/init.pp

@@ -235,6 +235,7 @@
   $facts_to_tags = [],
   $puppet_run_reports = false,
   $puppetmaster_user = $settings::user,
+  String $puppet_gem_provider = $datadog_agent::params::gem_provider,
   $non_local_traffic = false,
   $dogstreams = [],
   $log_level = 'info',
@@ -696,6 +697,7 @@
     class { 'datadog_agent::reports':
       api_key                   => $api_key,
       datadog_site              => $datadog_site,
+      puppet_gem_provider       => $puppet_gem_provider,
       dogapi_version            => $datadog_agent::params::dogapi_version,
       puppetmaster_user         => $puppetmaster_user,
       hostname_extraction_regex => $hostname_extraction_regex,

manifests/params.pp

@@ -22,6 +22,7 @@
   $service_name                   = 'datadog-agent'
   $agent_version                  = 'latest'
   $dogapi_version                 = 'installed'
+  $gem_provider                   = 'puppetserver_gem'
   $conf_dir_purge                 = false
   $apt_default_release            = 'stable'
   $apm_default_enabled            = false

manifests/reports.pp

@@ -19,10 +19,10 @@
   $dogapi_version,
   $hostname_extraction_regex = undef,
   $datadog_site = 'datadoghq.com',
-) {
+  $puppet_gem_provider = $datadog_agent::params::gem_provider,
+) inherits datadog_agent::params {
 
   include datadog_agent
-  include datadog_agent::params
   $rubydev_package = $datadog_agent::params::rubydev_package
 
   # check to make sure that you're not installing rubydev somewhere else
@@ -51,6 +51,6 @@
 
   package{ 'dogapi':
     ensure   => $dogapi_version,
-    provider => 'puppetserver_gem',
+    provider => $puppet_gem_provider,
   }
 }

spec/classes/datadog_agent_reports_spec.rb

@@ -99,6 +99,45 @@
     end
   end
 
+  context 'specific gem provider' do
+    let(:params) do
+      {
+        api_key: 'notanapikey',
+        puppetmaster_user: 'puppet',
+        dogapi_version: '1.2.2',
+        puppet_gem_provider: 'gem',
+
+      }
+    end
+    let(:conf_file) { '/etc/datadog-agent/datadog-reports.yaml' }
+
+    describe "datadog_agent class puppet gem provider override" do
+      let(:facts) do
+        {
+          operatingsystem: 'Debian',
+          osfamily: 'debian'
+        }
+      end
+
+      it { should contain_class('ruby').with_rubygems_update(false) }
+      it { should contain_class('ruby::params') }
+      it { should contain_package('ruby').with_ensure('installed') }
+      it { should contain_package('rubygems').with_ensure('installed') }
+
+      it do
+        should contain_package('ruby-dev')\
+          .with_ensure('installed')\
+          .that_comes_before('Package[dogapi]')
+      end
+
+      it do
+        should contain_package('dogapi')\
+          .with_ensure('1.2.2')
+          .with_provider('gem')
+      end
+    end
+  end
+
   context 'EU site in report' do
     let(:params) do
       {