.sync.yml

@@ -7,5 +7,3 @@ Gemfile:
 spec/spec_helper.rb:
   requires:
     - webmock/rspec
-spec/spec_helper_acceptance.rb:
-  locale_workaround: true

CHANGELOG.md

@@ -1,5 +1,40 @@
 # Changelog
 
+## [21.0.0](https://github.com/theforeman/puppet-foreman/tree/21.0.0) (2022-08-04)
+
+[Full Changelog](https://github.com/theforeman/puppet-foreman/compare/20.2.0...21.0.0)
+
+**Breaking changes:**
+
+- remove support for Debian 10 buster [\#1068](https://github.com/theforeman/puppet-foreman/pull/1068) ([evgeni](https://github.com/evgeni))
+- Stop accepting UNSET as a value and rewrite db.yml to EPP [\#1066](https://github.com/theforeman/puppet-foreman/pull/1066) ([ekohl](https://github.com/ekohl))
+- Drop EL7 support [\#1061](https://github.com/theforeman/puppet-foreman/pull/1061) ([ehelms](https://github.com/ehelms))
+- Fixes [\#34977](https://projects.theforeman.org/issues/34977): Drop apipie\_dsl:cache generation [\#1056](https://github.com/theforeman/puppet-foreman/pull/1056) ([ehelms](https://github.com/ehelms))
+
+**Implemented enhancements:**
+
+- Use Integer type for vhost ssl\_verify\_depth [\#1071](https://github.com/theforeman/puppet-foreman/pull/1071) ([wbclark](https://github.com/wbclark))
+- Update to voxpupuli-test 5 [\#1063](https://github.com/theforeman/puppet-foreman/pull/1063) ([ekohl](https://github.com/ekohl))
+- Add foreman plugin for netbox [\#1060](https://github.com/theforeman/puppet-foreman/pull/1060) ([dgoetz](https://github.com/dgoetz))
+- Add foreman plugin for git\_templates [\#1059](https://github.com/theforeman/puppet-foreman/pull/1059) ([dgoetz](https://github.com/dgoetz))
+- Add foreman plugin for vault [\#1058](https://github.com/theforeman/puppet-foreman/pull/1058) ([dgoetz](https://github.com/dgoetz))
+- Add foreman plugin for scc\_manager [\#1057](https://github.com/theforeman/puppet-foreman/pull/1057) ([dgoetz](https://github.com/dgoetz))
+- Replace template with to\_symbolized\_yaml function [\#1017](https://github.com/theforeman/puppet-foreman/pull/1017) ([ekohl](https://github.com/ekohl))
+- Move static parameters to init.pp [\#978](https://github.com/theforeman/puppet-foreman/pull/978) ([ekohl](https://github.com/ekohl))
+
+**Fixed bugs:**
+
+- Fixes [\#35089](https://projects.theforeman.org/issues/35089) - set NoDelay=false when deploying a UNIX socket [\#1062](https://github.com/theforeman/puppet-foreman/pull/1062) ([evgeni](https://github.com/evgeni))
+
+## [20.2.0](https://github.com/theforeman/puppet-foreman/tree/20.2.0) (2022-06-21)
+
+[Full Changelog](https://github.com/theforeman/puppet-foreman/compare/20.1.0...20.2.0)
+
+**Implemented enhancements:**
+
+- add foreman\_global\_parameter type [\#1054](https://github.com/theforeman/puppet-foreman/pull/1054) ([jhoblitt](https://github.com/jhoblitt))
+- derive base\_url from foreman-proxy/settings.yml by default [\#1053](https://github.com/theforeman/puppet-foreman/pull/1053) ([jhoblitt](https://github.com/jhoblitt))
+
 ## [20.1.0](https://github.com/theforeman/puppet-foreman/tree/20.1.0) (2022-05-24)
 
 [Full Changelog](https://github.com/theforeman/puppet-foreman/compare/20.0.0...20.1.0)

Gemfile

@@ -13,7 +13,7 @@ gem 'puppet-lint-param-docs', '>= 1.3.0', {"groups"=>["test"]}
 gem 'puppet-lint-spaceship_operator_without_tag-check', {"groups"=>["test"]}
 gem 'puppet-lint-strict_indent-check', {"groups"=>["test"]}
 gem 'puppet-lint-undef_in_function-check', {"groups"=>["test"]}
-gem 'voxpupuli-test', '~> 1.4', {"groups"=>["test"]}
+gem 'voxpupuli-test', '~> 5.0', {"groups"=>["test"]}
 gem 'github_changelog_generator', '>= 1.15.0', {"groups"=>["development"]}
 gem 'puppet_metadata', '~> 1.3'
 gem 'puppet-blacksmith', '>= 6.0.0', {"groups"=>["development"]}

HISTORY.md

@@ -1,3 +1,74 @@
+# Changelog
+
+## [20.2.0](https://github.com/theforeman/puppet-foreman/tree/20.2.0) (2022-06-21)
+
+[Full Changelog](https://github.com/theforeman/puppet-foreman/compare/20.1.0...20.2.0)
+
+**Implemented enhancements:**
+
+- add foreman\_global\_parameter type [\#1054](https://github.com/theforeman/puppet-foreman/pull/1054) ([jhoblitt](https://github.com/jhoblitt))
+- derive base\_url from foreman-proxy/settings.yml by default [\#1053](https://github.com/theforeman/puppet-foreman/pull/1053) ([jhoblitt](https://github.com/jhoblitt))
+
+## [20.1.0](https://github.com/theforeman/puppet-foreman/tree/20.1.0) (2022-05-24)
+
+[Full Changelog](https://github.com/theforeman/puppet-foreman/compare/20.0.0...20.1.0)
+
+**Implemented enhancements:**
+
+- use instance debug instead of Puppet.debug [\#1052](https://github.com/theforeman/puppet-foreman/pull/1052) ([jhoblitt](https://github.com/jhoblitt))
+- Fixes [\#34943](https://projects.theforeman.org/issues/34943): Allow configuration of additional cockpit origins [\#1051](https://github.com/theforeman/puppet-foreman/pull/1051) ([ehelms](https://github.com/ehelms))
+- Fixes [\#34602](https://projects.theforeman.org/issues/34602) - restart services after plugin installation [\#1046](https://github.com/theforeman/puppet-foreman/pull/1046) ([evgeni](https://github.com/evgeni))
+
+## [20.0.0](https://github.com/theforeman/puppet-foreman/tree/20.0.0) (2022-04-29)
+
+[Full Changelog](https://github.com/theforeman/puppet-foreman/compare/19.3.0...20.0.0)
+
+**Breaking changes:**
+
+- Fixes [\#34640](https://projects.theforeman.org/issues/34640) - Drop apipie:cache:index [\#1042](https://github.com/theforeman/puppet-foreman/pull/1042) ([ehelms](https://github.com/ehelms))
+
+**Implemented enhancements:**
+
+- Add Foreman Google plugin [\#1040](https://github.com/theforeman/puppet-foreman/pull/1040) ([stejskalleos](https://github.com/stejskalleos))
+
+**Fixed bugs:**
+
+- Fixes [\#34824](https://projects.theforeman.org/issues/34824) - properly restart foreman when puma config changed [\#1045](https://github.com/theforeman/puppet-foreman/pull/1045) ([evgeni](https://github.com/evgeni))
+
+## [19.3.0](https://github.com/theforeman/puppet-foreman/tree/19.3.0) (2022-04-08)
+
+[Full Changelog](https://github.com/theforeman/puppet-foreman/compare/19.2.1...19.3.0)
+
+**Implemented enhancements:**
+
+- Include apache::mod::env [\#1038](https://github.com/theforeman/puppet-foreman/pull/1038) ([wbclark](https://github.com/wbclark))
+- Allow puppetlabs/postgresql 8.x [\#1031](https://github.com/theforeman/puppet-foreman/pull/1031) ([ekohl](https://github.com/ekohl))
+- Refs [\#34505](https://projects.theforeman.org/issues/34505) - Add hammer plugin for foreman\_host\_reports [\#1030](https://github.com/theforeman/puppet-foreman/pull/1030) ([ofedoren](https://github.com/ofedoren))
+
+**Fixed bugs:**
+
+- metadata.json: Use https URL to git repo [\#1036](https://github.com/theforeman/puppet-foreman/pull/1036) ([bastelfreak](https://github.com/bastelfreak))
+- Use the new GPG key for Debian packages [\#1034](https://github.com/theforeman/puppet-foreman/pull/1034) ([ekohl](https://github.com/ekohl))
+
+## [19.2.1](https://github.com/theforeman/puppet-foreman/tree/19.2.1) (2022-02-21)
+
+[Full Changelog](https://github.com/theforeman/puppet-foreman/compare/19.2.0...19.2.1)
+
+**Fixed bugs:**
+
+- Refs [\#34394](https://projects.theforeman.org/issues/34394) - trigger dynflow restart when DB restarts [\#1028](https://github.com/theforeman/puppet-foreman/pull/1028) ([evgeni](https://github.com/evgeni))
+
+## [19.2.0](https://github.com/theforeman/puppet-foreman/tree/19.2.0) (2022-02-04)
+
+[Full Changelog](https://github.com/theforeman/puppet-foreman/compare/19.1.1...19.2.0)
+
+**Implemented enhancements:**
+
+- puppet/extlib: Allow 6.x [\#1027](https://github.com/theforeman/puppet-foreman/pull/1027) ([bastelfreak](https://github.com/bastelfreak))
+- Reflect Foreman 3.2+ support for Debian 11 [\#1025](https://github.com/theforeman/puppet-foreman/pull/1025) ([ekohl](https://github.com/ekohl))
+- Explicitly enable the foreman dnf module on Foreman 3.2+ [\#1023](https://github.com/theforeman/puppet-foreman/pull/1023) ([evgeni](https://github.com/evgeni))
+- Introduce foreman::settings\_fragment [\#1016](https://github.com/theforeman/puppet-foreman/pull/1016) ([ekohl](https://github.com/ekohl))
+
 ## [19.1.1](https://github.com/theforeman/puppet-foreman/tree/19.1.1) (2022-01-26)
 
 [Full Changelog](https://github.com/theforeman/puppet-foreman/compare/19.1.0...19.1.1)

README.md

@@ -75,7 +75,7 @@ previous stable release.
 ### Foreman version compatibility notes
 
 This module targets Foreman 3.1+.
-The module can be used with Foreman 2.4+ by setting `register_in_foreman => false`.
+The module can not be used to manage Foreman installations on EL7.
 
 ## Types and providers
 

lib/puppet/provider/foreman_global_parameter/rest_v3.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+Puppet::Type.type(:foreman_global_parameter)
+            .provide(
+              :rest_v3,
+              parent: Puppet::Type.type(:foreman_resource).provider(:rest_v3)
+            ) do
+  confine feature: %i[json oauth]
+
+  mk_resource_methods
+
+  # Note that #request is an instance method and as such prevents
+  # self.instances and self.prefetch from being implimented.
+
+  # The foreman api has both `hidden_value` and `hidden_value?` fields. The
+  # later is the boolean value.
+  def hidden_value
+    @property_hash[:hidden_value?]
+  end
+
+  def hidden_value=(value)
+    @property_hash[:hidden_value?] = value
+  end
+
+  def create
+    @property_hash[:ensure] = :present
+  end
+
+  def exists?
+    get_common_parameter!
+    @property_hash[:ensure] == :present
+  end
+
+  def destroy
+    @property_hash[:ensure] = :absent
+  end
+
+  def flush
+    case self.ensure
+    when :present
+      # if there is already an id, this is an update
+      if id.nil?
+        create_common_parameter
+      else
+        update_common_parameter
+      end
+    when :absent
+      destroy_common_parameter
+    else
+      raise Puppet::Error, "invalid :ensure value: #{self.ensure}"
+    end
+  end
+
+  private
+
+  def id
+    @property_hash[:id]
+  end
+
+  def base_path
+    'api/v2/common_parameters'
+  end
+
+  def get_common_parameter!
+    path = base_path
+    params = {
+      search: "name=#{resource[:name]}",
+      show_hidden: true
+    }
+    r = request(:get, base_path, params)
+
+    raise Puppet::Error, "Error making GET request to Foreman at #{request_uri(path)}: #{error_message(r)}" unless success?(r)
+
+    begin
+      results = JSON.parse(r.body)['results'].first
+    rescue JSON::ParserError
+      raise Puppet::Error, "unable to parse as JSON: #{r.body}"
+    end
+
+    if results.nil?
+      @property_hash[:ensure] = :absent
+    else
+      @property_hash = results.transform_keys(&:to_sym).transform_values do |v|
+        resource.munge_boolean_to_symbol(v)
+      end
+      @property_hash[:ensure] = :present
+    end
+  end
+
+  def create_common_parameter
+    path = base_path
+    data = {
+      common_parameter: {
+        name: resource[:name],
+        value: resource[:value],
+        parameter_type: resource[:parameter_type]
+      }
+    }
+    data[:hidden_value] = resource[:hidden_value] unless resource[:hidden_value].nil?
+    data.transform_values! { |v| resource.munge_symbol_to_boolean(v) }
+    r = request(:post, path, {}, data.to_json)
+
+    return if success?(r)
+
+    raise Puppet::Error, "Error making POST request to Foreman at #{request_uri(path)}: #{error_message(r)}"
+  end
+
+  def update_common_parameter
+    path = "#{base_path}/#{id}"
+    data = {
+      common_parameter: {
+        name: resource[:name],
+        value: resource[:value],
+        parameter_type: resource[:parameter_type]
+      }
+    }
+    data[:hidden_value] = resource[:hidden_value] unless resource[:hidden_value].nil?
+    data.transform_values! { |v| resource.munge_symbol_to_boolean(v) }
+    r = request(:put, path, {}, data.to_json)
+
+    return if success?(r)
+
+    raise Puppet::Error, "Error making PUT request to Foreman at #{request_uri(path)}: #{error_message(r)}"
+  end
+
+  def destroy_common_parameter
+    path = "#{base_path}/#{id}"
+    r = request(:delete, path)
+
+    unless success?(r)
+      error_string = "Error making DELETE request to Foreman at #{request_uri(path)}: #{error_message(r)}"
+      raise Puppet::Error, error_string
+    end
+
+    @property_hash.clear
+  end
+end

lib/puppet/provider/foreman_resource/rest_v3.rb

@@ -40,9 +40,23 @@ def oauth_consumer_secret
     end
   end
 
+  def foreman_url
+    @foreman_url ||= begin
+      if resource[:base_url]
+        resource[:base_url]
+      else
+        begin
+          YAML.load_file('/etc/foreman-proxy/settings.yml')[:foreman_url]
+        rescue
+          fail "Resource #{resource[:name]} cannot be managed: No base_url available"
+        end
+      end
+    end
+  end
+
   def oauth_consumer
     @consumer ||= OAuth::Consumer.new(oauth_consumer_key, oauth_consumer_secret, {
-      :site               => resource[:base_url],
+      :site               => foreman_url,
       :request_token_path => '',
       :authorize_path     => '',
       :access_token_path  => '',
@@ -56,7 +70,7 @@ def generate_token
   end
 
   def request_uri(path)
-    base_url = resource[:base_url]
+    base_url = foreman_url
     base_url += '/' unless base_url.end_with?('/')
     URI.join(base_url, path)
   end
@@ -99,7 +113,7 @@ def success?(response)
   end
 
   def error_message(response)
-    fqdn = URI::parse(resource[:base_url]).host
+    fqdn = URI::parse(foreman_url).host
 
     explanations = {
       '400' => "Something is wrong with the data sent to Foreman at #{fqdn}",

lib/puppet/type/foreman_global_parameter.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative '../../puppet_x/foreman/common'
+
+Puppet::Type.newtype(:foreman_global_parameter) do
+  desc 'foreman_global_parameter Manipulate global parameters'
+
+  instance_eval(&PuppetX::Foreman::Common::REST_API_COMMON_PARAMS)
+
+  newparam(:name, namevar: true) do
+    desc 'Parameter name'
+  end
+
+  newproperty(:parameter_type) do
+    desc 'Type of the parameter'
+
+    munge { |v| v.to_s }
+  end
+
+  newproperty(:value) do
+    desc 'Parameter value'
+
+    munge { |v| @resource.munge_boolean_to_symbol(v) }
+  end
+
+  newproperty(:hidden_value) do
+    desc 'Should the value be hidden'
+
+    munge { |v| @resource.munge_boolean_to_symbol(v) }
+
+    validate do |v|
+      unless [TrueClass, FalseClass].include?(v.class)
+        raise Puppet::ResourceError, 'hidden_value expected a boolean value.'
+      end
+    end
+  end
+
+  # Convert booleans into symbols to work around parameter/property handling of
+  # booleans being broken.
+  #
+  # See:
+  # https://tickets.puppetlabs.com/browse/PUP-2368
+  # https://tickets.puppetlabs.com/browse/PUP-8442
+  def munge_boolean_to_symbol(value)
+    case value
+    when TrueClass
+      :true
+    when FalseClass
+      :false
+    else
+      value
+    end
+  end
+
+  def munge_symbol_to_boolean(value)
+    case value
+    when :true
+      true
+    when :false
+      false
+    else
+      value
+    end
+  end
+end