inspec 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3f314957d073c6d9b4b319b99d73d9f382a7e4f
-  data.tar.gz: 661cb6f06494734459b528907a79bcd31c3bfd8b
+  metadata.gz: 796b3693c709761d312fc3dfab640ef38db11fd0
+  data.tar.gz: 16dc279d4819409321ceb5606b681ed8116b02ee
 SHA512:
-  metadata.gz: bf8d732cfb3d8459b5bf5d768bf295ac5f5c0e29f49f5c267b27fdb82b839fce9fbc24ede68b874736009382ff0f4243912ba570d02811af8c1b2b4ce16bd578
-  data.tar.gz: 444802539e79df6bad242d0604faa7da17c368fa46ff3153c560a71b47d3b2575240b67265a9b62848c423741f751cf831755dc45170db6da973c3d4daa22b3a
+  metadata.gz: ed72213ed8506323107724ea42f235349c28e0736ddfe8fbd2b31d62dd4580342b1f1799b8ab08111ef688572b125c157ec24b40c999505aa6ef276ca536de51
+  data.tar.gz: 1c75ca6acf92c2bab41f281baec8bb763ff3eba373424da026986bd345d101d84bf6fccf429e51815176e63ee62e683d909039376cd3f233b5ac251b57e88855

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 0.9.2
+
+* #219 bugfix: fix add_content to make `inspec shell` work again
+* #218 add version to resource declaration
+* #217 specify gemspec files directly (without git)
+* #216 update gemfile grouped dependencies
+* #214 fix legacy `should contain` in docs
+* #213 fix typos in readme
+* #212 add test-kitchen example to readme
+* #208 improved readme
+
 ## 0.8.0
 
 * #105 add to_s methods to resources, fixes #98

data/Gemfile

@@ -6,16 +6,16 @@ group :test do
   gem 'bundler', '~> 1.5'
   gem 'minitest', '~> 5.5'
   gem 'rake', '~> 10'
-  gem 'rubocop', '~> 0.33.0'
+  gem 'rubocop', '~> 0.32'
   gem 'simplecov', '~> 0.10'
   gem 'concurrent-ruby', '~> 0.9'
 end
 
 group :integration do
   gem 'berkshelf', '~> 4.0'
-  gem 'test-kitchen', git: 'https://github.com/chris-rock/test-kitchen', branch: 'test-path'
+  gem 'test-kitchen'
   gem 'kitchen-vagrant'
-  gem 'kitchen-inspec', git: 'git@github.com:chef/kitchen-inspec.git'
+  gem 'kitchen-inspec'
 end
 
 group :tools do

data/LICENSE

@@ -1,201 +1,14 @@
-                              Apache License
-                        Version 2.0, January 2004
-                     http://www.apache.org/licenses/
+Copyright (c) 2015 Chef Software Inc.
+Copyright (c) 2015 Vulcano Security GmbH.
 
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
 
-1. Definitions.
+       http://www.apache.org/licenses/LICENSE-2.0
 
