Merge pull request #221 from myii/test/manage-map.jinja-verification

test(map): verify `map.jinja` dump using `_mapdata` state

Author: myii

CODEOWNERS

@@ -15,8 +15,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

kitchen.yml

@@ -162,6 +162,7 @@ suites:
       state_top:
         base:
           '*':
+            - php._mapdata
             - php.repo
             - php.fpm.install
             - php.fpm.config
@@ -188,6 +189,7 @@ suites:
       state_top:
         base:
           '*':
+            - php._mapdata
             - php.repo
             - php.fpm.install
             - php.fpm.config
@@ -225,6 +227,7 @@ suites:
       state_top:
         base:
           '*':
+            - php._mapdata
             - php
       pillars:
         top.sls:
@@ -246,6 +249,7 @@ suites:
       state_top:
         base:
           '*':
+            - php._mapdata
             - php
       pillars:
         top.sls:

php/_mapdata/_mapdata.jinja

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

php/_mapdata/init.sls

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+# vim: ft=sls
+---
+{#- Get the `tplroot` from `tpldir` #}
+{%- set tplroot = tpldir.split('/')[0] %}
+{%- from tplroot ~ "/map.jinja" import php as mapdata with context %}
+
+{%- 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' %}
+
+{{ tplroot }}-mapdata-dump:
+  file.managed:
+    - name: {{ output_file }}
+    - source: salt://{{ tplroot }}/_mapdata/_mapdata.jinja
+    - template: jinja
+    - context:
+        map: {{ mapdata | yaml }}

test/integration/default/controls/_mapdata_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+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"
+
+  # 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/controls/config_spec.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 control 'Php configuration' do
   title 'should match desired lines'
 
+  # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
   def test_debian
     describe file('/etc/php/5.6/fpm/pool.d/radius-admin.conf') do
       its('content') { should include '[radius-admin]' }
@@ -20,12 +23,11 @@ def test_debian
       its('content') { should include 'date.timezone = Europe/Paris' }
     end
   end
+  # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
-  def test_redhat
-  end
+  def test_redhat; end
 
-  def test_suse
-  end
+  def test_suse; end
 
   case os[:family]
   when 'debian'

test/integration/default/controls/package_spec.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 control 'Php package' do
   title 'should be installed'
 
+  # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
   def test_debian
     describe package('php-imagick') do
       it { should be_installed }
@@ -18,7 +21,6 @@ def test_debian
       bz2 cli curl fpm gd imap intl mbstring
       mysql readline xml zip
     ].each do |pkg|
-
       describe package("php5.6-#{pkg}") do
         it { should be_installed }
       end
@@ -28,6 +30,7 @@ def test_debian
       end
     end
   end
+  # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
   def test_redhat
     describe package('php') do

test/integration/default/controls/service_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 control 'Php service' do
   title 'should be running and enabled'
 
@@ -13,11 +15,9 @@ def test_debian
     end
   end
 
-  def test_redhat
-  end
+  def test_redhat; end
 
-  def test_suse
-  end
+  def test_suse; end
 
   case os[:family]
   when 'debian'