Merge branch 'xenon8/puppet-8-upgrade' into fanny/unit-tests

Author: fanny-jiang

.circleci/config.yml

@@ -230,18 +230,18 @@ jobs:
 
   kitchen-tests:
     machine:
-      image: ubuntu-2004:2024.08.1
+      image: ubuntu-2204:2024.08.1
     environment:
       STRICT_VARIABLES: 'yes'
-      RUBY_VERSION: '3.1.6'
+      RUBY_VERSION: '3.4.1'
     steps:
     - checkout
     - run:
-        name: Setup
+        name: Install libcurl4 and openssl
         command: |
           # Needed to bundle install a puppet_litmus gem dependency
-          sudo apt update -y
-          sudo apt install -y libcurl4 curl libcurl4-openssl-dev      
+          sudo apt update
+          sudo apt install -y libcurl4 curl libcurl4-openssl-dev
     - run:
         name: Install RVM
         command: |

CHANGELOG.md

@@ -2,11 +2,15 @@ Changes
 =======
 # 4.0.0 / 2025-02-01
 
-* [FEATURE] Add Support for Puppet 8 ([#823])
-* [FEATURE] Update Module Dependencies including updates for StdLib, migrating to newer functions where appropriate ([#823])
-* [BUGFIX] Fix issue where MSI path was not correctly parsed ([#823])
+* [FEATURE] Add Support for Puppet 8 ([#779])
+* [FEATURE] Update Module Dependencies including updates for StdLib, migrating to newer functions where appropriate ([#800])
+* [FEATURE] Class definitions updated with references to DataDog examples
 * [FEATURE] Update to CI Builds to work with Ruby 3
+* [BUGFIX] Fix issue where MSI path was not correctly parsed ([#814])
+* [DEPRECATE] Drop support for Puppet 6 and below
 * [DEPRECATE] Remove support for supply a String to the SSL_Verify option on the elasticsearch integration. We now use tls_verify which matches core DataDog code.
+* [DEPRECATE] Support for Jenkins integrations is removed
+* [DEPRECATE] No longer possible to use the custom metrics parameter when using the PostgresSQL class
 
 # 3.23.0 / 2024-12-09
 
@@ -936,13 +940,16 @@ Please read the [docs]() for more details.
 [#756]: https://github.com/DataDog/puppet-datadog-agent/issues/756
 [#761]: https://github.com/DataDog/puppet-datadog-agent/issues/761
 [#770]: https://github.com/DataDog/puppet-datadog-agent/issues/770
+[#779]: https://github.com/DataDog/puppet-datadog-agent/issues/779
 [#782]: https://github.com/DataDog/puppet-datadog-agent/issues/782
 [#785]: https://github.com/DataDog/puppet-datadog-agent/issues/785
 [#789]: https://github.com/DataDog/puppet-datadog-agent/issues/789
 [#790]: https://github.com/DataDog/puppet-datadog-agent/issues/790
 [#798]: https://github.com/DataDog/puppet-datadog-agent/issues/798
 [#799]: https://github.com/DataDog/puppet-datadog-agent/issues/799
+[#800]: https://github.com/DataDog/puppet-datadog-agent/issues/800
 [#806]: https://github.com/DataDog/puppet-datadog-agent/issues/806
+[#814]: https://github.com/DataDog/puppet-datadog-agent/issues/814
 [#820]: https://github.com/DataDog/puppet-datadog-agent/issues/820
 [#821]: https://github.com/DataDog/puppet-datadog-agent/issues/821
 [@Aramack]: https://github.com/Aramack

Gemfile

@@ -32,7 +32,7 @@ group :development do
   gem "kitchen-puppet"
   gem "kitchen-docker", '~> 3.0.0',              require: false
   gem "kitchen-verifier-serverspec"
-  gem "rexml", '= 3.2.6',                        require: false
+  gem "rexml", '~> 3.4.0',                       require: false
   gem "mixlib-shellout", "~> 2.2.7",             platforms: [:ruby]
   if ruby_version >= Gem::Version.new('2.5') && ruby_version < Gem::Version.new('3.1')
     gem "test-kitchen", '= 3.0.0', platforms: [:ruby]

Gemfile.lock

@@ -345,7 +345,7 @@ GEM
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
     retryable (3.0.5)
-    rexml (3.2.6)
+    rexml (3.4.0)
     rgen (0.9.1)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
@@ -544,7 +544,7 @@ DEPENDENCIES
   puppet_litmus (~> 1.0)
   puppetlabs_spec_helper (~> 8.0)
   rb-readline (= 0.5.5)
-  rexml (= 3.2.6)
+  rexml (~> 3.4.0)
   rspec-puppet-facts (~> 4.0)
   rubocop (~> 1.50.0)
   rubocop-performance (= 1.16.0)

environments/etc/Puppetfile

@@ -1,9 +1,8 @@
 # Track control branch and fall-back to master if no matching branch.
 mod 'datadog_agent', :local => true
-mod 'puppetlabs-apt', '2.4.0'
-mod 'puppetlabs-concat', '4.0.0'
-mod 'puppetlabs-puppetserver_gem', '1.0.0'
-mod 'puppetlabs-stdlib', '4.25.0'
-mod 'puppetlabs-powershell', '2.3.0'
-mod 'puppetlabs-yumrepo_core', '1.0.3'
-mod 'puppet-zypprepo', '3.1.0'
+mod 'puppetlabs-apt', '10.0.1'
+mod 'puppetlabs-concat', '9.1.0'
+mod 'puppetlabs-stdlib', '9.7.0'
+mod 'puppetlabs-powershell', '6.0.2'
+mod 'puppetlabs-yumrepo_core', '2.1.0'
+mod 'puppet-zypprepo', '5.0.0'

kitchen.yml

@@ -14,58 +14,55 @@ provisioner:
   custom_pre_apply_command: 'cp -r /tmp/modules/* /tmp/kitchen/modules/'
 
 platforms:
-- name: centos-7-puppet-5
-  driver_config:
-    # we use a custom image that runs systemd
-    image: 'datadog/docker-library:chef_kitchen_systemd_centos_7'
-    run_command: /root/start.sh
+- name: ubuntu-24.04-puppet-8
   driver:
+    image: 'ubuntu:24.04'
     provision_command:
-    - rpm -ivh http://yum.puppetlabs.com/puppet5-release-el-7.noarch.rpm #installs the puppet-agent repo
-    - yum install -y puppet-agent rubygems
+    - apt-get install -y apt-utils apt-transport-https ca-certificates
+    - wget https://apt.puppet.com/puppet8-release-noble.deb
+    - dpkg -i puppet8-release-noble.deb #installs the puppet-agent repo
+    - apt-get update
+    - apt-get install -y puppet-agent rubygems ruby-dev make gcc
     - ln -s /opt/puppetlabs/bin/puppet /usr/bin/puppet
 
     - mkdir /home/kitchen/puppet
     - printf <%= File.read('environments/etc/Puppetfile').inspect %> > /home/kitchen/puppet/Puppetfile
     - printf <%= File.read('environments/etc/Gemfile').inspect %> > /home/Gemfile
 
     - gem install bundler -v '= 2.4.13'
-    # we use bundle to install gems and to lock dependencies versions of semantic_puppet and multipart-post
     - cd /home && bundle install
     - cd /home/kitchen/puppet && r10k puppetfile install --moduledir=/tmp/modules
 
-- name: rocky-8-puppet-5
-  driver_config:
-    # we use a custom image that runs systemd
-    image: 'datadog/docker-library:chef_kitchen_systemd_rocky_8'
-    platform: rhel # kitchen-docker doesn't recognize rocky otherwise
-    run_command: /root/start.sh
+- name: ubuntu-22.04-puppet-8
   driver:
+    image: 'ubuntu:22.04'
     provision_command:
-    - dnf install -y https://yum.puppetlabs.com/puppet7-release-el-8.noarch.rpm #installs the puppet-agent repo
-    - dnf install -y puppet-agent rubygems
+    - apt-get update
+    - apt-get install -y apt-utils apt-transport-https ca-certificates wget
+    - wget https://apt.puppet.com/puppet8-release-jammy.deb
+    - dpkg -i puppet8-release-jammy.deb #installs the puppet-agent repo
+    - apt-get update
+    - apt-get install -y puppet-agent rubygems ruby-dev make gcc
     - ln -s /opt/puppetlabs/bin/puppet /usr/bin/puppet
 
-    - mkdir /home/kitchen/puppet
+    - mkdir /home/kitchen/puppet -p
     - printf <%= File.read('environments/etc/Puppetfile').inspect %> > /home/kitchen/puppet/Puppetfile
     - printf <%= File.read('environments/etc/Gemfile').inspect %> > /home/Gemfile
 
     - gem install bundler -v '= 2.4.13'
-
     - cd /home && bundle install
     - cd /home/kitchen/puppet && r10k puppetfile install --moduledir=/tmp/modules
 
-- name: ubuntu-1604-puppet-6
-  driver_config:
-    # we use the official image
-    image: 'ubuntu:16.04'
+- name: ubuntu-20.04-puppet-8
   driver:
+    image: 'ubuntu:20.04'
+    docker_platform: linux/amd64
     provision_command:
-    - apt-get install -y apt-utils apt-transport-https ca-certificates
-    - wget https://apt.puppetlabs.com/puppet6-release-xenial.deb
-    - dpkg -i puppet6-release-xenial.deb #installs the puppet-agent repo
+    - apt-get install -y apt-utils apt-transport-https ca-certificates make gcc
+    - wget https://apt.puppet.com/puppet8-release-focal.deb
+    - dpkg -i puppet8-release-focal.deb #installs the puppet-agent repo
     - apt-get update
-    - apt-get install -y puppet-agent rubygems
+    - apt-get install -y puppet-agent rubygems ruby-dev
     - ln -s /opt/puppetlabs/bin/puppet /usr/bin/puppet
 
     - mkdir /home/kitchen/puppet
@@ -76,40 +73,99 @@ platforms:
     - cd /home && bundle install
     - cd /home/kitchen/puppet && r10k puppetfile install --moduledir=/tmp/modules
 
-- name: opensuse/leap-15
-  # Workaround for flakes on initializing opensuse/leap-15:
-  # => SCP did not finish successfully (255):  (Net::SCP::Error)
-  transport:
-    max_ssh_sessions: 1
-  driver_config:
-    # we use a custom image that runs systemd
-    image: 'datadog/docker-library:chef_kitchen_systemd_opensuse_leap_15'
-    run_command: /root/start.sh
-
+# mirrorlist.centos.org is no longer available for <= centos8/centos-stream8
+# - name: centos-stream8-puppet-8 
+#   driver_config:
+#     image: 'quay.io/centos/centos:stream9'
+#     platform: centosstream
+#   driver:
+#     use_sudo: true
+#     privileged: true
+#     provision_command:
+#     - rpm -Uvh https://yum.puppet.com/puppet8-release-el-8.noarch.rpm #installs the puppet-agent repo
+#     - yum install -y puppet-agent rubygems ruby-devel make gcc
+#     - ln -s /opt/puppetlabs/bin/puppet /usr/bin/puppet
+
+#     - mkdir /home/kitchen/puppet -p
+#     - printf <%= File.read('environments/etc/Puppetfile').inspect %> > /home/kitchen/puppet/Puppetfile
+#     - printf <%= File.read('environments/etc/Gemfile').inspect %> > /home/Gemfile
+
+#     - gem install bundler -v '= 2.4.13'
+#     # we use bundle to install gems and to lock dependencies versions of semantic_puppet and multipart-post
+#     - cd /home && bundle install
+#     - cd /home/kitchen/puppet && r10k puppetfile install --moduledir=/tmp/modules
+
+- name: centos-stream9-puppet-8
   driver:
+    image: 'quay.io/centos/centos:stream9'
+    platform: centosstream
+    use_sudo: true
+    privileged: true
     provision_command:
-    - zypper ar -G https://yum.puppet.com/puppet/sles/15/x86_64/ puppet-repo
-    - zypper install -y puppet-agent ruby=2.5
+    - rpm -Uvh https://yum.puppet.com/puppet8-release-el-9.noarch.rpm #installs the puppet-agent repo
+    - yum install -y puppet-agent rubygems ruby-devel
+    - dnf group install -y "Development Tools"
+    - ln -s /opt/puppetlabs/bin/puppet /usr/bin/puppet
+
+    - mkdir /home/kitchen/puppet -p
+    - printf <%= File.read('environments/etc/Puppetfile').inspect %> > /home/kitchen/puppet/Puppetfile
+    - printf <%= File.read('environments/etc/Gemfile').inspect %> > /home/Gemfile
+
     - gem install bundler -v '= 2.4.13'
-    - gem install net-ssh -v '= 6.1.0'
-    - gem install rspec-its -v '= 1.3.1'
-    - gem install serverspec rspec
-    - ln -s /usr/bin/rspec.ruby2.5 /usr/bin/rspec
-    - ln -s /opt/puppetlabs/puppet/bin/puppet /usr/bin/puppet
+    # we use bundle to install gems and to lock dependencies versions of semantic_puppet and multipart-post
+    - cd /home && bundle install
+    - cd /home/kitchen/puppet && r10k puppetfile install --moduledir=/tmp/modules
+
+- name: rocky-9-puppet-8
+  driver:
+    image: 'rockylinux:9.3'
+    platform: centosstream # kitchen-docker has issues installing packages otherwises
+    provision_command:
+    - dnf install -y https://yum.puppet.com/puppet8-release-el-9.noarch.rpm #installs the puppet-agent repo
+    - dnf install -y puppet-agent rubygems ruby-devel
+    - dnf group install -y "Development Tools"
+    - ln -s /opt/puppetlabs/bin/puppet /usr/bin/puppet
+
     - mkdir /home/kitchen/puppet
     - printf <%= File.read('environments/etc/Puppetfile').inspect %> > /home/kitchen/puppet/Puppetfile
     - printf <%= File.read('environments/etc/Gemfile').inspect %> > /home/Gemfile
 
-    - cd /home && bundle.ruby2.5 install
+    - gem install bundler -v '= 2.4.13'
+
+    - cd /home && bundle install
     - cd /home/kitchen/puppet && r10k puppetfile install --moduledir=/tmp/modules
 
-verifier:
-  name: serverspec
+# - name: opensuse/leap-15
+#     # Workaround for flakes on initializing opensuse/leap-15:
+#   # => SCP did not finish successfully (255):  (Net::SCP::Error)
+#   transport:
+#     max_ssh_sessions: 1
+#   driver_config:
+#     # we use a custom image that runs systemd
+#     image: 'datadog/docker-library:chef_kitchen_systemd_opensuse_leap_15'
+#     run_command: /root/start.sh
+#   driver:
+#     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 -v '= 1.17.3'
+#       - gem install net-ssh -v '= 6.1.0'
+#       - gem install rspec-its -v '= 1.3.1'
+#       - 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
+#       - printf <%= File.read('environments/etc/Puppetfile').inspect %> > /home/kitchen/puppet/Puppetfile
+#       - printf <%= File.read('environments/etc/Gemfile').inspect %> > /home/Gemfile
+
+#       - cd /home && bundle.ruby2.5 install
+#       - cd /home/kitchen/puppet && r10k puppetfile install --moduledir=/tmp/modules
 
 suites:
 - name: dd-agent
   manifests: init.pp
   verifier:
+    name: serverspec
     default_pattern: true
     additional_install_commmand: source /etc/profile.d/rvm.sh
     env_vars:
@@ -122,6 +178,7 @@ suites:
   provisioner:
     manifests_path: environments/etc/installer-manifests
   verifier:
+    name: serverspec
     default_pattern: true
     additional_install_commmand: source /etc/profile.d/rvm.sh
     env_vars:

manifests/integrations/activemq_xml.pp

@@ -1,6 +1,15 @@
 # Class: datadog_agent::integrations::activemq_xml
 #
-# This class will install the necessary configuration for the activemq_xml integration
+# This class will install the necessary configuration for the activemq_xml integration.
+#
+# See the sample activemq.d/conf.yaml for all available configuration options.
+# https://github.com/DataDog/integrations-core/blob/master/activemq/datadog_checks/activemq/data/conf.yaml.example 
+#
+# See the metrics.yaml file for the list of default collected metrics.
+# https://github.com/DataDog/integrations-core/blob/master/activemq/datadog_checks/activemq/data/metrics.yaml
+#
+# This check has a limit of 350 metrics per instance. If you require 
+# additional metrics, contact Datadog Support at https://docs.datadoghq.com/help/
 #
 # Parameters:
 #   $url

manifests/integrations/apache.pp

@@ -2,6 +2,9 @@
 #
 # This class will install the necessary configuration for the apache integration
 #
+# See the sample apache.d/conf.yaml for all available configuration options.
+# https://github.com/DataDog/integrations-core/blob/master/apache/datadog_checks/apache/data/conf.yaml.example
+#
 # Parameters:
 #   $url:
 #       The URL for apache status URL handled by mod-status.

manifests/integrations/cacti.pp

@@ -2,6 +2,9 @@
 #
 # This class will install the necessary configuration for the cacti integration
 #
+# See the sample cacti.d/conf.yaml for all available configuration options.
+# https://github.com/DataDog/integrations-core/blob/master/cacti/datadog_checks/cacti/data/conf.yaml.example
+# 
 # Parameters:
 #   $host:
 #       The host cacti MySQL db is running on

manifests/integrations/cassandra.pp

@@ -3,6 +3,12 @@
 # This class will install the necessary configuration for the Cassandra
 # integration.
 #
+# See the sample cassandra.d/conf.yaml for all available configuration options.
+# https://github.com/DataDog/integrations-core/blob/master/cassandra/datadog_checks/cassandra/data/conf.yaml.example
+#
+# See the metrics.yaml file for the list of default collected metrics.
+# https://github.com/DataDog/integrations-core/blob/master/cassandra/datadog_checks/cassandra/data/metrics.yaml
+#
 # This check has a limit of 350 metrics per instance. If you require 
 # additional metrics, contact Datadog Support at https://docs.datadoghq.com/help/
 #

manifests/integrations/ceph.pp

@@ -2,6 +2,9 @@
 #
 # This class will install the necessary configuration for the ceph integration
 #
+# See the sample ceph.d/conf.yaml for all available configuration options
+# https://github.com/DataDog/integrations-core/blob/master/ceph/datadog_checks/ceph/data/conf.yaml.example
+#
 # Parameters:
 #   $tags
 #       Optional array of tags

manifests/integrations/consul.pp

@@ -2,6 +2,9 @@
 #
 # This class will install the necessary configuration for the consul integration
 #
+# See the sample consul.d/conf.yaml for all available configuration options
+# https://github.com/DataDog/integrations-core/blob/master/consul/datadog_checks/consul/data/conf.yaml.example
+#
 # Parameters:
 #   $url:
 #     The URL for consul

manifests/integrations/directory.pp

@@ -2,6 +2,9 @@
 #
 # This class will install the necessary config to hook the directory in the agent
 #
+# See the sample directory.d/conf.yaml for all available configuration options
+# https://github.com/DataDog/integrations-core/blob/master/directory/datadog_checks/directory/data/conf.yaml.example
+#
 # Parameters:
 #   directory
 #       (Required) - string, the directory path to monitor