Commit graph

576 commits

Author SHA1 Message Date
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
Kimberly Garmoe
b6c60d11bb Normalizes resource (#2704)
* Normalizes resource

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-19 21:35:14 -05:00
Kimberly Garmoe
77ad71dc8b Refactors azure_virtual_machine doc (#2702)
* Refactors azure_virtual_machine doc

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-19 21:30:04 -05:00
Kimberly Garmoe
696dde39ef Refactors azure_virtual_machine_data_disk doc (#2701)
* Refactors azure_virtual_machine_data_disk doc

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-19 21:12:53 -05:00
Kimberly Garmoe
6bde79a39d Fixes formatting and words (#2703)
* Fixes formatting and words

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-19 20:54:42 -05:00
Kimberly Garmoe
6ffe2913d6 edits to platforms doc (#2695)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-19 23:29:19 +01:00
Kimberly Garmoe
9a7b9ccec0 Refactoring of azure generic resources doc (#2690)
* Refactoring of azure generic resources doc

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-19 08:43:12 -05:00
Kimberly Garmoe
4e71604ef5 Refactors the azure_resource_group doc (#2692)
* Refactors the azure_resource_group doc

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-19 08:42:52 -05:00
Christoph Hartmann
4641978716 Update InSpec website (#2681)
* New styles

* Fundamental styles for home page

* Legal pages

* Community page, downloads page, tutorials page

* Docs page

* Content toggle and github badge

* Add code - highlighter

* Copy button

* Sliding content animation

* fix particle animatino on downloads page

* Scroll-to-top button

* docs sidebar links

* innocent comments on resources

* Fancy code animation

* Small update to diamond

* whatever slider

* Slider styles

* initial selection if no sliders are there

* add netifly config

Signed-off-by: Christoph Hartmann <chris@lollyrock.com>

* inspec for provisioners

* fix incorrect text on aws ssm

* fix layout javascript

post-rebase

* resource grouping in docs

* introduce groups in docs/resources

* fix minor spelling issues and move download button in new features section

Signed-off-by: Christoph Hartmann <chris@lollyrock.com>

* pass linting

Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
2018-02-17 07:44:42 -08:00
Kimberly Garmoe
d76ae9eae7 Fixes merge conflict messages (#2677)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-16 19:39:41 -05:00
Jerry Aldrich
da5fe8d7a4 Add Release: to AWS inspec detect example (#2672)
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-02-16 16:47:16 -05:00
Kimberly Garmoe
b0bcc35fda Add one comma in all docs & deletes two repeated sentences. (#2658)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-15 22:07:18 -05:00
Miah Johnson
75fb488d2c Add example properties from azure integration tests. (#2659)
Remove trailing whitespace.
Clean up formatting and some rubocop issues.

Signed-off-by: Miah Johnson <miah@chia-pet.org>
2018-02-15 21:52:54 -05:00
Kimberly Garmoe
1e3df9d3bf Fixes obvious formatting (#2648)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-15 21:34:11 -05:00
Jerry Aldrich
947efd4064 Add platform tags and remove trailing whitespace (#2654)
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-02-15 19:28:15 -05:00
Jared Quick
0837b1fb0d
Merge pull request #2650 from chef/kg/remove-os
removes OS metadata from headers
2018-02-15 17:06:27 -05:00
Jared Quick
fc990346f2
Merge pull request #2655 from chef/release-2.0
Add in release-2.0 changes to master
2018-02-15 16:57:25 -05:00
Jared Quick
3623454153 Remove ruby headers from azure docs.
Signed-off-by: Jared Quick <jquick@chef.io>
2018-02-15 13:24:21 -05:00
kagarmoe
dc0d2727bc removes OS metadata from headers
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-15 09:54:17 -08:00
Kimberly Garmoe
a966cbd2b5 Formatting on XML resource (#2647)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-15 09:33:56 -05:00
Kimberly Garmoe
1218949d86 Normalizes terms accross resources (#2649)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-15 09:33:22 -05:00
kagarmoe
d63d15c457 Fixes formatting on aws/azure resources
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-14 20:33:18 -08:00
kagarmoe
b9162f5c1b Escapes and formatting 2018-02-14 20:33:18 -08:00
Clinton Wolfe
58629faf46
Document the terminology changeup for Azure creds (#2640)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-02-14 18:52:36 -05:00
kagarmoe
11d46622cc Changes aws docs extensions to .md.erb
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-14 13:29:27 -08:00
Clinton Wolfe
6c0422fbf0
Improvements and matcher renaming on aws_iam_password_policy (#2638)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-02-14 15:59:57 -05:00
Clinton Wolfe
33787124a7 Two deprecations in aws_ec2_instance (#2637)
* Drop deprecation warning for old name of aws_ec2

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-02-14 15:08:34 -05:00
Clinton Wolfe
4f341acfbc
Catch cloud exceptions and document connection info (#2636)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-02-14 14:15:20 -05:00
Jared Quick
f32c712a4c Merge branch 'master' into release-2.0 2018-02-14 09:36:44 -05:00
kagarmoe
c741e51484 AWS resource edits
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-13 17:44:01 -08:00
kagarmoe
86652992b0 AWS resource edits
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-13 17:44:01 -08:00
Jared Quick
686b028886 Add reporters reference page (#2617)
* Add reporters reference page.

Signed-off-by: Jared Quick <jquick@chef.io>

* Cleanup reporters page with suggestions.

Signed-off-by: Jared Quick <jquick@chef.io>

* Reorder reporters.

Signed-off-by: Jared Quick <jquick@chef.io>
2018-02-13 21:27:42 +01:00
Jared Quick
fde895f74a Merge branch 'master' into release-2.0 2018-02-13 15:11:53 -05:00
Jerry Aldrich
9ebd807ea4 http resource: Make remote worker the default (#2520)
* http resource: Make remote worker the default

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-02-13 12:42:16 -05:00
Franklin Webber
8f8ae290b4 Fixes the docs content for the user resource (#2553)
* Removed additional ending brackets } in a few cases
* Removed the belong_to_group
* Cleans white space and addressed a little formatting

Signed-off-by: Franklin Webber <franklin@chef.io>
2018-02-13 12:40:58 -05:00
Kimberly Garmoe
925c5bca8e Refactors kernel_parameter resource (#2625)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-13 12:37:30 -05:00
Kimberly Garmoe
e5cacc3105 Refactors key_rsa resource (#2627)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-13 12:35:14 -05:00
Kimberly Garmoe
78f51f8d9c Refactors limits_conf resource (#2629)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-13 12:34:51 -05:00
Kimberly Garmoe
2a52537196 Refactors the login_def resource (#2630)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-13 12:34:36 -05:00
Clinton Wolfe
2708a73e11 Merge branch 'aws-core-onramp' into aws-merge 2018-02-09 00:56:28 -05:00
Clinton Wolfe
d696c8b83f Merge branch 'cw/rename-resources' into core-onramp 2018-02-08 17:00:49 -05:00
Kimberly Garmoe
07e3e9fbdc Refactors grub_conf doc sligtly; adds os metadata (#2537)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-08 22:45:42 +01:00
Kimberly Garmoe
44abd94991 Kg/interface (#2550)
* Refactors interface docs

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes formatting

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-08 22:43:50 +01:00
Kimberly Garmoe
bd73b69c9e Refactors ini docs (#2544)
* Refactors ini docs

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes formatting

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes formatting

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-08 22:43:21 +01:00
Kimberly Garmoe
3f0642eef1 Refactors inetd_conf doc (#2543)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-08 22:42:51 +01:00
Kimberly Garmoe
f1b78c65d5 Refactors iis_site doc (#2542)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-08 22:42:12 +01:00
Kimberly Garmoe
a114a3015e Refactors iis_app docs (#2541)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-08 22:41:41 +01:00
Kimberly Garmoe
c7b9c56a34 Refactors http doc (#2540)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-08 22:41:14 +01:00
Clinton Wolfe
dfc73a52f0 Merge branch 'release-2.0' into aws-merge-release-merge-try
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-02-08 10:44:11 -05:00
Clinton Wolfe
6aaab8691c Merge branch 'aws-merge-prep' into aws-merge
Includes train aws:// targeting and some new resources

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-02-08 10:09:57 -05:00
Jared Quick
9bc0a5a32f Merge branch 'master' into release-2.0 2018-02-08 09:48:23 -05:00
Jerry Aldrich
84817366a1 Remove deprecations for InSpec 2.0 (#2506)
* Add `release-2.0` target branch to AppVeyor/Travis (#2510)

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>

* simpleconfig: Remove deprecated config keys

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>

* cli (exec): Remove `--cache` command line argument

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>

* platform: Remove lowercase os name protection

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>

* matcher: Remove `contain_legacy_plus` matcher

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>

* matcher: Remove `contain_match` matcher

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>

* matcher: Remove `with_version` matcher

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>

* matcher: Remove `belong_to_group` matcher

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>

* matcher: Remove `belong_to_primary_group` matcher

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>

* matcher: Remove `contain` matcher

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>

* passwd: Remove deprecated properties

This removes:
  - `passwd.count`
  - `passwd.username`
  - `passwd.usernames`
  - `passwd.uid`

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>

* auditd_rules: Remove in favor of `auditd` resource

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>

* cli: Remove `login_automate` command

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>

* Remove `resource_skipped` message method

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-02-08 11:05:21 +01:00
Christoph Hartmann
b40876715f
Merge pull request #2536 from chef/jq/merge_inspec_azure
Merge inspec-azure into inspec core
2018-02-08 10:57:05 +01:00
Kimberly Garmoe
f32bcdb74d Adds glossary.md file (#2450)
* Adds glossary.md file

Signed-off-by: kgarmoe <kgarmoe@chef.io>

* Adds glossary to sidebar and updates page formatting

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Changes glossary layout

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Replaces errant tic

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Requested changes

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Clarifies filter clause

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-08 10:00:51 +01:00
Clinton Wolfe
a0b6bac87b
Use train for AWS connection (#219)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-02-07 23:26:37 -05:00
Clinton Wolfe
4e07508317 Rename classes and resource names in files
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-02-07 23:23:05 -05:00
Clinton Wolfe
162335aa60 Move files for rename
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-02-07 22:56:45 -05:00
Clinton Wolfe
4d8eb48855
Skeletal aws_vpc_subnets resource (#228)
Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-02-07 20:12:02 -05:00
Miah Johnson
046b2ef419 Skeletal Resource: aws_route_table (#217)
Signed-off-by: Miah Johnson <miah@chia-pet.org>
2018-02-07 10:48:55 -05:00
Kimberly Garmoe
f4d08fbb40 Refactors crontab docs & adds 'property examples' (#2513)
* Refactors crontab docs & adds 'property examples'

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* adds note about crontab-supported time strings

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-07 16:11:28 +01:00
Matthew Dromazos
16fee68c88 Skeletal Resource: aws_vpc_subnet (#209)
Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
2018-02-07 10:03:11 -05:00
Clinton Wolfe
f7a11ee2df Merge branch 'aws-merge-prep' into aws-merge
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-02-07 09:53:21 -05:00
Kimberly Garmoe
24120b9b26 Refactors dh_params resource and publishes (#2515)
* Refactors dh_params resource and publishes

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Adds dh_params resource

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes esc chars

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-07 15:35:04 +01:00
Kimberly Garmoe
4a203e647b Kg/csv (#2514)
* Refactors csv resource

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Copy edits

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Copy edit

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Clarifies property example

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-07 15:25:42 +01:00
Kimberly Garmoe
36dd93701f Kg/etc fstab (#2523)
* Refactors etc_fstab resource

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Edits to fstab

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Removes duplicate line

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes terminal punctuation

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes typo

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-07 15:24:49 +01:00
Kimberly Garmoe
7a47273f5f Refactors elasticsearch resource (#2522)
* Refactors elasticsearch resource

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes typo

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-07 15:23:53 +01:00
Kimberly Garmoe
16d4f71d2e Refactors the bond docs (#2504)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-07 15:17:59 +01:00
Kimberly Garmoe
ecf6900e9f Kg/file (#2529)
* Refactors file docs

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes terminal punctuation

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Adds deprecations and differentiates OS

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-07 14:29:30 +01:00
Kimberly Garmoe
f5acd5d34e Kg/filesystem (#2530)
* Refactores filesystem doc.

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Removes file

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-07 14:27:48 +01:00
Jared Quick
e0ab84b11a Merge branch 'jq/azure_merge' of /Users/jquick/Chef/inspec-azure into jq/merge_inspec_azure 2018-02-06 13:23:54 -05:00
Kimberly Garmoe
be2216a1b8 Kg/etc hosts (#2528)
* Refactors etc_hosts docs

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Copy edits

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes terminal punctuation

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-06 12:31:46 +01:00
Kimberly Garmoe
980a1329b2 Kg/gem (#2527)
* Refactors gem resource

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Terminal punctuation

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-06 12:31:11 +01:00
Kimberly Garmoe
1ce72eecd8 Refactors etc_hosts_allow docs (#2526)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-06 12:30:47 +01:00
Kimberly Garmoe
719783e2b2 Refactors etc_hosts_deny docs (#2525)
* Refactors etc_hosts_deny docs

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes terminal punctuation

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes typo

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes terminal punctuation

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-06 12:30:09 +01:00
Kimberly Garmoe
ee18b7ef89 Refactors etc_group docs (#2524)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-06 12:29:15 +01:00
Kimberly Garmoe
15d4564c3a Updates directory resource (#2516)
* Updates directory resource

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Updates syntax example

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-06 12:27:09 +01:00
Kimberly Garmoe
bc3c5039f3 Updates aide-conf docs (#2493)
* Updates aide-conf docs

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Removes 'matchers' language.

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Really resolves merge conflict

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-05 19:57:45 +01:00
Kimberly Garmoe
b33aecec0c Updates auditd_conf doc (#2497)
* Updates auditd_conf doc

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* resolves merge conflict

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Moves example

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-05 19:56:36 +01:00
Kimberly Garmoe
903ab396f0 Refactors docker_service docs (#2519)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-02 08:13:56 -05:00
Kimberly Garmoe
73f2eebea5 Refactors docker_image resource (#2518)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-02 08:13:04 -05:00
Kimberly Garmoe
288e9f2607 Refactors docker_container resource (#2517)
* Refactors docker_container resource

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Edits matchers to properties

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-02 08:10:47 -05:00
Kimberly Garmoe
3e7e806eba Updates cran resource doc (#2512)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-02 07:36:36 -05:00
Kimberly Garmoe
d3a2957766 Kg/cpan (#2511)
* Refactors cpan resource doc

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Copy edit

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-02 07:35:50 -05:00
Kimberly Garmoe
16325b8a9b Refactors the bridge property (#2505)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-01 17:45:33 -05:00
Kimberly Garmoe
c9a226c4ab Refactors 'bash' resource docs page (#2500)
* Refactors 'bash' resource docs page

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Changes 'exist' description

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-01 17:44:10 -05:00
Kimberly Garmoe
6ed7616ac9 Refactors bsd_service resource doc (#2507)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-01 17:43:16 -05:00
Kimberly Garmoe
66e25fab8d Refactors command resource (#2508)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-01 17:42:27 -05:00
Sam Cornwell
14efd94050 Skeletal aws_iam_group resource (#221)
Signed-off-by: Sam Cornwell <14048146+samcornwell@users.noreply.github.com>
2018-02-01 15:55:53 -05:00
Sam Cornwell
d722827ebd Skeletal aws_iam_groups resource (#208)
Signed-off-by: Sam Cornwell <14048146+samcornwell@users.noreply.github.com>
2018-02-01 13:09:48 -05:00
Rony Xavier
23b57ab591 Add have_access_logging_enabled matcher to aws_s3_bucket (#212)
Signed-off-by: Rony Xavier <rx294@nyu.edu>
2018-02-01 11:50:38 -05:00
Rony Xavier
7d53056751 Password usage properties for aws_iam_users (#213)
Signed-off-by: Rony Xavier <rx294@nyu.edu>
2018-02-01 11:23:25 -05:00
Clinton Wolfe
e2e9915aa4 Skeletal aws_kms_keys resource
Signed-off-by: Rony Xavier <rx294@nyu.edu>
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-02-01 10:21:54 -05:00
Kimberly Garmoe
010ca42b2d Changes 'matcher' to 'property' in examples (#2499)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-01 11:51:12 +01:00
Rony Xavier
6ae80ad6f7 skeletal aws_iam_ policies resource (#193)
Signed-off-by: Rony Xavier <rx294@nyu.edu>
2018-01-31 22:45:02 -05:00
Rony Xavier
1b170dcfb6 aws_iam_access_keys incorrectly populates created_date (#215)
Signed-off-by: Rony Xavier <rx294@nyu.edu>
2018-01-31 22:16:30 -05:00
Kimberly Garmoe
7dc72c7491 Edits to audit_policy resource language (#2498)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-01-31 07:24:57 -05:00
Kimberly Garmoe
b45b77cd13 Simplifies 'matchers' language in docs (#2496)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-01-31 07:24:16 -05:00
Adam Leff
689fe34cc9 apache resource: document and deprecate (#2494)
* Docs for apache resource

Signed-off-by: kgarmoe <kgarmoe@chef.io>

* Add deprecation warning to apache docs and resource, and clean up examples.

Signed-off-by: Adam Leff <adam@leff.co>

* Update apache_conf resource to remove dependency on apache resource

Signed-off-by: Adam Leff <adam@leff.co>

* Make conf_dir method public

Signed-off-by: Adam Leff <adam@leff.co>

* Removes unnecessary aide_conf commit, pulled in from e25f0a45

Signed-off-by: Adam Leff <adam@leff.co>

* Switch to Pathname to calculate conf_dir

Needed to avoid Windows adding `C:\` in unit tests when calling
File.expand_path.

Signed-off-by: Adam Leff <adam@leff.co>
2018-01-31 11:16:15 +01:00
Franklin Webber
2cc446a686 Doc fixes the apache_conf properties returns an array (#2479)
* Fixes the apache_conf Listen property returns an array

The result is an array and not a string even when there is one value.

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

* Updates the apache_conf timeout, allowoverride, and maxclients to include

It seems that all of these values are placed in an array of values so
the matcher needs to be `include`.

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

* Updates docs for apache_conf

* Uses the suggested `cmp` instead of `include`
* Adds the way to properly compare a list of multiple ports

Signed-off-by: Franklin Webber <franklin@chef.io>
2018-01-29 13:03:36 -05:00
Rony Xavier
f09d4f5266 aws_iam_policy resource (#184)
Signed-off-by: Rony Xavier <rx294@nyu.edu>
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-01-26 15:21:49 -05:00
Jerry Aldrich
d96a6affa7 packages resource: Add architectures support (#2469)
This adds support for `architectures` to the `packages` resource.

Example:

```
describe packages(/compat-libstdc++-33/) do
  its('architectures') { should include 'x86_64' }
  its('architectures') { should include 'i686' }
end
```

This also adds documentation for the `packages` resource

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-01-25 23:57:34 -08:00
Vern Burton
55abdebdc9 filesystem resource: inspect linux filesystems (#2441)
* adding df resource

Signed-off-by: Vern Burton <me@vernburton.com>

* adding unit tests and required mocks for them, created integration test

Signed-off-by: Vern Burton <me@vernburton.com>

* cleaning up skip test to include only the filename and not full path

Signed-off-by: Vern Burton <me@vernburton.com>

* adding docs

Signed-off-by: Vern Burton <me@vernburton.com>

* size makes more sense than space

Signed-off-by: Vern Burton <me@vernburton.com>

* removing unneeded author lines

Signed-off-by: Vern Burton <me@vernburton.com>

* as the command changed, changing mock to the new sha

Signed-off-by: Vern Burton <me@vernburton.com>

* updating to address comments from #2441

* removing author lines
* using attr_reader functions
* using ruby string functions rather than pipe to sed
* adding os family detection
* using ResourceFailed as the pattern already existed for OS family detection
* using if for future case support for unix and unix-like (FreeBSD)

Signed-off-by: Vern Burton <me@vernburton.com>

* adding supports to resource metadata, and adding tests that show that resource says that it is not supported on windows/unix.

Signed-off-by: Vern Burton <me@vernburton.com>

* focusing on linux os family and removing logic for assumed future cases

Signed-off-by: Vern Burton <me@vernburton.com>

* changing df to filesystem

Signed-off-by: Vern Burton <me@vernburton.com>
2018-01-25 09:29:31 -05:00
Matt Kulka
c067798fc5 Docker Swarm service resource (#2456)
This change adds the `docker_service` resource for Docker swarm mode services. This
branches off some of the common elements (id, exists) into a `DockerObject` module along
with a utility function for parsing the image/repo string. That function was implemented
separately by `docker_image` and `docker_container`, now with a third resource, it made
sense to consolidate that into an included module. I used the most comprehensive
implementation. Existing classes had to be slightly modified for the genericization.

Signed-off-by: Matt Kulka <mkulka@parchment.com>
2018-01-23 12:30:14 -08:00
Rony Xavier
0af7105eba Functional aws_cloudtrail_trail resource (#186)
Signed-off-by: Rony Xavier <rx294@nyu.edu>
2018-01-23 11:26:27 -05:00
Rony Xavier
3a786babcf Skeletal aws_cloudtrail_trails resource (#191)
Signed-off-by: Rony Xavier <rx294@nyu.edu>
2018-01-23 11:06:05 -05:00
Rony Xavier
86843320df Correct access_key detection on aws_iam_root_user (#198)
Signed-off-by: Rony Xavier <rx294@nyu.edu>
2018-01-23 11:01:51 -05:00
Markus Grobelin
dee94b6416 pip resource docs: mention custom path to pip as introduced by GH-2097 (#2459)
Signed-off-by: Markus Grobelin <grobi@koppzu.de>
2018-01-19 17:03:00 -05:00
Clinton Wolfe
5ab68ecf03
aws_s3_bucket with modified interface (#183)
Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
    Signed-off-by: Aaron Lippold <lippold@gmail.com>
    Signed-off-by: Sam Cornwell <14048146+samcornwell@users.noreply.github.com>
    Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-01-19 11:50:08 -05:00
Sam Cornwell
e81937413b skeletal aws_vpcs (#182)
Signed-off-by: Sam Cornwell <14048146+samcornwell@users.noreply.github.com>
2018-01-18 10:51:06 -05:00
djenniex-bene
2cfc0acaae SMTP example for the ini resource was incorrect and did not work (#2461)
* SMTP example for the ini resource was incorrect and did not work

Obvious fix.

* Fixed documentation and removed semicolons as the ini parser includes those semicolons

Obvious fix.
2018-01-17 11:41:33 -08:00
Vern Burton
175c3e1189 xml resource: support fetching attributes (#2423)
* adding database.xml with attributes to files and mocking it in the helper.rb

Signed-off-by: Vern Burton <me@vernburton.com>

* adding logic to test class returned by XPATH and using functions from respective classes to fill a array for return, and unit and integration tests to ensure functionality

Signed-off-by: Vern Burton <me@vernburton.com>

* updating docs to show how attributes are used

Signed-off-by: Vern Burton <me@vernburton.com>

* 'and' instead of 'or' makes more sense

Signed-off-by: Vern Burton <me@vernburton.com>

* adding default else for capturing unknown classes from REXML

Signed-off-by: Vern Burton <me@vernburton.com>

* removing extra newline

Signed-off-by: Vern Burton <me@vernburton.com>

* adding fail case with enough information to debug in future case

Signed-off-by: Vern Burton <me@vernburton.com>
2018-01-16 14:26:39 -08:00
Vern Burton
9b4a276e9f firewalld resource: prepend rule string only when necessary (#2430)
* adding control statement to add rule in front of string as long as it doesn't already contain rule.

Correcting resource name in firewalld from etc_hosts_deny

adding tests for both branches of the statement created in firewalld

Signed-off-by: Vern Burton <me@vernburton.com>

* moving to unless with a start_with

Signed-off-by: Vern Burton <me@vernburton.com>

* adding documentation that states that it is not needed to add `rule` string

Signed-off-by: Vern Burton <me@vernburton.com>
2018-01-16 14:20:58 -08:00
Sam Cornwell
3d731a81f8 aws_vpc resource skeleton (#172)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
Signed-off-by: Sam Cornwell <14048146+samcornwell@users.noreply.github.com>
2018-01-11 22:51:17 -08:00
Nathen Harvey
65589f8f78 Markdown titles sometimes need _s escaped (#2451)
When a header includes two `_`s, they must be escaped, otherwise, the
text between the two `_`s is rendered with emphasis.  E.g.,

`<h1 id="etchostsallow">etc<em>hosts</em>allow</h1>`

Escaping the `_`s fixes this and the header is rendered properly.

This is a fix for:

* etc_hosts_allow
* etc_hosts_deny
* postgres_hba_conf
* postgres_ident_conf

This change also adds the `h1` title to the windows_hotfix resource
page.

Signed-off-by: Nathen Harvey <nharvey@chef.io>
2018-01-08 13:09:13 -05:00
Dominik Richter
be9ece65b9 load local dependencies in inspec shell (#2438)
* add --depends to inspec shell

for loading dependencies from local folders. mainly used for development.

Signed-off-by: Dominik Richter <dominik.richter@gmail.com>

* lint

Signed-off-by: Dominik Richter <dominik.richter@gmail.com>

* depends is not defined...

Signed-off-by: Dominik Richter <dominik.richter@gmail.com>

* much nicer description for --depends

kudos @adamleff

Signed-off-by: Dominik Richter <dominik.richter@gmail.com>

* add documentation for inspec shell --depends

Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
2018-01-04 14:39:01 -05:00
Eammon Hanlon
f6c7bffe78 Add bonding mode matcher to bond resource (#2414)
* Add mode method to test the value of Bonding Mode

Signed-off-by: Eammon Hanlon <eammon.hanlon@microsoft.com>

* Add test for bonding mode in bond unit test

Signed-off-by: Eammon Hanlon <eammon.hanlon@microsoft.com>

* Add documentation on mode matcher for bond resource

Signed-off-by: Eammon Hanlon <eammon.hanlon@microsoft.com>

* Update example for 'Test parameters for bond0'

Signed-off-by: Eammon Hanlon <eammon.hanlon@microsoft.com>
2017-12-22 15:02:40 +01:00
Adam Leff
777c90e43a docs: fix XML resource example to use alternate syntax (#2395)
Signed-off-by: Adam Leff <adam@leff.co>
2017-12-22 14:56:18 +01:00
Jerry Aldrich
0178602d02 Correct .where usage in passwd documentation (#2419)
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2017-12-21 22:59:20 -05:00
Franklin Webber
1cd7e1a120 Updates the docs for mysql_session (#2392)
* Fixes usage of 'output' to 'stdout'
* Adds examples for 'exit_status' and 'stderr'
* Modifies the matchers section to point to the command resource

Signed-off-by: Franklin Webber <franklin@chef.io>
2017-12-21 17:06:39 -05:00
Aaron Lippold
9784520d83 fixed 'count' to 'entries.count' in aws_ec2_security_groups as per the docs (#142)
* * added 'count' to `aws_ec2_security_groups`

Fixes #141

Signed-off-by: Aaron Lippold <lippold@gmail.com>
2017-12-20 12:20:09 -05:00
Clinton Wolfe
e00ec2df5e
Add created_with_user filter criteria to aws_iam_access_keys
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2017-12-15 00:07:28 -05:00
Clinton Wolfe
a33146f9a4
Skeleton aws_ec2_security_group resource
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2017-12-14 09:28:29 -05:00
Clinton Wolfe
4229974e7d
Skeleton resource for aws_ec2_security_groups
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2017-12-13 22:36:23 -05:00
Clinton Wolfe
e5dc4a1c29
Add skeleton of aws_iam_role
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2017-12-13 22:34:52 -05:00
Russell Seymour
cdbe8c1016 Create azure_generic_resource
* Rewrite of Inspec Azure Resource pack to allow the testing of _any_ value Azure reosurce.
Closes #36
Closes #37

This fixes #56 so that it works with the latest version of the SDK. In fact it will only work to version >= 0.15

Signed-off-by: Russell Seymour <russell.seymour@turtlesystems.co.uk>
2017-12-12 13:20:22 -05:00
Adam Leff
470582a84e xml resource: update docs with alternate syntax for keys with periods (#2389)
Signed-off-by: Adam Leff <adam@leff.co>
2017-12-12 16:31:50 +01:00
Andy Boutte
ac5ca9b5bc Added missing quote and removed extra bracket (#2386)
Signed-off-by: Andy Boutte <andy.boutte@reancloud.com>
2017-12-11 15:07:54 -05:00
Jordan Craig
d928c76702 Fix incorrect case in paragraph. (#2363)
Incorrect case used in paragraph to describe interactive debugging with Pry.

Obvious fix.
2017-12-04 11:55:33 -05:00