Commit graph

728 commits

Author SHA1 Message Date
Jerry Aldrich
74f0e7cf0e Correct example to use message in both places
Thanks @kclinden

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2019-07-18 10:06:59 -07:00
Jerry Aldrich
4a5103802a Change comment to be correct and fit on one line
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2019-07-17 22:38:43 -07:00
Jerry Aldrich
a9879544a9 Add SHA512 password example to shadow resource
Many thanks to @kclinden and @zenspider for helping make this possible

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2019-07-17 20:03:41 -07:00
Eike Waldt
68dd042bd0
use semi-realistic examples
Signed-off-by: Eike Waldt <waldt@b1-systems.de>
2019-07-16 21:02:52 +02:00
Eike Waldt
2a775ca6b7
indent all code samples in docs/resources/sys_info.md.erb
Signed-off-by: Eike Waldt <waldt@b1-systems.de>
2019-07-16 21:02:52 +02:00
Eike Waldt
2a072ad852
add docs for resource sys_info.manufacturer and sys_info.model
Signed-off-by: Eike Waldt <waldt@b1-systems.de>
2019-07-16 20:39:38 +02:00
Miah Johnson
1541879f0b
Merge pull request #4269 from shoekstra/users_docs_example
Add allowed users example to Users resource
2019-07-08 12:03:22 -07:00
Miah Johnson
8272d0184b
Merge pull request #4236 from ramereth/ip6tables
Add ip6tables resource
2019-07-08 11:45:33 -07:00
Stephen Hoekstra
c2b4bb878b Add allowed users example to Users resource
This example shows how to check for expected users and to flag any other
users that should not be present.

Signed-off-by: Stephen Hoekstra <stephenhoekstra@gmail.com>
2019-07-08 20:30:20 +02:00
kekaichinose
352f149015 Update azure_resource_group.md.erb
* corrected documentation to reflect missing method of "_count" (correct) vs. "_counts" (wrong)
* corrected incorrect spelling of "Inspec" to "InSpec"

Signed-off-by: Keka Ichinose <rikoomi@hotmail.com>
2019-07-03 22:52:46 -07:00
Jerry Aldrich
b7eb0f370f Add CLI target examples for Windows domain users
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2019-06-25 15:34:51 -07:00
Lance Albertson
3263d76627 Add ip6tables resource
This should resolve #1011 which provides an ip6tables resource to test IPv6
iptables rules. This is essentially a copy of the iptables resource with a few
renames.

In addition, I've pulled in the integration tests for iptables into ip6tables
and enabled it on docker so that it properly gets tested regularly. The test
cookbook recipe has been updated to support all of the current platforms that
are being tested.