-   "License" shall mean the terms and conditions for use, reproduction,
-   and distribution as defined by Sections 1 through 9 of this document.
-
-   "Licensor" shall mean the copyright owner or entity authorized by
-   the copyright owner that is granting the License.
-
-   "Legal Entity" shall mean the union of the acting entity and all
-   other entities that control, are controlled by, or are under common
-   control with that entity. For the purposes of this definition,
-   "control" means (i) the power, direct or indirect, to cause the
-   direction or management of such entity, whether by contract or
-   otherwise, or (ii) ownership of fifty percent (50%) or more of the
-   outstanding shares, or (iii) beneficial ownership of such entity.
-
-   "You" (or "Your") shall mean an individual or Legal Entity
-   exercising permissions granted by this License.
-
-   "Source" form shall mean the preferred form for making modifications,
-   including but not limited to software source code, documentation
-   source, and configuration files.
-
-   "Object" form shall mean any form resulting from mechanical
-   transformation or translation of a Source form, including but
-   not limited to compiled object code, generated documentation,
-   and conversions to other media types.
-
-   "Work" shall mean the work of authorship, whether in Source or
-   Object form, made available under the License, as indicated by a
-   copyright notice that is included in or attached to the work
-   (an example is provided in the Appendix below).
-
-   "Derivative Works" shall mean any work, whether in Source or Object
-   form, that is based on (or derived from) the Work and for which the
-   editorial revisions, annotations, elaborations, or other modifications
-   represent, as a whole, an original work of authorship. For the purposes
-   of this License, Derivative Works shall not include works that remain
-   separable from, or merely link (or bind by name) to the interfaces of,
-   the Work and Derivative Works thereof.
-
-   "Contribution" shall mean any work of authorship, including
-   the original version of the Work and any modifications or additions
-   to that Work or Derivative Works thereof, that is intentionally
-   submitted to Licensor for inclusion in the Work by the copyright owner
-   or by an individual or Legal Entity authorized to submit on behalf of
-   the copyright owner. For the purposes of this definition, "submitted"
-   means any form of electronic, verbal, or written communication sent
-   to the Licensor or its representatives, including but not limited to
-   communication on electronic mailing lists, source code control systems,
-   and issue tracking systems that are managed by, or on behalf of, the
-   Licensor for the purpose of discussing and improving the Work, but
-   excluding communication that is conspicuously marked or otherwise
-   designated in writing by the copyright owner as "Not a Contribution."
-
-   "Contributor" shall mean Licensor and any individual or Legal Entity
-   on behalf of whom a Contribution has been received by Licensor and
-   subsequently incorporated within the Work.
-
-2. Grant of Copyright License. Subject to the terms and conditions of
-   this License, each Contributor hereby grants to You a perpetual,
-   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-   copyright license to reproduce, prepare Derivative Works of,
-   publicly display, publicly perform, sublicense, and distribute the
-   Work and such Derivative Works in Source or Object form.
-
-3. Grant of Patent License. Subject to the terms and conditions of
-   this License, each Contributor hereby grants to You a perpetual,
-   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-   (except as stated in this section) patent license to make, have made,
-   use, offer to sell, sell, import, and otherwise transfer the Work,
-   where such license applies only to those patent claims licensable
-   by such Contributor that are necessarily infringed by their
-   Contribution(s) alone or by combination of their Contribution(s)
-   with the Work to which such Contribution(s) was submitted. If You
-   institute patent litigation against any entity (including a
-   cross-claim or counterclaim in a lawsuit) alleging that the Work
-   or a Contribution incorporated within the Work constitutes direct
-   or contributory patent infringement, then any patent licenses
-   granted to You under this License for that Work shall terminate
-   as of the date such litigation is filed.
-
-4. Redistribution. You may reproduce and distribute copies of the
-   Work or Derivative Works thereof in any medium, with or without
-   modifications, and in Source or Object form, provided that You
-   meet the following conditions:
-
-   (a) You must give any other recipients of the Work or
-       Derivative Works a copy of this License; and
-
-   (b) You must cause any modified files to carry prominent notices
-       stating that You changed the files; and
-
-   (c) You must retain, in the Source form of any Derivative Works
-       that You distribute, all copyright, patent, trademark, and
-       attribution notices from the Source form of the Work,
-       excluding those notices that do not pertain to any part of
-       the Derivative Works; and
-
-   (d) If the Work includes a "NOTICE" text file as part of its
-       distribution, then any Derivative Works that You distribute must
-       include a readable copy of the attribution notices contained
-       within such NOTICE file, excluding those notices that do not
-       pertain to any part of the Derivative Works, in at least one
-       of the following places: within a NOTICE text file distributed
-       as part of the Derivative Works; within the Source form or
-       documentation, if provided along with the Derivative Works; or,
-       within a display generated by the Derivative Works, if and
-       wherever such third-party notices normally appear. The contents
-       of the NOTICE file are for informational purposes only and
-       do not modify the License. You may add Your own attribution
-       notices within Derivative Works that You distribute, alongside
-       or as an addendum to the NOTICE text from the Work, provided
-       that such additional attribution notices cannot be construed
-       as modifying the License.
-
-   You may add Your own copyright statement to Your modifications and
-   may provide additional or different license terms and conditions
-   for use, reproduction, or distribution of Your modifications, or
-   for any such Derivative Works as a whole, provided Your use,
-   reproduction, and distribution of the Work otherwise complies with
-   the conditions stated in this License.
-
-5. Submission of Contributions. Unless You explicitly state otherwise,
-   any Contribution intentionally submitted for inclusion in the Work
-   by You to the Licensor shall be under the terms and conditions of
-   this License, without any additional terms or conditions.
-   Notwithstanding the above, nothing herein shall supersede or modify
-   the terms of any separate license agreement you may have executed
-   with Licensor regarding such Contributions.
-
-6. Trademarks. This License does not grant permission to use the trade
-   names, trademarks, service marks, or product names of the Licensor,
-   except as required for reasonable and customary use in describing the
-   origin of the Work and reproducing the content of the NOTICE file.
-
-7. Disclaimer of Warranty. Unless required by applicable law or
-   agreed to in writing, Licensor provides the Work (and each
-   Contributor provides its Contributions) on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-   implied, including, without limitation, any warranties or conditions
-   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-   PARTICULAR PURPOSE. You are solely responsible for determining the
-   appropriateness of using or redistributing the Work and assume any
-   risks associated with Your exercise of permissions under this License.
-
-8. Limitation of Liability. In no event and under no legal theory,
-   whether in tort (including negligence), contract, or otherwise,
-   unless required by applicable law (such as deliberate and grossly
-   negligent acts) or agreed to in writing, shall any Contributor be
-   liable to You for damages, including any direct, indirect, special,
-   incidental, or consequential damages of any character arising as a
-   result of this License or out of the use or inability to use the
-   Work (including but not limited to damages for loss of goodwill,
-   work stoppage, computer failure or malfunction, or any and all
-   other commercial damages or losses), even if such Contributor
-   has been advised of the possibility of such damages.
-
-9. Accepting Warranty or Additional Liability. While redistributing
-   the Work or Derivative Works thereof, You may choose to offer,
-   and charge a fee for, acceptance of support, warranty, indemnity,
-   or other liability obligations and/or rights consistent with this
-   License. However, in accepting such obligations, You may act only
-   on Your own behalf and on Your sole responsibility, not on behalf
-   of any other Contributor, and only if You agree to indemnify,
-   defend, and hold each Contributor harmless for any liability
-   incurred by, or claims asserted against, such Contributor by reason
-   of your accepting any such warranty or additional liability.
-
-END OF TERMS AND CONDITIONS
-
-APPENDIX: How to apply the Apache License to your work.
-
-   To apply the Apache License to your work, attach the following
-   boilerplate notice, with the fields enclosed by brackets "[]"
-   replaced with your own identifying information. (Don't include
-   the brackets!)  The text should be enclosed in the appropriate
-   comment syntax for the file format. We also recommend that a
-   file or class name and description of purpose be included on the
-   same "printed page" as the copyright notice for easier
-   identification within third-party archives.
-
-Copyright [yyyy] [name of copyright owner]
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,16 +1,10 @@
-# InSpec
+# InSpec: Inspect Your Infrastructure
 
