Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-11-24 05:33:17 +00:00
Code Issues Projects Releases Packages Wiki Activity
3956 commits 453 branches 1898 tags 74 MiB
Commit graph

292 commits

Author SHA1 Message Date
Nolan Davidson
fbe7b8ddf8 Refactor to options hash and add unit tests 
Switched the oracle_session resource to take an option hash and allow
for configuring hostname, DB_SID, and sqlplus binary path.

Added unit tests.

Signed-off-by: Nolan Davidson <ndavidson@chef.io>
 2017-05-05 09:29:38 -04:00
Nathan L Smith
b169bece52 Correct supermarket and github inspec.yaml examples 
Signed-off-by: Nathan L Smith <smith@chef.io>
 2017-05-04 16:10:13 -05:00
Dominik Richter
5d1765c9bb add inspec.profile.file(...) for profile files 
Fixes https://github.com/chef/inspec/issues/1396

Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
 2017-05-03 20:39:27 +02:00
Nolan Davidson
9cd69ce4af Add an oracle_session resource 
This adds an oracle_session resource similar to the existing resource
for MySQL and MSSQL.  It assumes the sqlplus tool is installed and in
the path of the user InSpec connects as.

Signed-off-by: Nolan Davidson <ndavidson@chef.io>
 2017-05-02 10:50:20 -04:00
Adam Leff
bc2458bf5a
Fix YAML resource documentation 
The `yaml` resource documentation was missing many clues that users
need to successfully use the resource.

Signed-off-by: Adam Leff <adam@leff.co>
 2017-05-01 16:16:00 -05:00
Adam Leff
d95d666bc9
Fix ServerSpec migration doc rendering 
RedCarpet table rendering was not enabled, and we need to treat
the resource names as code to avoid resources with two underscores
from being rendered as partial italics.

Signed-off-by: Adam Leff <adam@leff.co>
 2017-05-01 15:18:49 -05:00
Grant Ridder
4daf948eec Converge inspec doesn't have yet from comma seperated list to bullet list 
Signed-off-by: Grant Ridder <shortdudey123@gmail.com>
 2017-05-01 10:10:40 -07:00
Grant Ridder
82a478f2ba Improve "Which Serverspec resources are available in InSpec?" doc 
- Switch serverspec and inspec resource compare to a table and fix the links
- Add links for serverspec resources not in inspec

Serverspec to InSpec markdown table generated with:
```
mapping = {
  bond: 'bond',
  bridge: 'bridge',
  command: 'command',
  cron: 'crontab',
  docker_container: 'docker_container',
  docker_image: 'docker_image',
  file: 'file',
  group: 'group',
  host: 'host',
  interface: 'interface',
  iis_website: 'iis_website',
  iis_app_pool: 'iis_website',
  iptables: 'iptables',
  kernel_module: 'kernel_module',
  linux_kernel_parameter: 'kernel_parameter',
  mysql_config: 'mysql_conf',
  package: 'package',
  port: 'port',
  ppa: 'apt',
  process: 'processes',
  service: 'service',
  user: 'user',
  windows_feature: 'windows_feature',
  windows_registry_key: 'registry_key',
  x509_certificate: 'x509_certificate',
  yumrepo: 'yum',
  zfs: 'zfs_pool'
}

serverspec_base = 'http://serverspec.org/resource_types.html#'
inspec_base = "https://www.inspec.io/docs/reference/resources/"

serverspec_max = serverspec_base.length + mapping.max_by{|k,v| k.length}[0].length * 2 + 4
inspec_max = inspec_base.length + mapping.max_by{|k,v| v.length}[1].length * 2 + 5

serverspec_header_half = ' ' * ((serverspec_max - 'Serverspec'.length) / 2)
inspec_header_half = ' ' * ((inspec_max - 'InSpec'.length) / 2)

puts "| #{serverspec_header_half}Serverspec#{serverspec_header_half} | #{inspec_header_half}InSpec#{inspec_header_half} |"
puts "|:#{'-' * serverspec_max}:|:#{'-' * inspec_max}:|"

mapping.each do |serverspec, inspec|
  serverspec_text = "[#{serverspec}](#{serverspec_base}#{serverspec})"
  padding = serverspec_max - serverspec_text.length
  serverspec_string = serverspec_text + ' ' * padding

  inspec_text = "[#{inspec}](#{inspec_base}#{inspec}/)"
  padding = inspec_max - inspec_text.length
  inspec_string = inspec_text + ' ' * padding

  puts "| #{serverspec_string} | #{inspec_string} |"
end
```

