(CAT-2344) Updates matrix creation logic

Updates matrix creation logic to only include the version if requested.
Introduces a check to ensure the `latest-agent` and `pe-include`
options are not used simultaneously.

Author: david22swan

exe/matrix_from_metadata_v3

@@ -169,6 +169,8 @@ begin
   Action.config(debug: true) if options[:debug]
   Action.config(notice: false) if options[:quiet] && !options[:debug]
 
+  raise OptionParser::InvalidArgument, 'latest-agent and pe-include are mutually exclusive options' if options[:latest_agent] && options[:pe_include]
+
   # validate provisioners
   options[:provision_include].select! do |p|
     options[:matrix]['provisioners'].key?(p) or raise OptionParser::InvalidArgument, "--provision-include '#{p}' not found in provisioners"
@@ -276,8 +278,6 @@ options[:metadata]['requirements']&.each do |req|
                       all_versions = json_data.keys
                       versionx = all_versions.select { |v| v.start_with?("#{collection['puppet'].to_i}.") }
                       versionx.sort_by { |v| Gem::Version.new(v) }.last # rubocop:disable Style/RedundantSort
-                    else
-                      'latest'
                     end
 
     version = collection['puppet'].to_i
@@ -287,7 +287,21 @@ options[:metadata]['requirements']&.each do |req|
             else
               "#{prefix}#{version}"
             end
-    matrix[:collection] << { collection: group, version: agent_version }
+    matrix[:collection] << if options[:latest_agent] && collection['puppet'] != 'nightly'
+                             require 'net/http'
+                             require 'json'
+                             require 'uri'
+
+                             uri = URI('https://forgeapi.puppet.com/private/versions/puppet-agent')
+                             response = Net::HTTP.get_response(uri)
+                             json_data = JSON.parse(response.body)
+                             all_versions = json_data.keys
+                             versionx = all_versions.select { |v| v.start_with?("#{collection['puppet'].to_i}.") }
+                             versionx.sort_by { |v| Gem::Version.new(v) }.last # rubocop:disable Style/RedundantSort
+                             { collection: group, version: agent_version }
+                           else
+                             group
+                           end
 
     spec_matrix[:include] << {
       puppet_version: "~> #{collection['puppet']}",

spec/exe/matrix_from_metadata_v3_spec.rb

@@ -30,7 +30,7 @@
         '{"label":"Ubuntu-22.04","provider":"docker","arch":"x86_64","image":"litmusimage/ubuntu:22.04","runner":"ubuntu-latest"}',
         '],',
         '"collection":[',
-        '{"collection":"puppetcore8","version":"latest"}',
+        '"puppetcore8"',
         ']',
         '}'
       ].join
@@ -63,7 +63,7 @@
         '{"label":"Ubuntu-22.04-arm","provider":"provision_service","arch":"arm","image":"ubuntu-2204-lts-arm64","runner":"ubuntu-latest"}',
         '],',
         '"collection":[',
-        '{"collection":"puppetcore8","version":"latest"}',
+        '"puppetcore8"',
         ']',
         '}'
       ].join
@@ -103,7 +103,7 @@
         '{"label":"Ubuntu-22.04-arm","provider":"provision_service","arch":"arm","image":"ubuntu-2204-lts-arm64","runner":"ubuntu-latest"}',
         '],',
         '"collection":[',
-        '{"collection":"puppetcore8","version":"latest"}',
+        '"puppetcore8"',
         ']',
         '}'
       ].join
@@ -142,7 +142,7 @@
         '{"label":"Ubuntu-22.04-arm","provider":"provision_service","arch":"arm","image":"ubuntu-2204-lts-arm64","runner":"ubuntu-latest"}',
         '],',
         '"collection":[',
-        '{"collection":"puppetcore8","version":"latest"}',
+        '"puppetcore8"',
         ']',
         '}'
       ].join
@@ -175,7 +175,7 @@
         '"platforms":[',
         '],',
         '"collection":[',
-        '{"collection":"puppetcore8","version":"latest"}',
+        '"puppetcore8"',
         ']',
         '}'
       ].join
@@ -215,7 +215,7 @@
         '{"label":"Ubuntu-22.04","provider":"docker","arch":"x86_64","image":"litmusimage/ubuntu:22.04","runner":"ubuntu-latest"}',
         '],',
         '"collection":[',
-        '{"collection":"puppetcore8","version":"latest"}',
+        '"puppetcore8"',
         ']',
         '}'
       ].join
@@ -233,7 +233,7 @@
         '::group::spec_matrix'
       )
       expect(github_output_content).to include(
-        '"collection":["2023.8.4-puppet_enterprise","2021.7.9-puppet_enterprise",{"collection":"puppetcore8","version":"latest"}'
+        '"collection":["2023.8.4-puppet_enterprise","2021.7.9-puppet_enterprise","puppetcore8"'
       )
       expect(github_output_content).to include(
         'spec_matrix={"include":[{"puppet_version":"~> 8.0","ruby_version":3.2}]}'
@@ -257,7 +257,7 @@
         '{"label":"Ubuntu-22.04-arm","provider":"provision_service","arch":"arm","image":"ubuntu-2204-lts-arm64","runner":"ubuntu-latest"}',
         '],',
         '"collection":[',
-        '{"collection":"puppetcore8-nightly","version":"latest"}',
+        '"puppetcore8-nightly"',
         ']',
         '}'
       ].join
@@ -280,4 +280,25 @@
       )
     end
   end
+
+  context 'with argument --latest-agent' do
+    let(:result) { run_matrix_from_metadata_v3(['--puppetlabs', '--latest-agent']) }
+
+    it 'run successfully' do
+      expect(result.status_code).to eq 0
+    end
+
+    it 'generates the matrix' do
+      expect(result.stdout).to include(
+        '::warning::CentOS-6 no provisioner found',
+        '::warning::Ubuntu-14.04 no provisioner found',
+        '::group::matrix',
+        '::group::spec_matrix'
+      )
+      expect(github_output_content).to match(/{"collection":"puppetcore8","version":"\d+\.\d+\.\d+"}/)
+      expect(github_output_content).to include(
+        'spec_matrix={"include":[{"puppet_version":"~> 8.0","ruby_version":3.2}]}'
+      )
+    end
+  end
 end