Commit graph

603 commits

Author SHA1 Message Date
Clinton Wolfe
811318f2f8 Plugins API v2: Loader, Base API, and Test Harness (#3278)
* Functional tests for userdir option
* Accepts --config-dir CLI option
* Actually loads a config file from the config dir, more cases to test
* Able to load config and verify contents from config-dir
* Functional tests to ensure precedence for config options
* Enable setting config dir via env var
* .inspec, not .inspec.d
* Begin converting PluginCtl to PluginLoader/Registry
* Able to load and partially validate the plugins.json file
* More work on the plugin loader
* Break the world, move next gen stuff to plugin/
* Be sure to require base cli in bundled plugins
* Move test file
* Revert changes to v1 plugin, so we can have a separate one
* Checkpoint commit
* Move v2 plugin work to v2 area
* Move plugins v1 code into an isolated directory
* rubocop fixes
* Rip out the stuff about a user-dir config file, just use a plugin file
* Two psuedocode test file
* Working base API, moock plugin type, and loader.
* Adjust load path to be more welcoming
* Silence circular depencency warning, which was breaking a unit test
* Linting
* Fix plugin type registry, add tests to cover
* Feedback from Jerry

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-08-16 18:16:32 -04:00
Kimberly Garmoe
02aba82b38 Fixes docs images (#3288)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-08-14 14:24:11 -04:00
Christoph Hartmann
28df22bdbe update docs to use new platform attributes in supports (#3279)
* update docs to use new platform attributes in supports
* Updated supports docs.

Signed-off-by: Jared Quick <jquick@chef.io>
2018-08-09 14:07:18 -04:00
James Stocks
29d82a0460 Correct docs for Windows registry_key resource (#3248)
Last update was mistaken about the workaround that should be used.
This commit corrects that mistake and provides some example output from `inspec shell`.

Signed-off-by: James Stocks <jstocks@chef.io>
2018-08-09 09:17:05 -04:00
Clinton Wolfe
2de06bdeb5 Clean injection of Availability section (#3206)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-08-09 08:34:49 -04:00
Noel Georgi
9d3beb8d41 Adding docker plugin support (#3074)
* Fixing tests and squashing
* Updating as per some PR comments
* PR comments

Signed-off-by: Noel Georgi <18496730+frezbo@users.noreply.github.com>
2018-08-09 08:20:32 -04:00
Jerry Aldrich
f2d64938b7 windows_feature resource: Add DISM support (#3224)
* windows_feature resource: Add DISM support

This modifies the `windows_feature` resource to fallback to DISM when
the `Get-WindowsFeature` command is not available.

* Allow specifying `:dism` or `:powershell`
* Replace stacktrace with smaller error message
* Add notes/todo about raise behavior
* Remove duplicated platform check

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-07-25 16:00:06 -04:00
James Stocks
3b56223a52 Update docs for registry keys with period characters (#3216)
Signed-off-by: James Stocks <jstocks@chef.io>
2018-07-19 15:00:39 -04:00
Kimberly Garmoe
eb87fd384d Markdown and code fence fixes (#3230)
Signed-off-by: kgarmoe <kgarmoe@chef.io>
2018-07-19 14:31:38 -04:00
Jerry Aldrich
67405bca66 docs: Fix first xinetd_conf example (#3229)
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-07-18 11:29:39 -04:00
Jerry Aldrich
706493f2f3 command resource: Allow redacting #to_s (#3207)
* command resource: Allow redacting `#to_s`
* Respond to feedback

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-07-16 08:20:57 -04:00
Jerry Aldrich
3ea6780407 docs: Fix formatting/style on InSpec DSL page (#3201)
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-07-13 15:54:13 -04:00
Stanislav Voroniy
a16877f427 A number of bug fixes and new features for oracledb_session resource (#3170)
Signed-off-by: Stanislav Voroniy <stas@voroniy.com>
2018-07-09 13:57:45 -04:00
Clinton Wolfe
d0e2608ec3 Overhaul shadow docs (#3156)
* Overhaul shadow docs
* Feedback from stocksy
* Edits to shadow resource
* PR feedback correction
* Attempt to clarify grammar for expiry_date criterion

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-07-05 16:15:03 -04:00
Colin Hebert
7deed13425 Add support for shallow link paths (#3168)
* Add support for shallow link paths
* Improve documentation of the

Signed-off-by: Colin Hebert <hebert.colin@gmail.com>
2018-06-26 07:47:00 -04:00
Clinton Wolfe
44c0fd2e4f
Accept symbols and downcased criteria in aws_iam_policy have_statement matcher (#3129)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-06-21 14:19:56 -04:00
Clinton Wolfe
81d0423ee0 Overhaul Glossary (#3152)
* Move text glossary into main glossary file, and adjust headings
* Rewrite simple visual glossary example with more concrete example and add internal hyperlinks
* Add plural visual glossary
* Progress on the text glossary
* More Progress on the text glossary
* Remove skeletal advanced usage section for
* Edits for markdown, copy, passives

Signed-off-by: kgarmoe <kgarmoe@chef.io>
2018-06-20 21:26:36 -04:00
Christoph Hartmann
b2e0bccea8 deprecate azure_generic_resource (#3132)
* deprecate azure_generic_resource

Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
2018-06-15 08:44:19 -04:00
Jerry Aldrich
01d31efde3 docs: Remove extra backticks from windows_task (#3149)
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-06-15 08:08:03 -04:00
Jared Quick
7db83446ba
Add insecure option to the automate report json (#3124)
* Add insecure option to the automate report json.
* Add in automate and compliance json documentation.
* Fix typo.

Signed-off-by: Jared Quick <jquick@chef.io>
2018-06-14 14:05:21 -04:00
Clinton Wolfe
7aa60852e6 Add list properties back to shadow (#3140)
* Un-deprecate plural properties on shadow; deprecate the singular versions
* Update filtertable interface to current
* A weak attempt at making the docs coherent
* Doc feedback per Jerry

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-06-14 13:42:00 -04:00
Andrey Artemov
47bb4aa2fe Fix code examples for http resource (#3134)
Signed-off-by: Andrey Artemov <andrey.artemov@gmail.com>
2018-06-14 09:29:10 -04:00
Clinton Wolfe
6f46d52242
Add aws_elb and aws_elbs resources (#3079)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-06-07 15:06:05 -04:00
Miah Johnson
ab32446213 Adds a aws_flow_log resource with unit and integration testing. (#2906)
Signed-off-by: Miah Johnson <miah@chia-pet.org>
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-06-07 14:41:46 -04:00
Miah Johnson
5416f523a9 correct docs for shadow (#3042)
Signed-off-by: Miah Johnson <miah@chia-pet.org>
2018-06-06 14:13:34 -04:00
Miah Johnson
71ca82fd74 Documentation fixes (#3058)
Signed-off-by: Miah Johnson <miah@chia-pet.org>
2018-06-06 14:10:48 -04:00
Clinton Wolfe
f9dd82f2f6
Add common methods to FilterTable automatically (#3104)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-06-05 22:35:09 -04:00
Clinton Wolfe
ca6556e0fe
Add lazy-loading to FilterTable (#3093)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-06-05 17:32:52 -04:00
Clinton Wolfe
4cd6cc07cc
Two fixes to FilterTable where criteria handling (#3045)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-06-05 00:46:32 -04:00
Clinton Wolfe
8c274daaa9
Refactor: Perform internal rename and add comments to FilterTable (#3047)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-06-04 20:20:59 -04:00
Jerry Aldrich
49118a90b9 Spellcheck FilterTable Developer Documentation (#3111)
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-06-04 18:52:44 -04:00
Clinton Wolfe
b334eb65d9
FilterTable Developer Documentation (#3048)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-06-02 22:34:05 -04:00
Dominik Richter
ebd1d36600 support local npm package searches (#3105)
Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
2018-06-01 10:52:46 +02:00
Noel Georgi
317a6d1953 Adding YAML reporter (#3081)
* Adding YAML reporter
* Updating yaml o/p
* Removing comment
* Adding UT for YAML reporter, adding missing reporters
* This PR takes care of the following:
 - Fixes the YAML reporter UT
 - Adds the report method to YAML reporter to support code example as in #3085
 - Disables the cyclomatic complexity Metric for reporter

Signed-off-by: Noel Georgi <18496730+frezbo@users.noreply.github.com>
2018-05-31 13:42:09 -04:00
Jared Quick
03e87cd89d
Bup the release to test new gem builds (#3071)
Signed-off-by: Jared Quick <jquick@chef.io>
2018-05-17 20:05:04 -04:00
Miah Johnson
e2fe18028d true should not be a string. (#3043)
Fixes https://github.com/chef/inspec/issues/2786

Signed-off-by: Miah Johnson <miah@chia-pet.org>
2018-05-16 08:53:37 -04:00
Miah Johnson
988eb9749b AWS resource permission docs (#3036)
* Add documentation about required IAM permissions to AWS Resources.
* Change phrasing.

Signed-off-by: Miah Johnson <miah@chia-pet.org>
2018-05-10 14:57:53 -04:00
Clinton Wolfe
af72574b34 Skeletal aws_ec2_instances resource (#3023)
* Add integration and unit tests for aws_ec2_instances
* Basic docs for aws_ec2_instances
* Add basic aws_ec2_instances resource

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-05-10 14:54:33 -04:00
Jeremy
1407e681fc #2810 - Add check if aws s3 bucket is encrypted. (#2937)
* Add check if aws s3 bucket is encrypted.
Required terraform aws provider >= 1.6
Fix indentation issue in aws_s3_bucket.rb

* Implement most changes recommended by @TrevorBramble, and refactored other methods to align with recommendations (except Terraform nitpick; preference is to keep coding style consistent until full refactor).

Signed-off-by: Jeremy Phillips <github@uranusbytes.com>
2018-05-03 09:55:29 -04:00
Noel Georgi
ffbd6cbfb2 Fixing wrong filesystem size type (#3013)
Signed-off-by: Noel Georgi <noel.georgi@reancloud.com>
2018-05-03 09:16:07 -04:00
Clinton Wolfe
1a00853cd8
Catch exceptions in control blocks and fail the control (#2987)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-04-26 15:44:16 -04:00
Omar J. Irizarry
2495fd8196 extend os_env resource to select between Machine and User vars on Windows (#2945)
Signed-off-by: Omar J Irizarry <irizarry_omar_j@network.lilly.com>
2018-04-26 15:10:14 -04:00
Clinton Wolfe
8934352935 Make names for AWS Config service objects optional (#2928)
* Update tests and docs to assume one recorder per region
* Config recorder supports singleton fetch
* Docs and tests for singleton mode delivery_channel
* Implementation for singleton delivery channel, and some other code cleanup
* Implement some feedback, and fix a bug in traversing the struct in looking for empty results

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-04-19 13:08:16 -04:00
Axel Kummer
923f5a9e56 Update Resource documentation for Users Resource (#2954)
The `shell` matcher have to be `shells` and expects an array.
Wrong:
`its('shell') { should eq "/sbin/nologin" }`

Got error:
```
     ×  Users with username =~ /stockservice-.*/ shell
     undefined method 'shell' for Users with username =~ /stockservice-.*/:#<Class:0x000055c2471fa900>
     Did you mean?  shells
```

Correct:
its('shells') { should eq ["/sbin/nologin"] }

I think it's an documentation mistake.
-----------------------------------------
$ inspec --version
2.1.43

Signed-off-by: Axel Kummer <axel.kummer@netresearch.de>
2018-04-19 13:06:20 -04:00
Andrii Melekhovskiy
180482d0a7 Fix docs: 404 in URLs for docker resourse (#2974)
Signed-off-by: morkot <melekhovskiy@gmail.com>
2018-04-19 11:02:22 -04:00
Clinton Wolfe
73b7b6942c
Inline and attached policies for aws_iam_user and aws_iam_users (#2947)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-04-17 13:22:28 -04:00
Clinton Wolfe
745ff32c80 Basic fields for aws_vpcs (#2930)
* Update singular implementation to avoid use of inner object
* Update docs and tests for 3 new filters and properties on aws_vpcs
* Implement new filters and properties; one failing test due to odd FilterTable behavior
* changes to avoid bug 2929

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-04-12 15:48:55 -04:00
Bj Maldonado
eff4de6784 Fixed Docs asking for instead of (#2933)
Signed-off-by: Bj Maldonado <bj@maldonado.io>
2018-04-12 15:26:32 -04:00
Clinton Wolfe
7130a77c06
Policy Statement Search capability for aws_iam_policy (#2918)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-04-12 14:31:02 -04:00
Clinton Wolfe
ceec3fc66c Document the inspec_version metadata field (#2949)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-04-12 13:32:48 -04:00
Clinton Wolfe
9dee334706 Change its to it in aws root user docs (#2927)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-04-09 13:40:11 -04:00
borgified
cdccad1de4 typo (#2919)
Signed-off-by: borgified <borgified@gmail.com>
2018-04-06 17:10:13 -04:00
Clinton Wolfe
4200fdd779 AWS Security Group Rules properties and matchers (#2876)
Provides low-, and mid-level properties and matchers for examining rules on aws_security_group.

* Second draft of docs for SG rules interface; need to clarify semantics of reject
* First cut at unit tests
* Cleanup test fixtures
* Implementation for allow, with plausible unit tests
* Doc updates based on reality
* Add integration tests; move allow to allow_ / out; several docs updates
* Add be_open_to_the_world and be_open_to_the_world_on_port
* Update docs to reflect adding allow_only
* Update docs to reflect use of position to allow multiple rules with 'only'
* Implement allow_only with unit tests; still need integration tests
* Add integration tests for allow_only

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-04-06 14:22:25 -04:00
Matthew Dromazos
b5a0007851 aws_cloudtrail_trail feature: test how many days ago logs were delivered (#2887)
* * Adds new property to test how many days ago the CloudTrail delivered logs to the CloudWatch Logs.

* * Changes query for selected cloud trail in unit test
* Changes uses Time.now explicitly instead of making a variable in the unit test

Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
2018-04-06 14:04:57 -04:00
Matthew Dromazos
74076bc44a aws_iam_group feature: test users in an iam group (#2888)
* Adds new property to test the users in an aws_iam_group
* Adds terraform code to add the recall_hit user to the administrator group

Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
2018-04-06 14:04:13 -04:00
Gary
1677be6d42 Amended Syntax to correct formatting (#2911) 2018-04-06 09:14:41 -04:00
Matthew Dromazos
c04a98c9f8 New Skeletal Resource aws_route_tables (#2643)
* Initial commit of skeletal resource aws_route_tables
* Fixes issues with documentation
* Renames route table terraform resources to be more conventional
* Removes tags terraform resources
* Changes aws_route_table and aws_route_tables integration tests to use new terraform names
* Removes unneeded data given in unit tests

Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
2018-04-05 12:51:22 -04:00
Matthew Dromazos
0df67fc7d0 New Skeletal Resource aws_s3_buckets (#2653)
* Initial commit of skeletal resource aws_s3_buckets
* Add fixes to documents
* Removes property 'creation_date' for there is no use case as of right now
* Rebases on master and moves aws_s3_buckets integration test to the correct location
* Adds test on unit test for false exists

Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
2018-04-05 12:49:30 -04:00
David Alexander
3b97e16b97 New Resource: Chocolatey Package (#2793)
* Adds chocolatey package resource
* Adds docs for chocolatey_package resource
* Differentiate chocolatey package from windows feature

Suggested by @frezbo

Signed-off-by: David Alexander <opensource@thelonelyghost.com>
2018-04-05 08:54:27 -04:00
Jerry Aldrich
4731d95abd docs: Update example resource (#2904)
* Change `skip_resource` to use raise
* Add `supports` lines to example resource
* Change to rescue `StandardError` vs `Exception`
* Change raise to use `e.message` vs `$!`
* Remove redundant returns
* Change `File.exists?` to `File.exist?`
* Update shasum in tests

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-04-05 08:50:49 -04:00
Clinton Wolfe
fe591417f3 Wrong matcher name in example for aws_config_recorder (#2899)
* Wrong matcher name in example
* Remove spurious slash

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-04-03 09:17:50 -04:00
Paul Welch
27203110cd Add AWS hardware MFA matcher (#2892)
* Add AWS hardware MFA matcher
Adding a hardware as well as a virtual MFA matcher for aws_iam_root_user
resource

* Add New AWS Root Matcher Docs
- Add documentation for new root MFA matchers
- Fix logic for checking MFA devices from feedback on PR

* Add Integration tests for MFA matchers
- Add integration tests for virtual and hardware MFA matchers
- Clean up logic for has_virtual_mfa_enabled? method

Signed-off-by: Paul Welch <pwelch@chef.io>
2018-04-03 09:13:52 -04:00
Franklin Webber
6665555a73 Fixes the two incorrect examples in the YAML doc (#2875)
Signed-off-by: Franklin Webber <franklin@chef.io>
2018-03-28 13:20:56 -04:00
Mo Shark
fc3f1708c4 Porting over the singular rds resource from the aws-inspec git repo (#2866)
Signed-off-by: HackerShark <melsharkawi@mitre.org>
2018-03-28 11:23:44 -04:00
Nathan Haneysmith
002a589871 fix logic in examples for password used (#2874)
Signed-off-by: Nathan Haneysmith <nathan@chef.io>
2018-03-26 15:42:56 -04:00
Matthew Dromazos
0cbe5b60e5 New Skeletal Resource aws_config_delivery_channel (#2641)
* Initial commit of new skeletal resource aws_config_delivery_channel
* Changes delivery_frequency to be an integer and names delivery_frequency_in_hours
* Adds more documentation and clarifies descriptions
* Wraps API call in the aws_catch_errors function
* Changes config bucket name to use dashes instead of underscores
* Updates on master and changes directory location of build and integration files
* Fix integration tests to only create one ConfigRecorder

Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
2018-03-26 14:03:23 -04:00
Matthew Dromazos
603bef6f29 New Skeletal Resource aws_kms_key (#2746)
* Initial commit of skeletal resource aws_kms_key
* * Adds comments to rerun travis
* * Clarifies some parts of the doc.
* Changes matcher have_aws_key_manager to manged_by_aws
* Fixes copypasta
* Adds clarification to property names
* Fixes rescueing exceptions from the api
* raises exceptions in the unit tests

Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
2018-03-23 08:29:45 -04:00
Matthew Dromazos
9077a7b17b New Skeletal Resource aws_sns_subscription (#2697)
* Initial commit of skeletal resource aws_sns_subscription
* Fixes errors in documentation
* Clarifies documentation
* Wraps calls to aws api in catch_aws_errors metho
* Fixes integration tests

Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
2018-03-22 13:38:40 -04:00
Matthew Dromazos
1bb565c708 New Skeletal Resource aws_sns_topics (#2696)
* Initial commit of skeletal resource aws_sns_topics
* Adds clarification in documentation
* Adds functionality for calling the next token returned from aws api.
* Wraps api calls in the catch_aws_errs method

Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
2018-03-22 12:55:23 -04:00
David Alexander
9629bf6f73 Documentation: supports attribute of custom resource DSL (#2824)
* Documents `supports` attribute of custom resource DSL
* Uses html definition list for definitions
* Reverts <dl> changes to pure markdown again

Signed-off-by: David Alexander <opensource@thelonelyghost.com>
2018-03-22 08:47:31 -04:00
Paul Welch
a32a85eae5 Remove incorrect example from documentation (#2851)
Owner and mode are provided by the file resource, not ssh_config.

Fixes #2471

Co-authored-by: Trevor Bramble tbramble@chef.io
Co-authored-by: Paul Welch pwelch@chef.io

Signed-off-by: Paul Welch <pwelch@chef.io>
2018-03-21 12:52:51 -04:00
Franklin Webber
87a28b56bb The resource is login_defs not login_def (#2845)
The main index is displaying the wrong resource name. The url to the resource
is not correct either. This should generate the correct entry and path in the
docs.

Signed-off-by: Franklin Webber <franklin@chef.io>
2018-03-20 13:01:34 -04:00
eramoto
a687479e6c Fix typo in some docs (#2841)
Also includes fixes such as PostgreSQL, TCPMUX, and etc.

Signed-off-by: ERAMOTO Masaya <eramoto.masaya@jp.fujitsu.com>
2018-03-20 08:43:30 -04:00
Matthew Dromazos
555de72912 Skelatal resource: aws_s3_bucket_object (#2620)
* Initial commit of new resource
* Makes changes to docs to match changes to the resources.
* Adds clarifications in docs and changes it to be an erb file.
* Simplifies some unit tests
* Wraps calls to the api in a aws_catch_errors method
* Removes provisioner terraform code

Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
2018-03-19 13:10:17 -04:00
Paul Welch
03edd0cd2b Add Info about nginx_conf param (#2831)
Add information about setting the path to the NGINX server configuration
file if it is not in the default path.

Signed-off-by: Paul Welch <pwelch@chef.io>
2018-03-19 12:52:44 -04:00
David Alexander
afb931c4da Fixes ' not allowed to be nested in a single-quoted string (#2816)
Obvious fix, but just in case...

Signed-off-by: David Alexander <opensource@thelonelyghost.com>
2018-03-14 11:21:49 -04:00
Thomas Petchel
a48aea53c5 Add additional links to Learn Chef Rally content (#2477)
* Fix under construction page
Previously, the content was hidden behind the banner. The buttons also
did not contain horizontal spacing.

* Add links to Learn Chef Rally content.
I also corrected a few caplitalization issues and edited a few sentences for clarity.

* ssh => SSH
* Update Slack URL
Was pointing to Habitat by mistake.

Signed-off-by: Thomas Petchel <tpetchel@gmail.com>
2018-03-14 11:01:12 -04:00
Franklin Webber
bb538bfb5c Updates the os resource to use dot notation for family (#2807)
The dot notation is supported for family on the os resource. That is
by far easier to type out and use.

Also fixes that the platform names returned are Strings and not Symbols.

Signed-off-by: Franklin Webber <franklin@chef.io>
2018-03-12 13:02:48 -04:00
Clinton Wolfe
7d8dbe496d Docs: Describe support boundary between RSpec and InSpec (#2753)
* Describe boundary between RSpec and InSpec
2018-03-08 20:22:34 -08:00
Miah Johnson
75f39e74f2 Refine deprecated methods to be consisten with supported fields in (#2801)
shadow file.

After much thought the deprecations from #2642 were for the wrong methods.

Plural method names feel much more natural when working with this
resource because you can have more than a single result.

Consider a match like `shadow.user(/^www/)`, this could return multiple
users, so `shadow.users` feels more natural here.

The problem is that the fields we're matching in the shadow file itself
are singular. Each entry is for a user, which has a password, and some
other fields. A user never has `passwords` in the shadow file, only a
`password`.

This is made more obvious when you use the `filter` method.

When we use this filter: `shadow.filter(min_days: 20, max_days: 30)` we
are matching fields in the shadow file and not using our matcher
methods. This means that if there is a discrepancy between our matcher
methods, and the shadow fields the user could end up confused. Like I did =)

This PR changes:

Changed matchers to match shadow fields.
Updated documentation to reflect changes.
Updated tests to reflect changes.
Re-add `filter` method, and add a test for it.
Renamed variable for FilterTable to be less confusing.
Renamed query argument for methods to be consistent.
Cleanup docs based on comments from @jerryaldrichiii
Make Rubocop happy <3

Signed-off-by: Miah Johnson <miah@chia-pet.org>
2018-03-08 17:26:08 -05:00
Miah Johnson
f6db0e345a Update shadow resource to use FilterTable (#2642)
* Change shadow resource to use FilterTable rather than custom filter
implementation.

Add tests for singluar aliased methods and other minor changes to work
with FilterTable output.
Coverage is at 100%

Signed-off-by: Miah Johnson <miah@chia-pet.org>

* merge master

Signed-off-by: Miah Johnson <miah@chia-pet.org>
2018-03-07 15:31:30 +01:00
Louis Willcock
cd7f84f5e7 update docs to non-deprecated parameter syntax from name > username as per dep warnings (#2781)
Signed-off-by: JohnVonNeumann <louiswillcock@gmail.com>
2018-03-06 13:16:01 -05:00
Franklin Webber
c2f3dd4c61 Fixes docs for file example (#2552)
* Fixes docs for file example

* The version test should be a string
* There was a missing closing brace in the regex examples
* Some white-spaced got cleaned up
* I added the file name into the variable for the pg examples

Signed-off-by: Franklin Webber <franklin@chef.io>

* Updates docs file to use real postgre path

Signed-off-by: Franklin Webber <franklin@chef.io>

* Moves the 'real' example filepath to the describe

Signed-off-by: Franklin Webber <franklin@chef.io>
2018-03-06 19:00:26 +01:00
Nicholas Duffy
0853e12cc3 Fix AWS IAM access keys example (#2756)
There is no `created_age`. This should
be `created_days_ago`.

Signed-off-by: Nicholas Duffy <duffn@outlook.com>
2018-03-05 16:05:10 -05:00
Kimberly Garmoe
fbe2035a97 Corrects capitalization (#2764)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-03-05 09:07:06 -05:00
Kimberly Garmoe
77ee77c557 Removes errant articles (#2775)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-03-02 22:53:01 -05:00
Aleksey Tsalolikhin
50e952701d Add cautionary note to include leading zero in file mode specifications (#2606)
Signed-off-by: Aleksey Tsalolikhin <aleksey@verticalsysadmin.com>
2018-03-02 13:47:46 -05:00
Kimberly Garmoe
01357e1e29 Kg/az fix (#2763)
* Fixes typo
* Remove unclear phrase

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-03-02 09:18:01 -05:00
Kimberly Garmoe
d02ae42747 fixes ec2 reference (#2766)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-03-02 09:06:11 -05:00
Kimberly Garmoe
24d5a9832e Updates language for Resource Packs (#2449)
* Updates language for Resource Packs

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-03-01 11:32:55 -05:00
Clinton Wolfe
154ab8b05d Docs: Clarify Matchers page to speak about Universal matchers (#2754)
* Distinguish between universal and specialized matchers
* Make the table of contents clickable
* Add note about RSpec matchers, possibly regrettable

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
Signed-off-by: kgarmoe <kgarmoe@chef.io>
2018-03-01 09:20:20 -05:00
Kimberly Garmoe
f4ea53c3a5 Kg/k module (#2626)
* Refactors kernel_module

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-28 17:12:37 -05:00
Kimberly Garmoe
f7d7f63b02 WIP: Docker resource docs first commit (#2521)
* Docker resource docs
Signed-off-by: kgarmoe <kgarmoe@chef.io>
2018-02-28 16:44:11 -05:00
Matthew Dromazos
4394c5efc8 New Resource aws_config_recorder (#2635)
* Initial commit of new resource
* Removes deprecated matcher in example
* Adds a new terraform file for config resources
* Fixes and clarifies documentation
* Wraps calls to api in catch_aws_errors method
* Changes the names of two matchers

Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
2018-02-27 13:15:04 -05:00
Kimberly Garmoe
118a056f43 Refactors host docs (#2539)
* Refactors host docs

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-26 19:21:32 -05:00
Kimberly Garmoe
a0db14485a Refactore json docs (#2551)
* Refactore json docs

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-26 17:48:35 -05:00
Kimberly Garmoe
2ed473dcbb Fixes dh_params doc (#2644)
* Fixes dh_params doc

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-26 17:47:36 -05:00
Franklin Webber
a359399fa0 Fixes partially indented blocks and unescaped underscores (#2731)
Moved 2 space examples 2 more spaces in. Don't be shy, show the world your code the way it was meant to be seen.

Underscores in markdown must be escaped otherwise the world goes crooked.

Signed-off-by: Franklin Webber <franklin@chef.io>
2018-02-26 11:11:06 -05:00
Jerry Aldrich
0240ab4f6e docs: Enhance http resource documentation (#2715)
* Simplify `http` resource example

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-02-23 16:49:22 -05:00
Kimberly Garmoe
bd7327b91c Spelling and punctuation check on Azure and AWS (#2657)
* Spelling and punctuation check

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-19 22:09:51 -05:00