mirror of
https://github.com/inspec/inspec
synced 2024-11-23 21:23:29 +00:00
f284962450
* Provisioner script to setup resource tests for setgid/setuid/sticky bit tests. This appears to be the correct mechanism per docker_run, but I don't see any other provisioner scripts, so I suspect there is a different Chef-internal mechanism at play here. Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com> * TDD Red for setgid/setuid/sticky File matchers Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com> * Add documentation for file resource sgid, sticky, and suid matchers Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com> * Add matchers to File for setgid, setuid, and sticky by aliasing existing predicates; TDD green Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com> * Rubocop prefers alias to alias_method. Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com> * Lint before pushing, of course Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com> * Correct spelling of setgid and setuid matchers in docs Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com> * Add be_setgid, be_setuid, be_sticky matcher integration tests for File. Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com> * Revert "Provisioner script to setup resource tests for setgid/setuid/sticky bit tests. This appears to be the correct mechanism per docker_run, but I don't see any other provisioner scripts, so I suspect there is a different Chef-internal mechanism at play here." This reverts commit |
||
|---|---|---|
| .. | ||
| resources | ||
| shared | ||
| .gitignore | ||
| dsl_inspec.md | ||
| dsl_resource.md | ||
| habitat.md | ||
| inspec_and_friends.md | ||
| matchers.md | ||
| migration.md | ||
| plugin_kitchen_inspec.md | ||
| profiles.md | ||
| README.md | ||
| ruby_usage.md | ||
| shell.md | ||
InSpec documentation
This is the home of the InSpec documentation. This documentation provides an introduction to this mechanism and shows how to write custom tests.
The goal of this folder is for any community member to clone these docs, make the changes, check if they are valid, and contribute to the project.
How to build docs
We build docs by:
- Auto-generating docs from code
- Transforming markdown+snippets in this folder into pure markdown in
www/source/docs - Rendering them to the website via instructions in
www/
For development, you only need step 1!
1 Generate docs
To generate all docs run:
bundle exec rake docs
You can run tasks individually. For a list of tasks run:
bundle exec rake --tasks docs
Stability Index
Every available InSpec resource will indicate its stability. As InSpec matures, certain parts are more reliable than others. Brand new features are likely to be redesigned and marked as such.
The stability indices are as follows:
Stability: Deprecated- This features will be removed in future versions, because its known for being problematic. Do not rely on it.Stability: Experimental- New features may change or are removed in future versionsStability: Stable- API is well established and proofed. Maintaining compatibility is a high priorityStability: Locked- Only security and performance fixes are allowed