-## What is InSpec?
-
-InSpec is an open-source testing framework for infrastructure with an easy language for specifying compliance, security, and policy requirements. The project name stands for "infrastructure specification" and can be thought of as an abbreviation of "inspect".
-
-You can use InSpec to examine any node in your infrastructure. The InSpec framework runs locally or remotely on the node being inspected. It uses test rules written in the InSpec language as input. Detected security, compliance, or policy issues are flagged in a log.
-
-The InSpec project includes many resources that help you write audit rules quickly and easily. Here are some examples.
-
- * Disallow insecure protocols - In this example, the package and inetd_conf resources ensure that insecure services and protocols, such as telnet, are not used.
+InSpec is open-source testing framework for infrastructure with a human- and machine-readable language for specifying compliance, security and policy requirements.
 
 ```ruby
+# Disallow insecure protocols by testing
+
 describe package('telnetd') do
   it { should_not be_installed }
 end
@@ -20,54 +14,28 @@ describe inetd_conf do
 end
 ```
 
- * Only accept requests on secure ports - This test ensures, that a web server is only listening on well-secured ports.
-
-```ruby
-describe port(80) do
-  it { should_not be_listening }
-end
-
-describe port(443) do
-  it { should be_listening }
-  its('protocol') {should eq 'tcp'}
-end
-```
-
- * Use approved strong ciphers - This test ensures, that only enterprise-compliant ciphers are used for SSH servers.
+InSpec makes it easy to run your tests wherever you need.
 