Signed-off-by: Lance Albertson <lance@osuosl.org>
2019-06-24 17:01:34 -07:00
Clinton Wolfe
cc6faa49ce
Create Inputs documentation page (#4185)
Create Inputs documentation page
2019-06-12 13:26:39 -04:00
Clinton Wolfe
9eb7927c81 Replace semicolon
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-12 12:12:27 -04:00
Clinton Wolfe
425f13ef97 Mission-critical extra newline fix
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-06 15:26:37 -04:00
Clinton Wolfe
9366804335 PR Feedback
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-06 12:51:22 -04:00
Clinton Wolfe
93481a5814 Developer docs
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-06 12:51:22 -04:00
Clinton Wolfe
94bc98e32e copyedit feedback
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-06 12:50:19 -04:00
Mary Jinglewski
cc9532d065 Copyediting for Input docs
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2019-06-05 16:54:47 -04:00
Clinton Wolfe
68fc434ede Missed one
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-05 12:06:08 -04:00
Clinton Wolfe
aecd11b45c Update related docs
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-05 11:14:35 -04:00
Clinton Wolfe
35b27ee109 Readover edits
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-05 10:57:00 -04:00
Clinton Wolfe
896aca1ffd Resolve TODOs
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-05 10:57:00 -04:00
Clinton Wolfe
70ea81b245 bulk of text in place
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-05 10:57:00 -04:00
Clinton Wolfe
213613d978 Add profile metadata section
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-05 10:57:00 -04:00
Clinton Wolfe
97c62cf5fe Add reading imputs section
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-05 10:57:00 -04:00
Clinton Wolfe
e91f7a4ea8 Wrote out option reference
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-05 10:57:00 -04:00
Clinton Wolfe
682fa18313 Most of introduction in place
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-05 10:57:00 -04:00
Clinton Wolfe
0bd3941aaa outline of inputs doc
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-05 10:57:00 -04:00
Mary Jinglewski
8003305caf Fixing docs so Warning note appears
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2019-06-04 13:44:41 -04:00
Clinton Wolfe
82cafccebb Remove enclosing HTML and re-render
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-03 11:56:34 -04:00
Clinton Wolfe
3cb3ca9f94 Remove two misrendering hyperlinks
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-03 11:35:48 -04:00
Miah Johnson
2a1b1d8e88 Remove all leading newlines.
Signed-off-by: Miah Johnson <miah@chia-pet.org>
2019-05-31 11:43:44 -07:00
Clinton Wolfe
06de2dc941 Update azure gr sunset notice
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-05-30 11:40:05 -04:00
Clinton Wolfe
c4d7a52b94 Update apache resource sunset notice
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-05-30 11:39:20 -04:00
Miah Johnson
2215bb0570 Update all requires pointing to util/
Signed-off-by: Miah Johnson <miah@chia-pet.org>
2019-05-28 11:30:16 -07:00
Ryan Davis
f36a7c8061 No tabs.
Signed-off-by: Ryan Davis <zenspider@chef.io>
2019-05-25 03:40:36 -07:00
Mary Jinglewski
3dec5dad3e GCP InSpec Docs
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2019-05-21 16:45:02 -07:00
Miah Johnson
dafd91898d
Merge branch 'master' into changeInSpecText 2019-05-08 12:32:04 -07:00
Miah Johnson
5c00a44d71 Update resource registry_key documentation example
ref: https://github.com/inspec/inspec/issues/4003

Signed-off-by: Miah Johnson <miah@chia-pet.org>
2019-04-30 17:04:12 -07:00
Unknown
5c1467dfe9 Update software name from InSpec to Chef Inspec
Signed-off-by: IanMadd <maddaus@protonmail.com>
2019-04-29 15:16:56 -04:00
Mary Jinglewski
70db730b48 Remove be_immutable
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2019-04-23 13:52:48 -04:00
Clinton Wolfe
3d0b8dff2e
Merge pull request #3956 from inspec/cw/use-deprecation-everywhere-4-port
Use deprecation facility everywhere - v4 port
2019-04-17 17:12:24 -04:00
Clinton Wolfe
7aeb1763a9
Merge pull request #3897 from mattlqx/interface-addresses
Support address matchers on interface resource
2019-04-17 11:57:29 -04:00
Clinton Wolfe
1552dc0210 Merge branch 'cw/use-deprecation-everywhere-3-port' of github.com:inspec/inspec into cw/use-deprecation-everywhere-4-port 2019-04-16 17:42:45 -04:00
Clinton Wolfe
0c884b1415
Merge pull request #3895 from mitre/al-mitre/more-permissive-than
Signed-off-by: Aaron Lippold <lippold@gmail.com>
2019-04-16 14:41:43 -04:00
Matt Kulka
633cea6673 support address matchers on interface resource
Adds missing functionality to `interface`. Fixes #1830

```
describe interface("eth0") do
  its(ipv4_addresses) { should include 1.2.3.4 }
end
```

And so on... see diff/docs for additional matchers.

Signed-off-by: Matt Kulka <mkulka@parchment.com>
2019-04-12 08:24:13 -07:00
Jerry Aldrich
40031a9b83 Use deprecation facility throughout code
This converts all current deprecation warnings/TODOs to use the
`Inspec.deprecate()` deprecation facility.

This also modifies `Inspec.deprecate()` to only require 1 argument.

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2019-04-11 19:15:01 -04:00
Clinton Wolfe
082882d98d
Merge pull request #3915 from nqb/docs/apt-resource
apt: correct docs to clarify that it matches repositories not packages
2019-04-08 11:22:35 -04:00
Miah Johnson
8435990722
Merge pull request #3899 from inspec/sp/crontab-path-update
crontab: Add validation for path param
2019-04-04 17:26:13 +00:00
nqb
79078d611c
fix: apt resource matchs repositories not packages
Obvious fix.

Signed-off-by: nqb <nqb+git@azyx.fr>
2019-04-03 08:50:08 +02:00
Aaron Lippold
1e9f8fd018 Merge branch 'master' of https://github.com/inspec/inspec into al-mitre/more-permissive-than
Signed-off-by: Aaron Lippold <lippold@gmail.com>
2019-03-28 15:50:16 -04:00
Josh Larsen
3c24f37c33 Fix broken links in migration docs.
Obvious fix.
2019-03-28 13:17:13 -04:00
Aaron Lippold
e312b44563 Addressing review items.
Signed-off-by: Aaron Lippold <lippold@gmail.com>
2019-03-27 09:55:48 -04:00
Stuart Paterson
5accfa5391
Add protection for crontab resource path and document it.
Signed-off-by: Stuart Paterson <spaterson@chef.io>
2019-03-21 15:49:00 +00:00
Clinton Wolfe
2d40181f35
Merge pull request #3890 from inspec/cw/fix-glossary-links
Repair anchor links to use dashes instead of underscores
2019-03-20 11:06:51 -04:00
Aaron Lippold
9a8ed4d3e5 move the advanced use-case to the tips and tricks
Signed-off-by: Aaron Lippold <lippold@gmail.com>
2019-03-18 21:56:00 -04:00
Aaron Lippold
a2a86860d6 This adds the more_permissive_than?(mode) matcher to the file resource.
Fixes #3893

Signed-off-by: Aaron Lippold <lippold@gmail.com>
2019-03-18 18:10:13 -04:00
Keith Walters
c2bd0616fe Allow http resource to follow redirects
By specifying a `max_redirects` attribute, the `http` resource worker
will follow any HTTP Redirect response (301, 302, etc...) up to the
limit defined by this attribute. For a local worker, exceeding that
limit will raise a `FaradayMiddleware::RedirectLimitReached` exception.
For a remote worker, the curl command will exit without populating the
`status` and `body` properties.

Signed-off-by: Keith Walters <keith.walters@cattywamp.us>
2019-03-16 20:54:52 -04:00
Clinton Wolfe
0d299e9b1d Repair anchor links to use dashes instead of underscores
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-03-14 10:57:48 -04:00
Mary Jinglewski
222a13d75a Definition list format
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2019-02-27 15:14:27 -05:00
Clinton Wolfe
c28e48afa2 Docs feedback
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-02-27 15:14:27 -05:00
Jerry Aldrich
a1a6497989 Update docs/config.md
Co-Authored-By: clintoncwolfe <clintoncwolfe@gmail.com>
2019-02-27 15:14:27 -05:00
Clinton Wolfe
59de0c3c8a Clarify fallback behavior
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-02-27 15:14:27 -05:00
Clinton Wolfe
20ffbffb01 Document teh credential sets features and config file format
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-02-27 15:14:27 -05:00
jtimberman
d2d4c9605f add json example from http request
I was looking for an example of how to do this, but I didn't find
anything in the documentation. This is a simple examle in the `json`
resource that returns a JSON blob back from an `http` request to a
"`/health`" endpoint.

Signed-off-by: Joshua Timberman <joshua@chef.io>
2019-02-21 10:23:52 -07:00
Clinton Wolfe
48711fa7bb
Merge pull request #3778 from inspec/team/filesystem-free-percent
filesystem: Add free_kb, size_kb, type, and percent_free properties
2019-02-06 17:40:10 -05:00
Clinton Wolfe
2b836a35c1
Merge pull request #3781 from EmFl/patch-2
package: Correct contradictory docs examples
2019-02-06 14:22:30 -05:00
Clinton Wolfe
dd3d3cbd2f Add deprecation hook for size()
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-02-06 14:02:17 -05:00
Clinton Wolfe
02cb799ee6 Rename free to free_kb
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-02-06 14:01:04 -05:00
Clinton Wolfe
5bbd4c16d6 Add size_kb, and correct Powershell code to return KB for both total size and free space, rather than total in GB and free space in bytes
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-02-06 14:01:04 -05:00
Clinton Wolfe
fef637a6c6 Add percent_free property
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-02-06 14:01:04 -05:00
James Massardo
83c0c18fca Add free space and type to filesystem resource
Signed-off-by: James Massardo <jmassardo@chef.io>
2019-02-06 14:01:04 -05:00
EmFl
785430ec3f
Update package.md.erb
Some contradictory description vs code example
2019-02-06 09:45:38 +01:00
Elijah Oyekunle
179ce538ed changed wrong references to pg_hba to pg_ident
Obvious fix.

Signed-off-by: Elijah Oyekunle <eloyekunle@gmail.com>
2019-02-01 14:10:18 +01:00
Clinton Wolfe
8760c48dbd Update docs
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-01-28 00:42:27 -05:00
Sean Escriva
cae4cb7049
Apply suggestions from review, fix typos
Signed-off-by: Sean Escriva <sean.escriva@gmail.com>
2019-01-23 08:59:59 -05:00
Sean Escriva
b764ced5d9
Document additional usage of json resource
The `command` and `content` usage seems to have been supported for some time, but is not included in the documentation.

ref:
* https://github.com/inspec/inspec/pull/1271

Signed-off-by: Sean Escriva <sean.escriva@gmail.com>
2019-01-20 15:16:30 -05:00
Clinton Wolfe
267786bf81 Doc updates per PR feedback
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-01-15 15:37:08 -05:00
Jerry Aldrich
f5ec7c9c65 Fix style/RuboCop on cw/deprecation-facility
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2019-01-14 13:57:59 -08:00
Clinton Wolfe
4111d21e0e Added devdocs
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-01-10 23:54:50 -08:00
Miah Johnson
15162bf920 Add resources for aws_billing_report and aws_billing_reports. (#2838)
Signed-off-by: Miah Johnson <miah@chia-pet.org>
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-01-09 16:06:48 -08:00
Clinton Wolfe
1593903490
Adjust version number for availability of aws_sqs_queue (#3685)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-12-20 16:33:22 -05:00
Amit Saha
bbc07f5f11 aws_sqs_queue - new resource (#3674)
Signed-off-by: Amit Saha <amitsaha.in@gmail.com>
2018-12-20 14:33:21 -05:00
Jerry Aldrich
91fe4ad03b Fix labels on Docker containers (#3673)
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-12-20 12:31:13 -05:00
Nathan Haneysmith
ec04c36f55 Fix formatting of heading on doc for aws_config_delivery_channel (#3656)
Heading is displaying incorrect on https://www.inspec.io/docs/reference/resources/aws_config_delivery_channel/
2018-12-12 11:26:39 -05:00
Clinton Wolfe
fefa6c2ecd
Plugin Type: DSLs (#3557)
This PR adds 5 closely related plugin types, which allow a plugin to implement new DSL methods / keywords. The mechanism to activate the plugins are all very similar - basically, in a particular location in the code, `method_missing` is implemented, and is used to activate the particular type of DSL being requested.

4 of the DSL plugin types relate to code that could appear in a profile control file.

* outer_profile_dsl plugins allow you to extend the code in profile Ruby files that appear outside `control` or `describe` blocks.
* control_dsl plugins allow you to extend the code within `control` blocks.
* describe_dsl plugins allow you to extend the code within `describe` blocks.
* test_dsl plugins allow you to extend the code within `it`/`its` blocks.

Finally, the `resource_dsl` plugin allows you to extend the code used within custom resources.

Basic unit tests are provided to prove that the plugin types are properly defined.

A simple plugin fixture defining DSL hooks (based on favorite foods) is included, and is exercised through a set of functional tests.

The plugin developer docs are updated to describe the 5 DSLs.

*Note*: Implementing a plugin using any of the DSL plugin types is experimental.  The contexts that are exposed to the DSL methods are private and poorly documented. The InSpec project does not claim the APIs used by these plugin types are covered by SemVer.  Plugin authors are encouraged to pin tightly to the `inspec` gem in their gemspecs.

Motivation for this plugin comes from the desire to allow passionate community members to implement things like "2 out of 3" tests, example groups, improved serverspec compatibility, "they/their" and other "fluency" changes, as well as make it possible for future work by the InSpec team to be implemented as a core plugin, rather than a direct change to the main codebase.
2018-11-29 14:14:06 -05:00
Ian Savage
79f7239c69 Add SQLcl to Oracledb_session Doc (#3632)
* Add SQLcl option to oracledb_session.md.erb

Added sqlcl_bin option to oracledb_session documentation.

* Add SQLcl option to oracledb_session.md.erb

Signed-off-by: ibsavage <ianbsavage1@gmail.com>
2018-11-27 16:56:49 -05:00
Clinton Wolfe
b3fafab1e6 Add aws_eks_cluster resource (#3582)
* add aws_eks_cluster

Signed-off-by: Timothy van Zadelhoff
timothy.inspec@theothersolution.nl

* disable ABC check on fetch_from_api

Signed-off-by: Timothy van Zadelhoff <timothy.inspec@theothersolution.nl>

* add status predicates

* Change docs for status attribute

Signed-off-by: Timothy van Zadelhoff <timothy.inspec@theothersolution.nl>

*     Add integration tests

    Signed-off-by: Timothy van Zadelhoff <timothy.inspec@theothersolution.nl>

* Adjust EKS build code to almost work

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>

* EKS only uses private subnets - integration tests pass

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>

* Correct AWS Exception class for resource search miss in unit test

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>

* Update unit test to reflect AWS resource-standard miss behavior, returning nil for most properties

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-11-27 16:54:47 -05:00
Jared Quick
09b0c41e39
Update UUID documentation (#3612)
* Update UUID documentation
* Fix feedback.

Signed-off-by: Jared Quick <jquick@chef.io>
2018-11-15 13:19:37 -05:00
Timothy van Zadelhoff
5739cb2d6b aws_security_group: Query against other security group ids in allow_* matchers (#3576)
* add security-group to security-group rules
* update docs
* Add integration tests for security-group to security-group rules
* rubocop fix
*     Add one security group rule, with position.
* make control fit description

Signed-off-by: Timothy van Zadelhoff <timothy.inspec@theothersolution.nl
2018-11-13 13:25:33 -05:00
Mark Hughes
45926ef63a Added xml resource support for ints, bools, and string responses (#3583)
Methods like…

* `count()` return `Integer` values
* `boolean()` return `TrueClass`/`FalseClass` values
* `concat()` return `String` values

…but threw exceptions because those types weren't supported.

This adds support to the `xml` resource, and adds tests to verify some of those examples.

Signed-off-by: Mark Hughes <greenantdotcom@users.noreply.github.com>
2018-11-08 12:47:18 -05:00
David McCown
3ab956845c Fixes broken link in documentation (#3588)
Signed-off-by: David McCown <dmccown@chef.io>
2018-11-07 15:40:07 -05:00
Ksenia
c07ec59070 Add 17 hexadecimal characters support aws_vpc (#3518) (#3564)
aws_vpc: accept 17 hexadecimal characters for vpc_id 

Signed-off-by kchistova <kchistova@gmail.com>
2018-11-05 10:01:16 -05:00
David Grizzanti
d8c90df4df Doc typo fix (#3551)
Signed-off-by: Dave Grizzanti <david_grizzanti@comcast.com>
2018-11-05 09:11:23 -05:00
Nell Shamrell-Harrington
9faf638ff7 documents inspec habitat profile setup command (#3559)
* documents inspec habitat profile setup command
* fixes link and typo

Signed-off-by: Nell Shamrell <nellshamrell@gmail.com>
2018-11-01 13:47:23 -04:00
Jerry Aldrich
4a6f5f719a Fix rendering and other issues in the Style Guide (#3539)
* Fix rendering and other issues in the Style Guide
* Use backticks for technical literals
* Correct RubyGems spelling
* Clarify plugin installation instructions
* Clean up Avoid/Use style

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-11-01 13:07:02 -04:00
Jared Quick
0f42b31016
Allow end of options during Thor array parsing (#3547)
Signed-off-by: Jared Quick <jquick@chef.io>
2018-10-30 06:32:16 -04:00
Jerry Aldrich
329da7f679 Add cmp vs eq to the style guide (#3536)
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-10-25 13:21:02 -04:00
Jerry Aldrich
955d444b95 Correct/Enhance cmp matcher examples (#3537)
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-10-23 16:02:40 -04:00