inspec 0.9.5 → 0.9.6

data/examples/README.md

@@ -0,0 +1,7 @@
+# InSpec examples
+
+This directory contains multiple examples that explain the usage of the InSpec:
+
+ - `kitchen-chef` Test-Kitchen with [Chef and InSpec](kitchen-chef/README.md)
+ - `kitchen-puppet` Test-Kitchen with [Puppet and InSpec](kitchen-puppet/README.md)
+ - `kitchen-ansible` Test-Kitchen with [Ansible and InSpec](kitchen-ansible/README.md)

data/examples/kitchen-ansible/.kitchen.yml

@@ -0,0 +1,25 @@
+---
+driver:
+  name: vagrant
+
+provisioner:
+  hosts: webservers
+  name: ansible_playbook
+  # Use el7 epel repo instead of the default el6
+  ansible_yum_repo: "https://download.fedoraproject.org/pub/epel/7/x86_64/e/epel-release-7-5.noarch.rpm"
+  require_chef_for_busser: false
+  require_ruby_for_busser: false
+  ansible_verbosity: 2
+  ansible_verbose: true
+  # starting playbook is at: test/integration/default/default.yml
+
+verifier:
+  name: inspec
+
+platforms:
+  - name: centos-7.1
+  - name: ubuntu-12.04
+  - name: ubuntu-14.04
+
+suites:
+  - name: default

data/examples/kitchen-ansible/Gemfile

@@ -0,0 +1,20 @@
+# encoding: utf-8
+source 'https://rubygems.org'
+
+gem 'inspec', path: '../../.'
+
+group :test do
+  gem 'bundler', '~> 1.5'
+  gem 'minitest', '~> 5.5'
+  gem 'rake', '~> 10'
+  gem 'rubocop', '~> 0.33.0'
+  gem 'simplecov', '~> 0.10'
+end
+
+group :integration do
+  gem 'test-kitchen', '~> 1.4'
+  gem 'kitchen-ansible'
+  gem 'kitchen-vagrant'
+  gem 'kitchen-inspec'
+  gem 'concurrent-ruby', '~> 0.9'
+end

data/examples/kitchen-ansible/README.md

