inspec 2.1.0 → 2.1.10

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 }

data/docs/resources/crontab.md.erb

@@ -1,89 +1,89 @@
----
-title: About the crontab Resource
-platform: linux
----
-
-# crontab
-
-Use the `crontab` InSpec audit resource to test the crontab entries for a particular user on the system. It recognizes special time strings (@yearly, @weekly, etc).
-
-<br>
-
-## Syntax
-
-A `crontab` resource block declares a user (which defaults to the current user, if not specified), and then the details to be tested, such as the schedule elements for each crontab entry or the commands itself:
-
-    describe crontab do
-      its('commands') { should include '/some/scheduled/task.sh' }
-    end
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test that root's crontab has a particular command
-
-    describe crontab('root') do
-      its('commands') { should include '/path/to/some/script' }
-    end
-
-### Test that myuser's crontab entry for command '/home/myuser/build.sh' runs every minute
-
-    describe crontab('myuser').commands('/home/myuser/build.sh') do
-      its('hours') { should cmp '*' }
-      its('minutes') { should cmp '*' }
-    end
-
-### Test that the logged-in user's crontab has no tasks set to run on every hour and every minute
-
-    describe crontab.where({'hour' => '*', 'minute' => '*'}) do
-      its('entries.length') { should cmp '0' }
-    end
-
-### Test that the logged-in user's crontab contains a single command that matches a mattern
-
-    describe crontab.where { command =~ /a partial command string/ } do
-      its('entries.length') { should cmp 1 }
-    end
-
-### Test a special time string (i.e., @yearly /root/anual_report.sh)
-
-    describe crontab.commands('/root/anual_report.sh') do
-      its('hours') { should cmp '0' }
-      its('minutes') { should cmp '0' }
-      its('days') { should cmp '1' }
-      its('months') { should cmp '1' }
-    end
-
-### Test @reboot case
-
-    describe crontab.commands('/root/reboot.sh') do
-      its('hours') { should cmp '-1' }
-      its('minutes') { should cmp '-1' }
-    end
-
-<br>
-
-## Property Examples
-
-
-### Test a special time string
-
-    describe crontab do
-      its('minutes') { should cmp '0' }
-      its('hours') { should cmp '0' }
-      its('days') { should cmp '1' }
-      its('weekdays') { should cmp '1' }
-      its('user') { should include 'username'}
-      its('commands') { should include '/some/scheduled/task.sh' }
-    end
-
-InSpec will automatically interpret crontab-supported special time strings. For example, a crontab entry set to run `@yearly` can be tested as if the entry was manually configured to run on January 1, 12 AM.
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+---
+title: About the crontab Resource
+platform: linux
+---
+
+# crontab
+
+Use the `crontab` InSpec audit resource to test the crontab entries for a particular user on the system. It recognizes special time strings (@yearly, @weekly, etc).
+
+<br>
+
+## Syntax
+
+A `crontab` resource block declares a user (which defaults to the current user, if not specified), and then the details to be tested, such as the schedule elements for each crontab entry or the commands itself:
+
+    describe crontab do
+      its('commands') { should include '/some/scheduled/task.sh' }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test that root's crontab has a particular command
+
+    describe crontab('root') do
+      its('commands') { should include '/path/to/some/script' }
+    end
+
+### Test that myuser's crontab entry for command '/home/myuser/build.sh' runs every minute
+
+    describe crontab('myuser').commands('/home/myuser/build.sh') do
+      its('hours') { should cmp '*' }
+      its('minutes') { should cmp '*' }
+    end
+
+### Test that the logged-in user's crontab has no tasks set to run on every hour and every minute
+
+    describe crontab.where({'hour' => '*', 'minute' => '*'}) do
+      its('entries.length') { should cmp '0' }
+    end
+
+### Test that the logged-in user's crontab contains a single command that matches a pattern
+
+    describe crontab.where { command =~ /a partial command string/ } do
+      its('entries.length') { should cmp 1 }
+    end
+
+### Test a special time string (i.e., @yearly /root/annual_report.sh)
+
+    describe crontab.commands('/root/annual_report.sh') do
+      its('hours') { should cmp '0' }
+      its('minutes') { should cmp '0' }
+      its('days') { should cmp '1' }
+      its('months') { should cmp '1' }
+    end
+
+### Test @reboot case
+
+    describe crontab.commands('/root/reboot.sh') do
+      its('hours') { should cmp '-1' }
+      its('minutes') { should cmp '-1' }
+    end
+
+<br>
+
+## Property Examples
+
+
+### Test a special time string
+
+    describe crontab do
+      its('minutes') { should cmp '0' }
+      its('hours') { should cmp '0' }
+      its('days') { should cmp '1' }
+      its('weekdays') { should cmp '1' }
+      its('user') { should include 'username'}
+      its('commands') { should include '/some/scheduled/task.sh' }
+    end
+
+InSpec will automatically interpret crontab-supported special time strings. For example, a crontab entry set to run `@yearly` can be tested as if the entry was manually configured to run on January 1, 12 AM.
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).