Require datadog_agent instead of including it (#725)

Also fixes and expands the kitchen tests.

Author: albertvaka

environments/etc/manifests/site.pp

@@ -1,5 +1,25 @@
 node default {
+
   class { 'datadog_agent':
-    api_key => 'somenonnullapikeythats32charlong',
+    api_key             => 'somenonnullapikeythats32charlong',
+    agent_extra_options => {
+        use_http => true,
+    },
+    facts_to_tags       => ['osfamily'],
+    integrations        => {
+      'ntp' => {
+        init_config => {},
+        instances   => [{
+            offset_threshold => 30,
+        }],
+      },
+    },
   }
+
+  class { 'datadog_agent::integrations::apache':
+    url      => 'http://example.com/server-status?auto',
+    username => 'status',
+    password => 'hunter1',
+  }
+
 }

kitchen.yml

@@ -28,6 +28,7 @@ platforms:
         - mkdir /home/kitchen/puppet
         - printf <%= File.read('environments/etc/Puppetfile').inspect %> > /home/kitchen/puppet/Puppetfile
 
+        - gem install bundler -v '= 1.17.3'
         - gem install r10k -v 2.6.7
         - cd /home/kitchen/puppet && r10k puppetfile install --moduledir=/tmp/modules
 
@@ -45,6 +46,7 @@ platforms:
         - mkdir /home/kitchen/puppet
         - printf <%= File.read('environments/etc/Puppetfile').inspect %> > /home/kitchen/puppet/Puppetfile
 
+        - gem install bundler -v '= 1.17.3'
         - gem install r10k -v 2.6.7
         - cd /home/kitchen/puppet && r10k puppetfile install --moduledir=/tmp/modules
 
@@ -64,6 +66,7 @@ platforms:
         - mkdir /home/kitchen/puppet
         - printf <%= File.read('environments/etc/Puppetfile').inspect %> > /home/kitchen/puppet/Puppetfile
 
+        - gem install bundler -v '= 1.17.3'
         - gem install r10k -v 2.6.7
         - cd /home/kitchen/puppet && r10k puppetfile install --moduledir=/tmp/modules
 
@@ -81,7 +84,8 @@ platforms:
       provision_command:
         - zypper ar -G https://yum.puppet.com/puppet/sles/15/x86_64/ puppet-repo
         - zypper install -y puppet-agent ruby=2.5
-        - gem install bundler serverspec rspec
+        - gem install bundler -v '= 1.17.3'
+        - gem install serverspec rspec
         - ln -s /usr/bin/rspec.ruby2.5 /usr/bin/rspec
         - ln -s /opt/puppetlabs/puppet/bin/puppet /usr/bin/puppet
         - mkdir /home/kitchen/puppet

manifests/install_integration.pp

@@ -5,7 +5,7 @@
   Boolean                   $third_party      = false,
 ){
 
-  include datadog_agent
+  require ::datadog_agent
 
   if $ensure == 'present' {
 

manifests/integration.pp

@@ -7,7 +7,9 @@
   Enum['present', 'absent'] $ensure = 'present',
 ){
 
-  include datadog_agent
+  # We can't `require ::datadog_agent` from here since this class is used by the
+  # datadog_agent class, causing a dependency cycle. If using this class
+  # directly, you should define datadog_agent before datadog_agent::integration.
 
   if $::datadog_agent::_agent_major_version > 5 {
     $dst_dir = "${datadog_agent::params::conf_dir}/${integration}.d"

manifests/integrations/activemq_xml.pp

@@ -52,7 +52,7 @@
   Optional[Array[String]] $detailed_subscribers = [],
   Optional[Array] $instances                    = undef,
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   $legacy_dst = "${datadog_agent::params::legacy_conf_dir}/activemq_xml.yaml"
   if $::datadog_agent::_agent_major_version > 5 {

manifests/integrations/apache.pp

@@ -33,7 +33,7 @@
   Array $tags                     = [],
   Boolean $disable_ssl_validation = false
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   $legacy_dst = "${datadog_agent::params::legacy_conf_dir}/apache.yaml"
   if $::datadog_agent::_agent_major_version > 5 {

manifests/integrations/cacti.pp

@@ -18,7 +18,7 @@
   $mysql_password = undef,
   $rrd_path = '/var/lib/cacti/rra/',
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   $legacy_dst = "${datadog_agent::params::legacy_conf_dir}/cacti.yaml"
   if $::datadog_agent::_agent_major_version > 5 {

manifests/integrations/ceph.pp

@@ -17,7 +17,7 @@
   Array $tags = [ 'name:ceph_cluster' ],
   String $ceph_cmd = '/usr/bin/ceph',
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   file { '/etc/sudoers.d/datadog_ceph':
     content => "# This file is required for dd ceph \ndd-agent ALL=(ALL) NOPASSWD:/usr/bin/ceph\n"

manifests/integrations/consul.pp

@@ -33,7 +33,7 @@
   Boolean $new_leader_checks         = true,
   Optional[Array] $service_whitelist = []
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   $legacy_dst = "${datadog_agent::params::legacy_conf_dir}/consul.yaml"
   if $::datadog_agent::_agent_major_version > 5 {

manifests/integrations/directory.pp

@@ -65,7 +65,7 @@
   String $pattern            = '',
   Optional[Array] $instances = undef,
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   if !$instances and $directory == '' {
     fail('bad directory argument and no instances hash provided')

manifests/integrations/disk.pp

@@ -81,7 +81,7 @@
   Optional[String] $excluded_disk_re       = undef,  # deprecated in agent versions >6.9
   Optional[String] $excluded_mountpoint_re = undef,  # deprecated in agent versions >6.9
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   validate_legacy('Optional[String]', 'validate_re', $all_partitions, '^(no|yes)$')
 

manifests/integrations/dns_check.pp

@@ -33,7 +33,7 @@
     }
   ]
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   $legacy_dst = "${datadog_agent::params::legacy_conf_dir}/dns_check.yaml"
   if $::datadog_agent::_agent_major_version > 5 {

manifests/integrations/docker_daemon.pp

@@ -55,7 +55,7 @@
   $collect_labels_as_tags = [],
   $event_attributes_as_tags = [],
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   exec { 'dd-agent-should-be-in-docker-group':
     command => "/usr/sbin/usermod -aG ${group} ${datadog_agent::params::dd_user}",

manifests/integrations/elasticsearch.pp

@@ -37,7 +37,7 @@
   Optional[String] $username           = undef,
   Optional[Array] $instances           = undef
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   # $ssl_verify can be a bool or a string
   # https://github.com/DataDog/dd-agent/blob/master/checks.d/elastic.py#L454-L455

manifests/integrations/fluentd.pp

@@ -21,7 +21,7 @@
   $monitor_agent_url = 'http://localhost:24220/api/plugins.json',
   Optional[Array] $plugin_ids = [],
 ) inherits datadog_agent::params {
-  include ::datadog_agent
+  require ::datadog_agent
 
   $legacy_dst = "${datadog_agent::params::legacy_conf_dir}/fluentd.yaml"
   if $::datadog_agent::_agent_major_version > 5 {

manifests/integrations/generic.pp

@@ -21,7 +21,7 @@
   Optional[String] $integration_name     = undef,
   Optional[String] $integration_contents = undef,
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   $legacy_dst = "${datadog_agent::params::legacy_conf_dir}/${integration_name}.yaml"
   if $::datadog_agent::_agent_major_version > 5 {

manifests/integrations/haproxy.pp

@@ -22,7 +22,7 @@
   $options                   = {},
   Optional[Array] $instances = undef
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   if !$instances and $url {
     $_instances = [{

manifests/integrations/http_check.pp

@@ -199,7 +199,7 @@
   Optional[Array] $instances  = undef,
   $ca_certs  = undef,
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   if !$instances and $url {
     $_instances = [{

manifests/integrations/jenkins.pp

@@ -16,7 +16,7 @@
 class datadog_agent::integrations::jenkins(
   $path = '/var/lib/jenkins'
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   $legacy_dst = "${datadog_agent::params::legacy_conf_dir}/jenkins.yaml"
   if $::datadog_agent::_agent_major_version > 5 {

manifests/integrations/jmx.pp

@@ -65,7 +65,7 @@
   $init_config = {},
   $instances   = [],
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   $legacy_dst = "${datadog_agent::params::legacy_conf_dir}/jmx.yaml"
   if $::datadog_agent::_agent_major_version > 5 {

manifests/integrations/kafka.pp

@@ -65,7 +65,7 @@
   Optional[Hash[String[1], String[1]]] $tags = undef,
   Optional[Array[Hash[String[1], Data]]] $instances = undef,
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   if !$instances and $host and $port {
     $servers = [{

manifests/integrations/kong.pp

@@ -32,7 +32,7 @@
     }
   ]
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   $legacy_dst = "${datadog_agent::params::legacy_conf_dir}/kong.yaml"
   if $::datadog_agent::_agent_major_version > 5 {

manifests/integrations/kubernetes.pp

@@ -30,7 +30,7 @@
   $tags = [],
 
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   $legacy_dst = "${datadog_agent::params::legacy_conf_dir}/kubernetes.yaml"
   if $::datadog_agent::_agent_major_version > 5 {

manifests/integrations/kubernetes_state.pp

@@ -22,7 +22,7 @@
   $tags = [],
 
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   $legacy_dst = "${datadog_agent::params::legacy_conf_dir}/kubernetes_state.yaml"
   if $::datadog_agent::_agent_major_version > 5 {

manifests/integrations/linux_proc_extras.pp

@@ -16,7 +16,7 @@
 class datadog_agent::integrations::linux_proc_extras(
   $tags = [],
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   $legacy_dst = "${datadog_agent::params::legacy_conf_dir}/linux_proc_extras.yaml"
   if $::datadog_agent::_agent_major_version > 5 {

manifests/integrations/logs.pp

@@ -40,7 +40,7 @@
   Array $logs = [],
 ) inherits datadog_agent::params {
   unless $::datadog_agent::_agent_major_version == 5 {
-    include datadog_agent
+    require ::datadog_agent
 
     file { "${datadog_agent::params::conf_dir}/logs.yaml":
       ensure  => file,

manifests/integrations/marathon.pp

@@ -16,7 +16,7 @@
   $marathon_timeout = 5,
   $url = 'http://localhost:8080'
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   $legacy_dst = "${datadog_agent::params::legacy_conf_dir}/marathon.yaml"
   if $::datadog_agent::_agent_major_version > 5 {

manifests/integrations/memcache.pp

@@ -38,7 +38,7 @@
   Variant[Boolean, String] $slabs = false,
   Optional[Array] $instances      = undef,
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   if !$instances and $url {
     $_instances = [{

manifests/integrations/mesos_master.pp

@@ -16,7 +16,7 @@
   $mesos_timeout = 10,
   $url = 'http://localhost:5050'
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   if $::datadog_agent::_agent_major_version > 5 {
     $dst_dir = "${datadog_agent::params::conf_dir}/mesos.d"

manifests/integrations/mongo.pp

@@ -59,7 +59,7 @@
 class datadog_agent::integrations::mongo(
   Array $servers = [{'host' => 'localhost', 'port' => '27017'}]
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   $legacy_dst = "${datadog_agent::params::legacy_conf_dir}/mongo.yaml"
   if $::datadog_agent::_agent_major_version > 5 {

manifests/integrations/mysql.pp

@@ -81,7 +81,7 @@
   Optional[Array] $instances               = undef,
   Optional[Array] $logs                    = [],
   ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   if ($host == undef and $sock == undef) or
     ($host != undef and $port == undef and $sock == undef) {

manifests/integrations/network.pp

@@ -25,7 +25,7 @@
   String $excluded_interface_re = '',
   Boolean $combine_connection_states = true,
 ) inherits datadog_agent::params {
-  include ::datadog_agent
+  require ::datadog_agent
 
   $legacy_dst = "${datadog_agent::params::legacy_conf_dir}/network.yaml"
   if $::datadog_agent::_agent_major_version > 5 {

manifests/integrations/nginx.pp

@@ -61,7 +61,7 @@
   Array $instances = [],
   Optional[Array] $logs = undef,
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   $legacy_dst = "${datadog_agent::params::legacy_conf_dir}/nginx.yaml"
   if $::datadog_agent::_agent_major_version > 5 {

manifests/integrations/ntp.pp

@@ -30,7 +30,7 @@
   $version          = undef,
   $timeout          = undef,
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   $legacy_dst = "${datadog_agent::params::legacy_conf_dir}/ntp.yaml"
   if $::datadog_agent::_agent_major_version > 5 {

manifests/integrations/oom_kill.pp

@@ -22,7 +22,7 @@
 class datadog_agent::integrations::oom_kill(
   Array $instances = [],
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   $dst_dir = "${datadog_agent::params::conf_dir}/oom_kill.d"
   file { $dst_dir:

manifests/integrations/pgbouncer.pp

@@ -51,7 +51,7 @@
   Array $tags = [],
   Array $pgbouncers = [],
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   $legacy_dst = "${datadog_agent::params::legacy_conf_dir}/pgbouncer.yaml"
   if $::datadog_agent::_agent_major_version > 5 {

manifests/integrations/php_fpm.pp

@@ -35,7 +35,7 @@
   $instances        = undef,
   $use_fastcgi      = 'false'
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   if !$instances {
     $_instances = [{

manifests/integrations/postfix.pp

@@ -34,7 +34,7 @@
   Optional[Array] $tags      = [],
   Optional[Array] $instances = undef,
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   if !$instances and $directory {
     $_instances = [{

manifests/integrations/postgres.pp

@@ -100,7 +100,7 @@
   Hash $custom_metrics                   = {},
   Optional[Array] $instances             = undef,
 ) inherits datadog_agent::params {
-  include datadog_agent
+  require ::datadog_agent
 
   $legacy_dst = "${datadog_agent::params::legacy_conf_dir}/postgres.yaml"
   if $::datadog_agent::_agent_major_version > 5 {