inspec 2.3.10 → 2.3.23

data/docs/resources/bsd_service.md.erb

@@ -1,77 +0,0 @@
----
-title: About the bsd_service Resource
-platform: linux
----
-
-# bsd_service
-
-Use the `bsd_service` InSpec audit resource to test a service using a Berkeley OS-style `init` on the FreeBSD platform.
-
-<br>
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v1.0.0 of InSpec.
-
-## Syntax
-
-A `bsd_service` resource block declares the name of a service and then one (or more) matchers to test the state of the service:
-
-    describe bsd_service('service_name') do
-      it { should be_installed }
-      it { should be_enabled }
-      it { should be_running }
-    end
-
-where
-
-* `('service_name')` must specify a service name
-* `be_installed`, `be_enabled`, and `be_running` are valid matchers for this resource.
-
-### Using `bsd_service` resource parameters
-
-#### Path
-
-The path to the service manager's control may be specified for situations where the path isn't available in the current `PATH`. For example:
-
-    describe bsd_service('service_name', '/path/to/control') do
-      it { should be_enabled }
-      it { should be_installed }
-      it { should be_running }
-    end
-
-<br>
-
-## Properties
-
-All properties available to the `service` resource may be used.
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### be_enabled
-
-The `be_enabled` matcher tests if the named service is enabled:
-
-    it { should be_enabled }
-
-### be_installed
-
-The `be_installed` matcher tests if the named service is installed:
-
-    it { should be_installed }
-
-### be_running
-
-The `be_running` matcher tests if the named service is running:
-
-    it { should be_running }

data/docs/resources/chocolatey_package.md.erb

@@ -1,68 +0,0 @@
----
-title: About the chocolatey_package Resource
-platform: windows
----
-
-# chocolatey_package
-
-Use the `chocolatey_package` InSpec audit resource to test if the named [Chocolatey](https://chocolatey.org/) package and/or package version is installed on the system.
-
-<br>
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v2.1.30 of InSpec.
-
-## Syntax
-
-A `chocolatey_package` resource block declares the name of a Chocolatey package to be tested:
-
-    describe chocolatey_package('name') do
-      it { should be_installed }
-    end
-
-where
-
-* `('name')` must specify the (case-sensitive) name of a package, such as `'nssm'`
-* `be_installed` is a valid matcher for this resource
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource
-
-### Test if NSSM version 2.1.0 is installed
-
-    describe chocolatey_package('nssm') do
-      it { should be_installed }
-      its('version') { should eq '2.1.0' }
-    end
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers).
-
-### be_installed
-
-The `be_installed` matcher tests if the named package is installed at all.
-
-    it { should be_installed }
-
-### version
-
-The `version` matcher tests if the named package version is on the system:
-
-    its('version') { should eq '2.1.0' }
-
-You can also use the `cmp OPERATOR` matcher to perform comparisons using the version attribute:
-
-    its('version') { should cmp >= '1.93.4-13debug84' }
-
-`cmp` understands version numbers using Gem::Version, and can use the operators `==, <, <=, >=, and >`. It will compare versions by each segment, not as a string - so '7.4' is smaller than '7.30', for example.

data/docs/resources/command.md.erb

