From d2404d5175bdc01f532032c82a4891e2f5d070cc Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Wed, 23 Dec 2020 00:02:25 +0000 Subject: [PATCH] test(map): verify `map.jinja` dump using `_mapdata` state * Semi-automated using https://github.com/myii/ssf-formula/pull/285 --- CODEOWNERS | 3 + kitchen.github.yml | 1 + kitchen.vagrant.yml | 1 + kitchen.yml | 4 + salt/_mapdata/_mapdata.jinja | 13 +++ salt/_mapdata/init.sls | 26 ++++++ test/integration/share/README.md | 21 +++++ test/integration/share/inspec.yml | 21 +++++ test/integration/share/libraries/system.rb | 89 +++++++++++++++++++ .../v3000-py2/controls/_mapdata_spec.rb | 47 ++++++++++ test/integration/v3000-py2/inspec.yml | 3 + .../v3000-py3/controls/_mapdata_spec.rb | 47 ++++++++++ test/integration/v3000-py3/inspec.yml | 3 + .../v3001-py3/controls/_mapdata_spec.rb | 47 ++++++++++ test/integration/v3001-py3/inspec.yml | 3 + .../v3002-py3/controls/_mapdata_spec.rb | 47 ++++++++++ test/integration/v3002-py3/inspec.yml | 3 + 17 files changed, 379 insertions(+) create mode 100644 salt/_mapdata/_mapdata.jinja create mode 100644 salt/_mapdata/init.sls create mode 100644 test/integration/share/README.md create mode 100644 test/integration/share/inspec.yml create mode 100644 test/integration/share/libraries/system.rb create mode 100644 test/integration/v3000-py2/controls/_mapdata_spec.rb create mode 100644 test/integration/v3000-py3/controls/_mapdata_spec.rb create mode 100644 test/integration/v3001-py3/controls/_mapdata_spec.rb create mode 100644 test/integration/v3002-py3/controls/_mapdata_spec.rb diff --git a/CODEOWNERS b/CODEOWNERS index b2f3e71..76f22be 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -16,8 +16,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 diff --git a/kitchen.github.yml b/kitchen.github.yml index 87357fe..0a4ec00 100644 --- a/kitchen.github.yml +++ b/kitchen.github.yml @@ -25,6 +25,7 @@ suites: state_top: base: '*': + - salt._mapdata - salt.minion pillars: top.sls: diff --git a/kitchen.vagrant.yml b/kitchen.vagrant.yml index 3b6cda7..55e38e5 100644 --- a/kitchen.vagrant.yml +++ b/kitchen.vagrant.yml @@ -23,6 +23,7 @@ suites: state_top: base: '*': + - salt._mapdata - salt.minion pillars: top.sls: diff --git a/kitchen.yml b/kitchen.yml index a8f5a05..f9dc2b5 100644 --- a/kitchen.yml +++ b/kitchen.yml @@ -301,6 +301,7 @@ suites: state_top: base: '*': + - salt._mapdata - salt.pkgrepo - salt.master - salt.minion @@ -337,6 +338,7 @@ suites: state_top: base: '*': + - salt._mapdata - salt.pkgrepo - salt.master - salt.minion @@ -370,6 +372,7 @@ suites: state_top: base: '*': + - salt._mapdata - salt.pkgrepo - salt.master - salt.minion @@ -393,6 +396,7 @@ suites: state_top: base: '*': + - salt._mapdata - salt.pkgrepo - salt.master - salt.minion diff --git a/salt/_mapdata/_mapdata.jinja b/salt/_mapdata/_mapdata.jinja new file mode 100644 index 0000000..aa9649c --- /dev/null +++ b/salt/_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 +}} diff --git a/salt/_mapdata/init.sls b/salt/_mapdata/init.sls new file mode 100644 index 0000000..e1d741c --- /dev/null +++ b/salt/_mapdata/init.sls @@ -0,0 +1,26 @@ +# -*- coding: utf-8 -*- +# vim: ft=sls +--- +{#- Get the `tplroot` from `tpldir` #} +{%- set tplroot = tpldir.split("/")[0] %} +{%- from tplroot ~ "/map.jinja" import salt_settings with context %} +{%- from tplroot ~ "/map.jinja" import formulas_settings with context %} + +{%- set _mapdata = { + "values": { + "salt_settings": salt_settings, + "formulas_settings": formulas_settings, + } + } %} +{%- 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 }} diff --git a/test/integration/share/README.md b/test/integration/share/README.md new file mode 100644 index 0000000..5bc510c --- /dev/null +++ b/test/integration/share/README.md @@ -0,0 +1,21 @@ +# InSpec Profile: `share` + +This shows the implementation of the `share` InSpec [profile](https://github.com/inspec/inspec/blob/master/docs/profiles.md). + +Its goal is to share the libraries between all profiles. + +## Libraries + +### `system` + +The `system` library provides easy access to system dependent information: + +- `system.platform`: based on `inspec.platform`, modify to values that are more consistent from a SaltStack perspective + - `system.platform[:family]` provide a family name for Arch and Gentoo + - `system.platform[:name]` append `linux` to both `amazon` and `oracle`; ensure Windows platforms are resolved as simply `windows` + - `system.platform[:release]` tweak Arch, Amazon Linux, Gentoo and Windows: + - `Arch` is always `base-latest` + - `Amazon Linux` release `2018` is resolved as `1` + - `Gentoo` release is trimmed to its major version number and then the init system is appended (i.e. `sysv` or `sysd`) + - `Windows` uses the widely-used release number (e.g. `8.1` or `2019-server`) in place of the actual system release version + - `system.platform[:finger]` is the concatenation of the name and the major release number (except for Ubuntu, which gives `ubuntu-20.04` for example) diff --git a/test/integration/share/inspec.yml b/test/integration/share/inspec.yml new file mode 100644 index 0000000..697417a --- /dev/null +++ b/test/integration/share/inspec.yml @@ -0,0 +1,21 @@ +# -*- coding: utf-8 -*- +# vim: ft=yaml +--- +name: share +title: InSpec shared resources +maintainer: SaltStack Formulas +license: Apache-2.0 +summary: shared resources +supports: + - platform-name: debian + - platform-name: ubuntu + - platform-name: centos + - platform-name: fedora + - platform-name: opensuse + - platform-name: suse + - platform-name: freebsd + - platform-name: amazon + - platform-name: oracle + - platform-name: arch + - platform-name: gentoo + - platform: windows diff --git a/test/integration/share/libraries/system.rb b/test/integration/share/libraries/system.rb new file mode 100644 index 0000000..ef23499 --- /dev/null +++ b/test/integration/share/libraries/system.rb @@ -0,0 +1,89 @@ +# frozen_string_literal: true + +# system.rb -- InSpec resources for system values +# Author: Daniel Dehennin +# Copyright (C) 2020 Daniel Dehennin + +class SystemResource < Inspec.resource(1) + name 'system' + + attr_reader :platform + + def initialize + super + @platform = build_platform + end + + private + + def build_platform + { + family: build_platform_family, + name: build_platform_name, + release: build_platform_release, + finger: build_platform_finger + } + end + + def build_platform_family + case inspec.platform[:name] + when 'arch', 'gentoo' + inspec.platform[:name] + else + inspec.platform[:family] + end + end + + def build_platform_name + case inspec.platform[:name] + when 'amazon', 'oracle' + "#{inspec.platform[:name]}linux" + when 'windows_8.1_pro', 'windows_server_2019_datacenter' + 'windows' + else + inspec.platform[:name] + end + end + + # rubocop:disable Metrics/MethodLength + def build_platform_release + case inspec.platform[:name] + when 'amazon' + # `2018` relase is named `1` in kitchen.yaml + inspec.platform[:release].gsub(/2018.*/, '1') + when 'arch' + 'base-latest' + when 'gentoo' + "#{inspec.platform[:release].split('.')[0]}-#{derive_gentoo_init_system}" + when 'windows_8.1_pro' + '8.1' + when 'windows_server_2019_datacenter' + '2019-server' + else + inspec.platform[:release] + end + end + # rubocop:enable Metrics/MethodLength + + def derive_gentoo_init_system + case inspec.command('systemctl').exist? + when true + 'sysd' + else + 'sysv' + end + end + + def build_platform_finger + "#{build_platform_name}-#{build_finger_release}" + end + + def build_finger_release + case inspec.platform[:name] + when 'ubuntu' + build_platform_release.split('.').slice(0, 2).join('.') + else + build_platform_release.split('.')[0] + end + end +end diff --git a/test/integration/v3000-py2/controls/_mapdata_spec.rb b/test/integration/v3000-py2/controls/_mapdata_spec.rb new file mode 100644 index 0000000..6463532 --- /dev/null +++ b/test/integration/v3000-py2/controls/_mapdata_spec.rb @@ -0,0 +1,47 @@ +# frozen_string_literal: true + +require 'yaml' + +control '`map.jinja` YAML dump' do + title 'should match the comparison file' + + ### 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 + + ### 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) + + ### 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' + # 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(output_file_dump).to eq(mapdata_file_dump) + end + end +end diff --git a/test/integration/v3000-py2/inspec.yml b/test/integration/v3000-py2/inspec.yml index 57a8d0e..14d9876 100644 --- a/test/integration/v3000-py2/inspec.yml +++ b/test/integration/v3000-py2/inspec.yml @@ -6,6 +6,9 @@ title: salt formula maintainer: SaltStack Formulas license: Apache-2.0 summary: Verify that Salt `v3000-py2` is setup and configured +depends: + - name: share + path: test/integration/share supports: - platform-name: debian - platform-name: ubuntu diff --git a/test/integration/v3000-py3/controls/_mapdata_spec.rb b/test/integration/v3000-py3/controls/_mapdata_spec.rb new file mode 100644 index 0000000..6463532 --- /dev/null +++ b/test/integration/v3000-py3/controls/_mapdata_spec.rb @@ -0,0 +1,47 @@ +# frozen_string_literal: true + +require 'yaml' + +control '`map.jinja` YAML dump' do + title 'should match the comparison file' + + ### 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 + + ### 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) + + ### 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' + # 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(output_file_dump).to eq(mapdata_file_dump) + end + end +end diff --git a/test/integration/v3000-py3/inspec.yml b/test/integration/v3000-py3/inspec.yml index aab8e51..8cf3c2d 100644 --- a/test/integration/v3000-py3/inspec.yml +++ b/test/integration/v3000-py3/inspec.yml @@ -6,6 +6,9 @@ title: salt formula maintainer: SaltStack Formulas license: Apache-2.0 summary: Verify that Salt `v3000-py3` is setup and configured +depends: + - name: share + path: test/integration/share supports: - platform-name: debian - platform-name: ubuntu diff --git a/test/integration/v3001-py3/controls/_mapdata_spec.rb b/test/integration/v3001-py3/controls/_mapdata_spec.rb new file mode 100644 index 0000000..6463532 --- /dev/null +++ b/test/integration/v3001-py3/controls/_mapdata_spec.rb @@ -0,0 +1,47 @@ +# frozen_string_literal: true + +require 'yaml' + +control '`map.jinja` YAML dump' do + title 'should match the comparison file' + + ### 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 + + ### 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) + + ### 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' + # 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(output_file_dump).to eq(mapdata_file_dump) + end + end +end diff --git a/test/integration/v3001-py3/inspec.yml b/test/integration/v3001-py3/inspec.yml index 4d9d790..0e6c84b 100644 --- a/test/integration/v3001-py3/inspec.yml +++ b/test/integration/v3001-py3/inspec.yml @@ -6,6 +6,9 @@ title: salt formula maintainer: SaltStack Formulas license: Apache-2.0 summary: Verify that Salt `v3001-py3` is setup and configured +depends: + - name: share + path: test/integration/share supports: - platform-name: debian - platform-name: ubuntu diff --git a/test/integration/v3002-py3/controls/_mapdata_spec.rb b/test/integration/v3002-py3/controls/_mapdata_spec.rb new file mode 100644 index 0000000..6463532 --- /dev/null +++ b/test/integration/v3002-py3/controls/_mapdata_spec.rb @@ -0,0 +1,47 @@ +# frozen_string_literal: true + +require 'yaml' + +control '`map.jinja` YAML dump' do + title 'should match the comparison file' + + ### 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 + + ### 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) + + ### 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' + # 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(output_file_dump).to eq(mapdata_file_dump) + end + end +end diff --git a/test/integration/v3002-py3/inspec.yml b/test/integration/v3002-py3/inspec.yml index 9e358ee..0db02cd 100644 --- a/test/integration/v3002-py3/inspec.yml +++ b/test/integration/v3002-py3/inspec.yml @@ -6,6 +6,9 @@ title: salt formula maintainer: SaltStack Formulas license: Apache-2.0 summary: Verify that Salt `v3002-py3` is setup and configured +depends: + - name: share + path: test/integration/share supports: - platform-name: debian - platform-name: ubuntu