(CAT-1545) - Add machine type to matrix

This commit adds a machine_type field to each object in the matrix
platforms.
This means that for arm-based architectures, we can return the
t2a-standard-2 machine which supports arm.
If not arm based, then resort back to default.

README.md

@@ -59,7 +59,7 @@ In order to use this new functionality, run:
 
 `$: bundle exec matrix_from_metadata_v2 --custom-matrix matrix.json`
 
-> Note: The file should contain a valid Array of JSON Objects (i.e. `[{"label":"AlmaLinux-8","provider":"provision_service","image":"almalinux-cloud/almalinux-8"}, {..}]`), otherwise it will throw an error.
+> Note: The file should contain a valid Array of JSON Objects (i.e. `[{"label":"AlmaLinux-8","provider":"provision_service","image":"almalinux-cloud/almalinux-8","machine_type":"n1-standard-2"}, {"label":"RedHat-9-arm","provider":"provision_service","image":"rhel-9-arm64","machine_type":"t2a-standard-2"}, {..}]`), otherwise it will throw an error.
 
 ## Documentation
 

exe/matrix_from_metadata_v2

@@ -28,7 +28,6 @@ IMAGE_TABLE = {
   'RedHat-7' => 'rhel-7',
   'RedHat-8' => 'rhel-8',
   'RedHat-9' => 'rhel-9',
-  'RedHat-9-arm' => 'rhel-9-arm64',
   'SLES-12' => 'sles-12',
   'SLES-15' => 'sles-15',
   'Windows-2016' => 'windows-2016',
@@ -116,7 +115,7 @@ if ARGV.include?('--provision-service')
   updated_list = IMAGE_TABLE.dup.clone
   updated_list.merge!(updated_platforms)
 
-  IMAGE_TABLE = updated_list.freeze
+  IMAGE_TABLE = updated_list
   DOCKER_PLATFORMS = {}.freeze
 end
 
@@ -150,14 +149,20 @@ else
   # Set platforms based on declared operating system support
   metadata['operatingsystem_support'].sort_by { |a| a['operatingsystem'] }.each do |sup|
     os = sup['operatingsystem']
+    if os.casecmp('redhat').zero? && sup['operatingsystemrelease'].include?('9')
+      IMAGE_TABLE['RedHat-9-arm'] = 'rhel-9-arm64'
+      sup['operatingsystemrelease'] << '9-arm'
+    end
     sup['operatingsystemrelease'].sort_by(&:to_i).each do |ver|
       image_key = "#{os}-#{ver}"
 
       if IMAGE_TABLE.key?(image_key) && !exclude_list.include?(image_key.downcase)
         matrix[:platforms] << {
           label: image_key,
           provider: 'provision_service',
-          image: IMAGE_TABLE[image_key]
+          image: IMAGE_TABLE[image_key],
+          # if the image is to be an ARM based instance, use t2a-standard-2 machine type
+          machine_type: image_key.end_with?('-arm') ? 't2a-standard-2' : 'n1-standard-2'
         }
       elsif DOCKER_PLATFORMS.key?(image_key) && !exclude_list.include?(image_key.downcase)
         matrix[:platforms] << {

spec/exe/fake_metadata.json

@@ -24,7 +24,7 @@
       "operatingsystem": "RedHat",
       "operatingsystemrelease": [
         "8",
-        "9-arm"
+        "9"
       ]
     },
     {

spec/exe/matrix_from_metadata_v2_spec.rb

@@ -16,15 +16,16 @@
       expect(result.status_code).to eq 0
     end
 
-    it 'generates the matrix' do
+    it 'generates the matrix' do # rubocop:disable RSpec/ExampleLength
       expect(result.stdout).to include('::warning::Cannot find image for Ubuntu-14.04')
       expect(github_output_content).to include(
         [
           'matrix={',
           '"platforms":[',
           '{"label":"CentOS-6","provider":"docker","image":"litmusimage/centos:6"},',
-          '{"label":"RedHat-8","provider":"provision_service","image":"rhel-8"},',
-          '{"label":"RedHat-9-arm","provider":"provision_service","image":"rhel-9-arm64"},',
+          '{"label":"RedHat-8","provider":"provision_service","image":"rhel-8","machine_type":"n1-standard-2"},',
+          '{"label":"RedHat-9","provider":"provision_service","image":"rhel-9","machine_type":"n1-standard-2"},',
+          '{"label":"RedHat-9-arm","provider":"provision_service","image":"rhel-9-arm64","machine_type":"t2a-standard-2"},',
           '{"label":"Ubuntu-18.04","provider":"docker","image":"litmusimage/ubuntu:18.04"}',
           '],',
           '"collection":[',
@@ -36,7 +37,7 @@
       expect(github_output_content).to include(
         'spec_matrix={"include":[{"puppet_version":"~> 7.24","ruby_version":2.7},{"puppet_version":"~> 8.0","ruby_version":3.2}]}'
       )
-      expect(result.stdout).to include("Created matrix with 10 cells:\n  - Acceptance Test Cells: 8\n  - Spec Test Cells: 2")
+      expect(result.stdout).to include("Created matrix with 12 cells:\n  - Acceptance Test Cells: 10\n  - Spec Test Cells: 2")
     end
   end
 
@@ -53,16 +54,17 @@
       expect(result.status_code).to eq 0
     end
 
-    it 'generates the matrix without excluded platforms' do
+    it 'generates the matrix without excluded platforms' do # rubocop:disable RSpec/ExampleLength
       expect(result.stdout).to include('::warning::Cannot find image for Ubuntu-14.04')
       expect(result.stdout).to include('::warning::Ubuntu-18.04 was excluded from testing')
       expect(github_output_content).to include(
         [
           'matrix={',
           '"platforms":[',
           '{"label":"CentOS-6","provider":"docker","image":"litmusimage/centos:6"},',
-          '{"label":"RedHat-8","provider":"provision_service","image":"rhel-8"},',
-          '{"label":"RedHat-9-arm","provider":"provision_service","image":"rhel-9-arm64"}',
+          '{"label":"RedHat-8","provider":"provision_service","image":"rhel-8","machine_type":"n1-standard-2"},',
+          '{"label":"RedHat-9","provider":"provision_service","image":"rhel-9","machine_type":"n1-standard-2"},',
+          '{"label":"RedHat-9-arm","provider":"provision_service","image":"rhel-9-arm64","machine_type":"t2a-standard-2"}',
           '],',
           '"collection":[',
           '"puppet7-nightly","puppet8-nightly"',
@@ -73,7 +75,7 @@
       expect(github_output_content).to include(
         'spec_matrix={"include":[{"puppet_version":"~> 7.24","ruby_version":2.7},{"puppet_version":"~> 8.0","ruby_version":3.2}]}'
       )
-      expect(result.stdout).to include("Created matrix with 8 cells:\n  - Acceptance Test Cells: 6\n  - Spec Test Cells: 2")
+      expect(result.stdout).to include("Created matrix with 10 cells:\n  - Acceptance Test Cells: 8\n  - Spec Test Cells: 2")
     end
   end
 
@@ -99,7 +101,7 @@
           'matrix={',
           '"platforms":[',
           '{"label":"CentOS-6","provider":"docker","image":"litmusimage/centos:6"},',
-          '{"label":"RedHat-9-arm","provider":"provision_service","image":"rhel-9-arm64"}',
+          '{"label":"RedHat-9-arm","provider":"provision_service","image":"rhel-9-arm64","machine_type":"t2a-standard-2"}',
           '],',
           '"collection":[',
           '"puppet7-nightly","puppet8-nightly"',