add --hosts param

[jhoblitt]

Related to:

• add support for metadata2 --hosts param gha-puppet#46
• add support for arbitrary with values for beaker.yml workflow modulesync_config#858

[jhoblitt]

Is --roles the right name for this functionality as beaker has its own concept of a role?

[jhoblitt]

It is starting to look like using a hostname prefix is a PITA for writing tests. It might be necessary to completely override the hostname.

[jhoblitt]

The "host" matching doesn't seem to be purely literal as this is working locally for me:

# server/replica is only supported on Redhat
if fact_on('master', 'os.family') == 'RedHat'
  describe 'easy_ipa class' do
    include_examples 'the example', 'master.pp', 'master'
  end
end

if fact_on('client', 'os.family') == 'RedHat'
  describe 'easy_ipa class' do
    include_examples 'the example', 'client.pp', 'client'
  end
end

with:

BEAKER_destroy=no BEAKER_setfile=almalinux9-64{hostname=master-almalinux9-64.example.com}-almalinux9-64{hostname=client-almalinux9-64.example.com} BEAKER_PUPPET_COLLECTION=puppet7 bundle exec rake beaker

[jhoblitt]

I've renamed --roles to --hosts and changed the semantics to provider a list of hostnames which completely override the "short hostname" of the SUTs.

[ekohl]

Overall it looks good. Some small nit picks about style.

[ekohl]

Perhaps bring the shostname declaration to within this block?

[jhoblitt]

that shouldn't break any of the existing tests but I suspect the logic here is wrong... the hostname should be set even when there isn't a domain component.

[jhoblitt]

This probably makes more sense but would require updating 5 existing tests:

diff --git a/lib/puppet_metadata/beaker.rb b/lib/puppet_metadata/beaker.rb
index bdf3955..e5b38cf 100644
--- a/lib/puppet_metadata/beaker.rb
+++ b/lib/puppet_metadata/beaker.rb
@@ -63,7 +63,7 @@ module PuppetMetadata
 
         aos = adjusted_os(os)
         name = "#{aos}#{release.tr('.', '')}-64"
-        shostname = if hostname
+        full_hostname = if hostname
                       hostname
                     elsif !puppet_version.nil?
                       "#{name}-#{puppet_version}"
@@ -72,12 +72,11 @@ module PuppetMetadata
                     end
 
         domain ||= 'example.com' if use_fqdn
+        full_hostname += ".#{domain}" if domain
 
         options = {}
-        if domain
-          options[:hostname] = "#{shostname}.#{domain}"
-        elsif hostname
-          options[:hostname] = hostname
+        if full_hostname != name
+          options[:hostname] = full_hostname
         end
 
         # Docker messes up cgroups and some systemd versions can't deal with

However, I'm leaning towards leaving it alone as I feel like a bigger picture rethink might be called for.

[alexjfisher]

Before I was directed to this PR, I spent some time today hacking away myself. To support some of the existing use cases some way of assigning roles would be helpful.
beaker-hostgenerator has a concept of arbitrary roles as well as a bunch of predefined ones.

But it starts to become a bit difficult to support everything in a single command line option with loads of different delimiters needed.
--hosts hostname1:compile_master,another_role.ma;hostname2:agent,another_role2.a

I think with the optparse library it also be possible to create an option that can be specified zero to multiple times.

eg maybe --host hostname1 --host hostname2:ROLE_STRING (where the first host isn't assigned any roles, but the second one uses a string that if present would be used verbatim eg. my_role.ma or just a)??

Did you have specific vox modules or other use-cases in mind? (The ones I came across were openvpn and spiped)

[jhoblitt]

@alexjfisher My initial use case was acceptance testing for freeipa with coverage of a replica server and a client. lsst-it/puppet-ipa#3 This is a fork of https://forge.puppet.com/modules/puppetfinland/easy_ipa/readme after upstream removed the vox module plumbing. I would be more than happy to contribute this mod to vox...

I intentionally implemented the absolute minimum viable feature to get acceptance testing to run, in that server/replica/client can be tested for the same OS. There clearly needs to be more complicated configuration for mix role/os. As in freeipa server is only packaged for ELx these days. So it would be nice to be able to test EL9 servers with a Debian client. I think what is needed is the ability to configure a matrix of roles:os combos.

[h-haaks]

@jhoblitt Could you have a look at #124? It covers roles as well as hostnames.

[jhoblitt]

@h-haaks I'm fine with it as long as @ekohl is. This PR was intended to be a first step to adding more functionality that would be easy to review. 😮‍💨

[ekohl]

Since #124 is merged now, I'm going to close this.