From 8af3849f1c64664fdab7ca2082a77cd86fef2ca9 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Mon, 15 Jul 2019 16:46:17 +0100 Subject: [PATCH] chore: use `semantic-release` cross-formula standard structure * Automated using `ssf-formula` (v0.1.0-rc.1) --- .gitignore | 9 ++++++ .travis.yml | 21 +++--------- docs/CONTRIBUTING.rst | 1 + kitchen.yml | 47 ++++++++++++--------------- test/integration/default/README.md | 50 +++++++++++++++++++++++++++++ test/integration/default/inspec.yml | 20 ++++++------ 6 files changed, 97 insertions(+), 51 deletions(-) create mode 100644 test/integration/default/README.md diff --git a/.gitignore b/.gitignore index ba07ed8..0bbb03c 100644 --- a/.gitignore +++ b/.gitignore @@ -48,6 +48,7 @@ coverage.xml .kitchen .kitchen.local.yml kitchen.local.yml +junit-*.xml # Translations *.mo @@ -111,3 +112,11 @@ docs/*.md # Vim *.sw? + +## Collected when centralising formulas (check and sort) +# `collectd-formula` +.pytest_cache/ +/.idea/ +Dockerfile.*_* +ignore/ +tmp/ diff --git a/.travis.yml b/.travis.yml index 476d64e..87b7433 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,3 +1,6 @@ +# -*- coding: utf-8 -*- +# vim: ft=yaml +--- stages: - test - commitlint @@ -7,23 +10,13 @@ stages: sudo: required cache: bundler language: ruby +dist: xenial services: - docker # Make sure the instances listed below match up with # the `platforms` defined in `kitchen.yml` -# NOTE: Please try to select up to six instances that add some meaningful -# testing of the formula's behaviour. If possible, try to refrain from -# the classical "chosing all the instances because I want to test on -# another/all distro/s" trap: it will just add time to the testing (see -# the discussion on #121). As an example, the set chosen below covers -# the most used distros families, systemd and non-systemd and the latest -# three supported Saltstack versions with python2 and 3." -# As for `kitchen.yml`, that should still contain all of the platforms, -# to allow for comprehensive local testing -# Ref: https://github.com/saltstack-formulas/template-formula/issues/118 -# Ref: https://github.com/saltstack-formulas/template-formula/issues/121 env: matrix: - INSTANCE: default-debian-9-develop-py3 @@ -40,19 +33,15 @@ env: # - INSTANCE: default-ubuntu-1604-2018-3-py2 # - INSTANCE: default-centos-7-2018-3-py2 - INSTANCE: default-fedora-29-2018-3-py2 - # TODO: Use this when fixed instead of `opensuse-leap-42` - # Ref: https://github.com/netmanagers/salt-image-builder/issues/2 - # - INSTANCE: default-opensuse-leap-15-2018-3-py2 - INSTANCE: default-opensuse-leap-42-2018-3-py2 # - INSTANCE: default-debian-8-2017-7-py2 # - INSTANCE: default-ubuntu-1604-2017-7-py2 - # TODO: Enable after improving the formula to work with other than `systemd` - INSTANCE: default-centos-6-2017-7-py2 # - INSTANCE: default-fedora-28-2017-7-py2 # - INSTANCE: default-opensuse-leap-42-2017-7-py2 script: - - bundle exec kitchen verify ${INSTANCE} + - bin/kitchen verify ${INSTANCE} jobs: include: diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst index 5da9ae8..b7da8f4 100644 --- a/docs/CONTRIBUTING.rst +++ b/docs/CONTRIBUTING.rst @@ -156,3 +156,4 @@ An example of that: BREAKING CHANGE: With the removal of all of the `.sls` files under `template package`, this formula no longer supports the installation of packages. + diff --git a/kitchen.yml b/kitchen.yml index 3538aeb..9ccd163 100644 --- a/kitchen.yml +++ b/kitchen.yml @@ -44,7 +44,7 @@ platforms: - sh bootstrap-salt.sh -XdPbfrq -x python3 git develop run_command: /usr/lib/systemd/systemd - ## SALT 2019.2 + ## SALT `2019.2` - name: debian-9-2019-2-py3 driver: image: netmanagers/salt-2019.2-py3:debian-9 @@ -62,7 +62,7 @@ platforms: image: netmanagers/salt-2019.2-py3:opensuse-leap-15 run_command: /usr/lib/systemd/systemd - ## SALT 2018.3 + ## SALT `2018.3` - name: debian-9-2018-3-py2 driver: image: netmanagers/salt-2018.3-py2:debian-9 @@ -75,25 +75,18 @@ platforms: - name: fedora-29-2018-3-py2 driver: image: netmanagers/salt-2018.3-py2:fedora-29 - # TODO: Use this when fixed instead of `opensuse-leap-42` - # Ref: https://github.com/netmanagers/salt-image-builder/issues/2 - # - name: opensuse-leap-15-2018-3-py2 - # driver: - # image: netmanagers/salt-2018.3-py2:opensuse-leap-15 - # run_command: /usr/lib/systemd/systemd - name: opensuse-leap-42-2018-3-py2 driver: image: netmanagers/salt-2018.3-py2:opensuse-leap-42 run_command: /usr/lib/systemd/systemd - ## SALT 2017.7 + ## SALT `2017.7` - name: debian-8-2017-7-py2 driver: image: netmanagers/salt-2017.7-py2:debian-8 - name: ubuntu-1604-2017-7-py2 driver: image: netmanagers/salt-2017.7-py2:ubuntu-16.04 - # TODO: Modify the formula to work for non-`systemd` platforms - name: centos-6-2017-7-py2 driver: image: netmanagers/salt-2017.7-py2:centos-6 @@ -115,20 +108,6 @@ provisioner: salt_copy_filter: - .kitchen - .git - state_top: - base: - '*': - - sudoers - - sudoers.included - pillars: - top.sls: - base: - '*': - - kitchen - - sudoers - pillars_from_files: - kitchen.sls: test/salt/pillar/kitchen.sls - sudoers.sls: test/salt/pillar/default.sls verifier: # https://www.inspec.io/ @@ -137,8 +116,24 @@ verifier: # cli, documentation, html, progress, json, json-min, json-rspec, junit reporter: - cli - inspec_tests: - - path: test/integration/default suites: - name: default + provisioner: + state_top: + base: + '*': + - sudoers + - sudoers.included + pillars: + top.sls: + base: + '*': + - kitchen + - sudoers + pillars_from_files: + kitchen.sls: test/salt/pillar/kitchen.sls + sudoers.sls: test/salt/pillar/default.sls + verifier: + inspec_tests: + - path: test/integration/default diff --git a/test/integration/default/README.md b/test/integration/default/README.md new file mode 100644 index 0000000..37cf963 --- /dev/null +++ b/test/integration/default/README.md @@ -0,0 +1,50 @@ +# InSpec Profile: `default` + +This shows the implementation of the `default` InSpec [profile](https://github.com/inspec/inspec/blob/master/docs/profiles.md). + +## Verify a profile + +InSpec ships with built-in features to verify a profile structure. + +```bash +$ inspec check default +Summary +------- +Location: default +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 default +.. + +Finished in 0.0025 seconds (files took 0.12449 seconds to load) +8 examples, 0 failures +``` + +## Execute a specific control from a profile + +To run one control from the profile use `inspec exec /path/to/profile --controls name`. + +```bash +$ inspec exec default --controls package +. + +Finished in 0.0025 seconds (files took 0.12449 seconds to load) +1 examples, 0 failures +``` + +See an [example control here](https://github.com/inspec/inspec/blob/master/examples/profile/controls/example.rb). diff --git a/test/integration/default/inspec.yml b/test/integration/default/inspec.yml index b16d5dd..1fd9a81 100644 --- a/test/integration/default/inspec.yml +++ b/test/integration/default/inspec.yml @@ -1,12 +1,14 @@ -name: sudoers -title: Sudoers Formula -maintainer: Saltstack-formulas +name: default +title: sudoers formula +maintainer: SaltStack Formulas license: Apache-2.0 summary: Verify that the sudoers formula is setup and configured correctly supports: - - os-name: debian - - os-name: ubuntu - - os-name: centos - - os-name: fedora - - os-name: opensuse - - os-name: suse + - platform-name: debian + - platform-name: ubuntu + - platform-name: centos + - platform-name: fedora + - platform-name: opensuse + - platform-name: suse + - platform-name: freebsd + - platform-name: amazon