@@ -0,0 +1,53 @@
+# Test-Kitchen - InSpec with Ansible Example
+
+This example demonstrates a complete roundtrip via [Test-Kitchen](http://kitchen.ci/).
+
+```bash
+# install all dependencies
+$ bundle install
+# show all available tests
+$ bundle exec kitchen list
+Instance             Driver   Provisioner      Verifier  Transport  Last Action
+default-centos-71    Vagrant  AnsiblePlaybook  Inspec    Ssh        <Not Created>
+default-ubuntu-1204  Vagrant  AnsiblePlaybook  Inspec    Ssh        <Not Created>
+default-ubuntu-1404  Vagrant  AnsiblePlaybook  Inspec    Ssh        <Not Created>
+
+# Now we are ready to run a complete test
+$ bundle exec kitchen test default-ubuntu-1404
+-----> Starting Kitchen (v1.4.2)
+-----> Cleaning up any prior instances of <default-ubuntu-1404>
+-----> Destroying <default-ubuntu-1404>...
+       Finished destroying <default-ubuntu-1404> (0m0.00s).
+-----> Testing <default-ubuntu-1404>
+-----> Creating <default-ubuntu-1404>...
+       Bringing machine 'default' up with 'virtualbox' provider...
+       ==> default: Importing base box 'opscode-ubuntu-14.04'...
+
+...
+
+       Vagrant instance <default-ubuntu-1404> created.
+       Finished creating <default-ubuntu-1404> (0m37.51s).
+-----> Converging <default-ubuntu-1404>...
+       Preparing files for transfer
+       Preparing playbook
+
+...
+
+       Finished converging <default-ubuntu-1404> (1m14.53s).
+-----> Setting up <default-ubuntu-1404>...
+       Finished setting up <default-ubuntu-1404> (0m0.00s).
+-----> Verifying <default-ubuntu-1404>...
+.....
+
+Finished in 0.08796 seconds (files took 1 minute 52.3 seconds to load)
+5 examples, 0 failures
+
+       Finished verifying <default-ubuntu-1404> (0m0.27s).
+-----> Destroying <default-ubuntu-1404>...
+       ==> default: Forcing shutdown of VM...
+       ==> default: Destroying VM and associated drives...
+       Vagrant instance <default-ubuntu-1404> destroyed.
+       Finished destroying <default-ubuntu-1404> (0m4.41s).
+       Finished testing <default-ubuntu-1404> (1m56.73s).
+-----> Kitchen is finished. (1m57.06s)
+```

data/examples/kitchen-ansible/files/nginx.repo

@@ -0,0 +1,6 @@
+[nginx]
+name=Nginx Repo
+baseurl=http://nginx.org/packages/centos/7/x86_64
+enabled=1
+gpgcheck=1
+gpgkey=http://nginx.org/keys/nginx_signing.key

data/examples/kitchen-ansible/tasks/main.yml

@@ -0,0 +1,16 @@
+---
+- name: create nginx yum repo if OS family is RedHat
+  copy: src=nginx.repo dest=/etc/yum.repos.d/
+        owner=root group=root mode=0644
+  when: (ansible_os_family == "RedHat" and ansible_distribution_major_version == "7")
+
+- name: ensure nginx is at the latest version if OS family is RedHat
+  yum: name=nginx state=latest
+  when: ansible_os_family == "RedHat"
+
+- name: ensure nginx is at the latest version if OS family is Debian
+  apt: name=nginx state=latest
+  when: ansible_os_family == "Debian"
+
+- name: ensure nginx is running (and enable it at boot)
+  service: name=nginx state=started enabled=yes

data/examples/kitchen-ansible/test/integration/default/default.yml

@@ -0,0 +1,5 @@
+---
+- name: wrapper playbook for kitchen testing
+  hosts: webservers
+  roles:
+    - kitchen-ansible

data/examples/{test-kitchen → kitchen-chef}/.kitchen.yml

@@ -3,7 +3,7 @@ driver:
   name: vagrant
 
 provisioner:
-  name: chef_solo
+  name: chef_zero
 
 verifier:
   name: inspec

data/examples/{test-kitchen → kitchen-chef}/Gemfile

@@ -2,7 +2,6 @@
 source 'https://rubygems.org'
 
 gem 'inspec', path: '../../.'
-gem 'r-train', git: 'git@github.com:chef/train.git'
 
 group :test do
   gem 'bundler', '~> 1.5'
@@ -16,6 +15,6 @@ group :integration do
   gem 'berkshelf', '~> 4.0'
   gem 'test-kitchen', '~> 1.4'
   gem 'kitchen-vagrant'
-  gem 'kitchen-inspec', git: 'git@github.com:chef/kitchen-inspec.git'
+  gem 'kitchen-inspec'
   gem 'concurrent-ruby', '~> 0.9'
 end

data/examples/{test-kitchen → kitchen-chef}/README.md

@@ -1,4 +1,4 @@
-# InSpec Test-Kitchen Example
+# Test-Kitchen - InSpec with Chef Example
 
 This example demonstrates a complete roundtrip via [Test-Kitchen](http://kitchen.ci/).
 

data/examples/kitchen-chef/test/integration/default/web_spec.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+# author: Christoph Hartmann
+# author: Dominik Richter
+
+# use basic tests
+describe package('nginx') do
+  it { should be_installed }
+end
+
+# extend tests with metadata
+control '01' do
+  impact 0.7
+  title 'Verify nginx service'
+  desc 'Ensures nginx service is up and running'
+  describe service('nginx') do
+    it { should be_enabled }
+    it { should be_installed }
+    it { should be_running }
+  end
+end
+
+# implement os dependent tests
+web_user = 'www-data'
+web_user = 'nginx' if os[:family] == 'centos'
+
+describe user(web_user) do
+  it { should exist }
+end

data/examples/kitchen-puppet/.kitchen.yml

@@ -0,0 +1,22 @@
+---
+driver:
+  name: vagrant
+
+provisioner:
+  name: puppet_apply
+  # Not installing chef since inspec is used for testing
+  require_chef_for_busser: false
+  manifests_path: manifests
+
+verifier:
+  name: inspec
+
+platforms:
+  - name: centos-7.1
+  - name: ubuntu-12.04
+  - name: ubuntu-14.04
+
+suites:
+  - name: default
+    provisioner:
+      manifest: site.pp

data/examples/kitchen-puppet/Gemfile

@@ -0,0 +1,21 @@
+# encoding: utf-8
+source 'https://rubygems.org'
+
+gem 'inspec', path: '../../.'
+
+group :test do
+  gem 'bundler', '~> 1.5'
+  gem 'minitest', '~> 5.5'
+  gem 'rake', '~> 10'
+  gem 'rubocop', '~> 0.33.0'
+  gem 'simplecov', '~> 0.10'
+end
+
+group :integration do
+  gem 'test-kitchen', '~> 1.4'
+  gem 'kitchen-vagrant'
+  gem 'kitchen-puppet'
+  gem 'librarian-puppet'
+  gem 'kitchen-inspec'
+  gem 'concurrent-ruby', '~> 0.9'
+end

data/examples/kitchen-puppet/Puppetfile

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+#^syntax detection
+
+forge "https://forgeapi.puppetlabs.com"
+
+# use dependencies defined in metadata.json
+metadata
+
+# use dependencies defined in Modulefile
+# modulefile
+
+# A module from the Puppet Forge
+# mod 'puppetlabs-stdlib'
+
+# A module from git
+# mod 'puppetlabs-ntp',
+#   :git => 'git://github.com/puppetlabs/puppetlabs-ntp.git'
+
+# A module from a git branch/tag
+# mod 'puppetlabs-apt',
+#   :git => 'https://github.com/puppetlabs/puppetlabs-apt.git',
+#   :ref => '1.4.x'
+
+# A module from Github pre-packaged tarball
+# mod 'puppetlabs-apache', '0.6.0', :github_tarball => 'puppetlabs/puppetlabs-apache'

data/examples/kitchen-puppet/README.md

@@ -0,0 +1,53 @@
+# Test-Kitchen - InSpec with Puppet Example
+
+This example demonstrates a complete roundtrip via [Test-Kitchen](http://kitchen.ci/).
+
+```bash
+# install all dependencies
+$ bundle install
+# show all available tests
+$ bundle exec kitchen list
+Instance             Driver   Provisioner  Verifier  Transport  Last Action
+default-centos-71    Vagrant  PuppetApply  Inspec    Ssh        <Not Created>
+default-ubuntu-1204  Vagrant  PuppetApply  Inspec    Ssh        <Not Created>
+default-ubuntu-1404  Vagrant  PuppetApply  Inspec    Ssh        <Not Created>
+
+# Now we are ready to run a complete test
+$ bundle exec kitchen test default-ubuntu-1404
+-----> Starting Kitchen (v1.4.2)
+-----> Cleaning up any prior instances of <default-ubuntu-1404>
+-----> Destroying <default-ubuntu-1404>...
+       Finished destroying <default-ubuntu-1404> (0m0.00s).
+-----> Testing <default-ubuntu-1404>
+-----> Creating <default-ubuntu-1404>...
+       Bringing machine 'default' up with 'virtualbox' provider...
+       ==> default: Importing base box 'opscode-ubuntu-14.04'...
+
+...
+
+       Vagrant instance <default-ubuntu-1404> created.
+       Finished creating <default-ubuntu-1404> (0m33.62s).
+-----> Converging <default-ubuntu-1404>...
+       Preparing files for transfer
+
+...
+
+       Finished converging <default-ubuntu-1404> (0m48.95s).
+-----> Setting up <default-ubuntu-1404>...
+       Finished setting up <default-ubuntu-1404> (0m0.00s).
+-----> Verifying <default-ubuntu-1404>...
+.....
+
+Finished in 0.08278 seconds (files took 1 minute 22.81 seconds to load)
+5 examples, 0 failures
+
+       Finished verifying <default-ubuntu-1404> (0m0.22s).
+-----> Destroying <default-ubuntu-1404>...
+       ==> default: Forcing shutdown of VM...
+       ==> default: Destroying VM and associated drives...
+       Vagrant instance <default-ubuntu-1404> destroyed.
+       Finished destroying <default-ubuntu-1404> (0m3.97s).
+       Finished testing <default-ubuntu-1404> (1m26.79s).
+-----> Kitchen is finished. (1m27.34s)
+
+```

data/examples/kitchen-puppet/manifests/site.pp

@@ -0,0 +1,33 @@
+# == Class prepare::site
+#
+
+# Install nginx from package repos
+case $osfamily {
+  'RedHat': {
+    yumrepo { 'nginx':
+      descr => 'Nginx Repo',
+      baseurl => 'http://nginx.org/packages/centos/7/x86_64',
+      gpgkey => 'http://nginx.org/keys/nginx_signing.key',
+      enabled => 1
+    }
+
+    package { 'nginx':
+      require => [Yumrepo[nginx]],
+      ensure => 'latest'
+    }
+  }
+  'Debian': {
+    package { 'nginx':
+      ensure => 'latest'
+    }
+  }
+  default: {
+    fail("Unsupported platform: ${osfamily}/${operatingsystem}")
+  }
+}
+
+# Start the service
+service { 'nginx':
+  enable => 'true',
+  ensure => 'running'
+}

data/examples/kitchen-puppet/metadata.json

@@ -0,0 +1,11 @@
+{
+  "name": "prepare",
+  "version": "0.1.0",
+  "author": "support@chef.io",
+  "summary": "This module prepares the test operating systems",
+  "license": "Apache-2.0",
+  "source": "https://github.com/chef/inspec/examples/kitchen-puppet",
+  "project_page": "https://github.com/chef/inspec/examples/kitchen-puppet",
+  "issues_url": "https://github.com/chef/inspec/issues",
+  "dependencies": []
+}

data/examples/kitchen-puppet/test/integration/default/web_spec.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+# author: Christoph Hartmann
+# author: Dominik Richter
+
+# use basic tests
+describe package('nginx') do
+  it { should be_installed }
+end
+
+# extend tests with metadata
+control '01' do
+  impact 0.7
+  title 'Verify nginx service'
+  desc 'Ensures nginx service is up and running'
+  describe service('nginx') do
+    it { should be_enabled }
+    it { should be_installed }
+    it { should be_running }
+  end
+end
+
+# implement os dependent tests
+web_user = 'www-data'
+web_user = 'nginx' if os[:family] == 'centos'
+
+describe user(web_user) do
+  it { should exist }
+end

data/inspec.gemspec

@@ -33,4 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rspec', '~> 3.3'
   spec.add_dependency 'rspec-its', '~> 1.2'
   spec.add_dependency 'pry', '~> 0'
+
+  spec.add_development_dependency 'mocha', '~> 1.1'
 end

data/lib/inspec/plugins/resource.rb

@@ -7,9 +7,20 @@ module Inspec
     class Resource
       def self.name(name = nil)
         return if name.nil?
+        @name = name
         Inspec::Plugins::Resource.__register(name, self)
       end
 
+      def self.desc(description = nil)
+        return if description.nil?
+        Inspec::Resource.registry[@name].desc(description)
+      end
+
+      def self.example(example = nil)
+        return if example.nil?
+        Inspec::Resource.registry[@name].example(example)
+      end
+
       def self.__register(name, obj)
         # rubocop:disable Lint/NestedMethodDefinition
         cl = Class.new(obj) do
@@ -23,6 +34,16 @@ module Inspec
             super(*args)
           end
 
+          def self.desc(description = nil)
+            return @description if description.nil?
+            @description = description
+          end
+
+          def self.example(example = nil)
+            return @example if example.nil?
+            @example = example
+          end
+
           def inspec
             @__backend_runner__
           end