From 3fa7bcee1bdfce90d563514f0a0bab5a16a40219 Mon Sep 17 00:00:00 2001 From: N Date: Sat, 15 Jun 2019 23:15:32 +0100 Subject: [PATCH] test(inspec): readme for default profile & os-name depreciated --- test/integration/default/README.md | 50 +++++++++++++++++++++++++++++ test/integration/default/inspec.yml | 12 +++---- 2 files changed, 56 insertions(+), 6 deletions(-) create mode 100644 test/integration/default/README.md diff --git a/test/integration/default/README.md b/test/integration/default/README.md new file mode 100644 index 00000000..8019607e --- /dev/null +++ b/test/integration/default/README.md @@ -0,0 +1,50 @@ +# Default InSpec Profile + +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 57950582..2897c699 100644 --- a/test/integration/default/inspec.yml +++ b/test/integration/default/inspec.yml @@ -4,9 +4,9 @@ maintainer: Your Name license: Apache-2.0 summary: Verify that the template 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