foreman-nightly-rpm-pipeline 1124 failed

evgeni · July 22, 2021, 1:09pm

The winner gets 3.0 points, and ows both @Marek_Hulan and me 3.0 pints of beer each.

foreman_puppet has a nice check to only be overriding things when it’s actually needed: ForemanPuppet.extracted_from_core?:

github.com

theforeman/foreman_puppet/blob/eab57b72349ed148f2c785884d4ad8c205dd758a/lib/foreman_puppet.rb#L2-L7

    
      
          FOREMAN_EXTRACTION_VERSION = '3.0'.freeze
          
          
def self.extracted_from_core?
            ENV['PUPPET_EXTRACTED'].to_s == '1' ||
              Gem::Dependency.new('', ">= #{FOREMAN_EXTRACTION_VERSION}").match?('', SETTINGS[:version].notag)
          end

As you can see there, the checked version is “3.0”, but our develop branch is still versioned 2.6. That means that this method returns false. And then the API override does not get applied in

github.com

theforeman/foreman_puppet/blob/eab57b72349ed148f2c785884d4ad8c205dd758a/app/controllers/concerns/foreman_puppet/extensions/api_v2_hosts_controller.rb#L9-L31

    
      
          if ForemanPuppet.extracted_from_core?
            method_desc = Apipie.get_method_description(self, :index)
            method_desc.apis << Apipie::MethodDescription::Api.new(:GET, '/environments/:environment_id/hosts', N_('List hosts per environment'), {})
          
          
  apipie_update_methods([:index]) do
              param :environment_id, String, desc: N_('ID of puppet environment')
            end
          
          
  apipie_update_methods(%i[create update]) do
              param :host, Hash do
                param :environment_id, String, desc: N_('Deprecated in favor of host/puppet_attributes/environment_id')
                param :puppetclass_ids, Array, desc: N_('Deprecated in favor of host/puppet_attributes/puppetclass_ids')
                param :config_group_ids, Array, desc: N_('Deprecated in favor of host/puppet_attributes/config_group_ids')
          
          
      param :puppet_attributes, Hash do
                  param :environment_id, String, desc: N_('ID of associated puppet Environment')
                  param :puppetclass_ids, Array, desc: N_('IDs of associated Puppetclasses')
                  param :config_group_ids, Array, desc: N_('IDs of associated ConfigGroups')
                end
              end

This file has been truncated. show original

Which means the apidoc is missing the puppetclasses_ids parameter when creating/updating hosts (and hostgroups). And well, if something is not in the apidoc, hammer ignores it. And so would FAM.

So we either need to revert the extraction, or bump to 3.0 with red nightlies and hope it works. (Given it’s the only failing test, I do expect it to become green then)