From 63865a286ef37dec6cdc1b4e1b4ddaa36baca594 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Tue, 25 Aug 2020 05:03:17 +0100 Subject: [PATCH] test(map): verify `map.jinja` dump using `_mapdata` state * Semi-automated using https://github.com/myii/ssf-formula/pull/245 --- kitchen.yml | 1 + sudoers/_mapdata/_mapdata.jinja | 13 +++ sudoers/_mapdata/init.sls | 21 ++++ .../default/controls/_mapdata_spec.rb | 13 +++ .../default/files/_mapdata/amazonlinux-1.yaml | 5 + .../default/files/_mapdata/amazonlinux-2.yaml | 5 + .../files/_mapdata/arch-base-latest.yaml | 5 + .../default/files/_mapdata/centos-6.yaml | 5 + .../default/files/_mapdata/centos-7.yaml | 5 + .../default/files/_mapdata/centos-8.yaml | 5 + .../default/files/_mapdata/debian-10.yaml | 5 + .../default/files/_mapdata/debian-9.yaml | 5 + .../default/files/_mapdata/fedora-31.yaml | 5 + .../default/files/_mapdata/fedora-32.yaml | 5 + .../default/files/_mapdata/opensuse-15.yaml | 5 + .../default/files/_mapdata/ubuntu-16.yaml | 5 + .../default/files/_mapdata/ubuntu-18.yaml | 5 + .../default/files/_mapdata/ubuntu-20.yaml | 5 + test/integration/default/inspec.yml | 3 + test/integration/share/README.md | 38 +++++++ test/integration/share/inspec.yml | 18 ++++ test/integration/share/libraries/system.rb | 99 +++++++++++++++++++ 22 files changed, 276 insertions(+) create mode 100644 sudoers/_mapdata/_mapdata.jinja create mode 100644 sudoers/_mapdata/init.sls create mode 100644 test/integration/default/controls/_mapdata_spec.rb create mode 100644 test/integration/default/files/_mapdata/amazonlinux-1.yaml create mode 100644 test/integration/default/files/_mapdata/amazonlinux-2.yaml create mode 100644 test/integration/default/files/_mapdata/arch-base-latest.yaml create mode 100644 test/integration/default/files/_mapdata/centos-6.yaml create mode 100644 test/integration/default/files/_mapdata/centos-7.yaml create mode 100644 test/integration/default/files/_mapdata/centos-8.yaml create mode 100644 test/integration/default/files/_mapdata/debian-10.yaml create mode 100644 test/integration/default/files/_mapdata/debian-9.yaml create mode 100644 test/integration/default/files/_mapdata/fedora-31.yaml create mode 100644 test/integration/default/files/_mapdata/fedora-32.yaml create mode 100644 test/integration/default/files/_mapdata/opensuse-15.yaml create mode 100644 test/integration/default/files/_mapdata/ubuntu-16.yaml create mode 100644 test/integration/default/files/_mapdata/ubuntu-18.yaml create mode 100644 test/integration/default/files/_mapdata/ubuntu-20.yaml 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 diff --git a/kitchen.yml b/kitchen.yml index 3000f30..d8d391e 100644 --- a/kitchen.yml +++ b/kitchen.yml @@ -153,6 +153,7 @@ suites: state_top: base: '*': + - sudoers._mapdata - sudoers - sudoers.included pillars: diff --git a/sudoers/_mapdata/_mapdata.jinja b/sudoers/_mapdata/_mapdata.jinja new file mode 100644 index 0000000..ad54eaa --- /dev/null +++ b/sudoers/_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/sudoers/_mapdata/init.sls b/sudoers/_mapdata/init.sls new file mode 100644 index 0000000..fa7ac00 --- /dev/null +++ b/sudoers/_mapdata/init.sls @@ -0,0 +1,21 @@ +# -*- coding: utf-8 -*- +# vim: ft=sls +--- +{#- Get the `tplroot` from `tpldir` #} +{%- set tplroot = tpldir.split('/')[0] %} +{%- from tplroot ~ "/map.jinja" import sudoers with context %} + +{%- set map = { + 'sudoers': sudoers, + } %} +{%- do salt['log.debug']('### MAP.JINJA DUMP ###\n' ~ map | yaml(False)) %} + +{%- set output_file = '/tmp/salt_mapdata_dump.yaml' %} + +{{ tplroot }}-mapdata-dump: + file.managed: + - name: {{ output_file }} + - source: salt://{{ tplroot }}/_mapdata/_mapdata.jinja + - template: jinja + - context: + map: {{ map | yaml }} diff --git a/test/integration/default/controls/_mapdata_spec.rb b/test/integration/default/controls/_mapdata_spec.rb new file mode 100644 index 0000000..bd3e990 --- /dev/null +++ b/test/integration/default/controls/_mapdata_spec.rb @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +control '`map.jinja` YAML dump' do + title 'should contain the lines' + + 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 include mapdata_dump } + end +end diff --git a/test/integration/default/files/_mapdata/amazonlinux-1.yaml b/test/integration/default/files/_mapdata/amazonlinux-1.yaml new file mode 100644 index 0000000..07b23f8 --- /dev/null +++ b/test/integration/default/files/_mapdata/amazonlinux-1.yaml @@ -0,0 +1,5 @@ +# yamllint disable rule:indentation rule:line-length +# Amazon Linux AMI-2018 +--- +sudoers: + pkg: sudo diff --git a/test/integration/default/files/_mapdata/amazonlinux-2.yaml b/test/integration/default/files/_mapdata/amazonlinux-2.yaml new file mode 100644 index 0000000..e42b341 --- /dev/null +++ b/test/integration/default/files/_mapdata/amazonlinux-2.yaml @@ -0,0 +1,5 @@ +# yamllint disable rule:indentation rule:line-length +# Amazon Linux-2 +--- +sudoers: + pkg: sudo diff --git a/test/integration/default/files/_mapdata/arch-base-latest.yaml b/test/integration/default/files/_mapdata/arch-base-latest.yaml new file mode 100644 index 0000000..c9dbfc3 --- /dev/null +++ b/test/integration/default/files/_mapdata/arch-base-latest.yaml @@ -0,0 +1,5 @@ +# yamllint disable rule:indentation rule:line-length +# Arch +--- +sudoers: + pkg: sudo diff --git a/test/integration/default/files/_mapdata/centos-6.yaml b/test/integration/default/files/_mapdata/centos-6.yaml new file mode 100644 index 0000000..9f1a778 --- /dev/null +++ b/test/integration/default/files/_mapdata/centos-6.yaml @@ -0,0 +1,5 @@ +# yamllint disable rule:indentation rule:line-length +# CentOS-6 +--- +sudoers: + pkg: sudo diff --git a/test/integration/default/files/_mapdata/centos-7.yaml b/test/integration/default/files/_mapdata/centos-7.yaml new file mode 100644 index 0000000..db20b1d --- /dev/null +++ b/test/integration/default/files/_mapdata/centos-7.yaml @@ -0,0 +1,5 @@ +# yamllint disable rule:indentation rule:line-length +# CentOS Linux-7 +--- +sudoers: + pkg: sudo diff --git a/test/integration/default/files/_mapdata/centos-8.yaml b/test/integration/default/files/_mapdata/centos-8.yaml new file mode 100644 index 0000000..3093f8c --- /dev/null +++ b/test/integration/default/files/_mapdata/centos-8.yaml @@ -0,0 +1,5 @@ +# yamllint disable rule:indentation rule:line-length +# CentOS Linux-8 +--- +sudoers: + pkg: sudo diff --git a/test/integration/default/files/_mapdata/debian-10.yaml b/test/integration/default/files/_mapdata/debian-10.yaml new file mode 100644 index 0000000..f8357d5 --- /dev/null +++ b/test/integration/default/files/_mapdata/debian-10.yaml @@ -0,0 +1,5 @@ +# yamllint disable rule:indentation rule:line-length +# Debian-10 +--- +sudoers: + pkg: sudo diff --git a/test/integration/default/files/_mapdata/debian-9.yaml b/test/integration/default/files/_mapdata/debian-9.yaml new file mode 100644 index 0000000..f280c9f --- /dev/null +++ b/test/integration/default/files/_mapdata/debian-9.yaml @@ -0,0 +1,5 @@ +# yamllint disable rule:indentation rule:line-length +# Debian-9 +--- +sudoers: + pkg: sudo diff --git a/test/integration/default/files/_mapdata/fedora-31.yaml b/test/integration/default/files/_mapdata/fedora-31.yaml new file mode 100644 index 0000000..1aaf4af --- /dev/null +++ b/test/integration/default/files/_mapdata/fedora-31.yaml @@ -0,0 +1,5 @@ +# yamllint disable rule:indentation rule:line-length +# Fedora-31 +--- +sudoers: + pkg: sudo diff --git a/test/integration/default/files/_mapdata/fedora-32.yaml b/test/integration/default/files/_mapdata/fedora-32.yaml new file mode 100644 index 0000000..671d375 --- /dev/null +++ b/test/integration/default/files/_mapdata/fedora-32.yaml @@ -0,0 +1,5 @@ +# yamllint disable rule:indentation rule:line-length +# Fedora-32 +--- +sudoers: + pkg: sudo diff --git a/test/integration/default/files/_mapdata/opensuse-15.yaml b/test/integration/default/files/_mapdata/opensuse-15.yaml new file mode 100644 index 0000000..611c6ef --- /dev/null +++ b/test/integration/default/files/_mapdata/opensuse-15.yaml @@ -0,0 +1,5 @@ +# yamllint disable rule:indentation rule:line-length +# Leap-15 +--- +sudoers: + pkg: sudo diff --git a/test/integration/default/files/_mapdata/ubuntu-16.yaml b/test/integration/default/files/_mapdata/ubuntu-16.yaml new file mode 100644 index 0000000..4f1629b --- /dev/null +++ b/test/integration/default/files/_mapdata/ubuntu-16.yaml @@ -0,0 +1,5 @@ +# yamllint disable rule:indentation rule:line-length +# Ubuntu-16.04 +--- +sudoers: + pkg: sudo diff --git a/test/integration/default/files/_mapdata/ubuntu-18.yaml b/test/integration/default/files/_mapdata/ubuntu-18.yaml new file mode 100644 index 0000000..2b9d0d4 --- /dev/null +++ b/test/integration/default/files/_mapdata/ubuntu-18.yaml @@ -0,0 +1,5 @@ +# yamllint disable rule:indentation rule:line-length +# Ubuntu-18.04 +--- +sudoers: + pkg: sudo diff --git a/test/integration/default/files/_mapdata/ubuntu-20.yaml b/test/integration/default/files/_mapdata/ubuntu-20.yaml new file mode 100644 index 0000000..c961135 --- /dev/null +++ b/test/integration/default/files/_mapdata/ubuntu-20.yaml @@ -0,0 +1,5 @@ +# yamllint disable rule:indentation rule:line-length +# Ubuntu-20.04 +--- +sudoers: + pkg: sudo diff --git a/test/integration/default/inspec.yml b/test/integration/default/inspec.yml index 52b3343..9263257 100644 --- a/test/integration/default/inspec.yml +++ b/test/integration/default/inspec.yml @@ -6,6 +6,9 @@ title: sudoers formula maintainer: SaltStack Formulas license: Apache-2.0 summary: Verify that the sudoers formula is setup and configured correctly +depends: + - name: share + path: test/integration/share supports: - platform-name: debian - platform-name: ubuntu diff --git a/test/integration/share/README.md b/test/integration/share/README.md new file mode 100644 index 0000000..06fd928 --- /dev/null +++ b/test/integration/share/README.md @@ -0,0 +1,38 @@ +# InSpec Profile: `share` + +This shows the implementation of the `share` InSpec [profile](https://github.com/inspec/inspec/blob/master/docs/profiles.md). + +It's goal is to share the libraries between all profiles. + +## Verify a profile + +InSpec ships with built-in features to verify a profile structure. + +```bash +$ inspec check share +Summary +------- +Location: share +Profile: profile +Controls: 4 +Timestamp: 2019-06-24T23:09:01+00:00 +Valid: true + +Errors +------ + +Warnings +-------- +``` + +## Execute a profile + +To run all **supported** controls on a local machine use `inspec exec /path/to/profile`. + +```bash +$ inspec exec share +.. + +Finished in 0.0025 seconds (files took 0.12449 seconds to load) +8 examples, 0 failures +``` diff --git a/test/integration/share/inspec.yml b/test/integration/share/inspec.yml new file mode 100644 index 0000000..1305933 --- /dev/null +++ b/test/integration/share/inspec.yml @@ -0,0 +1,18 @@ +# -*- coding: utf-8 -*- +# vim: ft=yaml +--- +name: share +title: sudoers formula +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: arch diff --git a/test/integration/share/libraries/system.rb b/test/integration/share/libraries/system.rb new file mode 100644 index 0000000..3c6304c --- /dev/null +++ b/test/integration/share/libraries/system.rb @@ -0,0 +1,99 @@ +# frozen_string_literal: true + +# system.rb -- InSpec resources for system values +# Author: Daniel Dehennin +# Copyright (C) 2020 Daniel Dehennin + +HOSTNAME_CMDS = %w[hostname hostnamectl].freeze +HOSTNAME_CMDS_OPT = { + 'hostname' => '-s', + 'hostnamectl' => '--static' +}.freeze + +class SystemResource < Inspec.resource(1) + name 'system' + + attr_reader :platform + attr_reader :hostname + + def initialize + @platform = build_platform + @hostname = found_hostname + end + + private + + def found_hostname + cmd = guess_hostname_cmd + + unless cmd.exit_status.zero? + raise Inspec::Exceptions::ResourceSkipped, + "Error running '#{cmd}': #{cmd.stderr}" + end + + cmd.stdout.chomp + end + + def guess_hostname_cmd + HOSTNAME_CMDS.each do |cmd| + if inspec.command(cmd).exist? + return inspec.command("#{cmd} #{HOSTNAME_CMDS_OPT[cmd]}") + end + end + + raise Inspec::Exceptions::ResourceSkipped, + "Error: #{@platform[:finger]}} has none of #{HOSTNAME_CMDS.join(', ')}" + end + + 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' + 'arch' + else + inspec.platform[:family] + end + end + + def build_platform_name + case inspec.platform[:name] + when 'amazon' + 'amazonlinux' + else + inspec.platform[:name] + end + end + + 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' + else + inspec.platform[:release] + 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