Signed-off-by: Grant Ridder <shortdudey123@gmail.com>
 2017-04-28 15:03:04 -07:00
Adam Leff
a1769cc01b
Update inspec.io references in docs/code 
The website is now at https://www.inspec.io - updating all inspec.io
references accordingly. :)

Signed-off-by: Adam Leff <adam@leff.co>
 2017-04-27 18:05:51 -04:00
Adam Leff
5c63210390 Merge pull request #1726 from chef/dr/ports-doc-cmp 
use cmp in port docs instead of eq
 2017-04-26 18:22:27 -04:00
Dominik Richter
84a59cab50 use cmp in port docs instead of eq 
Fixes https://github.com/chef/inspec/issues/438

Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
 2017-04-27 00:17:34 +02:00
Dominik Richter
1dafe50bd9 rename SimpleConfig / parse_config / parse_config_file options 
See https://github.com/chef/inspec/issues/1709
Fixes https://github.com/chef/inspec/issues/1709

Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
 2017-04-26 23:18:40 +02:00
Dominik Richter
a7771a4ebc describe the value ranges of impact 
Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
 2017-04-25 19:01:16 +02:00
Dominik Richter
6b2532224b add podcast link to docs on serverspec-inspec 
Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
 2017-04-25 15:49:56 +02:00
Dominik Richter
ec05c16797 reference docs to other tools in readme 
Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
 2017-04-25 15:44:33 +02:00