@@ -1,176 +0,0 @@
----
-title: About the command Resource
-platform: os
----
-
-# command
-
-Use the `command` InSpec audit resource to test an arbitrary command that is run on the system.
-
-<br>
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v1.0.0 of InSpec.
-
-## Syntax
-
-A `command` resource block declares a command to be run, one (or more) expected values, and the location to which that output is sent:
-
-    describe command('command') do
-      it { should exist }
-      its('property') { should eq 'value' }
-    end
-
-where
-
-* `'command'` must specify a command to be run
-* `'property'` is one of `exit_status`, `stderr`, or `stdout`
-* `'output'` tests the output of the command run on the system versus the output value stated in the test
-
-<br>
-
-## Property Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### exit_status
-
-The `exit_status` property tests the exit status for the command:
-
-    its('exit_status') { should eq 123 }
-
-### stderr
-
-The `stderr` property tests results of the command as returned in standard error (stderr):
-
-    its('stderr') { should eq 'error' }
-
-### stdout
-
-The `stdout` property tests results of the command as returned in standard output (stdout). The following example shows matching output using a regular expression:
-
-    describe command('echo 1') do
-       its('stdout') { should match (/[0-9]/) }
-    end
-
-### Test standard output (stdout)
-
-    describe command('echo hello') do
-      its('stdout') { should eq "hello\n" }
-      its('stderr') { should eq '' }
-      its('exit_status') { should eq 0 }
-    end
-
-### Test standard error (stderr)
-
-    describe command('>&2 echo error') do
-      its('stdout') { should eq '' }
-      its('stderr') { should eq "error\n" }
-      its('exit_status') { should eq 0 }
-    end
-
-### Test an exit status code
-
-    describe command('exit 123') do
-      its('stdout') { should eq '' }
-      its('stderr') { should eq '' }
-      its('exit_status') { should eq 123 }
-    end
-
-### Test if the command shell exists
-
-    describe command('/bin/sh').exist? do
-      it { should eq true }
-    end
-
-### Test for a command that should not exist
-
-    describe command('this is not existing').exist? do
-      it { should eq false }
-    end
-
-### Test for PostgreSQL database running a RC, development, or beta release
-
-    describe command('psql -V') do
-      its('stdout') { should eq '/RC/' }
-      its('stdout') { should_not eq '/DEVEL/' }
-      its('stdout') { should_not eq '/BETA/' }
-    end
-
-### Verify NTP
-
-The following example shows how to use the `file` audit resource to verify if the `ntp.conf` and `leap-seconds` files are present, and then the `command` resource to verify if NTP is installed and running:
-
-    describe file('/etc/ntp.conf') do
-       it { should be_file }
-    end
-
-    describe file('/etc/ntp.leapseconds') do
-      it { should be_file }
-    end
-
-    describe command('pgrep ntp') do
-       its('exit_status') { should eq 0 }
-    end
-
-### Verify WiX
-
-Wix includes several tools -- such as `candle` (preprocesses and compiles source files into object files), `light` (links and binds object files to an installer database), and `heat` (harvests files from various input formats). The following example uses a whitespace array and the `file` audit resource to verify if these three tools are present:
-
-    %w(
-      candle.exe
-      heat.exe
-      light.exe
-    ).each do |utility|
-      describe file("C:/wix/##{utility}") do
-        it { should be_file }
-      end
-    end
-
-### Redacting Sensitive Commands
-
-By default the command that is ran is shown in the InSpec output. This can be problematic if the command contains sensitive arguments such as a password. These sensitive parts can be redacted by passing in `redact_regex` and a regular expression to redact. Optionally, you can use 2 capture groups to fine tune what is redacted.
-
-The following examples show how to use `redact_regex`:
-
-    # Example without capture groups
-    describe command('myapp -p secretpassword -d no_redact', redact_regex: /-p .* -d/) do
-      its('exit_status') { should cmp 0 }
-    end
-
-    # Result (no capture groups used)
-    Command: `myapp REDACTED no_redact`
-       ✔  exit_status should cmp == 0
-
-    # Example with capture groups
-    # Each set of parenthesis is a capture group.
-    # Anything in the two capture groups will not be 'REDACTED'
-    describe command('myapp -p secretpassword -d no_redact', redact_regex: /(-p ).*( -d)/) do
-      its('exit_status') { should cmp 0 }
-    end
-
-    # Result (capture groups used)
-    Command: `myapp -p REDACTED -d no_redact`
-       ✔  exit_status should cmp == 0
-
-> For more info/help on regular expressions, we recommend [RegExr](https://regexr.com/)
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### exist
-
-The `exist` matcher tests if a command may be run on the system:
-
-    it { should exist }
-

data/docs/resources/cpan.md.erb

@@ -1,89 +0,0 @@
----
-title: About the cpan Resource
-platform: linux
----
-
-# cpan
-
-Use the `cpan` InSpec audit resource to test Perl modules that are installed by system packages or the CPAN installer.
-
-<br>
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v1.43.5 of InSpec.
-
-## Syntax
-
-A `cpan` resource block declares a package and (optionally) a package version:
-
-    describe cpan('package_name') do
-      it { should be_installed }
-    end
-
-where
-
-* `'package_name'` is the name of the package, such as `'DBD::Pg'`
-* `be_installed` tests to see if the package described above is installed
-
-<br>
-
-## Resource Parameters
-
-This resource uses package names and perl library paths as resource parameters.
-
-<br>
-
-## Resource Parameter Examples
-
-### Test if DBD::Pg is installed on the system
-
-    describe cpan('DBD:Pg') do
-      it { should be_installed }
-    end
-
-### Test if DBD::Pg 3.7.0 is installed on the system
-
-    describe cpan('DBD::Pg') do
-      it { should be_installed }
-      its('version') { should eq '3.7.0' }
-    end
-
-### Test if DBD::Pg is installed within a custom PERL5LIB path on the system
-
-Hint: You can pass multiple paths separated with a colon
-`/path/to/perl5/lib:/usr/share/perl5/vendor_perl/lib/perl5`
-
-    describe cpan('DBD::Pg', '/home/jdoe/perl5/lib/perl5') do
-      it { should be_installed }
-    end
-
-<br>
-
-## Property Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### version
-
-The `version` property tests if the named package version is on the system:
-
-    its('version') { should eq '1.2.3' }
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### be_installed
-
-The `be_installed` matcher tests if the named package is installed on the system:
-
-    it { should be_installed }

data/docs/resources/cran.md.erb

@@ -1,74 +0,0 @@
----
-title: About the cran Resource
-platform: linux
----
-
-# cran
-
-Use the `cran` InSpec audit resource to test R modules that are installed from CRAN package repository.
-
-<br>
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v1.43.5 of InSpec.
-
-## Syntax
-
-A `cran` resource block declares a package and (optionally) a package version:
-
-    describe cran('package_name') do
-      it { should be_installed }
-    end
-
-where
-
-* `'package_name'` is the name of the package, such as `'DBI'`
-* `be_installed` tests to see if the package described above is installed
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test if DBI is installed on the system
-
-    describe cran('DBI') do
-      it { should be_installed }
-    end
-
-### Test if DBI 0.5.1 is installed on the system
-
-    describe cran('DBI') do
-      it { should be_installed }
-      its('version') { should eq '0.5.1' }
-    end
-
-<br>
-
-## Property Examples
-
-### version
-
-The `version` property tests if the named package version is on the system:
-
-    its('version') { should eq '1.2.3' }
-
-<br>
-
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be_installed
-
-The `be_installed` matcher tests if the named package is installed on the system:
-
-    it { should be_installed }