inspec 2.0.16 → 2.0.17

data/docs/reporters.md

@@ -1,105 +1,105 @@
----
-title: InSpec Reporters
----
-
-# InSpec Reporters
-
-Introduced in InSpec 1.51.6
-
-InSpec allows you to output your test results to one or more reporters. You can configure the reporter(s) using either the `--json-config` option or the `--reporter` option. While you can configure multiple reporters to write to different files, only one reporter can output to the screen(stdout).
-
-## Syntax
-
-You can specify one or more reporters using the `--reporter` cli flag. You can also specify a output by appending a path seperated by a colon.
-
-Output json to screen.
-
-```bash
-inspec exec --reporter json
-or
-inspec exec --reporter json:-
-```
-
-Output cli to screen and write json to a file.
-
-```bash
-inspec exec --reporter cli json:/tmp/output.json
-```
-
-Output nothing to screen and write junit and html to a file.
-
-```bash
-inspec exec --reporter junit:/tmp/junit.xml html:www/index.html
-```
-
-Output json to screen and write to a file. Write junit to a file.
-
-```bash
-inspec exec --reporter json junit:/tmp/junit.xml | tee out.json
-```
-
-If you are using the cli option `--json-config` you can also set reporters.
-
-Output cli to screen.
-
-```json
-{
-    "reporter": {
-        "cli" : {
-            "stdout" : true
-        }
-    }
-}
-```
-
-Output cli to screen and write json to a file.
-
-```json
-{
-    "reporter": {
-        "cli" : {
-            "stdout" : true
-        },
-        "json" : {
-            "file" : "/tmp/output.json",
-            "stdout" : false
-        }
-    }
-}
-```
-
-## Supported Reporters
-
-The following are the current supported reporters:
-
-### cli
-
-This is the basic text base report. It includes details about which tests passed and failed and includes an overall summary at the end.
-
-### json
-
-This reporter includes all information about the profiles and test results in standard json format.
-
-### json-min
-
-This reporter is a redacted version of the json and only includes test results.
-
-### documentation
-
-This reporter is a very minimal text base report. It shows you which tests passed by name and has a small summary at the end.
-
-### junit
-
-This reporter outputs the standard junit spec in xml format.
-
-### progress
-
-This reporter is very condensed and gives you a `.`(pass), `f`(fail), or `*`(skip) character per test and a small summary at the end.
-
-### json-rspec
-
-This reporter includes all information from the rspec runner. Unlike the json reporter this includes rspec specific details.
-
-### html
-
-This renders html code to view your tests in a browser. It includes all the test and summary information.
+---
+title: InSpec Reporters
+---
+
+# InSpec Reporters
+
+Introduced in InSpec 1.51.6
+
+InSpec allows you to output your test results to one or more reporters. You can configure the reporter(s) using either the `--json-config` option or the `--reporter` option. While you can configure multiple reporters to write to different files, only one reporter can output to the screen(stdout).
+
+## Syntax
+
+You can specify one or more reporters using the `--reporter` cli flag. You can also specify a output by appending a path seperated by a colon.
+
+Output json to screen.
+
+```bash
+inspec exec --reporter json
+or
+inspec exec --reporter json:-
+```
+
+Output cli to screen and write json to a file.
+
+```bash
+inspec exec --reporter cli json:/tmp/output.json
+```
+
+Output nothing to screen and write junit and html to a file.
+
+```bash
+inspec exec --reporter junit:/tmp/junit.xml html:www/index.html
+```
+
+Output json to screen and write to a file. Write junit to a file.
+
+```bash
+inspec exec --reporter json junit:/tmp/junit.xml | tee out.json
+```
+
+If you are using the cli option `--json-config` you can also set reporters.
+
+Output cli to screen.
+
+```json
+{
+    "reporter": {
+        "cli" : {
+            "stdout" : true
+        }
+    }
+}
+```
+
+Output cli to screen and write json to a file.
+
+```json
+{
+    "reporter": {
+        "cli" : {
+            "stdout" : true
+        },
+        "json" : {
+            "file" : "/tmp/output.json",
+            "stdout" : false
+        }
+    }
+}
+```
+
+## Supported Reporters
+
+The following are the current supported reporters:
+
+### cli
+
+This is the basic text base report. It includes details about which tests passed and failed and includes an overall summary at the end.
+
+### json
+
+This reporter includes all information about the profiles and test results in standard json format.
+
+### json-min
+
+This reporter is a redacted version of the json and only includes test results.
+
+### documentation
+
+This reporter is a very minimal text base report. It shows you which tests passed by name and has a small summary at the end.
+
+### junit
+
+This reporter outputs the standard junit spec in xml format.
+
+### progress
+
+This reporter is very condensed and gives you a `.`(pass), `f`(fail), or `*`(skip) character per test and a small summary at the end.
+
+### json-rspec
+
+This reporter includes all information from the rspec runner. Unlike the json reporter this includes rspec specific details.
+
+### html
+
+This renders html code to view your tests in a browser. It includes all the test and summary information.

