diff --git a/README.md b/README.md index 9bac29ee0..ea50ad816 100644 --- a/README.md +++ b/README.md @@ -193,7 +193,7 @@ end ``` * Test your `kitchen.yml` file to verify that only Vagrant is configured as the driver. The %w() formatting will -pass rubocop lintng and allow you to access nested mappings. +pass rubocop linting and allow you to access nested mappings. ```ruby describe yaml('.kitchen.yml') do diff --git a/docs/dsl_inspec.md b/docs/dsl_inspec.md index b590194ce..4afadf9d7 100644 --- a/docs/dsl_inspec.md +++ b/docs/dsl_inspec.md @@ -100,7 +100,7 @@ control 'windows-account-102' do end ``` -## Are PosgtreSQL passwords empty? +## Are PostgreSQL passwords empty? The following test shows how to audit machines running PostgreSQL to ensure that passwords are not empty. diff --git a/docs/migration.md b/docs/migration.md index 1b06de7b8..c785d8bb5 100644 --- a/docs/migration.md +++ b/docs/migration.md @@ -256,7 +256,7 @@ end ## Are you supporting the `expect` syntax? -Of course. We still prefer the `should` syntax for UX reasons. We did surveys with various types of customers like devops engineers, auditors, managers. All participants who prefered the `expect` syntax have been Ruby experts. All non-Ruby developers found it easier to understand the `should` syntax. +Of course. We still prefer the `should` syntax for UX reasons. We did surveys with various types of customers like devops engineers, auditors, managers. All participants who preferred the `expect` syntax have been Ruby experts. All non-Ruby developers found it easier to understand the `should` syntax. ### `should` syntax with InSpec diff --git a/docs/reporters.md b/docs/reporters.md index 4b693fdde..ecd91b195 100644 --- a/docs/reporters.md +++ b/docs/reporters.md @@ -10,7 +10,7 @@ InSpec allows you to output your test results to one or more reporters. You can ## Syntax -You can specify one or more reporters using the `--reporter` cli flag. You can also specify a output by appending a path seperated by a colon. +You can specify one or more reporters using the `--reporter` cli flag. You can also specify a output by appending a path separated by a colon. Output json to screen. diff --git a/docs/resources/auditd.md.erb b/docs/resources/auditd.md.erb index bbd41bfff..925d65845 100644 --- a/docs/resources/auditd.md.erb +++ b/docs/resources/auditd.md.erb @@ -5,7 +5,7 @@ platform: linux # auditd -Use the `auditd` InSpec audit resource to test the rules for logging that exist on the system. The audit.rules file is typically located under /etc/audit/ and contains the list of rules that define what is captured in log files. These rules are output using the auditcl -l command. This resource supports versions of `audit` >= 2.3. +Use the `auditd` InSpec audit resource to test the rules for logging that exist on the system. The audit.rules file is typically located under /etc/audit/ and contains the list of rules that define what is captured in log files. These rules are output using the auditctl -l command. This resource supports versions of `audit` >= 2.3.
diff --git a/docs/resources/aws_sns_topic.md.erb b/docs/resources/aws_sns_topic.md.erb index 7cd5b879b..0605435a5 100644 --- a/docs/resources/aws_sns_topic.md.erb +++ b/docs/resources/aws_sns_topic.md.erb @@ -25,7 +25,7 @@ Use the `aws_sns_topic` InSpec audit resource to test properties of a single AWS ### ARN -This resource expects a single parameter that uniquely identifes the SNS Topic, an ARN. Amazon Resource Names for SNS topics have the format `arn:aws:sns:region:account-id:topicname`. AWS requires a fully-specified ARN for looking up an SNS topic. The account ID and region are required. Wildcards are not permitted. +This resource expects a single parameter that uniquely identifies the SNS Topic, an ARN. Amazon Resource Names for SNS topics have the format `arn:aws:sns:region:account-id:topicname`. AWS requires a fully-specified ARN for looking up an SNS topic. The account ID and region are required. Wildcards are not permitted. See also the [AWS documentation on ARNs](http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). diff --git a/docs/resources/aws_subnet.md.erb b/docs/resources/aws_subnet.md.erb index 09115545c..32437493a 100644 --- a/docs/resources/aws_subnet.md.erb +++ b/docs/resources/aws_subnet.md.erb @@ -41,7 +41,7 @@ A string identifying the subnet that the VPC contains. ## Properties -* `availavailability_zone`, `available_ip_address_count`, `cidr_block`, `subnet_id`, `vpc_id` +* `availability_zone`, `available_ip_address_count`, `cidr_block`, `subnet_id`, `vpc_id`
@@ -131,4 +131,4 @@ Provides the VPC ID for the subnet. describe aws_subnet(subnet_id: 'subnet-12345678') do it { should be_mapping_public_ip_on_launch } - end \ No newline at end of file + end diff --git a/docs/resources/aws_subnets.md.erb b/docs/resources/aws_subnets.md.erb index e501515c6..1f5531d1a 100644 --- a/docs/resources/aws_subnets.md.erb +++ b/docs/resources/aws_subnets.md.erb @@ -43,7 +43,7 @@ As this is the initial release of `aws_subnets`, its limited functionality precl A string identifying the VPC which may or may not contain subnets. - # Look for all subnts within a vpc. + # Look for all subnets within a vpc. describe aws_subnets.where( vpc_id: 'vpc-12345678') do its('subnet_ids') { should include 'subnet-12345678' } its('subnet_ids') { should include 'subnet-98765432' } diff --git a/docs/resources/azure_generic_resource.md.erb b/docs/resources/azure_generic_resource.md.erb index 554fe1b3b..f67631e3d 100644 --- a/docs/resources/azure_generic_resource.md.erb +++ b/docs/resources/azure_generic_resource.md.erb @@ -16,7 +16,7 @@ where * `MyResourceGroup` is the name of the resource group that contains the Azure Resource to be validated * `MyResource` is the name of the resource that needs to be checked -* `property` This generic resource dynamically creates the properties on the fly based on the type of resource that has been targetted. +* `property` This generic resource dynamically creates the properties on the fly based on the type of resource that has been targeted. * `value` is the expected output from the chosen property
@@ -168,4 +168,4 @@ This InSpec audit resource has the following special matchers. For a full list o Please see the integration tests for in depth examples of how this resource can be used. -[Inspec Integration Tests for Azure Generic Resources](https://github.com/chef/inspec/tree/master/test/azure/verify/controls) \ No newline at end of file +[Inspec Integration Tests for Azure Generic Resources](https://github.com/chef/inspec/tree/master/test/azure/verify/controls) diff --git a/docs/resources/azure_resource_group.md.erb b/docs/resources/azure_resource_group.md.erb index 9649912f8..f2ed28f7f 100644 --- a/docs/resources/azure_resource_group.md.erb +++ b/docs/resources/azure_resource_group.md.erb @@ -119,7 +119,7 @@ This takes the format: `/subscriptions//resourceGroups/ diff --git a/docs/resources/filesystem.md.erb b/docs/resources/filesystem.md.erb index 7cb139bf2..269092602 100644 --- a/docs/resources/filesystem.md.erb +++ b/docs/resources/filesystem.md.erb @@ -11,7 +11,7 @@ Use the `filesystem` InSpec resource to audit filesystem disk space usage. ## Syntax -A `filesystem` resource block declares tests for disk space in a partion: +A `filesystem` resource block declares tests for disk space in a partition: describe filesystem('/') do its('size') { should be >= 32000 } diff --git a/docs/resources/grub_conf.md.erb b/docs/resources/grub_conf.md.erb index 7d1b1ef5b..c953638bb 100644 --- a/docs/resources/grub_conf.md.erb +++ b/docs/resources/grub_conf.md.erb @@ -73,7 +73,7 @@ The following test verifies the kernel, ensures that kernel is the default kerne its('timeout') { should eq '10' } end -The following test verifies the `ramdisk_size` for the non-deault kernel: +The following test verifies the `ramdisk_size` for the non-default kernel: describe grub_conf('/etc/grub.conf', 'Red Hat Enterprise Linux ES (2.6.32-358.14.1.el6.x86_64)') do its('kernel') { should include 'ramdisk_size=400000' } diff --git a/docs/resources/package.md.erb b/docs/resources/package.md.erb index 014871360..a95d0d80c 100644 --- a/docs/resources/package.md.erb +++ b/docs/resources/package.md.erb @@ -113,7 +113,7 @@ The `version` matcher tests if the named package version is on the system: its('version') { should eq '1.2.3' } -You can also use the `cmp OPERATOR` matcher to perform comparisions using the version attribute: +You can also use the `cmp OPERATOR` matcher to perform comparisons using the version attribute: its('version') { should cmp >= '7.35.0-1ubuntu3.10' } diff --git a/docs/resources/processes.md.erb b/docs/resources/processes.md.erb index 7bcc55885..1c633ae04 100644 --- a/docs/resources/processes.md.erb +++ b/docs/resources/processes.md.erb @@ -34,7 +34,7 @@ The following examples show how to use this InSpec audit resource. its('list.length') { should eq 1 } end -### Test if the process is owned by a specifc user +### Test if the process is owned by a specific user describe processes('init') do its('users') { should eq ['root'] } diff --git a/docs/resources/registry_key.md.erb b/docs/resources/registry_key.md.erb index 858c2e3c7..3bdf96378 100644 --- a/docs/resources/registry_key.md.erb +++ b/docs/resources/registry_key.md.erb @@ -42,7 +42,7 @@ A Windows registry key can be used as a string in Ruby code, such as when a regi HKCU\SOFTWARE\Policies\Microsoft\Windows\CurrentVersion\Themes -may be encloused in a single-quoted string with a single backslash: +may be enclosed in a single-quoted string with a single backslash: 'HKCU\SOFTWARE\path\to\key\Themes' diff --git a/docs/resources/windows_task.md.erb b/docs/resources/windows_task.md.erb index 430731ab6..2f66ad67c 100644 --- a/docs/resources/windows_task.md.erb +++ b/docs/resources/windows_task.md.erb @@ -6,7 +6,7 @@ platform: windows # windows_task Use the `windows_task` InSpec audit resource to test a scheduled tasks configuration on a Windows platform. -Microsoft and application vendors use scheduled tasks to perform a variety of system maintaince tasks but system administrators can schedule their own. +Microsoft and application vendors use scheduled tasks to perform a variety of system maintenance tasks but system administrators can schedule their own.
diff --git a/docs/resources/xinetd_conf.md.erb b/docs/resources/xinetd_conf.md.erb index 7857962b2..4e52ad960 100644 --- a/docs/resources/xinetd_conf.md.erb +++ b/docs/resources/xinetd_conf.md.erb @@ -40,7 +40,7 @@ The network socket type: `dgram` (a datagram-based service), `raw` (a service th ### Test a service type -The type of service: `INTERNAL` (a service provided by xinetd), `RPC` (an RPC-based service), `TCPMUX` (a service that is started on a well-known TPCMUX port), or `UNLISTED` (a service that is not listed in a standard system file location). +The type of service: `INTERNAL` (a service provided by xinetd), `RPC` (an RPC-based service), `TCPMUX` (a service that is started on a well-known TCPMUX port), or `UNLISTED` (a service that is not listed in a standard system file location). describe xinetd_conf.services('service_name') do its('type') { should include 'RPC' } @@ -93,7 +93,7 @@ All three settings can be tested in the same block as well: For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). -### be_enabed +### be_enabled The `be_enabled` matcher tests if a service listed under `/etc/xinet.d` is enabled: diff --git a/docs/resources/yum.md.erb b/docs/resources/yum.md.erb index 2743026c6..d8a05d361 100644 --- a/docs/resources/yum.md.erb +++ b/docs/resources/yum.md.erb @@ -91,7 +91,7 @@ The `repos` matcher tests if a named repo, using either a full identifier (`'upd ### shortname -The `shortname` matcher names a specific package repository's group identifier. For example, if a repository's group name is "Directory Server", the corresponding group idenfier is typically "directory-server": +The `shortname` matcher names a specific package repository's group identifier. For example, if a repository's group name is "Directory Server", the corresponding group identifier is typically "directory-server": describe yum.repo('Directory Server') do its('shortname') { should eq 'directory-server' } diff --git a/examples/profile-sensitive/README.md b/examples/profile-sensitive/README.md index 7a4632d7c..d5d627e73 100644 --- a/examples/profile-sensitive/README.md +++ b/examples/profile-sensitive/README.md @@ -1,6 +1,6 @@ # Example InSpec Profile with Sensitive failures -This profile demostrates resources flagged as sensitive +This profile demonstrates resources flagged as sensitive ## Usage diff --git a/lib/bundles/inspec-compliance/README.md b/lib/bundles/inspec-compliance/README.md index cdab20c6d..8e761db82 100644 --- a/lib/bundles/inspec-compliance/README.md +++ b/lib/bundles/inspec-compliance/README.md @@ -14,7 +14,7 @@ To use the CLI, this InSpec add-on adds the following commands: * `$ inspec compliance upload path/to/local/profile` - uploads a local profile to Chef Automate/Chef Compliance * `$ inspec compliance logout` - logout of Chef Automate/Chef Compliance -Compliance profiles can be executed in two mays: +Compliance profiles can be executed in two ways: - via compliance exec: `inspec compliance exec profile` - via compliance scheme: `inspec exec compliance://profile` diff --git a/lib/bundles/inspec-supermarket/README.md b/lib/bundles/inspec-supermarket/README.md index 329fae843..2dc09fc32 100644 --- a/lib/bundles/inspec-supermarket/README.md +++ b/lib/bundles/inspec-supermarket/README.md @@ -6,7 +6,7 @@ To use the CLI, this InSpec add-on adds the following commands: * `$ inspec supermarket search` - searches for a compliance profile on supermarket * `$ inspec supermarket exec nathenharvey/tmp-compliance-profile` - extends execute to load the profile - Compliance profiles from Supermarket can be executed in two mays: + Compliance profiles from Supermarket can be executed in two ways: - via supermarket exec: `inspec supermarket exec nathenharvey/tmp-compliance-profile` - via supermarket scheme: `inspec exec supermarket://nathenharvey/tmp-compliance-profile`