1
0
Fork 0
mirror of synced 2024-11-21 16:35:33 -05:00

Merge pull request #72 from myii/refactor/use-top-level-values-in-map-jinja-dumps

refactor(map): use top-level `values:` key in `map.jinja` dumps
This commit is contained in:
Imran Iqbal 2020-12-23 18:46:35 +00:00 committed by GitHub
commit 6f21f9455b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
17 changed files with 969 additions and 912 deletions

View file

@ -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,

View file

@ -2,13 +2,18 @@
# vim: ft=sls
---
{#- Get the `tplroot` from `tpldir` #}
{%- set tplroot = tpldir.split('/')[0] %}
{%- from tplroot ~ "/map.jinja" import sudoers as mapdata with context %}
{%- set tplroot = tpldir.split("/")[0] %}
{%- from tplroot ~ "/map.jinja" import sudoers with context %}
{%- do salt['log.debug']('### MAP.JINJA DUMP ###\n' ~ mapdata | yaml(False)) %}
{%- set _mapdata = {
"values": {
"sudoers": sudoers,
}
} %}
{%- 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:
@ -16,4 +21,4 @@
- source: salt://{{ tplroot }}/_mapdata/_mapdata.jinja
- template: jinja
- context:
map: {{ mapdata | yaml }}
map: {{ _mapdata | yaml }}

View file

@ -5,19 +5,43 @@ 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"
mapdata_file = "_mapdata/#{system.platform[:finger].split('.').first}.yaml"
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)
# 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 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

View file

@ -1,7 +1,9 @@
# yamllint disable rule:indentation rule:line-length
# Amazon Linux AMI-2018
---
aliases:
values:
sudoers:
aliases:
commands:
PROCESSES:
- /usr/bin/nice
@ -19,9 +21,9 @@ aliases:
- millert
- dowdy
- mikef
arch: amd64
configpath: /etc
defaults:
arch: amd64
configpath: /etc
defaults:
command_list:
PROCESSES: noexec
generic:
@ -35,13 +37,13 @@ defaults:
user_list:
ADMINS: '!lecture'
johndoe: '!requiretty'
execprefix: /usr/sbin
group: root
groups:
execprefix: /usr/sbin
group: root
groups:
sudo:
- ALL=(ALL) ALL
- 'ALL=(nodejs) NOPASSWD: ALL'
included_files:
included_files:
/etc/sudoers.d/extra-file:
users:
foo:
@ -54,14 +56,14 @@ included_files:
netgroups:
other_netgroup:
- ALL=(ALL) ALL
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
sysadmins:
- ALL=(ALL) ALL
pkg: sudo
purge_includedir: false
users:
pkg: sudo
purge_includedir: false
users:
johndoe:
- ALL=(ALL) ALL
- 'ALL=(root) NOPASSWD: /etc/init.d/httpd'

View file

@ -1,7 +1,9 @@
# yamllint disable rule:indentation rule:line-length
# Amazon Linux-2
---
aliases:
values:
sudoers:
aliases:
commands:
PROCESSES:
- /usr/bin/nice
@ -19,9 +21,9 @@ aliases:
- millert
- dowdy
- mikef
arch: amd64
configpath: /etc
defaults:
arch: amd64
configpath: /etc
defaults:
command_list:
PROCESSES: noexec
generic:
@ -35,13 +37,13 @@ defaults:
user_list:
ADMINS: '!lecture'
johndoe: '!requiretty'
execprefix: /usr/sbin
group: root
groups:
execprefix: /usr/sbin
group: root
groups:
sudo:
- ALL=(ALL) ALL
- 'ALL=(nodejs) NOPASSWD: ALL'
included_files:
included_files:
/etc/sudoers.d/extra-file:
users:
foo:
@ -54,14 +56,14 @@ included_files:
netgroups:
other_netgroup:
- ALL=(ALL) ALL
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
sysadmins:
- ALL=(ALL) ALL
pkg: sudo
purge_includedir: false
users:
pkg: sudo
purge_includedir: false
users:
johndoe:
- ALL=(ALL) ALL
- 'ALL=(root) NOPASSWD: /etc/init.d/httpd'

View file

@ -1,7 +1,9 @@
# yamllint disable rule:indentation rule:line-length
# Arch
---
aliases:
values:
sudoers:
aliases:
commands:
PROCESSES:
- /usr/bin/nice
@ -19,9 +21,9 @@ aliases:
- millert
- dowdy
- mikef
arch: amd64
configpath: /etc
defaults:
arch: amd64
configpath: /etc
defaults:
command_list:
PROCESSES: noexec
generic:
@ -35,13 +37,13 @@ defaults:
user_list:
ADMINS: '!lecture'
johndoe: '!requiretty'
execprefix: /usr/sbin
group: root
groups:
execprefix: /usr/sbin
group: root
groups:
sudo:
- ALL=(ALL) ALL
- 'ALL=(nodejs) NOPASSWD: ALL'
included_files:
included_files:
/etc/sudoers.d/extra-file:
users:
foo:
@ -54,14 +56,14 @@ included_files:
netgroups:
other_netgroup:
- ALL=(ALL) ALL
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
sysadmins:
- ALL=(ALL) ALL
pkg: sudo
purge_includedir: false
users:
pkg: sudo
purge_includedir: false
users:
johndoe:
- ALL=(ALL) ALL
- 'ALL=(root) NOPASSWD: /etc/init.d/httpd'

View file

@ -1,7 +1,9 @@
# yamllint disable rule:indentation rule:line-length
# CentOS-6
---
aliases:
values:
sudoers:
aliases:
commands:
PROCESSES:
- /usr/bin/nice
@ -19,9 +21,9 @@ aliases:
- millert
- dowdy
- mikef
arch: amd64
configpath: /etc
defaults:
arch: amd64
configpath: /etc
defaults:
command_list:
PROCESSES: noexec
generic:
@ -35,13 +37,13 @@ defaults:
user_list:
ADMINS: '!lecture'
johndoe: '!requiretty'
execprefix: /usr/sbin
group: root
groups:
execprefix: /usr/sbin
group: root
groups:
sudo:
- ALL=(ALL) ALL
- 'ALL=(nodejs) NOPASSWD: ALL'
included_files:
included_files:
/etc/sudoers.d/extra-file:
users:
foo:
@ -54,14 +56,14 @@ included_files:
netgroups:
other_netgroup:
- ALL=(ALL) ALL
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
sysadmins:
- ALL=(ALL) ALL
pkg: sudo
purge_includedir: false
users:
pkg: sudo
purge_includedir: false
users:
johndoe:
- ALL=(ALL) ALL
- 'ALL=(root) NOPASSWD: /etc/init.d/httpd'

View file

@ -1,7 +1,9 @@
# yamllint disable rule:indentation rule:line-length
# CentOS Linux-7
---
aliases:
values:
sudoers:
aliases:
commands:
PROCESSES:
- /usr/bin/nice
@ -19,9 +21,9 @@ aliases:
- millert
- dowdy
- mikef
arch: amd64
configpath: /etc
defaults:
arch: amd64
configpath: /etc
defaults:
command_list:
PROCESSES: noexec
generic:
@ -35,13 +37,13 @@ defaults:
user_list:
ADMINS: '!lecture'
johndoe: '!requiretty'
execprefix: /usr/sbin
group: root
groups:
execprefix: /usr/sbin
group: root
groups:
sudo:
- ALL=(ALL) ALL
- 'ALL=(nodejs) NOPASSWD: ALL'
included_files:
included_files:
/etc/sudoers.d/extra-file:
users:
foo:
@ -54,14 +56,14 @@ included_files:
netgroups:
other_netgroup:
- ALL=(ALL) ALL
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
sysadmins:
- ALL=(ALL) ALL
pkg: sudo
purge_includedir: false
users:
pkg: sudo
purge_includedir: false
users:
johndoe:
- ALL=(ALL) ALL
- 'ALL=(root) NOPASSWD: /etc/init.d/httpd'

View file

@ -1,7 +1,9 @@
# yamllint disable rule:indentation rule:line-length
# CentOS Linux-8
---
aliases:
values:
sudoers:
aliases:
commands:
PROCESSES:
- /usr/bin/nice
@ -19,9 +21,9 @@ aliases:
- millert
- dowdy
- mikef
arch: amd64
configpath: /etc
defaults:
arch: amd64
configpath: /etc
defaults:
command_list:
PROCESSES: noexec
generic:
@ -35,13 +37,13 @@ defaults:
user_list:
ADMINS: '!lecture'
johndoe: '!requiretty'
execprefix: /usr/sbin
group: root
groups:
execprefix: /usr/sbin
group: root
groups:
sudo:
- ALL=(ALL) ALL
- 'ALL=(nodejs) NOPASSWD: ALL'
included_files:
included_files:
/etc/sudoers.d/extra-file:
users:
foo:
@ -54,14 +56,14 @@ included_files:
netgroups:
other_netgroup:
- ALL=(ALL) ALL
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
sysadmins:
- ALL=(ALL) ALL
pkg: sudo
purge_includedir: false
users:
pkg: sudo
purge_includedir: false
users:
johndoe:
- ALL=(ALL) ALL
- 'ALL=(root) NOPASSWD: /etc/init.d/httpd'

View file

@ -1,7 +1,9 @@
# yamllint disable rule:indentation rule:line-length
# Debian-10
---
aliases:
values:
sudoers:
aliases:
commands:
PROCESSES:
- /usr/bin/nice
@ -19,9 +21,9 @@ aliases:
- millert
- dowdy
- mikef
arch: amd64
configpath: /etc
defaults:
arch: amd64
configpath: /etc
defaults:
command_list:
PROCESSES: noexec
generic:
@ -35,13 +37,13 @@ defaults:
user_list:
ADMINS: '!lecture'
johndoe: '!requiretty'
execprefix: /usr/sbin
group: root
groups:
execprefix: /usr/sbin
group: root
groups:
sudo:
- ALL=(ALL) ALL
- 'ALL=(nodejs) NOPASSWD: ALL'
included_files:
included_files:
/etc/sudoers.d/extra-file:
users:
foo:
@ -54,14 +56,14 @@ included_files:
netgroups:
other_netgroup:
- ALL=(ALL) ALL
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
sysadmins:
- ALL=(ALL) ALL
pkg: sudo
purge_includedir: false
users:
pkg: sudo
purge_includedir: false
users:
johndoe:
- ALL=(ALL) ALL
- 'ALL=(root) NOPASSWD: /etc/init.d/httpd'

View file

@ -1,7 +1,9 @@
# yamllint disable rule:indentation rule:line-length
# Debian-9
---
aliases:
values:
sudoers:
aliases:
commands:
PROCESSES:
- /usr/bin/nice
@ -19,9 +21,9 @@ aliases:
- millert
- dowdy
- mikef
arch: amd64
configpath: /etc
defaults:
arch: amd64
configpath: /etc
defaults:
command_list:
PROCESSES: noexec
generic:
@ -35,13 +37,13 @@ defaults:
user_list:
ADMINS: '!lecture'
johndoe: '!requiretty'
execprefix: /usr/sbin
group: root
groups:
execprefix: /usr/sbin
group: root
groups:
sudo:
- ALL=(ALL) ALL
- 'ALL=(nodejs) NOPASSWD: ALL'
included_files:
included_files:
/etc/sudoers.d/extra-file:
users:
foo:
@ -54,14 +56,14 @@ included_files:
netgroups:
other_netgroup:
- ALL=(ALL) ALL
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
sysadmins:
- ALL=(ALL) ALL
pkg: sudo
purge_includedir: false
users:
pkg: sudo
purge_includedir: false
users:
johndoe:
- ALL=(ALL) ALL
- 'ALL=(root) NOPASSWD: /etc/init.d/httpd'

View file

@ -1,7 +1,9 @@
# yamllint disable rule:indentation rule:line-length
# Fedora-31
---
aliases:
values:
sudoers:
aliases:
commands:
PROCESSES:
- /usr/bin/nice
@ -19,9 +21,9 @@ aliases:
- millert
- dowdy
- mikef
arch: amd64
configpath: /etc
defaults:
arch: amd64
configpath: /etc
defaults:
command_list:
PROCESSES: noexec
generic:
@ -35,13 +37,13 @@ defaults:
user_list:
ADMINS: '!lecture'
johndoe: '!requiretty'
execprefix: /usr/sbin
group: root
groups:
execprefix: /usr/sbin
group: root
groups:
sudo:
- ALL=(ALL) ALL
- 'ALL=(nodejs) NOPASSWD: ALL'
included_files:
included_files:
/etc/sudoers.d/extra-file:
users:
foo:
@ -54,14 +56,14 @@ included_files:
netgroups:
other_netgroup:
- ALL=(ALL) ALL
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
sysadmins:
- ALL=(ALL) ALL
pkg: sudo
purge_includedir: false
users:
pkg: sudo
purge_includedir: false
users:
johndoe:
- ALL=(ALL) ALL
- 'ALL=(root) NOPASSWD: /etc/init.d/httpd'

View file

@ -1,7 +1,9 @@
# yamllint disable rule:indentation rule:line-length
# Fedora-32
---
aliases:
values:
sudoers:
aliases:
commands:
PROCESSES:
- /usr/bin/nice
@ -19,9 +21,9 @@ aliases:
- millert
- dowdy
- mikef
arch: amd64
configpath: /etc
defaults:
arch: amd64
configpath: /etc
defaults:
command_list:
PROCESSES: noexec
generic:
@ -35,13 +37,13 @@ defaults:
user_list:
ADMINS: '!lecture'
johndoe: '!requiretty'
execprefix: /usr/sbin
group: root
groups:
execprefix: /usr/sbin
group: root
groups:
sudo:
- ALL=(ALL) ALL
- 'ALL=(nodejs) NOPASSWD: ALL'
included_files:
included_files:
/etc/sudoers.d/extra-file:
users:
foo:
@ -54,14 +56,14 @@ included_files:
netgroups:
other_netgroup:
- ALL=(ALL) ALL
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
sysadmins:
- ALL=(ALL) ALL
pkg: sudo
purge_includedir: false
users:
pkg: sudo
purge_includedir: false
users:
johndoe:
- ALL=(ALL) ALL
- 'ALL=(root) NOPASSWD: /etc/init.d/httpd'

View file

@ -1,7 +1,9 @@
# yamllint disable rule:indentation rule:line-length
# Leap-15
---
aliases:
values:
sudoers:
aliases:
commands:
PROCESSES:
- /usr/bin/nice
@ -19,9 +21,9 @@ aliases:
- millert
- dowdy
- mikef
arch: amd64
configpath: /etc
defaults:
arch: amd64
configpath: /etc
defaults:
command_list:
PROCESSES: noexec
generic:
@ -35,13 +37,13 @@ defaults:
user_list:
ADMINS: '!lecture'
johndoe: '!requiretty'
execprefix: /usr/sbin
group: root
groups:
execprefix: /usr/sbin
group: root
groups:
sudo:
- ALL=(ALL) ALL
- 'ALL=(nodejs) NOPASSWD: ALL'
included_files:
included_files:
/etc/sudoers.d/extra-file:
users:
foo:
@ -54,14 +56,14 @@ included_files:
netgroups:
other_netgroup:
- ALL=(ALL) ALL
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
sysadmins:
- ALL=(ALL) ALL
pkg: sudo
purge_includedir: false
users:
pkg: sudo
purge_includedir: false
users:
johndoe:
- ALL=(ALL) ALL
- 'ALL=(root) NOPASSWD: /etc/init.d/httpd'

View file

@ -1,7 +1,9 @@
# yamllint disable rule:indentation rule:line-length
# Ubuntu-16.04
---
aliases:
values:
sudoers:
aliases:
commands:
PROCESSES:
- /usr/bin/nice
@ -19,9 +21,9 @@ aliases:
- millert
- dowdy
- mikef
arch: amd64
configpath: /etc
defaults:
arch: amd64
configpath: /etc
defaults:
command_list:
PROCESSES: noexec
generic:
@ -35,13 +37,13 @@ defaults:
user_list:
ADMINS: '!lecture'
johndoe: '!requiretty'
execprefix: /usr/sbin
group: root
groups:
execprefix: /usr/sbin
group: root
groups:
sudo:
- ALL=(ALL) ALL
- 'ALL=(nodejs) NOPASSWD: ALL'
included_files:
included_files:
/etc/sudoers.d/extra-file:
users:
foo:
@ -54,14 +56,14 @@ included_files:
netgroups:
other_netgroup:
- ALL=(ALL) ALL
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
sysadmins:
- ALL=(ALL) ALL
pkg: sudo
purge_includedir: false
users:
pkg: sudo
purge_includedir: false
users:
johndoe:
- ALL=(ALL) ALL
- 'ALL=(root) NOPASSWD: /etc/init.d/httpd'

View file

@ -1,7 +1,9 @@
# yamllint disable rule:indentation rule:line-length
# Ubuntu-18.04
---
aliases:
values:
sudoers:
aliases:
commands:
PROCESSES:
- /usr/bin/nice
@ -19,9 +21,9 @@ aliases:
- millert
- dowdy
- mikef
arch: amd64
configpath: /etc
defaults:
arch: amd64
configpath: /etc
defaults:
command_list:
PROCESSES: noexec
generic:
@ -35,13 +37,13 @@ defaults:
user_list:
ADMINS: '!lecture'
johndoe: '!requiretty'
execprefix: /usr/sbin
group: root
groups:
execprefix: /usr/sbin
group: root
groups:
sudo:
- ALL=(ALL) ALL
- 'ALL=(nodejs) NOPASSWD: ALL'
included_files:
included_files:
/etc/sudoers.d/extra-file:
users:
foo:
@ -54,14 +56,14 @@ included_files:
netgroups:
other_netgroup:
- ALL=(ALL) ALL
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
sysadmins:
- ALL=(ALL) ALL
pkg: sudo
purge_includedir: false
users:
pkg: sudo
purge_includedir: false
users:
johndoe:
- ALL=(ALL) ALL
- 'ALL=(root) NOPASSWD: /etc/init.d/httpd'

View file

@ -1,7 +1,9 @@
# yamllint disable rule:indentation rule:line-length
# Ubuntu-20.04
---
aliases:
values:
sudoers:
aliases:
commands:
PROCESSES:
- /usr/bin/nice
@ -19,9 +21,9 @@ aliases:
- millert
- dowdy
- mikef
arch: amd64
configpath: /etc
defaults:
arch: amd64
configpath: /etc
defaults:
command_list:
PROCESSES: noexec
generic:
@ -35,13 +37,13 @@ defaults:
user_list:
ADMINS: '!lecture'
johndoe: '!requiretty'
execprefix: /usr/sbin
group: root
groups:
execprefix: /usr/sbin
group: root
groups:
sudo:
- ALL=(ALL) ALL
- 'ALL=(nodejs) NOPASSWD: ALL'
included_files:
included_files:
/etc/sudoers.d/extra-file:
users:
foo:
@ -54,14 +56,14 @@ included_files:
netgroups:
other_netgroup:
- ALL=(ALL) ALL
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
includedir: /etc/sudoers.d
manage_main_config: true
netgroups:
sysadmins:
- ALL=(ALL) ALL
pkg: sudo
purge_includedir: false
users:
pkg: sudo
purge_includedir: false
users:
johndoe:
- ALL=(ALL) ALL
- 'ALL=(root) NOPASSWD: /etc/init.d/httpd'