data/docs/resources/aide_conf.md.erb

@@ -1,76 +1,76 @@
----
-title: The aide_conf Resource
-platform: linux
----
-
-# aide_conf
-
-Use the `aide_conf` InSpec audit resource to test the rules established for the file integrity tool AIDE. Controlled by the aide.conf file typically at /etc/aide.conf.
-
-<br>
-
-## Syntax
-
-An `aide_conf` resource block can be used to determine if the selection lines contain one (or more) directories whose files should be added to the aide database:
-
-    describe aide_conf('path') do
-      its('selection_lines') { should include '/sbin' }
-    end
-
-where
-
-* `'selection_lines'` refers to all selection lines found in the aide.conf file
-* `('path')` is the non-default path to the `aide.conf` file (optional)
-* `should include 'value'` is the value that is expected
-
-Use the where clause to match a selection_line to one rule or a particular set of rules found in the aide.conf file:
-
-    describe aide_conf.where { selection_line == '/bin' } do
-      its('rules.flatten') { should include 'r' }
-    end
-
-    describe aide_conf.where { selection_line == '/sbin' } do
-      its('rules') { should include ['p', 'i', 'l', 'n', 'u', 'g', 'sha512'] }
-    end
-
-<br>
-
-## Properties
-
-* `conf_path`, `content`, `rules`, `all_have_rule`
-
-<br>
-
-## Property Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test if all selection lines contain the xattr rule
-
-    describe aide_conf.all_have_rule('xattr') do
-      it { should eq true }
-    end
-
-### Test whether selection line for /bin contains a particular rule
-
-    describe aide_conf.where { selection_line == '/bin' } do
-      its('rules.flatten') { should include 'r' }
-    end
-
-### Test whether selection line for /sbin consists of a particular set of rules
-
-    describe aide_conf.where { selection_line == '/sbin' } do
-      its('rules') { should include ['r', 'sha512'] }
-    end
-
-### The usage of all\_have\_rule will return whether or not all selection lines in audit.conf contain a particular rule:
-
-    describe aide_conf.all_have_rule('sha512') do
-      it { should eq true }
-    end
-
-<br>
-
-## Matchers
-
+---
+title: The aide_conf Resource
+platform: linux
+---
+
+# aide_conf
+
+Use the `aide_conf` InSpec audit resource to test the rules established for the file integrity tool AIDE. Controlled by the aide.conf file typically at /etc/aide.conf.
+
+<br>
+
+## Syntax
+
+An `aide_conf` resource block can be used to determine if the selection lines contain one (or more) directories whose files should be added to the aide database:
+
+    describe aide_conf('path') do
+      its('selection_lines') { should include '/sbin' }
+    end
+
+where
+
+* `'selection_lines'` refers to all selection lines found in the aide.conf file
+* `('path')` is the non-default path to the `aide.conf` file (optional)
+* `should include 'value'` is the value that is expected
+
+Use the where clause to match a selection_line to one rule or a particular set of rules found in the aide.conf file:
+
+    describe aide_conf.where { selection_line == '/bin' } do
+      its('rules.flatten') { should include 'r' }
+    end
+
+    describe aide_conf.where { selection_line == '/sbin' } do
+      its('rules') { should include ['p', 'i', 'l', 'n', 'u', 'g', 'sha512'] }
+    end
+
+<br>
+
+## Properties
+
+* `conf_path`, `content`, `rules`, `all_have_rule`
+
+<br>
+
+## Property Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test if all selection lines contain the xattr rule
+
+    describe aide_conf.all_have_rule('xattr') do
+      it { should eq true }
+    end
+
+### Test whether selection line for /bin contains a particular rule
+
+    describe aide_conf.where { selection_line == '/bin' } do
+      its('rules.flatten') { should include 'r' }
+    end
+
+### Test whether selection line for /sbin consists of a particular set of rules
+
+    describe aide_conf.where { selection_line == '/sbin' } do
+      its('rules') { should include ['r', 'sha512'] }
+    end
+
+### The usage of all\_have\_rule will return whether or not all selection lines in audit.conf contain a particular rule:
+
+    describe aide_conf.all_have_rule('sha512') do
+      it { should eq true }
+    end
+
+<br>
+
+## Matchers
+
 For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).