Christoph Hartmann
218bda9c34 Docker resource (#1566) 
* add docker, docker_container, and docker_image resources

Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
 2017-04-24 10:47:03 -04:00
Richard Shade
532efccf0e showing how to shellout in docs (#1689) 
* showing how to shellout in docs

Signed-off-by: Richard Shade <rshade@rightscale.com>
 2017-04-21 13:47:28 -04:00
Adam Leff
cdfabd9362 Fix docs pages for x509_certificate and key_rsa 
These files were not named correctly and the docs rake task
was not picking them up.

Signed-off-by: Adam Leff <adam@leff.co>
 2017-04-21 07:22:12 +02:00
Dominik Richter
02e435b6d0 add rabbitmq config resource 
Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
 2017-04-12 20:51:12 +02:00
Christoph Hartmann
afc7859fdb add documentation for registry_key backslashes and #1281 
Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
 2017-04-07 10:57:02 +02:00
Dominik Richter
7562138248 Merge pull request #1623 from chef/adamleff/http-resource-warning 
[www] Add warning to the http resource documentation
 2017-04-05 16:41:08 +02:00
Doc Walker
692e660140 Fix #1617 Add dh_params resource (#1618) 
* Fix #1617 Add dh_params resource

Signed-off-by: Doc Walker <4-20ma@wvfans.net>
 2017-04-04 10:34:09 -04:00
Adam Leff
6b49303136
Add warning to the http resource documentation 
Currently, the `http` resource only operates on the node on which
`inspec exec` is run, even if the user uses the `--target` flag.
This has caused some confusion in the community.

Until this can be fixed, this change adds a warning to the documentation.

Signed-off-by: Adam Leff <adam@leff.co>
 2017-04-03 17:21:15 -04:00
Adam Leff
fba3c68281
Fix protocols matcher text on ssl resource docs 
The `protocols` matcher section on the `ssl` resource
doc page fell victim to some copy/paste. This change
updates the text to the correct description.

Signed-off-by: Adam Leff <adam@leff.co>
 2017-04-03 15:21:08 -04:00
Adam Leff
1cf80737ad Yum resource fix for non-existent repos and repo info 
If a repo did not exist, running matchers against it (such as `exist`)
were failing due to a bug in `#to_s` when fetching the repo name. The
`info` method would return nil and we'd still try to treat it as a hash.

This change ensures that info is always a hash, possibly empty if the
repo doesn't exist, and uses the repo name provided by the user rather
than shortening it to be consistent with our other resources which don't
manipulate the user input in the formatter.

Also added a method_missing to allow users to interrogate repo options,
such as baseurl or gpgcheck.

Signed-off-by: Adam Leff <adam@leff.co>
 2017-03-29 10:42:25 +02:00
Adam Leff
5a12cddc9c
Add docs for habitat CLI commands 
Adding a dedicated page for the InSpec/Habitat integration which
explains what it is, and details the commands a user needs to use
the integration.

Signed-off-by: Adam Leff <adam@leff.co>
 2017-03-28 13:59:38 -04:00
joe.nuspl
1ab80ea052 Extend gem to take an optional gem_binary 
Allows one to test whether gems are installed into an omnibus environment.

Signed-off-by: Joe Nuspl <nuspl@nvwls.com>
 2017-03-24 22:28:42 -07:00
Christoph Hartmann
d2f000e435 refactor x509 resources and rsa key 
Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
 2017-03-22 11:44:32 +01:00
Richard Nixon
f66f0b3a18 Initial support for x509_certificate and rsa_key 
* Includes unit tests
* Includes 2 new resources
* Includes documentation

Signed-off-by: Richard Nixon <richard.nixon@btinternet.com>
 2017-03-22 10:00:48 +01:00
Adam Leff
bf36c0a7a7 Merge pull request #1555 from nvtkaszpir/patch-1 
Update file.md with example how to test symlinked files
 2017-03-15 09:00:32 -05:00
Michał Sochoń
7a935a204e Update file.md with example how to test symlinked files. 
Added detailed example why and how.
Updated with suggestions from Adam Leff.

Signed-off-by: Michał Sochoń <kaszpir@gmail.com>
 2017-03-15 07:53:14 +01:00
Adam Leff
8155357d0a Add additional example for matching crontab commands 
As raised in #1526, adding an additional example showing how
a user can use the `where` accessor to find commands matching
a pattern and write a test using the results.

Signed-off-by: Adam Leff <adam@leff.co>
 2017-03-14 22:16:39 +01:00
Adam Leff
7667c9cb0a Merge pull request #1525 from spiffytech/patch-1 
windows_task docs: Correct syntax error and misspelled word
 2017-03-08 15:03:15 -07:00
Tristan Escalada
27d94c5037 Fixing a typo 
changing paht to be path.
 2017-03-03 14:03:54 -05:00
Christoph Hartmann
e8e34c2ffe fix ident in cmp matcher docs 
Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
 2017-03-02 12:28:50 +01:00
spiffytech
152f056335 windows_task docs: Correct syntax error and misspelled word 2017-03-01 13:43:26 -05:00
Basil Peace
4bc1c1df4e
doc: Fix inspec.yml example with several supports settings 
Mapping keys should be unique according to YAML specification.
Note that some implementations don't enforce it, but silenty
overwrite previous declaration. See e.g.
https://github.com/ruby/psych/issues/79

Signed-off-by: Basil Peace <grv87@yandex.ru>
 2017-02-26 18:09:54 +03:00
Basil Peace
2b4f7ea5c9
doc: Fix problem with link to plugin_kitchen_inspec 2017-02-26 17:25:39 +03:00
Joseph Benden
1fdecc6680 Add FreeBSD support for ZFS datasets and pools 
The following new resources have been added; however, they
presently only support FreeBSD and similar.

* `zfs_dataset`: tests if a named ZFS dataset is present
  and/or has certain properties.
* `zfs_pool`: tests if a named ZFS pool is present and/or
  has certain properties.

Additionally, the `mount` resource has been reworked to
include support for FreeBSD; while the existing class
was renamed to LinuxMountParser.

Unit-tests were added for all of the above.

Signed-off-by: Joseph Benden <joe@benden.us>
 2017-02-22 10:29:49 -07:00
Adam Leff
417b791baa Adding new crontab resource 
The crontab resource parses a particular user's crontab file into
individual entries and allows the user to assert information about
each entry as needed.

Signed-off-by: Adam Leff <adam@leff.co>
 2017-02-10 09:33:31 -05:00
Christoph Hartmann
78b7a2c680 Merge pull request #1435 from postgred/kernel_module_version 
Version method for kernel_module
 2017-01-27 17:49:23 +01:00
Andrey Aleksandrov
3783357e50
Add version method to kernel_module 
Signed-off-by: Andrey Aleksandrov <postgred@gmail.com>
 2017-01-27 13:33:41 +03:00
Christoph Hartmann
976e5d85e4 improve http header handling 
Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
 2017-01-26 17:16:37 +01:00
Guilhem Lettron
51ca98c468 Add an http test method 
Signed-off-by: Guilhem Lettron <g.lettron@criteo.com>
 2017-01-26 12:02:54 +01:00
Christoph Hartmann
791f2db2e5 Merge pull request #1407 from gscho/rhel-doc-fix 
Fixed error in OS docs, added CentOS to redhat family docs.
 2017-01-25 12:13:51 +01:00
Nathen Harvey
2eda02932f
'execution' is spelled correctly 
Fixes a minor typo. The correct spelling is 'execution', not
'executation'

Signed-off-by: Nathen Harvey <nharvey@chef.io>
 2017-01-24 23:19:30 -05:00
techraf
3741cbe9d4 Fix resource name 2017-01-20 22:19:02 +09:00
techraf
a86b438ce4 Use double quotes to prevent escaping backslash in the expected string 2017-01-16 12:30:57 +09:00
gscho
3b7711adbc Update os.md.erb 2017-01-08 19:59:02 -05:00
Gregory Schofield
452b716591 Fixed error in OS docs, added CentOS to rehat family docs. 2017-01-08 19:51:33 -05:00
Alex Pop
607de99f75 mention inspec vendor for compliance dependency 
Signed-off-by: Alex Pop <apop@chef.io>
 2016-12-22 12:11:46 +00:00
Christoph Hartmann
fd2e29da38 add guidance for Serverspec migration 
Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
 2016-12-15 18:14:05 +01:00
Christoph Hartmann
71127cf33e Merge pull request #1354 from jerryaldrichiii/fix-iis-site-example 
Remove trailing `\\` from iis_site example
 2016-12-12 11:06:32 +01:00
Jerry Aldrich III
f2e6577460 Remove trailing \\ from iis_site example 
Signed-off-by: Jerry Aldrich III <jerry@chef.io>
 2016-12-09 10:00:10 -05:00
Christoph Hartmann
a990d20fcd Merge pull request #1306 from username-is-already-taken2/digitalgaz/windows_task 
Adding windows_task resource
 2016-11-25 11:46:42 -07:00
Jerry Aldrich III
66a47ce8b9 Remove extra ' in registry key examples 
Signed-off-by: Jerry Aldrich III <jerry@chef.io>
 2016-11-21 10:18:01 -06:00
username-is-already-taken2
4084a770ef Added documentation 
Signed-off-by: username-is-already-taken2 <digitalgaz@hotmail.com>
 2016-11-20 20:25:03 +00:00
Franklin Webber
a9726910ff Fixes resources in the docs 
* Fixes the npm package example to state 'npm' vs 'gem'
* Fixes powershell resource to specify the resource instead of 'script'
* Updates the example to rename variable 'script'

While ruby would allow the local variable and the presence of the InSpec method at the same time I think that it is bad form. Other resource examples also use 'script'.

* Changes pip to show generic example

Other package like resources show a generic example in the default.

Signed-off-by: Franklin Webber <franklin@chef.io>
 2016-11-19 17:57:03 -08:00
Alex Pop
c94407ca2c docs: quoted version for package resource example 
Signed-off-by: Alex Pop <apop@chef.io>
 2016-11-16 11:24:19 +00:00
Christoph Hartmann
a95f0cf116 fix #1226 
Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
 2016-11-03 00:32:31 +01:00
Artem Sidorenko
755f24ed6f Code-block directive is not needed here (#1247) 
and breaks the layout: http://inspec.io/docs/reference/resources/file/

Signed-off-by: Artem Sidorenko <artem@posteo.de>
 2016-10-25 23:26:08 +02:00
Seth
23456c5e86 Fix issue with registry_key example (#1243) 
* Fix issue with registry_key example

* Fix issue with registry_key example

Signed-off-by: Seth Thoenen <seththoenen@gmail.com>
 2016-10-25 22:34:30 +02:00
Nathen Harvey
7e4157ddf4 Headers and list elements that include more than one _ character were being rendered incorrectly. (Perhaps it is only when there are an even number but in any case I only found words with either one or two _s.) 
The html rendered from markdown would look like:

`<h3>be<em>grouped</em>into</h3>`

When there is only one `_` the html rendered correctly:

`<h3>be_directory</h3>`

This change escapes the `_` when there are multiple.

* New markdown:  `### be\_grouped\_into`
* New html:      `<h3>be_grouped_into</h3>`

resource matchers fixed:
* be_block_device
* be_character_device
* be_grouped_into
* be_linked_to
* be_owned_by
* have_app_pool
* have_property_value

resource fixed:
* parse_config_file

Signed-off-by: Nathen Harvey <nharvey@chef.io>
 2016-10-20 07:07:18 -04:00
Dominik Richter
b08de666e8 Merge pull request #1179 from davidwrede/doc_edits 
Changing headings to align with SEO best practices
 2016-09-30 15:33:21 +02:00
Victoria Jeffrey
3c9db53b6f add example for yumconf-like structured files 2016-09-30 13:37:47 +02:00
tpetchel
e2f878eaee Fix a few typos 2016-09-27 22:02:20 -04:00
David Wrede
9283f19b6e Changing headings to align with SEO best practices 
Signed-off-by: David Wrede <dwrede@chef.io>
 2016-09-27 12:03:23 -07:00
Alex Pop
9ce4ebb3a0 update dependency documentation and mention the lockfile 2016-09-26 16:31:06 +01:00
Steven Danna
3507c970a9
Document the require_resource function 
Signed-off-by: Steven Danna <steve@chef.io>
 2016-09-26 11:53:33 +01:00
Dominik Richter
babbf71dd1 add intro to inspec and friends 2016-09-26 06:21:05 +02:00
Dominik Richter
f9248033c3 render resource docs 2016-09-22 16:47:58 +02:00
Dominik Richter
dba8638e3a ignore auto-generated docs 2016-09-22 16:47:54 +02:00
Dominik Richter
67c990d19c add all partials for resources 2016-09-22 15:23:21 +02:00
Dominik Richter
5a5fa03321 add ruby usage in inspec as markdown 2016-09-22 15:06:04 +02:00
Dominik Richter
f179c88074 improve cli docs styling 2016-09-22 13:49:56 +02:00
Dominik Richter
a4982fc4f1 generate docs for cli 2016-09-22 13:43:57 +02:00
Christoph Hartmann
0e7c534ea7 1.0.0.beta2 2016-09-22 11:33:43 +02:00
Dominik Richter
c8638f9917 update docs to markdown 
run 2/3
 2016-09-22 10:16:16 +02:00
Jake Gage
6de1c47b72 Fix minor typo in documentation 2016-09-15 15:27:44 -05:00
Michał Sochoń
52b5b59b87 Extend Inspec DSL docs (#1006) 
Update dsl_inspec.rst
 2016-09-01 23:11:10 +02:00
Alex Pop
fd676ceb5c promote cmp usage as it provides results with octal mode 2016-08-30 18:23:47 +01:00
Steven Danna
f9952d922a Reformat service resource docs for discoverability 
This makes the service-manager-specific resources stand out a bit more
in the documentation.

Signed-off-by: Steven Danna <steve@chef.io>
 2016-08-26 11:23:59 +02:00
Steven Danna
91fa58f421
Generate documentation for the vendor command 
This was generated using `rake docs:cli`.
 2016-08-26 09:33:19 +01:00
Victoria Jeffrey
eb3b80ff87 document ini resource 2016-08-26 09:54:40 +02:00
Tim Smith
0dbe816f57 Docs should reference family not platform 
Signed-off-by: Tim Smith <tsmith@chef.io>
 2016-08-19 20:14:03 +02:00
Tim Smith
86247c012f Add missing platforms to the docs 
Signed-off-by: Tim Smith <tsmith@chef.io>
 2016-08-19 20:14:03 +02:00
Kartik Null Cating-Subramanian
83d9deda4f inspec shell documentation 2016-08-19 19:29:32 +02:00
Peter Burkholder
69a96665de Document awesome where syntax for port 2016-08-18 12:29:23 -04:00
Chris Evett
3df98b7a19 add iis_site tests and refactor post code review 2016-08-17 06:57:48 -04:00
Chris Evett
4d63afc1f8 add documentation to resources.rst for iis_site and fix comment 2016-08-17 06:57:48 -04:00
Dominik Richter
e637067c43 auto-genreate inspec cli docs 2016-08-12 13:40:59 +02:00
Patrick Münch
216a6aeac1 FIX: file(hba_config_file) test in documentation, it is not working and rubocop detect some issues 
Signed-off-by: Patrick Münch <patrick.muench1111@gmail.com>
 2016-07-14 13:06:41 +02:00
Patrick Münch
19c449b158 change the Test for risky database entries example 
Signed-off-by: Patrick Münch <patrick.muench1111@gmail.com>
 2016-07-06 16:07:32 +02:00
Montague, Brent
faffc236dd Add array documentation to yaml / json resource 2016-06-21 18:06:27 -04:00
Nick Rycar
820cd1ae86 Updating ctl docs to include the init command 2016-06-21 11:27:56 -07:00
Christoph Hartmann
e2b707f51d add documentation for bash resource 2016-06-19 23:46:20 +02:00
Tim Smith
b2876bf2f4 Update documentation for matching output of commands 2016-05-31 13:56:31 -07:00
Christoph Hartmann
7515b488fd Merge pull request #754 from jeremymv2/sudo_command 
add sudo_command option
 2016-05-16 15:32:29 +02:00
Christoph Hartmann
9896278599 remove string quotes from regex 2016-05-16 11:33:13 +02:00
Lamont Granquist
452047011d remove string quotes around regexp 2016-05-16 11:31:58 +02:00