-```ruby
-describe sshd_config do
-   its('Ciphers') { should eq('chacha20-poly1305@openssh.com,aes256-ctr,aes192-ctr,aes128-ctr') }
-end
-```
-
- * Test your `kitchen.yml` file, to verify that only Vagrant is configured as the driver.
-
-```ruby
-describe yaml('.kitchen.yml') do
-  its('driver.name') { should eq('vagrant') }
-end
-```
-
-## Test your Server, VM, or workstation.
+```bash
+# run test locally
+inspec exec test.rb
 
-Small example: Write a your checks in `test.rb`:
+# run test on remote host on SSH
+inspec exec test.rb -t ssh://user@hostname
 
-```ruby
-describe file('/proc/cpuinfo') do
-  it { should be_file }
-end
+# run test on remote windows host on WinRM
+inspec exec test.rb -t winrm://Administrator@windowshost --password 'your-password'
 
-describe ssh_config do
-  its('Protocol') { should eq('2') }
-end
+# run test on docker container
+inspec exec test.rb -t docker://container_id
 ```
 
-Run this file locally:
+# Features
 
-```bash
-inspec exec test.rb
-```
+- Built-in Compliance: Compliance no longer occurs at the end of the release cycle
+- Targeted Tests: InSpec writes tests that specifically target compliance issues
+- Metadata: Includes the metadata required by security and compliance pros
+- Easy Testing: Includes a command-line interface to run tests quickly
 
 ## Installation
 
@@ -93,7 +61,40 @@ You should now be able to run:
 inspec --help
 ```
 
