refactor(map): use top-level values: key in map.jinja dumps

TEMPLATE/_mapdata/_mapdata.jinja

@@ -1,9 +1,9 @@
 # yamllint disable rule:indentation rule:line-length
-# {{ grains.get('osfinger', grains.os) }}
+# {{ grains.get("osfinger", grains.os) }}
 ---
 {#- use salt.slsutil.serialize to avoid encoding errors on some platforms #}
-{{ salt['slsutil.serialize'](
-     'yaml',
+{{ salt["slsutil.serialize"](
+     "yaml",
      map,
      default_flow_style=False,
      allow_unicode=True,

TEMPLATE/_mapdata/init.sls

@@ -2,18 +2,23 @@
 # vim: ft=sls
 ---
 {#- Get the `tplroot` from `tpldir` #}
-{%- set tplroot = tpldir.split('/')[0] %}
-{%- from tplroot ~ "/map.jinja" import TEMPLATE as mapdata with context %}
+{%- set tplroot = tpldir.split("/")[0] %}
+{%- from tplroot ~ "/map.jinja" import TEMPLATE with context %}
 
-{%- do salt['log.debug']('### MAP.JINJA DUMP ###\n' ~ mapdata | yaml(False)) %}
+{%- set _mapdata = {
+      "values": {
+        "TEMPLATE": TEMPLATE,
+      }
+    } %}
+{%- do salt["log.debug"]("### MAP.JINJA DUMP ###\n" ~ _mapdata | yaml(False)) %}
 
-{%- set output_dir = '/temp' if grains.os_family == 'Windows' else '/tmp' %}
-{%- set output_file = output_dir ~ '/salt_mapdata_dump.yaml' %}
+{%- set output_dir = "/temp" if grains.os_family == "Windows" else "/tmp" %}
+{%- set output_file = output_dir ~ "/salt_mapdata_dump.yaml" %}
 
 {{ tplroot }}-mapdata-dump:
   file.managed:
     - name: {{ output_file }}
     - source: salt://{{ tplroot }}/_mapdata/_mapdata.jinja
     - template: jinja
     - context:
-        map: {{ mapdata | yaml }}
+        map: {{ _mapdata | yaml }}

bin/convert-formula.sh

@@ -68,6 +68,16 @@ convert_formula() {
     sedi "s/\([[:space:]]\{1,\}\)TEMPLATE:/\1${NEW_NAME_PYSAFE}:/" "$filename"
   done
 
+  # Temporarily, until the v5 `map.jinja` is implemented for this formula, this
+  # specific py-safe replacement is also required (`map.jinja` import variable)
+  sedi "s/TEMPLATE/${NEW_NAME_PYSAFE}/g" "${NEW_NAME}/_mapdata/init.sls"
+  # However, this section will probably be needed even for the v5 `map.jinja`
+  # All of the YAML comparison files need the py-safe `map.jinja` import variable
+  git ls-files -- 'test/integration/*.yaml' \
+  | while read -r filename; do
+    sedi "/^\(  \)TEMPLATE\(:\)$/s//\1${NEW_NAME_PYSAFE}\2/" "$filename"
+  done
+
   # Replace all other instances of TEMPLATE with the regular new formula name
   grep --recursive --files-with-matches --exclude-dir=.git TEMPLATE . \
   | while read -r filename; do

test/integration/default/controls/_mapdata_spec.rb

@@ -5,19 +5,43 @@
 control '`map.jinja` YAML dump' do
   title 'should match the comparison file'
 
-  # Strip the `platform[:finger]` version number down to the "OS major release"
-  mapdata_file = "_mapdata/#{system.platform[:finger].split('.').first}.yaml"
+  ### Method
+  # The steps below for each file appear convoluted but they are both required
+  # and similar in nature:
+  # 1. The earliest method was to simply compare the files textually but this often
+  #    led to false positives due to inconsistencies (e.g. spacing, ordering)
+  # 2. The next method was to load the files back into YAML structures and then
+  #    compare but InSpec provided block diffs this way, unusable by end users
+  # 3. The final step was to dump the YAML structures back into a string to use
+  #    for the comparison; this both worked and provided human-friendly diffs
 
-  # Load the mapdata from profile https://docs.chef.io/inspec/profiles/#profile-files
-  mapdata_dump = YAML.safe_load(inspec.profile.file(mapdata_file))
+  ### Comparison file for the specific platform
+  ### Static, adjusted as part of code contributions, as map data is changed
+  # Strip the `platform[:finger]` version number down to the "OS major release"
+  platform_finger = system.platform[:finger].split('.').first.to_s
+  # Use that to set the path to the file (relative to the InSpec suite directory)
+  mapdata_file_path = "_mapdata/#{platform_finger}.yaml"
+  # Load the mapdata from profile, into a YAML structure
+  # https://docs.chef.io/inspec/profiles/#profile-files
+  mapdata_file_yaml = YAML.safe_load(inspec.profile.file(mapdata_file_path))
+  # Dump the YAML back into a string for comparison
+  mapdata_file_dump = YAML.dump(mapdata_file_yaml)
 
-  # Derive the location of the dumped mapdata
+  ### Output file produced by running the `_mapdata` state
+  ### Dynamic, generated during Kitchen's `converge` phase
+  # Derive the location of the dumped mapdata (differs for Windows)
   output_dir = platform[:family] == 'windows' ? '/temp' : '/tmp'
-  output_file = "#{output_dir}/salt_mapdata_dump.yaml"
+  # Use that to set the path to the file (absolute path, i.e. within the container)
+  output_file_path = "#{output_dir}/salt_mapdata_dump.yaml"
+  # Load the output into a YAML structure using InSpec's `yaml` resource
+  # https://github.com/inspec/inspec/blob/49b7d10/lib/inspec/resources/yaml.rb#L29
+  output_file_yaml = yaml(output_file_path).params
+  # Dump the YAML back into a string for comparison
+  output_file_dump = YAML.dump(output_file_yaml)
 
   describe 'File content' do
     it 'should match profile map data exactly' do
-      expect(yaml(output_file).params).to eq(mapdata_dump)
+      expect(output_file_dump).to eq(mapdata_file_dump)
     end
   end
 end

test/integration/default/files/_mapdata/amazonlinux-1.yaml

@@ -1,34 +1,36 @@
 # yamllint disable rule:indentation rule:line-length
 # Amazon Linux AMI-2018
 ---
-added_in_defaults: defaults_value
-added_in_lookup: lookup_value
-added_in_pillar: pillar_value
-arch: amd64
-config: /etc/template-formula.conf
-lookup:
-  added_in_lookup: lookup_value
-  master: template-master
-  winner: lookup
-master: template-master
-pkg:
-  name: cronie
-rootgroup: root
-service:
-  name: crond
-subcomponent:
-  config: /etc/TEMPLATE-subcomponent-formula.conf
-tofs:
-  files_switch:
-  - any/path/can/be/used/here
-  - id
-  - roles
-  - osfinger
-  - os
-  - os_family
-  source_files:
-    TEMPLATE-config-file-file-managed:
-    - example.tmpl.jinja
-    TEMPLATE-subcomponent-config-file-file-managed:
-    - subcomponent-example.tmpl.jinja
-winner: pillar
+values:
+  TEMPLATE:
+    added_in_defaults: defaults_value
+    added_in_lookup: lookup_value
+    added_in_pillar: pillar_value
+    arch: amd64
+    config: /etc/template-formula.conf
+    lookup:
+      added_in_lookup: lookup_value
+      master: template-master
+      winner: lookup
+    master: template-master
+    pkg:
+      name: cronie
+    rootgroup: root
+    service:
+      name: crond
+    subcomponent:
+      config: /etc/TEMPLATE-subcomponent-formula.conf
+    tofs:
+      files_switch:
+      - any/path/can/be/used/here
+      - id
+      - roles
+      - osfinger
+      - os
+      - os_family
+      source_files:
+        TEMPLATE-config-file-file-managed:
+        - example.tmpl.jinja
+        TEMPLATE-subcomponent-config-file-file-managed:
+        - subcomponent-example.tmpl.jinja
+    winner: pillar

test/integration/default/files/_mapdata/amazonlinux-2.yaml

@@ -1,34 +1,36 @@
 # yamllint disable rule:indentation rule:line-length
 # Amazon Linux-2
 ---
-added_in_defaults: defaults_value
-added_in_lookup: lookup_value
-added_in_pillar: pillar_value
-arch: amd64
-config: /etc/template-formula.conf
-lookup:
-  added_in_lookup: lookup_value
-  master: template-master
-  winner: lookup
-master: template-master
-pkg:
-  name: bash
-rootgroup: root
-service:
-  name: systemd-journald
-subcomponent:
-  config: /etc/TEMPLATE-subcomponent-formula.conf
-tofs:
-  files_switch:
-  - any/path/can/be/used/here
-  - id
-  - roles
-  - osfinger
-  - os
-  - os_family
-  source_files:
-    TEMPLATE-config-file-file-managed:
-    - example.tmpl.jinja
-    TEMPLATE-subcomponent-config-file-file-managed:
-    - subcomponent-example.tmpl.jinja
-winner: pillar
+values:
+  TEMPLATE:
+    added_in_defaults: defaults_value
+    added_in_lookup: lookup_value
+    added_in_pillar: pillar_value
+    arch: amd64
+    config: /etc/template-formula.conf
+    lookup:
+      added_in_lookup: lookup_value
+      master: template-master
+      winner: lookup
+    master: template-master
+    pkg:
+      name: bash
+    rootgroup: root
+    service:
+      name: systemd-journald
+    subcomponent:
+      config: /etc/TEMPLATE-subcomponent-formula.conf
+    tofs:
+      files_switch:
+      - any/path/can/be/used/here
+      - id
+      - roles
+      - osfinger
+      - os
+      - os_family
+      source_files:
+        TEMPLATE-config-file-file-managed:
+        - example.tmpl.jinja
+        TEMPLATE-subcomponent-config-file-file-managed:
+        - subcomponent-example.tmpl.jinja
+    winner: pillar

test/integration/default/files/_mapdata/arch-base-latest.yaml

@@ -1,34 +1,36 @@
 # yamllint disable rule:indentation rule:line-length
 # Arch
 ---
-added_in_defaults: defaults_value
-added_in_lookup: lookup_value
-added_in_pillar: pillar_value
-arch: amd64
-config: /etc/template-formula.conf
-lookup:
-  added_in_lookup: lookup_value
-  master: template-master
-  winner: lookup
-master: template-master
-pkg:
-  name: bash
-rootgroup: root
-service:
-  name: systemd-journald
-subcomponent:
-  config: /etc/TEMPLATE-subcomponent-formula.conf
-tofs:
-  files_switch:
-  - any/path/can/be/used/here
-  - id
-  - roles
-  - osfinger
-  - os
-  - os_family
-  source_files:
-    TEMPLATE-config-file-file-managed:
-    - example.tmpl.jinja
-    TEMPLATE-subcomponent-config-file-file-managed:
-    - subcomponent-example.tmpl.jinja
-winner: pillar
+values:
+  TEMPLATE:
+    added_in_defaults: defaults_value
+    added_in_lookup: lookup_value
+    added_in_pillar: pillar_value
+    arch: amd64
+    config: /etc/template-formula.conf
+    lookup:
+      added_in_lookup: lookup_value
+      master: template-master
+      winner: lookup
+    master: template-master
+    pkg:
+      name: bash
+    rootgroup: root
+    service:
+      name: systemd-journald
+    subcomponent:
+      config: /etc/TEMPLATE-subcomponent-formula.conf
+    tofs:
+      files_switch:
+      - any/path/can/be/used/here
+      - id
+      - roles
+      - osfinger
+      - os
+      - os_family
+      source_files:
+        TEMPLATE-config-file-file-managed:
+        - example.tmpl.jinja
+        TEMPLATE-subcomponent-config-file-file-managed:
+        - subcomponent-example.tmpl.jinja
+    winner: pillar

test/integration/default/files/_mapdata/centos-6.yaml

@@ -1,34 +1,36 @@
 # yamllint disable rule:indentation rule:line-length
 # CentOS-6
 ---
-added_in_defaults: defaults_value
-added_in_lookup: lookup_value
-added_in_pillar: pillar_value
-arch: amd64
-config: /etc/template-formula.conf
-lookup:
-  added_in_lookup: lookup_value
-  master: template-master
-  winner: lookup
-master: template-master
-pkg:
-  name: cronie
-rootgroup: root
-service:
-  name: crond
-subcomponent:
-  config: /etc/TEMPLATE-subcomponent-formula.conf
-tofs:
-  files_switch:
-  - any/path/can/be/used/here
-  - id
-  - roles
-  - osfinger
-  - os
-  - os_family
-  source_files:
-    TEMPLATE-config-file-file-managed:
-    - example.tmpl.jinja
-    TEMPLATE-subcomponent-config-file-file-managed:
-    - subcomponent-example.tmpl.jinja
-winner: pillar
+values:
+  TEMPLATE:
+    added_in_defaults: defaults_value
+    added_in_lookup: lookup_value
+    added_in_pillar: pillar_value
+    arch: amd64
+    config: /etc/template-formula.conf
+    lookup:
+      added_in_lookup: lookup_value
+      master: template-master
+      winner: lookup
+    master: template-master
+    pkg:
+      name: cronie
+    rootgroup: root
+    service:
+      name: crond
+    subcomponent:
+      config: /etc/TEMPLATE-subcomponent-formula.conf
+    tofs:
+      files_switch:
+      - any/path/can/be/used/here
+      - id
+      - roles
+      - osfinger
+      - os
+      - os_family
+      source_files:
+        TEMPLATE-config-file-file-managed:
+        - example.tmpl.jinja
+        TEMPLATE-subcomponent-config-file-file-managed:
+        - subcomponent-example.tmpl.jinja
+    winner: pillar