Merge pull request #69 from myii/test/compare-mapdata-using-yaml

test(map): standardise `map.jinja` verification

CODEOWNERS

@@ -19,8 +19,11 @@
 /docs/AUTHORS.rst                           @saltstack-formulas/ssf
 /docs/CHANGELOG.rst                         @saltstack-formulas/ssf
 /docs/TOFS_pattern.rst                      @saltstack-formulas/ssf
+/*/_mapdata/                                @saltstack-formulas/ssf
 /*/libsaltcli.jinja                         @saltstack-formulas/ssf
 /*/libtofs.jinja                            @saltstack-formulas/ssf
+/test/integration/**/_mapdata_spec.rb       @saltstack-formulas/ssf
+/test/integration/**/libraries/system.rb    @saltstack-formulas/ssf
 /test/integration/**/inspec.yml             @saltstack-formulas/ssf
 /test/integration/**/README.md              @saltstack-formulas/ssf
 /.gitignore                                 @saltstack-formulas/ssf

sudoers/_mapdata/init.sls

@@ -3,19 +3,17 @@
 ---
 {#- Get the `tplroot` from `tpldir` #}
 {%- set tplroot = tpldir.split('/')[0] %}
-{%- from tplroot ~ "/map.jinja" import sudoers with context %}
+{%- from tplroot ~ "/map.jinja" import sudoers as mapdata with context %}
 
-{%- set map = {
-      'sudoers': sudoers,
-    } %}
-{%- do salt['log.debug']('### MAP.JINJA DUMP ###\n' ~ map | yaml(False)) %}
+{%- do salt['log.debug']('### MAP.JINJA DUMP ###\n' ~ mapdata | yaml(False)) %}
 
-{%- set output_file = '/tmp/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: {{ map | yaml }}
+        map: {{ mapdata | yaml }}

test/integration/default/controls/_mapdata_spec.rb

@@ -1,13 +1,23 @@
 # frozen_string_literal: true
 
+require 'yaml'
+
 control '`map.jinja` YAML dump' do
-  title 'should contain the lines'
+  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"
-  mapdata_dump = inspec.profile.file(mapdata_file)
 
-  describe file('/tmp/salt_mapdata_dump.yaml') do
-    it { should exist }
-    its('content') { should eq mapdata_dump }
+  # Load the mapdata from profile https://docs.chef.io/inspec/profiles/#profile-files
+  mapdata_dump = YAML.safe_load(inspec.profile.file(mapdata_file))
+
+  # Derive the location of the dumped mapdata
+  output_dir = platform[:family] == 'windows' ? '/temp' : '/tmp'
+  output_file = "#{output_dir}/salt_mapdata_dump.yaml"
+
+  describe 'File content' do
+    it 'should match profile map data exactly' do
+      expect(yaml(output_file).params).to eq(mapdata_dump)
+    end
   end
 end

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

@@ -1,70 +1,69 @@
 # yamllint disable rule:indentation rule:line-length
 # Amazon Linux AMI-2018
 ---
-sudoers:
-  aliases:
-    commands:
-      PROCESSES:
-      - /usr/bin/nice
-      - /bin/kill
-      - /usr/bin/renice
-      - /usr/bin/pkill
-      - /usr/bin/top
-    hosts:
-      WEBSERVERS:
-      - www1
-      - www2
-      - www3
-    users:
-      ADMINS:
-      - millert
-      - dowdy
-      - mikef
-  arch: amd64
-  configpath: /etc
-  defaults:
-    command_list:
-      PROCESSES: noexec
-    generic:
-    - env_reset
-    - mail_badpass
-    - secure_path="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
-    host_list:
-      www1: log_year, logfile=/var/log/sudo.log
-    runas_list:
-      root: '!set_logname'
-    user_list:
-      ADMINS: '!lecture'
-      johndoe: '!requiretty'
-  execprefix: /usr/sbin
-  group: root
-  groups:
-    sudo:
-    - ALL=(ALL) ALL
-    - 'ALL=(nodejs) NOPASSWD: ALL'
-  included_files:
-    /etc/sudoers.d/extra-file:
-      users:
-        foo:
-        - ALL=(ALL) ALL
-    extra-file-2:
-      groups:
-        bargroup:
-        - 'ALL=(ALL) NOPASSWD: ALL'
-    extra-file-3:
-      netgroups:
-        other_netgroup:
-        - ALL=(ALL) ALL
-  includedir: /etc/sudoers.d
-  manage_main_config: true
-  netgroups:
-    sysadmins:
-    - ALL=(ALL) ALL
-  pkg: sudo
-  purge_includedir: false
+aliases:
+  commands:
+    PROCESSES:
+    - /usr/bin/nice
+    - /bin/kill
+    - /usr/bin/renice
+    - /usr/bin/pkill
+    - /usr/bin/top
+  hosts:
+    WEBSERVERS:
+    - www1
+    - www2
+    - www3
   users:
-    johndoe:
-    - ALL=(ALL) ALL
-    - 'ALL=(root) NOPASSWD: /etc/init.d/httpd'
-    kitchen:
-    - 'ALL=(root) NOPASSWD: ALL'
+    ADMINS:
+    - millert
+    - dowdy
+    - mikef
+arch: amd64
+configpath: /etc
+defaults:
+  command_list:
+    PROCESSES: noexec
+  generic:
+  - env_reset
+  - mail_badpass
+  - secure_path="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
+  host_list:
+    www1: log_year, logfile=/var/log/sudo.log
+  runas_list:
+    root: '!set_logname'
+  user_list:
+    ADMINS: '!lecture'
+    johndoe: '!requiretty'
+execprefix: /usr/sbin
+group: root
+groups:
+  sudo:
+  - ALL=(ALL) ALL
+  - 'ALL=(nodejs) NOPASSWD: ALL'
+included_files:
+  /etc/sudoers.d/extra-file:
+    users:
+      foo:
+      - ALL=(ALL) ALL
+  extra-file-2:
+    groups:
+      bargroup:
+      - 'ALL=(ALL) NOPASSWD: ALL'
+  extra-file-3:
+    netgroups:
+      other_netgroup:
+      - ALL=(ALL) ALL
+includedir: /etc/sudoers.d
+manage_main_config: true
+netgroups:
+  sysadmins:
+  - ALL=(ALL) ALL
+pkg: sudo
+purge_includedir: false
+users:
+  johndoe:
+  - ALL=(ALL) ALL
+  - 'ALL=(root) NOPASSWD: /etc/init.d/httpd'
+  kitchen:
+  - 'ALL=(root) NOPASSWD: ALL'

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

@@ -1,70 +1,69 @@
 # yamllint disable rule:indentation rule:line-length
 # Amazon Linux-2
 ---
-sudoers:
-  aliases:
-    commands:
-      PROCESSES:
-      - /usr/bin/nice
-      - /bin/kill
-      - /usr/bin/renice
-      - /usr/bin/pkill
-      - /usr/bin/top
-    hosts:
-      WEBSERVERS:
-      - www1
-      - www2
-      - www3
-    users:
-      ADMINS:
-      - millert
-      - dowdy
-      - mikef
-  arch: amd64
-  configpath: /etc
-  defaults:
-    command_list:
-      PROCESSES: noexec
-    generic:
-    - env_reset
-    - mail_badpass
-    - secure_path="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
-    host_list:
-      www1: log_year, logfile=/var/log/sudo.log
-    runas_list:
-      root: '!set_logname'
-    user_list:
-      ADMINS: '!lecture'
-      johndoe: '!requiretty'
-  execprefix: /usr/sbin
-  group: root
-  groups:
-    sudo:
-    - ALL=(ALL) ALL
-    - 'ALL=(nodejs) NOPASSWD: ALL'
-  included_files:
-    /etc/sudoers.d/extra-file:
-      users:
-        foo:
-        - ALL=(ALL) ALL
-    extra-file-2:
-      groups:
-        bargroup:
-        - 'ALL=(ALL) NOPASSWD: ALL'
-    extra-file-3:
-      netgroups:
-        other_netgroup:
-        - ALL=(ALL) ALL
-  includedir: /etc/sudoers.d
-  manage_main_config: true
-  netgroups:
-    sysadmins:
-    - ALL=(ALL) ALL
-  pkg: sudo
-  purge_includedir: false
+aliases:
+  commands:
+    PROCESSES:
+    - /usr/bin/nice
+    - /bin/kill
+    - /usr/bin/renice
+    - /usr/bin/pkill
+    - /usr/bin/top
+  hosts:
+    WEBSERVERS:
+    - www1
+    - www2
+    - www3
   users:
-    johndoe:
-    - ALL=(ALL) ALL
-    - 'ALL=(root) NOPASSWD: /etc/init.d/httpd'
-    kitchen:
-    - 'ALL=(root) NOPASSWD: ALL'
+    ADMINS:
+    - millert
+    - dowdy
+    - mikef
+arch: amd64
+configpath: /etc
+defaults:
+  command_list:
+    PROCESSES: noexec
+  generic:
+  - env_reset
+  - mail_badpass
+  - secure_path="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
+  host_list:
+    www1: log_year, logfile=/var/log/sudo.log
+  runas_list:
+    root: '!set_logname'
+  user_list:
+    ADMINS: '!lecture'
+    johndoe: '!requiretty'
+execprefix: /usr/sbin
+group: root
+groups:
+  sudo:
+  - ALL=(ALL) ALL
+  - 'ALL=(nodejs) NOPASSWD: ALL'
+included_files:
+  /etc/sudoers.d/extra-file:
+    users:
+      foo:
+      - ALL=(ALL) ALL
+  extra-file-2:
+    groups:
+      bargroup:
+      - 'ALL=(ALL) NOPASSWD: ALL'
+  extra-file-3:
+    netgroups:
+      other_netgroup:
+      - ALL=(ALL) ALL
+includedir: /etc/sudoers.d
+manage_main_config: true
+netgroups:
+  sysadmins:
+  - ALL=(ALL) ALL
+pkg: sudo
+purge_includedir: false
+users:
+  johndoe:
+  - ALL=(ALL) ALL
+  - 'ALL=(root) NOPASSWD: /etc/init.d/httpd'
+  kitchen:
+  - 'ALL=(root) NOPASSWD: ALL'