-## Usage
+# Examples
+
+* Only accept requests on secure ports - This test ensures that a web server is only listening on well-secured ports.
+
+```ruby
+describe port(80) do
+  it { should_not be_listening }
+end
+
+describe port(443) do
+  it { should be_listening }
+  its('protocol') {should eq 'tcp'}
+end
+```
+
+* Use approved strong ciphers - This test ensures that only enterprise-compliant ciphers are used for SSH servers.
+
+```ruby
+describe sshd_config do
+   its('Ciphers') { should eq('chacha20-poly1305@openssh.com,aes256-ctr,aes192-ctr,aes128-ctr') }
+end
+```
+
+* Test your `kitchen.yml` file to verify that only Vagrant is configured as the driver.
+
+```ruby
+describe yaml('.kitchen.yml') do
+  its('driver.name') { should eq('vagrant') }
+end
+```
+
+Also have a look at our [example](https://github.com/chef/inspec/tree/master/examples/test-kitchen) that uses `inspec` in combination with `test-kitchen`
+
+## Command Line Usage
 
 ### exec
 
@@ -128,15 +129,15 @@ Which will provide you with:
 {"family":"ubuntu","release":"14.04","arch":null}
 ```
 
-## Custom resources
+## Custom InSpec resources
 
 You can easily create your own resources. Here is a custom resource for an
-application called Gordon and save it in `gordon_config.rb`:
+application called Gordon. It is saved as `gordon_config.rb`.
 
 ```ruby
 require 'yaml'
 
-class GordonConfig < Inspec.resource
+class GordonConfig < Inspec.resource(1)
   name 'gordon_config'
 
   def initialize
@@ -165,7 +166,25 @@ describe gordon_config do
 end
 ```
 
-## Tests
+## Documentation
+
+Documentation is available: https://github.com/chef/inspec/tree/master/docs
+
+## Kudos
+
+InSpec is inspired by the wonderful [Serverspec](http://serverspec.org) project. Kudos to [mizzy](https://github.com/mizzy) and [all contributors](https://github.com/mizzy/serverspec/graphs/contributors)!
+
+
+## Contribute
+
+1. Fork it
+1. Create your feature branch (git checkout -b my-new-feature)
+1. Commit your changes (git commit -am 'Add some feature')
+1. Push to the branch (git push origin my-new-feature)
+1. Create new Pull Request
+
+
+## Testing InSpec
 
 We perform `unit`, `resource` and `integration` tests.
 
@@ -175,15 +194,13 @@ We perform `unit`, `resource` and `integration` tests.
 
 ### Unit tests
 
-Just
 ```bash
 bundle exec rake test
 ```
-as usual.
 
 ### Resource tests
 
-Make sure the backend execution layer behaves as expected. These tests will take a while, as a lot of different operating systems and configurations are being tested.
+Resource tests make sure the backend execution layer behaves as expected. These tests will take a while, as a lot of different operating systems and configurations are being tested.
 
 You will require:
 
@@ -216,22 +233,6 @@ bundle exec kitchen test -t .
 
 It may be informative to look at what [tests Chef Delivery](https://github.com/chef/inspec/blob/master/.delivery/build-cookbook/recipes/unit.rb) is running for CI.
 
-## Learn More
-
-For more information see the InSpec documentation: https://github.com/chef/inspec/tree/master/docs
-
-## Kudos
-
-InSpec is inspired by the wonderful [Serverspec](http://serverspec.org) project. Kudos to [mizzy](https://github.com/mizzy) and [all contributors](https://github.com/mizzy/serverspec/graphs/contributors)!
-
-## Contributing
-
-1. Fork it
-1. Create your feature branch (git checkout -b my-new-feature)
-1. Commit your changes (git commit -am 'Add some feature')
-1. Push to the branch (git push origin my-new-feature)
-1. Create new Pull Request
-
 ## License
 
 | **Author:**          | Dominik Richter (<drichter@chef.io>)

data/Rakefile

@@ -1,6 +1,8 @@
 #!/usr/bin/env rake
 # encoding: utf-8
 
+require 'bundler'
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rubocop/rake_task'
 require_relative 'tasks/maintainers'

data/bin/inspec.orig

@@ -0,0 +1,115 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+# Copyright 2015 Dominik Richter. All rights reserved.
+# author: Dominik Richter
+# author: Christoph Hartmann
+
+require 'thor'
+require 'json'
+require_relative '../lib/inspec'
+
+class InspecCLI < Thor
+  def self.target_options
+    option :target, aliases: :t, type: :string, default: nil,
+      desc: 'Simple targeting option using URIs, e.g. ssh://user:pass@host:port'
+    option :backend, aliases: :b, type: :string, default: nil,
+      desc: 'Choose a backend: local, ssh, winrm, docker.'
+    option :host, type: :string,
+      desc: 'Specify a remote host which is tested.'
+    option :port, type: :numeric,
+      desc: 'Specify the login port for a remote scan.'
+    option :user, type: :string, default: nil,
+      desc: 'The login user for a remote scan.'
+    option :password, type: :string, default: nil,
+      desc: 'Login password for a remote scan, if required.'
+    option :key_files, type: :array, default: nil,
+      desc: 'Login key or certificate file for a remote scan.'
+    option :path, type: :string, default: nil,
+<<<<<<< HEAD
+      desc: 'Login path to use when connecting to the target.'
+    option :sudo, type: :boolean, default: false,
+      desc: 'Run scans with sudo. Only activates on Unix and non-root user.'
+=======
+      desc: 'Login path to use when connecting to the target (WinRM).'
+    option :disable_sudo, type: :boolean, default: false,
+      desc: 'To not run remote scans via sudo.'
+>>>>>>> update cli description of --path
+    option :sudo_password, type: :string, default: nil,
+      desc: 'Specify a sudo password, if it is required.'
+    option :sudo_options, type: :string, default: '',
+      desc: 'Additional sudo options for a remote scan.'
+    option :ssl, type: :boolean, default: false,
+      desc: 'Use SSL for transport layer encryption (WinRM).'
+    option :self_signed, type: :boolean, default: false,
+      desc: 'Allow remote scans with self-signed certificates (WinRM).'
+  end
+
+  desc 'json PATH', 'read all tests in PATH and generate a JSON profile'
+  option :id, type: :string,
+    desc: 'Attach a profile ID to all test results'
+  option :output, aliases: :o, type: :string,
+    desc: 'Save the created profile to a path'
+  def json(path)
+    profile = Inspec::Profile.from_path(path, options)
+    dst = options[:output].to_s
+    if dst.empty?
+      puts JSON.pretty_generate(profile.info)
+    else
+      if File.exist? dst
+        puts "----> updating #{dst}"
+      else
+        puts "----> creating #{dst}"
+      end
+      fdst = File.expand_path(dst)
+      File.write(fdst, JSON.dump(profile.info))
+    end
+  end
+
+  desc 'check PATH', 'verify test structure in PATH'
+  def check(path)
+    o = options.dup
+    o[:logger] = Logger.new(STDOUT)
+    profile = Inspec::Profile.from_path(path, o)
+    exit 1 unless profile.check
+  end
+
+  desc 'exec PATHS', 'run all test files'
+  option :id, type: :string,
+    desc: 'Attach a profile ID to all test results'
+  target_options
+  option :format, type: :string, default: 'progress'
+  def exec(*tests)
+    runner = Inspec::Runner.new(options)
+    runner.add_tests(tests)
+    runner.run
+  rescue RuntimeError => e
+    puts e.message
+  end
+
+  desc 'detect', 'detect the target OS'
+  target_options
+  def detect
+    runner = Inspec::Runner.new(options)
+    rel = File.join(File.dirname(__FILE__), *%w{.. lib utils detect.rb})
+    detect_util = File.expand_path(rel)
+    runner.add_tests([detect_util])
+    runner.run
+  rescue RuntimeError => e
+    puts e.message
+  end
+
+  desc 'shell', 'open an interactive debugging shell'
+  target_options
+  def shell_func
+    runner = Inspec::Runner.new(options)
+    Inspec::Shell.new(runner).start
+  rescue RuntimeError => e
+    puts e.message
+  end
+
+  desc 'version', 'prints the version of this tool'
+  def version
+    puts Inspec::VERSION
+  end
+end
+InspecCLI.start(ARGV)

data/docs/inspec_and_friends.rst

@@ -0,0 +1,81 @@
+=====================================================
+InSpec and friends
+=====================================================
+
+RSpec
+=====================================================
+
+RSpec is an awesome framework that is widely used to test Ruby code. It enables test-driven development (TDD) and helps developers to write better code every day.
+
+InSpec is built on top of RSpec and uses it as the underlying foundation to execute tests. It uses the key strengths of RSpec, easily execute tests and a DSL to write tests, but extends the functionality for use as compliance audits. InSpec ships with custom audit resources that make it easy to write audit checks and with the ability to run those checks on remote servers. These audit resources provided know the differences between operating systems and help you abstract from the local operating system, similar to other resources you might use in your Chef recipes.
+
+A complete InSpec rule looks like:
+
+.. code-block:: ruby
+
+  control "sshd-11" do
+    impact 1.0
+    title "Server: Set protocol version to SSHv2"
+    desc "
+      Set the SSH protocol version to 2. Don't use legacy
+      insecure SSHv1 connections anymore.
+    "
+    describe sshd_config do
+      its('Protocol') { should eq('2') }
+    end
+  end
+
+
+
+Serverspec
+=====================================================
+
+Serverspec can be credited as the first extension of RSpec that enabled users to run RSpec tests on servers to verify deployed artifacts. It was created in March 2013 by Gosuke Miyashita and has been widely adopted. It is also one of the core test frameworks within test-kitchen and has been widely used within the Chef ecosystem.  InSpec takes lessons learned implementing and using Serverspec and builds on them to make auditing and compliance easier.
+
+Lessons learned from Serverspec include:
+
+* IT, compliance, and security professional require metadata beyond what Serverspec offers, such as criticality, to fully describe controls.
+
+* Setting up and running the same tests across multiple machines must be easy.
+
+* It must be easy to locate, debug, and extend operating system-dependent code.
+
+* It must be easy to extend the language and create custom resources.
+
+* It must run multiple tests simultaneously.
+
+* Support for Windows is a first-class requirement.
+
+* A command line interface (CLI) is required for faster iteration of test code.
+
+
+How is InSpec different than Serverspec
+-----------------------------------------------------
+
+One of the key differences is that InSpec targets more user groups. It is optimized for DevOps, Security, and Compliance professionals. Additional metadata, such as impact, title, and description, make it easier to fully describe the controls which makes it easier to share the controls with other departments. This enables Security departments to prioritize rules. DevOps teams use this information to focus on the most critical issues to remediate.
+
+.. code-block:: ruby
+
+  control "sshd-11" do
+    impact 1.0
+    title "Server: Set protocol version to SSHv2"
+    desc "
+      Set the SSH protocol version to 2. Don't use legacy
+      insecure SSHv1 connections anymore.
+    "
+    describe sshd_config do
+      its('Protocol') { should eq('2') }
+    end
+  end
+
+**Why not fork Serverspec?**
+
+InSpec started as an extension of Serverspec. As the extension grew, it became clear that a new library was required.  Creating and maintaining a fork was not practical so a new project was born.
+
+**Will InSpec only work on machines managed by Chef?**
+
+No, InSpec can be used on any machine.  It doesn’t matter if that machine was configured by Chef or configured lovingly by the hands of your local System Administrator.
+
+**Is InSpec a replacement of Serverspec?**
+
+InSpec is intended to be a drop-in replacement of Serverspec. Popular Serverspec resources have been ported to InSpec. It changed some behaviour as documented in our migration guide.

data/docs/resources.rst

@@ -1067,7 +1067,7 @@ The ``content`` matcher tests if contents in the file match the value specified
 
 .. code-block:: ruby
 
-   its('content') { should contain 'value' }
+   its('content') { should match 'value' }
 
 The following complete example tests the ``pg_hba.conf`` file in |postgresql| for |md5| requirements.  The tests look at all ``host`` and ``local`` settings in that file, and then compare the |md5| checksums against the values in the test:
 
@@ -2602,7 +2602,7 @@ The ``version`` matcher tests if the named package version is on the system:
 
 .. code-block:: ruby
 
-   its('version) { should eq '1.2.3' }
+   its('version') { should eq '1.2.3' }
 
 Examples
 -----------------------------------------------------

data/examples/test-kitchen/Gemfile

@@ -2,7 +2,7 @@
 source 'https://rubygems.org'
 
 gem 'inspec', path: '../../.'
-gem 'train', git: 'git@github.com:chef/train.git'
+gem 'r-train', git: 'git@github.com:chef/train.git'
 
 group :test do
   gem 'bundler', '~> 1.5'

data/inspec.gemspec

@@ -13,8 +13,9 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/chef/inspec'
   spec.license       = 'Apache 2.0'
 
-  spec.files         = `hash git 2>/dev/null && git ls-files -z`.split("\x0").find_all { |x| x !~ /^\.delivery/ }
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.files = %w(README.md Rakefile MAINTAINERS.toml MAINTAINERS.md LICENSE inspec.gemspec Gemfile CHANGELOG.md .rubocop.yml) +
+    Dir.glob("{bin,docs,examples,lib,tasks,test}/**/*", File::FNM_DOTMATCH).reject { |f|  File.directory?(f) }
+  spec.executables   = %w( inspec )
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 

data/lib/inspec/shell.rb

@@ -13,7 +13,8 @@ module Inspec
 
     def start
       # store context to run commands in this context
-      @runner.add_content('binding.pry', __FILE__, __LINE__)
+      @runner.add_content({
+        content: 'binding.pry', ref: __FILE__, line: __LINE__}, [])
       @runner.run
     end
 

data/lib/inspec/version.rb

@@ -3,5 +3,5 @@
 # author: Christoph Hartmann
 
 module Inspec
-  VERSION = '0.9.1'
+  VERSION = '0.9.2'
 end

data/test/unit/mock/profiles/rules/metadata.rb

@@ -0,0 +1,2 @@
+name 'metadata profile'
+

data/test/unit/mock/profiles/rules/test/test.rb

@@ -0,0 +1,6 @@
+rule 'id-1' do
+  title 'hello title'
+	desc 'hello desc'
+	impact 0.0
+	expect(file '/dev/zero').to be_file
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inspec
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-03 00:00:00.000000000 Z
+date: 2015-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: r-train
@@ -144,9 +144,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -155,8 +153,10 @@ files:
 - README.md
 - Rakefile
 - bin/inspec
+- bin/inspec.orig
 - docs/ctl_inspec.rst
 - docs/dsl_inspec.rst
+- docs/inspec_and_friends.rst
 - docs/readme.rst
 - docs/resources.rst
 - docs/template.rst
@@ -193,6 +193,7 @@ files:
 - lib/inspec/targets/zip.rb
 - lib/inspec/version.rb
 - lib/matchers/matchers.rb
+- lib/resources/.service.rb.swp
 - lib/resources/apache.rb
 - lib/resources/apache_conf.rb
 - lib/resources/apt.rb
@@ -347,6 +348,8 @@ files:
 - test/unit/mock/files/sshd_config
 - test/unit/mock/profiles/empty/metadata.rb
 - test/unit/mock/profiles/metadata/metadata.rb
+- test/unit/mock/profiles/rules/metadata.rb
+- test/unit/mock/profiles/rules/test/test.rb
 - test/unit/profile_context_test.rb
 - test/unit/profile_test.rb
 - test/unit/resources/apt_test.rb
@@ -510,6 +513,8 @@ test_files:
 - test/unit/mock/files/sshd_config
 - test/unit/mock/profiles/empty/metadata.rb
 - test/unit/mock/profiles/metadata/metadata.rb
+- test/unit/mock/profiles/rules/metadata.rb
+- test/unit/mock/profiles/rules/test/test.rb
 - test/unit/profile_context_test.rb
 - test/unit/profile_test.rb
 - test/unit/resources/apt_test.rb
@@ -552,4 +557,3 @@ test_files:
 - test/unit/resources/yum_test.rb
 - test/unit/simpleconfig_test.rb
 - test/unit/utils/content_parser_test.rb
-has_rdoc: 

data/.gitignore

@@ -1,8 +0,0 @@
-Gemfile.lock
-coverage
-*.gem
-.gallery
-.kitchen
-.delivery/cli.toml
-Berksfile.lock
-.bundle

data/.travis.yml

@@ -1,23 +0,0 @@
----
-sudo: required
-language: ruby
-cache: bundler
-
-bundler_args: --without integration tools maintenance
-
-matrix:
-  include:
-  - rvm: 1.9.3
-    gemfile: Gemfile
-  - rvm: 2.0
-    gemfile: Gemfile
-  - rvm: 2.2
-    gemfile: Gemfile
-    script: bundle exec rake lint test test:resources config=test/test.yaml
-    before_script:
-      - source <(curl -sL https://raw.githubusercontent.com/zuazo/kitchen-in-travis/0.3.0/scripts/start_docker.sh)
-  - rvm: 2.2
-    gemfile: Gemfile
-    script: bundle exec rake test:resources config=test/test-extra.yaml
-    before_script:
-      - source <(curl -sL https://raw.githubusercontent.com/zuazo/kitchen-in-travis/0.3.0/scripts/start_docker.sh)