data/docs/resources/apache.md.erb

@@ -1,67 +1,67 @@
----
-title: About the apache Resource
-platform: linux
----
-
-# apache
-
-Use the `apache` InSpec audit resource to test the state of the Apache server on Linux/Unix systems.
-
-<p class="warning">This resource is deprecated and should not be used. It will be removed in InSpec 3.0.</p>
-
-<br>
-
-## Syntax
-
-An `apache` InSpec audit resource block declares settings that should be tested:
-
-    describe apache do
-      its('setting_name') { should cmp 'value' }
-    end
-
-where
-
-* `'setting_name'` is description of the Apache configuration file
-* `{ should cmp 'value' }` is the value that is expected
-
-<br>
-
-## Properties
-
-* 'service', 'conf_dir', 'conf_path', 'user'
-
-<br>
-
-## Property Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test the service name.
-
-    describe apache do
-      its ('service') { should cmp 'apache2' }
-    end
-
-### Test the configuration location
-
-    describe apache do
-      its ('conf_dir') { should cmp '/etc/apache2' }
-    end
-
-### Test the path of the configuration file
-
-    describe apache do
-      its ('conf_path') { should cmp '/etc/apache2/apache2.conf' }
-    end
-
-### Test the apache user
-
-    describe apache do
-      its ('user') { should cmp 'www-data' }
-    end
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+---
+title: About the apache Resource
+platform: linux
+---
+
+# apache
+
+Use the `apache` InSpec audit resource to test the state of the Apache server on Linux/Unix systems.
+
+<p class="warning">This resource is deprecated and should not be used. It will be removed in InSpec 3.0.</p>
+
+<br>
+
+## Syntax
+
+An `apache` InSpec audit resource block declares settings that should be tested:
+
+    describe apache do
+      its('setting_name') { should cmp 'value' }
+    end
+
+where
+
+* `'setting_name'` is description of the Apache configuration file
+* `{ should cmp 'value' }` is the value that is expected
+
+<br>
+
+## Properties
+
+* 'service', 'conf_dir', 'conf_path', 'user'
+
+<br>
+
+## Property Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test the service name.
+
+    describe apache do
+      its ('service') { should cmp 'apache2' }
+    end
+
+### Test the configuration location
+
+    describe apache do
+      its ('conf_dir') { should cmp '/etc/apache2' }
+    end
+
+### Test the path of the configuration file
+
+    describe apache do
+      its ('conf_path') { should cmp '/etc/apache2/apache2.conf' }
+    end
+
+### Test the apache user
+
+    describe apache do
+      its ('user') { should cmp 'www-data' }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).