example42 · alvagante · Oct 14, 2023 · Feb 8, 2023 · Feb 15, 2023 · Feb 16, 2023
diff --git a/.gitignore b/.gitignore
@@ -16,7 +16,7 @@
 /log/
 /pkg/
 /spec/fixtures/manifests/
-/spec/fixtures/modules/
+/spec/fixtures/modules/*
 /tmp/
 /vendor/
 /convert_report.txt

diff --git a/.pdkignore b/.pdkignore
@@ -16,7 +16,7 @@
 /log/
 /pkg/
 /spec/fixtures/manifests/
-/spec/fixtures/modules/
+/spec/fixtures/modules/*
 /tmp/
 /vendor/
 /convert_report.txt
@@ -26,20 +26,16 @@
 .envrc
 /inventory.yaml
 /spec/fixtures/litmus_inventory.yaml
-/appveyor.yml
-/.editorconfig
 /.fixtures.yml
 /Gemfile
 /.gitattributes
 /.gitignore
-/.gitlab-ci.yml
 /.pdkignore
 /.puppet-lint.rc
 /Rakefile
 /rakelib/
 /.rspec
-/.rubocop.yml
-/.travis.yml
+/..yml
 /.yardopts
 /spec/
 /.vscode/

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 3.10.0
+
+-   Added support for $MAJVERSION variable in tinydata
+-   Added support for xz release files
+-   Refactorings in install type management:
+-   -   support for root and normal users
+    -   install_type file renamed to release
+    -   settings are computed in tp::install and used in tp::install::* defines
+-   get_version and url_replace functions accept an addtional version type paramter
+-   Widened support for variables in tinydata
+-   Removed legacy facts for Puppet 8 compatibility
+
 ## 3.9.1
 
 -   Fixed tp debug cli command

diff --git a/Gemfile b/Gemfile
@@ -14,30 +14,32 @@ def location_for(place_or_version, fake_version = nil)
 end
 
 group :development do
-  gem "json", '= 2.1.0',                               require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "json", '= 2.3.0',                               require: false if Gem::Requirement.create(['>= 2.7.0', '< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "json", '= 2.5.1',                               require: false if Gem::Requirement.create(['>= 3.0.0', '< 3.0.5']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "json", '= 2.6.1',                               require: false if Gem::Requirement.create(['>= 3.1.0', '< 3.1.3']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "json", '= 2.6.3',                               require: false if Gem::Requirement.create(['>= 3.2.0', '< 4.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "voxpupuli-puppet-lint-plugins", '~> 3.1',       require: false
-  gem "facterdb", '~> 1.18',                           require: false
-  gem "metadata-json-lint", '>= 2.0.2', '< 4.0.0',     require: false
-  gem "puppetlabs_spec_helper", '>= 3.0.0', '< 5.0.0', require: false
-  gem "rspec-puppet-facts", '~> 2.0',                  require: false
-  gem "codecov", '~> 0.2',                             require: false
-  gem "dependency_checker", '~> 0.2',                  require: false
-  gem "parallel_tests", '~> 3.4',                      require: false
-  gem "pry", '~> 0.10',                                require: false
-  gem "simplecov-console", '~> 0.5',                   require: false
-  gem "puppet-debugger", '~> 1.0',                     require: false
-  gem "rubocop", '= 1.6.1',                            require: false
-  gem "rubocop-performance", '= 1.9.1',                require: false
-  gem "rubocop-rspec", '= 2.0.1',                      require: false
-  gem "rb-readline", '= 0.5.5',                        require: false, platforms: [:mswin, :mingw, :x64_mingw]
+  gem "json", '= 2.1.0',                         require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "json", '= 2.3.0',                         require: false if Gem::Requirement.create(['>= 2.7.0', '< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "json", '= 2.5.1',                         require: false if Gem::Requirement.create(['>= 3.0.0', '< 3.0.5']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "json", '= 2.6.1',                         require: false if Gem::Requirement.create(['>= 3.1.0', '< 3.1.3']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "json", '= 2.6.3',                         require: false if Gem::Requirement.create(['>= 3.2.0', '< 4.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "racc", '~> 1.4.0',                        require: false if Gem::Requirement.create(['>= 2.7.0', '< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "voxpupuli-puppet-lint-plugins", '~> 5.0', require: false
+  gem "facterdb", '~> 1.18',                     require: false
+  gem "metadata-json-lint", '~> 3.0',            require: false
+  gem "puppetlabs_spec_helper", '~> 6.0',        require: false
+  gem "rspec-puppet-facts", '~> 2.0',            require: false
+  gem "codecov", '~> 0.2',                       require: false
+  gem "dependency_checker", '~> 1.0.0',          require: false
+  gem "parallel_tests", '= 3.12.1',              require: false
+  gem "pry", '~> 0.10',                          require: false
+  gem "simplecov-console", '~> 0.5',             require: false
+  gem "puppet-debugger", '~> 1.0',               require: false
+  gem "rubocop", '= 1.48.1',                     require: false
+  gem "rubocop-performance", '= 1.16.0',         require: false
+  gem "rubocop-rspec", '= 2.19.0',               require: false
+  gem "puppet-strings", '~> 3.0',                require: false
+  gem "rb-readline", '= 0.5.5',                  require: false, platforms: [:mswin, :mingw, :x64_mingw]
 end
 group :system_tests do
-  gem "puppet_litmus", '< 1.0.0', require: false, platforms: [:ruby]
-  gem "serverspec", '~> 2.41',    require: false
+  gem "puppet_litmus", '~> 1.0', require: false, platforms: [:ruby, :x64_mingw]
+  gem "serverspec", '~> 2.41',   require: false
 end
 
 puppet_version = ENV['PUPPET_GEM_VERSION']

diff --git a/Rakefile b/Rakefile
@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
 require 'bundler'
-require 'puppet_litmus/rake_tasks' if Bundler.rubygems.find_name('puppet_litmus').any?
+require 'puppet_litmus/rake_tasks' if Gem.loaded_specs.key? 'puppet_litmus'
 require 'puppetlabs_spec_helper/rake_tasks'
 require 'puppet-syntax/tasks/puppet-syntax'
-require 'puppet_blacksmith/rake_tasks' if Bundler.rubygems.find_name('puppet-blacksmith').any?
-require 'github_changelog_generator/task' if Bundler.rubygems.find_name('github_changelog_generator').any?
-require 'puppet-strings/tasks' if Bundler.rubygems.find_name('puppet-strings').any?
+require 'github_changelog_generator/task' if Gem.loaded_specs.key? 'github_changelog_generator'
+require 'puppet-strings/tasks' if Gem.loaded_specs.key? 'puppet-strings'
 
 def changelog_user
   return unless Rake.application.top_level_tasks.include? "changelog"
@@ -44,7 +43,7 @@ end
 PuppetLint.configuration.send('disable_relative')
 
 
-if Bundler.rubygems.find_name('github_changelog_generator').any?
+if Gem.loaded_specs.key? 'github_changelog_generator'
   GitHubChangelogGenerator::RakeTask.new :changelog do |config|
     raise "Set CHANGELOG_GITHUB_TOKEN environment variable eg 'export CHANGELOG_GITHUB_TOKEN=valid_token_here'" if Rake.application.top_level_tasks.include? "changelog" and ENV['CHANGELOG_GITHUB_TOKEN'].nil?
     config.user = "#{changelog_user}"

diff --git a/functions/get_version.pp b/functions/get_version.pp
@@ -4,13 +4,16 @@ function tp::get_version (
   String $_ensure = '',
   Optional[String] $_version = undef,
   Hash $_settings = {},
+  Enum['full', 'major'] $_version_type = 'full',
 ) {
-  if $_version != undef and $_ensure != 'absent' {
+  if $_version_type == 'major' {
+    $real_version = pick_default(getvar('_settings.release.latest_version_major'))
+  } elsif $_version != undef and $_ensure != 'absent' {
     $real_version = $_version
   } elsif $_ensure !~ /^present$|^latest$|^absent$/ {
     $real_version = $_ensure
-  } elsif getvar('_settings.releases.latest_version') {
-    $real_version = getvar('_settings.releases.latest_version')
+  } elsif getvar('_settings.release.latest_version') {
+    $real_version = getvar('_settings.release.latest_version')
   } else {
     $real_version = ''
   }

diff --git a/functions/url_replace.pp b/functions/url_replace.pp
@@ -3,16 +3,22 @@
 function tp::url_replace (
   String $url,
   String $_version,
+  Optional[String] $_majversion = undef,
 ) {
   # TODO: Improve and make dynamic when needed
   $translated_arch = $facts['os']['architecture'] ? {
     'x86_64' => 'amd64',
     'x64'    => 'amd64',
     'i386'   => '386',
-    default  => $facts['os']['architecture'],
+    default  => pick_default($facts['os']['architecture'], ''),
   }
   $versioned_url = regsubst($url,'\$VERSION', $_version, 'G')
-  $os_replaced_url = regsubst($versioned_url,'\$OS', downcase($facts['kernel']), 'G')
+  if $_majversion == undef {
+    $majversioned_url = $versioned_url
+  } else {
+    $majversioned_url = regsubst($versioned_url,'\$MAJVERSION', $_majversion, 'G')
+  }
+  $os_replaced_url = regsubst($majversioned_url,'\$OS', downcase($facts['kernel']), 'G')
   $arch_replaced_url = regsubst($os_replaced_url,'\$ARCH', downcase($translated_arch), 'G') # lint:ignore:140chars
 
   return $arch_replaced_url

diff --git a/manifests/cli.pp b/manifests/cli.pp
@@ -86,10 +86,11 @@
         }
       }
       $epp_params = {
-        'real_ruby_path' => $real_ruby_path,
-        'options'        => $real_options,
+        'real_ruby_path'       => $real_ruby_path,
+        'options'              => $real_options,
         'suppress_tp_warnings' => $suppress_tp_warnings,
-        'tp_dir'         => $tp::tp_dir,
+        'suppress_tp_output'   => $suppress_tp_output,
+        'tp_dir'               => $tp::tp_dir,
       }
       file { $tp::tp_path:
         path    => $tp::tp_path,

diff --git a/manifests/install.pp b/manifests/install.pp
@@ -18,7 +18,7 @@
 #
 # @example installation of prometheus directly from a binary of the given version
 #   tp::install { 'prometheus':
-#     install_method: 'file'
+#     install_method: 'release'
 #     ensure: '2.41.0',
 #   }
 #
@@ -142,7 +142,7 @@
   Boolean                 $use_v4           = pick(getvar('tp::use_v4'),false),
 
   # V4 params
-  Optional[Enum['package', 'image', 'file', 'source']] $install_method = undef,
+  Tp::Install_method $install_method = undef,
   Tp::Fail $on_missing_data = pick(getvar('tp::on_missing_data'),'notify'),
 
   String $base_package   = 'main',
@@ -161,6 +161,9 @@
   Optional[String] $source                  = undef,
   Optional[String] $destination             = undef,
 
+  String[1] $owner = pick(getvar('identity.user'),'root'),
+  String[1] $group = pick(getvar('identity.group'),'root'),
+
 # Legacy params preserved
 #  Boolean                 $auto_prereq      = false,
 #  Boolean                 $cli_enable       = false,
@@ -214,23 +217,59 @@
   }
 
   # Settings evaluation
-  $tinydata_settings = tp_lookup($app,'settings',$data_module,'deep_merge')
+  $tp_settings = tp_lookup($app,'settings',$data_module,'deep_merge')
+
+  $real_install_method = pick($install_method, getvar('tp_settings.install_method'), 'package')
+  $real_version = tp::get_version($ensure,$version,$tp_settings)
+  $real_majversion = tp::get_version($ensure,$version,$tp_settings,'major')
+  $real_filename = pick(tp::url_replace(pick(getvar("tp_settings.${real_install_method}.file_name"),$app), $real_version, $real_majversion), $app) # lint:ignore:140chars
+  if $use_v4 {
+    if getvar('tp_settings.release.base_url') {
+      $real_base_url = tp::url_replace(pick(getvar("tp_settings.${real_install_method}.base_url"), $app), $real_version, $real_majversion)
+      $real_url = "${real_base_url}/${real_filename}"
+    } else {
+      tp::fail($on_missing_data, "tp::install::release - ${app} - Missing tinydata: settings.${real_install_method}.base_url") # lint:ignore:140chars
+    }
+  }
+
+  $extracted_dir = getvar('tp_settings.release.extracted_dir') ? {
+    String  => tp::url_replace(getvar('tp_settings.release.extracted_dir'), $real_version, $real_majversion), # lint:ignore:140chars
+    default => tp::url_replace(basename($real_filename), $real_version, $real_majversion),
+  }
+  $extracted_file = getvar('tp_settings.release.extracted_file')
+
   $local_settings = delete_undef_values({
-      install_method => $install_method,
+      install_method => $real_install_method,
       repo           => $repo,
       upstream_repo  => $upstream_repo,
-      git_source     => $install_method ? {
+      git_source     => $real_install_method ? {
         'source' => $source,
         default  => undef,
       },
-      destination    => pick($install_method, getvar('tinydata_settings.install_method')) ? {
-        'source' => pick($destination, "${tp::data_dir}/source/${app}"),
-        'file'   => pick($destination, "${tp::data_dir}/download/${app}"),
-        default  => undef,
+      destination    => $real_install_method ? {
+        'source'  => pick($destination, "${tp::data_dir}/source/${app}"),
+        'release' => pick($destination, "${tp::data_dir}/download/${app}"),
+        default   => undef,
       },
+      packages => delete_undef_values({
+        main => delete_undef_values({
+          name => tp::title_replace(getvar('settings.packages.main.name'),$app),
+      }),
+      }),
+      release => delete_undef_values({
+        base_url    => pick_default($real_base_url),
+        file_name   => $real_filename,
+        url         => $real_url,
+        extracted_dir => $extracted_dir,
+        extracted_file => $extracted_file,
+        setup => delete_undef_values({
+          enable => getvar('tp_settings.release.setup.enable'),
+          links  => getvar('tp_settings.release.setup.links'),
+        }),
+      }),
   })
 
-  $settings = deep_merge($tinydata_settings,$settings_hash,$my_settings,$local_settings)
+  $settings = deep_merge($tp_settings,$settings_hash,$my_settings,$local_settings)
 
   # v4 code
   if $use_v4 {
@@ -243,10 +282,22 @@
       version         => $version,
       on_missing_data => $on_missing_data,
     }
-
     # If not user specified or set as settings.install_method, the default
     # installation method is 'package'
-    $real_install_method = pick($install_method, getvar('settings.install_method'), 'package')
+
+    # Setup
+    tp::setup { "tp::install::${real_install_method} ${app}":
+      ensure          => $ensure,
+      version         => $real_version,
+      install_method      => $real_install_method,
+      source_dir      => getvar('settings.destination'),
+      app             => $app,
+      on_missing_data => $on_missing_data,
+      settings        => $settings,
+      owner           => $owner,
+      group           => $group,
+    }
+# on       source_dir      => $real_postextract_cwd,
 
     case $real_install_method {
       'package': {
@@ -267,22 +318,32 @@
         }
       }
       'source': {
+        $default_install_source_params = {
+          owner       => $owner,
+          group       => $group,
+        }
         tp::install::source { $app:
-          * => $default_install_params + $params,
+          * => $default_install_params + $default_install_source_params + $params,
         }
       }
-      'file': {
+      'release': {
         $default_install_file_params = {
           source      => $source,
           destination => $destination,
+          owner       => $owner,
+          group       => $group,
         }
-        tp::install::file { $app:
+        tp::install::release { $app:
           * => $default_install_params + $default_install_file_params + $params,
         }
       }
       'image': {
+        $default_install_image_params = {
+          owner       => $owner,
+          group       => $group,
+        }
         tp::install::image { $app:
-          * => $default_install_params + $params,
+          * => $default_install_params + $default_install_image_params + $params,
         }
       }
       default: {
@@ -296,7 +357,7 @@
       $tp_dir = $tp::tp_dir
       file { "${tp_dir}/app/${sane_app}":
         ensure  => tp::ensure2file($ensure),
-        content => inline_epp('<%= $settings.to_yaml %>'),
+        content => $settings.to_yaml,
       }
       file { "${tp_dir}/shellvars/${sane_app}":
         ensure  => tp::ensure2file($ensure),