Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

(FEAT) - Add ability to supply a custom matrix and override default provisioner #506

Merged
merged 7 commits into from
Jul 6, 2023
Merged

(FEAT) - Add ability to supply a custom matrix and override default provisioner #506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
88fb3df
(feat) - Add ability to override default provisioner
jordanbreen28 Jul 6, 2023
2e57ea6
(feat) - Add ability to provide a custom matrix
jordanbreen28 Jul 6, 2023
1d0af2e
(maint) - remove unnecessary provision:: prefix
jordanbreen28 Jul 6, 2023
c17fd46
(maint) - correct typo in warning
jordanbreen28 Jul 6, 2023
7d9c9ad
(maint) - add rocky/alma 8 gcp images
jordanbreen28 Jul 6, 2023
a1ec970
(bug) - correct bug with ordering custom matrix
jordanbreen28 Jul 6, 2023
4aec93a
(maint) - Update warning
jordanbreen28 Jul 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 71 additions & 22 deletions exe/matrix_from_metadata_v2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,29 +94,79 @@ else
exclude_list = []
end

# Force the use of the provision_service provisioner, if the --provision-service argument is present
if ARGV.include?('--provision-service')
provision_service_occurrences = ARGV.count { |arg| arg == '--provision-service' }
raise 'the --provision-service argument should be present just one time in the command' unless provision_service_occurrences <= 1

# NOTE: that the below are the only available images for the provision service
updated_platforms = {
'AlmaLinux-8' => 'almalinux-cloud/almalinux-8',
'CentOS-7' => 'centos-7',
'CentOS-8' => 'centos-stream-8',
'Rocky-8' => 'rocky-linux-cloud/rocky-linux-8',
'Debian-10' => 'debian-10',
'Debian-11' => 'debian-11',
'Ubuntu-20.04' => 'ubuntu-2004-lts',
'Ubuntu-22.04' => 'ubuntu-2204-lts'
}

updated_list = IMAGE_TABLE.dup.clone
updated_list.merge!(updated_platforms)

IMAGE_TABLE = updated_list.freeze
DOCKER_PLATFORMS = {}.freeze
end

metadata_path = ENV['TEST_MATRIX_FROM_METADATA'] || 'metadata.json'
metadata = JSON.parse(File.read(metadata_path))
# Set platforms based on declared operating system support
metadata['operatingsystem_support'].sort_by { |a| a['operatingsystem'] }.each do |sup|
os = sup['operatingsystem']
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::provision_service',
image: IMAGE_TABLE[image_key]
}
elsif DOCKER_PLATFORMS.key?(image_key) && !exclude_list.include?(image_key.downcase)
matrix[:platforms] << {
label: image_key,
provider: 'provision::docker',
image: DOCKER_PLATFORMS[image_key]
}

# Allow the user to pass a file containing a custom matrix
if ARGV.include?('--custom-matrix')
custom_matrix_occurrences = ARGV.count { |arg| arg == '--custom-matrix' }
raise '--custom-matrix argument should be present just one time in the command' unless custom_matrix_occurrences <= 1

file_path = ARGV[ARGV.find_index('--custom-matrix') + 1]
raise 'no file path specified' if file_path.nil?

begin
custom_matrix = JSON.parse(File.read(file_path))
rescue StandardError => e
case e
when JSON::ParserError
raise 'the matrix must be an array of valid JSON objects'
when Errno::ENOENT
raise "File not found: #{e.message}"
else
puts "::warning::#{image_key} was excluded from testing" if exclude_list.include?(image_key.downcase)
puts "::warning::Cannot find image for #{image_key}" unless exclude_list.include?(image_key.downcase)
raise "An unknown exception occurred: #{e.message}"
end
end
custom_matrix.each do |platform|
matrix[:platforms] << platform
end
else
# Set platforms based on declared operating system support
metadata['operatingsystem_support'].sort_by { |a| a['operatingsystem'] }.each do |sup|
os = sup['operatingsystem']
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]
}
elsif DOCKER_PLATFORMS.key?(image_key) && !exclude_list.include?(image_key.downcase)
matrix[:platforms] << {
label: image_key,
provider: 'docker',
image: DOCKER_PLATFORMS[image_key]
}
else
puts "::warning::#{image_key} was excluded from testing" if exclude_list.include?(image_key.downcase)
puts "::warning::Cannot find image for #{image_key}" unless exclude_list.include?(image_key.downcase)
end
end
end
end
Expand Down Expand Up @@ -155,9 +205,8 @@ end

# Set to defaults (all collections) if no matches are found
matrix[:collection] = COLLECTION_TABLE.map { |collection| "puppet#{collection[:puppet_maj_version]}-nightly" } if matrix[:collection].empty?

# Just to make sure there aren't any duplicates
matrix[:platforms] = matrix[:platforms].uniq.sort_by { |a| a[:label] }
matrix[:platforms] = matrix[:platforms].uniq.sort_by { |a| a[:label] } unless ARGV.include?('--custom-matrix')
matrix[:collection] = matrix[:collection].uniq.sort

set_output('matrix', JSON.generate(matrix))
Expand Down
2 changes: 1 addition & 1 deletion lib/puppet_litmus/rake_helper.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ def provisioner_task(provisioner)
if SUPPORTED_PROVISIONERS.include?(provisioner)
"provision::#{provisioner}"
else
warn "WARNING: Unsuported provisioner '#{provisioner}', try #{SUPPORTED_PROVISIONERS.join('/')}"
warn "WARNING: Unsupported provisioner '#{provisioner}', try #{SUPPORTED_PROVISIONERS.join('/')}"
provisioner.to_s
end
end
Expand Down
12 changes: 6 additions & 6 deletions spec/exe/matrix_from_metadata_v2_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@
[
'matrix={',
'"platforms":[',
'{"label":"CentOS-6","provider":"provision::docker","image":"litmusimage/centos:6"},',
'{"label":"RedHat-8","provider":"provision::provision_service","image":"rhel-8"},',
'{"label":"Ubuntu-18.04","provider":"provision::docker","image":"litmusimage/ubuntu:18.04"}',
'{"label":"CentOS-6","provider":"docker","image":"litmusimage/centos:6"},',
'{"label":"RedHat-8","provider":"provision_service","image":"rhel-8"},',
'{"label":"Ubuntu-18.04","provider":"docker","image":"litmusimage/ubuntu:18.04"}',
'],',
'"collection":[',
'"puppet7-nightly","puppet8-nightly"',
Expand Down Expand Up @@ -59,8 +59,8 @@
[
'matrix={',
'"platforms":[',
'{"label":"CentOS-6","provider":"provision::docker","image":"litmusimage/centos:6"},',
'{"label":"RedHat-8","provider":"provision::provision_service","image":"rhel-8"}',
'{"label":"CentOS-6","provider":"docker","image":"litmusimage/centos:6"},',
'{"label":"RedHat-8","provider":"provision_service","image":"rhel-8"}',
'],',
'"collection":[',
'"puppet7-nightly","puppet8-nightly"',
Expand Down Expand Up @@ -96,7 +96,7 @@
[
'matrix={',
'"platforms":[',
'{"label":"CentOS-6","provider":"provision::docker","image":"litmusimage/centos:6"}',
'{"label":"CentOS-6","provider":"docker","image":"litmusimage/centos:6"}',
'],',
'"collection":[',
'"puppet7-nightly","puppet8-nightly"',
Expand Down