Initial puppet module for linux (#405)

.circleci/config.yml

@@ -262,6 +262,10 @@ workflows:
           filters:
             tags:
               only: /^v[0-9]+\.[0-9]+\.[0-9]+.*/
+      - puppet-test:
+          filters:
+            tags:
+              only: /^v[0-9]+\.[0-9]+\.[0-9]+.*/
 
 jobs:
   setup-environment:
@@ -481,7 +485,7 @@ jobs:
           name: Check for relevant changes
           command: |
             # Only run installer tests for main branch, tags, or if the branch has relevant changes
-            if [[ "$CIRCLE_BRANCH" != "main" ]] && [[ -z "${CIRCLE_TAG:-}" ]] && ! .circleci/scripts/changes-include internal/buildscripts/packaging; then
+            if [[ "$CIRCLE_BRANCH" != "main" ]] && [[ -z "${CIRCLE_TAG:-}" ]] && ! .circleci/scripts/changes-include internal/buildscripts/packaging/installer internal/buildscripts/packaging/tests; then
               echo "SKIP_TESTS=yes" >> $BASH_ENV
             fi
       - install_pytest
@@ -537,3 +541,49 @@ jobs:
             $msi_path = Resolve-Path .\dist\splunk-otel-collector*.msi
             $env:VERIFY_ACCESS_TOKEN = "false"
             .\internal\buildscripts\packaging\installer\install.ps1 -access_token "testing123" -msi_path "$msi_path" -mode "<< parameters.mode >>"
+
+  puppet-test:
+    machine:
+      image: ubuntu-1604:202007-01
+      docker_layer_caching: true
+    parallelism: 2
+    steps:
+      - checkout
+      - run:
+          name: Lint
+          command: |
+            # Only run lint for main branch, tags, or if the branch has relevant changes
+            if [[ "$CIRCLE_BRANCH" = "main" ]] || [[ -n "${CIRCLE_TAG:-}" ]] || .circleci/scripts/changes-include deployments/puppet; then
+              make -C deployments/puppet lint
+            fi
+      - run:
+          name: Rake spec
+          command: |
+            # Only run rake-spec for main branch, tags, or if the branch has relevant changes
+            if [[ "$CIRCLE_BRANCH" = "main" ]] || [[ -n "${CIRCLE_TAG:-}" ]] || .circleci/scripts/changes-include deployments/puppet; then
+              make -C deployments/puppet rake-spec
+            fi
+      - run:
+          name: Check for relevant changes
+          command: |
+            # Only run puppet tests for main branch, tags, or if the branch has relevant changes
+            if [[ "$CIRCLE_BRANCH" != "main" ]] && [[ -z "${CIRCLE_TAG:-}" ]] && ! .circleci/scripts/changes-include deployments/puppet internal/buildscripts/packaging/tests; then
+              echo "SKIP_TESTS=yes" >> $BASH_ENV
+            fi
+      - install_pytest
+      - run:
+          name: Test puppet module
+          command: |
+            [[ "$SKIP_TESTS" = "yes" ]] && exit 0
+            mkdir -p ~/testresults
+            if [[ $CIRCLE_NODE_INDEX -eq 0 ]]; then
+              PACKAGE_TYPE=deb
+            else
+              PACKAGE_TYPE=rpm
+            fi
+            pytest -n2 --verbose -m $PACKAGE_TYPE \
+              --junitxml=~/testresults/results.xml \
+              --html=~/testresults/results.html \
+              --self-contained-html \
+              internal/buildscripts/packaging/tests/deployments/puppet/puppet_test.py
+      - save_pytest_results

deployments/puppet/.dockerignore

@@ -0,0 +1 @@
+pkg/*

deployments/puppet/.fixtures.yml

@@ -0,0 +1,11 @@
+fixtures:
+  forge_modules:
+    stdlib:
+      repo: "puppetlabs/stdlib"
+      ref: "4.24.0"
+    apt:
+      repo: "puppetlabs/apt"
+      ref: "7.0.0"
+    yum:
+      repo: "puppet/yum"
+      ref: "4.3.0"

deployments/puppet/.gitignore

@@ -0,0 +1 @@
+/pkg/

deployments/puppet/Dockerfile

@@ -0,0 +1,31 @@
+FROM ubuntu:16.04
+
+ENV PATH=$PATH:/opt/puppetlabs/bin:/opt/puppetlabs/pdk/bin
+
+WORKDIR /tmp
+RUN apt update &&\
+    apt install -y make wget vim gcc ruby ruby-dev libxml2 libxml2-dev libxslt1-dev git apt-transport-https ca-certificates g++
+
+RUN wget https://apt.puppetlabs.com/puppet6-release-xenial.deb &&\
+    dpkg -i puppet6-release-xenial.deb &&\
+    rm *.deb &&\
+    apt update &&\
+    apt install -y puppet-agent
+
+RUN wget https://apt.puppet.com/puppet-tools-release-xenial.deb && \
+    dpkg -i puppet-tools-release-xenial.deb && \
+    apt-get update && \
+    apt-get install -y pdk && \
+    rm -f *.deb
+
+WORKDIR /etc/puppetlabs/code/modules/splunk_otel_collector
+COPY ./Rakefile ./Gemfile ./Gemfile.lock ./
+RUN gem install bundler && bundle install
+
+RUN mkdir -p /root/.config/puppet && \
+    echo "---\n\
+disabled: true" > /root/.config/puppet/analytics.yml
+
+ENV PATH=/opt/puppetlabs/bin:$PATH
+
+COPY ./ ./

deployments/puppet/Gemfile

@@ -0,0 +1,127 @@
+source ENV['GEM_SOURCE'] || 'https://rubygems.org'
+
+def location_for(place_or_version, fake_version = nil)
+  if place_or_version =~ %r{\A(git[:@][^#]*)#(.*)}
+    [fake_version, { git: Regexp.last_match(1), branch: Regexp.last_match(2), require: false }].compact
+  elsif place_or_version =~ %r{\Afile:\/\/(.*)}
+    ['>= 0', { path: File.expand_path(Regexp.last_match(1)), require: false }]
+  else
+    [place_or_version, { require: false }]
+  end
+end
+
+def gem_type(place_or_version)
+  if place_or_version =~ %r{\Agit[:@]}
+    :git
+  elsif !place_or_version.nil? && place_or_version.start_with?('file:')
+    :file
+  else
+    :gem
+  end
+end
+
+ruby_version_segments = Gem::Version.new(RUBY_VERSION.dup).segments
+minor_version = ruby_version_segments[0..1].join('.')
+
+group :development do
+  gem "fast_gettext", '1.1.0',                         require: false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.1.0')
+  gem "fast_gettext",                                  require: false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0')
+  gem "json_pure", '<= 2.0.1',                         require: false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0')
+  gem "json", '>= 2.3.0',                              require: false if Gem::Version.new(RUBY_VERSION.dup) == Gem::Version.new('2.1.9')
+  gem "puppet-module-posix-default-r#{minor_version}", require: false, platforms: [:ruby]
+  gem "puppet-module-posix-dev-r#{minor_version}",     require: false, platforms: [:ruby]
+  gem "puppet-module-win-default-r#{minor_version}",   require: false, platforms: [:mswin, :mingw, :x64_mingw]
+  gem "puppet-module-win-dev-r#{minor_version}",       require: false, platforms: [:mswin, :mingw, :x64_mingw]
+  gem "rspec_junit_formatter"
+end
+
+puppet_version = ENV['PUPPET_GEM_VERSION']
+puppet_type = gem_type(puppet_version)
+facter_version = ENV['FACTER_GEM_VERSION']
+hiera_version = ENV['HIERA_GEM_VERSION']
+
+def puppet_older_than?(version)
+  puppet_version = ENV['PUPPET_GEM_VERSION']
+  !puppet_version.nil? &&
+    Gem::Version.correct?(puppet_version) &&
+    Gem::Requirement.new("< #{version}").satisfied_by?(Gem::Version.new(puppet_version.dup))
+end
+
+gems = {}
+
+gems['puppet'] = location_for(puppet_version)
+
+# If facter or hiera versions have been specified via the environment
+# variables, use those versions. If not, and if the puppet version is < 3.5.0,
+# use known good versions of both for puppet < 3.5.0.
+if facter_version
+  gems['facter'] = location_for(facter_version)
+elsif puppet_type == :gem && puppet_older_than?('3.5.0')
+  gems['facter'] = ['>= 1.6.11', '<= 1.7.5', require: false]
+end
+
+if hiera_version
+  gems['hiera'] = location_for(ENV['HIERA_GEM_VERSION'])
+elsif puppet_type == :gem && puppet_older_than?('3.5.0')
+  gems['hiera'] = ['>= 1.0.0', '<= 1.3.0', require: false]
+end
+
+if Gem.win_platform? && (puppet_type != :gem || puppet_older_than?('3.5.0'))
+  # For Puppet gems < 3.5.0 (tested as far back as 3.0.0) on Windows
+  if puppet_type == :gem
+    gems['ffi'] =            ['1.9.0',                require: false]
+    gems['minitar'] =        ['0.5.4',                require: false]
+    gems['win32-eventlog'] = ['0.5.3',    '<= 0.6.5', require: false]
+    gems['win32-process'] =  ['0.6.5',    '<= 0.7.5', require: false]
+    gems['win32-security'] = ['~> 0.1.2', '<= 0.2.5', require: false]
+    gems['win32-service'] =  ['0.7.2',    '<= 0.8.8', require: false]
+  else
+    gems['ffi'] =            ['~> 1.9.0',             require: false]
+    gems['minitar'] =        ['~> 0.5.4',             require: false]
+    gems['win32-eventlog'] = ['~> 0.5',   '<= 0.6.5', require: false]
+    gems['win32-process'] =  ['~> 0.6',   '<= 0.7.5', require: false]
+    gems['win32-security'] = ['~> 0.1',   '<= 0.2.5', require: false]
+    gems['win32-service'] =  ['~> 0.7',   '<= 0.8.8', require: false]
+  end
+
+  gems['win32-dir'] = ['~> 0.3', '<= 0.4.9', require: false]
+
+  if RUBY_VERSION.start_with?('1.')
+    gems['win32console'] = ['1.3.2', require: false]
+    # sys-admin was removed in Puppet 3.7.0 and doesn't compile under Ruby 2.x
+    gems['sys-admin'] =    ['1.5.6', require: false]
+  end
+
+  # Puppet < 3.7.0 requires these.
+  # Puppet >= 3.5.0 gem includes these as requirements.
+  # The following versions are tested to work with 3.0.0 <= puppet < 3.7.0.
+  gems['win32-api'] =           ['1.4.8', require: false]
+  gems['win32-taskscheduler'] = ['0.2.2', require: false]
+  gems['windows-api'] =         ['0.4.3', require: false]
+  gems['windows-pr'] =          ['1.2.3', require: false]
+elsif Gem.win_platform?
+  # If we're using a Puppet gem on Windows which handles its own win32-xxx gem
+  # dependencies (>= 3.5.0), set the maximum versions (see PUP-6445).
+  gems['win32-dir'] =      ['<= 0.4.9', require: false]
+  gems['win32-eventlog'] = ['<= 0.6.5', require: false]
+  gems['win32-process'] =  ['<= 0.7.5', require: false]
+  gems['win32-security'] = ['<= 0.2.5', require: false]
+  gems['win32-service'] =  ['<= 0.8.8', require: false]
+end
+
+gems.each do |gem_name, gem_params|
+  gem gem_name, *gem_params
+end
+
+# Evaluate Gemfile.local and ~/.gemfile if they exist
+extra_gemfiles = [
+  "#{__FILE__}.local",
+  File.join(Dir.home, '.gemfile'),
+]
+
+extra_gemfiles.each do |gemfile|
+  if File.file?(gemfile) && File.readable?(gemfile)
+    eval(File.read(gemfile), binding)
+  end
+end
+# vim: syntax=ruby