|
| 1 | +# frozen_string_literal: true |
| 2 | + |
| 3 | +require 'yaml' |
| 4 | + |
| 5 | +control 'packages._mapdata' do |
| 6 | + title '`map.jinja` should match the reference file' |
| 7 | + |
| 8 | + ### Method |
| 9 | + # The steps below for each file appear convoluted but they are both required |
| 10 | + # and similar in nature: |
| 11 | + # 1. The earliest method was to simply compare the files textually but this often |
| 12 | + # led to false positives due to inconsistencies (e.g. spacing, ordering) |
| 13 | + # 2. The next method was to load the files back into YAML structures and then |
| 14 | + # compare but InSpec provided block diffs this way, unusable by end users |
| 15 | + # 3. The final step was to dump the YAML structures back into a string to use |
| 16 | + # for the comparison; this both worked and provided human-friendly diffs |
| 17 | + |
| 18 | + ### Comparison file for the specific platform |
| 19 | + ### Static, adjusted as part of code contributions, as map data is changed |
| 20 | + # Strip the `platform[:finger]` version number down to the "OS major release" |
| 21 | + platform_finger = system.platform[:finger].split('.').first.to_s |
| 22 | + # Use that to set the path to the file (relative to the InSpec suite directory) |
| 23 | + mapdata_file_path = "_mapdata/#{platform_finger}.yaml" |
| 24 | + # Load the mapdata from profile, into a YAML structure |
| 25 | + # https://docs.chef.io/inspec/profiles/#profile-files |
| 26 | + mapdata_file_yaml = YAML.load(inspec.profile.file(mapdata_file_path)) |
| 27 | + # Dump the YAML back into a string for comparison |
| 28 | + mapdata_file_dump = YAML.dump(mapdata_file_yaml) |
| 29 | + |
| 30 | + ### Output file produced by running the `_mapdata` state |
| 31 | + ### Dynamic, generated during Kitchen's `converge` phase |
| 32 | + # Derive the location of the dumped mapdata (differs for Windows) |
| 33 | + output_dir = platform[:family] == 'windows' ? '/temp' : '/tmp' |
| 34 | + # Use that to set the path to the file (absolute path, i.e. within the container) |
| 35 | + output_file_path = "#{output_dir}/salt_mapdata_dump.yaml" |
| 36 | + # Load the output into a YAML structure using InSpec's `yaml` resource |
| 37 | + # https://github.com/inspec/inspec/blob/49b7d10/lib/inspec/resources/yaml.rb#L29 |
| 38 | + output_file_yaml = yaml(output_file_path).params |
| 39 | + # Dump the YAML back into a string for comparison |
| 40 | + output_file_dump = YAML.dump(output_file_yaml) |
| 41 | + |
| 42 | + describe 'File content' do |
| 43 | + it 'should match profile map data exactly' do |
| 44 | + expect(output_file_dump).to eq(mapdata_file_dump) |
| 45 | + end |
| 46 | + end |
| 47 | +end |
0 commit comments