inspec 2.1.21 → 2.1.30

data/docs/resources/command.md.erb

@@ -1,138 +1,138 @@
----
-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>
-
-## 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
-
-<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 }
-
+---
+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>
+
+## 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
+
+<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,79 +1,79 @@
----
-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>
-
-## 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 }
+---
+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>
+
+## 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,64 +1,64 @@
----
-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>
-
-## 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 }
+---
+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>
+
+## 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 }