inspec 0.9.8 → 0.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05af717dedcf5fea001060356a73c799927a3ac5
-  data.tar.gz: 5fb4a23de7019a3f89d806737758e61ae8dace4c
+  metadata.gz: ec38b70d89c495843d834ff8825ed447419a29fd
+  data.tar.gz: 2d3ef5b473cef4c2c2beb2dfd299e8a964b599bb
 SHA512:
-  metadata.gz: f0da77acc1e683f4cef31cb497eecba9052e854555357f030e631e9749ad030bfdca6adf26ef5f1501b1d3789aae1377b6a416833ffc9c7c6baa2e074aae6ecf
-  data.tar.gz: 4523247eeb675b640da571394253bd47f7f396a1a500140a280b394fa44472ea7a1b60ef0abfd7a1cb66490bbf15596e1cc104bacbc56b5e433dcd2689251825
+  metadata.gz: 26e4ecc01b3091ef0918a2733d73c455b708de5a34dbc3bb869bb9563bfe4f3360becb2bc80c7c7b331eb57db22223af0d5430f012dd829da1add361643d9266
+  data.tar.gz: 045c295e95f3377e15796011d42fdc3c5b9d82b32073d1476b981cfc0c14d255ac236742e4cf5124e5e134d99f0a87a1bffb453338400337095846e9e4b867e0

data/.rubocop.yml

@@ -45,13 +45,17 @@ Style/PredicateName:
   Enabled: false
 Style/ClassAndModuleChildren:
   Enabled: false
+Style/ConditionalAssignment:
+  Enabled: false
 Style/BracesAroundHashParameters:
   Enabled: false
 Style/AndOr:
   Enabled: false
 Style/Not:
   Enabled: false
-Style/TrailingComma:
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: comma
 Style/NegatedIf:
   Enabled: false

data/CHANGELOG.md

@@ -1,7 +1,27 @@
 # Change Log
 
-## [0.9.8](https://github.com/chef/inspec/tree/0.9.8) (2016-01-11)
-[Full Changelog](https://github.com/chef/inspec/compare/v0.9.7...0.9.8)
+## [0.9.9](https://github.com/chef/inspec/tree/0.9.9) (2016-01-15)
+[Full Changelog](https://github.com/chef/inspec/compare/v0.9.8...0.9.9)
+
+**Fixed bugs:**
+
+- Resource registry\_key { should\_not exist } unavailable [\#322](https://github.com/chef/inspec/issues/322)
+- bugfix: only skip regkey if required [\#364](https://github.com/chef/inspec/pull/364) ([chris-rock](https://github.com/chris-rock))
+
+**Merged pull requests:**
+
+- add tests for loading metadata yaml internals [\#368](https://github.com/chef/inspec/pull/368) ([arlimus](https://github.com/arlimus))
+- make metadata.rb legacy mode consistent for supports [\#367](https://github.com/chef/inspec/pull/367) ([arlimus](https://github.com/arlimus))
+- lint with rubocop 0.36 [\#366](https://github.com/chef/inspec/pull/366) ([arlimus](https://github.com/arlimus))
+- Fix ssh\_config example [\#365](https://github.com/chef/inspec/pull/365) ([tas50](https://github.com/tas50))
+- Correctly detect UDP ports on linux [\#363](https://github.com/chef/inspec/pull/363) ([mivok](https://github.com/mivok))
+- Update the title of the gordon-1.0 control [\#359](https://github.com/chef/inspec/pull/359) ([chris-rock](https://github.com/chris-rock))
+- Inspec::Targets::UrlHelper: fix github handling, add tests [\#357](https://github.com/chef/inspec/pull/357) ([srenatus](https://github.com/srenatus))
+- Fix systemd service enabled check [\#356](https://github.com/chef/inspec/pull/356) ([jmccann](https://github.com/jmccann))
+- Adding AIX classes, tests, and targetted ssh testing [\#333](https://github.com/chef/inspec/pull/333) ([foobarbam](https://github.com/foobarbam))
+
+## [v0.9.8](https://github.com/chef/inspec/tree/v0.9.8) (2016-01-11)
+[Full Changelog](https://github.com/chef/inspec/compare/v0.9.7...v0.9.8)
 
 **Implemented enhancements:**
 
@@ -29,6 +49,7 @@
 **Merged pull requests:**
 
 - fix reading profiles bug [\#352](https://github.com/chef/inspec/pull/352) ([srenatus](https://github.com/srenatus))
+- 0.9.8 [\#350](https://github.com/chef/inspec/pull/350) ([chris-rock](https://github.com/chris-rock))
 - clarify how to bump version in rake [\#348](https://github.com/chef/inspec/pull/348) ([arlimus](https://github.com/arlimus))
 - Add `supports` to metadata to specify supported systems [\#344](https://github.com/chef/inspec/pull/344) ([arlimus](https://github.com/arlimus))
 - Update list of examples [\#340](https://github.com/chef/inspec/pull/340) ([chris-rock](https://github.com/chris-rock))

data/Gemfile

@@ -6,7 +6,7 @@ group :test do
   gem 'bundler', '~> 1.5'
   gem 'minitest', '~> 5.5'
   gem 'rake', '~> 10'
-  gem 'rubocop', '~> 0.32'
+  gem 'rubocop', '~> 0.36.0'
   gem 'simplecov', '~> 0.10'
   gem 'concurrent-ruby', '~> 0.9'
 end

data/Rakefile

@@ -46,6 +46,20 @@ namespace :test do
     path = File.join(File.dirname(__FILE__), 'test', 'integration')
     sh('sh', '-c', "cd #{path} && bundle exec kitchen test -c #{concurrency} -t .")
   end
+
+  task :ssh, [:target] do |_t, args|
+    tests_path = File.join(File.dirname(__FILE__), 'test', 'integration', 'test', 'integration', 'default')
+    key_files = ENV['key_files'] || File.join(ENV['HOME'], '.ssh', 'id_rsa')
+
+    sh_cmd =  "bin/inspec exec #{tests_path}/"
+    sh_cmd += ENV['test'] ? "#{ENV['test']}_spec.rb" : '*'
+    sh_cmd += " --sudo" unless args[:target].split('@')[0] == 'root'
+    sh_cmd += " -t ssh://#{args[:target]}"
+    sh_cmd += " --key_files=#{key_files}"
+    sh_cmd += " --format=#{ENV['format']}" if ENV['format']
+
+    sh('sh', '-c', sh_cmd)
+  end
 end
 
 # Print the current version of this gem or update it.
@@ -60,7 +74,7 @@ def inspec_version(target = nil)
 
   unless target.nil?
     raw = File.read(path)
-    nu = raw.sub(/VERSION.*/, "VERSION = '#{target}'")
+    nu = raw.sub(/VERSION.*/, "VERSION = '#{target}'.freeze")
     File.write(path, nu)
     load(path)
   end

data/docs/resources.rst

@@ -3888,7 +3888,7 @@ The following examples show how to use this InSpec audit resource.
 
    describe ssh_config do
      its('cipher') { should contain '3des' }
-     its('port') { should '22' }
+     its('port') { should eq '22' }
      its('hostname') { should include('example.com') }
    end
 

data/examples/profile/controls/gordon.rb

@@ -12,7 +12,7 @@ title 'Gordon Config Checks'
 # ```
 control 'gordon-1.0' do
   impact 0.7
-  title 'Create separate /tmp partition'
+  title 'Verify the version number of Gordon'
   desc 'An optional description...'
   describe gordon_config do
     its('version') { should eq('1.0') }

data/examples/resource/controls/tiny.rb

@@ -0,0 +1,3 @@
+describe tiny do
+require 'pry'; binding.pry
+end

data/examples/resource/inspec.yml

@@ -0,0 +1,10 @@
+name: resource
+title: InSpec Example Resources
+maintainer: Chef Software, Inc.
+copyright: Chef Software, Inc.
+copyright_email: support@chef.io
+license: Apache 2 license
+summary: Demonstrates the use of InSpec custom resources
+version: 1.0.0
+supports:
+  - linux

data/examples/resource/libraries/tiny.rb

@@ -0,0 +1,3 @@
+class Tiny < Inspec.resource(1)
+  name 'tiny'
+end

data/lib/inspec/dsl.rb

@@ -13,8 +13,21 @@ module Inspec::DSL
     ::Inspec::DSL.load_spec_files_for_profile self, id, true, &block
   end
 
-  alias_method :require_rules, :require_controls
-  alias_method :include_rules, :include_controls
+  alias require_rules require_controls
+  alias include_rules include_controls
+
+  def self.rule_from_check(m, a, b)
+    if a.is_a?(Array) && !a.empty? &&
+       a[0].respond_to?(:resource_skipped) &&
+       !a[0].resource_skipped.nil?
+      ::Inspec::Rule.__send__(m, *a) do
+        it a[0].resource_skipped
+      end
+    else
+      # execute the method
+      ::Inspec::Rule.__send__(m, *a, &b)
+    end
+  end
 
   # Register a given rule with RSpec and
   # let it run. This happens after everything
@@ -24,24 +37,11 @@ module Inspec::DSL
     fid = InspecBaseRule.full_id(r, profile_id)
     checks.each do |m, a, b|
       # check if the resource is skippable and skipped
-      if a.is_a?(Array) && !a.empty? &&
-         a[0].respond_to?(:resource_skipped) &&
-         !a[0].resource_skipped.nil?
-        cres = ::Inspec::Rule.__send__(m, *a) do
-          it a[0].resource_skipped
-        end
-      else
-        # execute the method
-        cres = ::Inspec::Rule.__send__(m, *a, &b)
-      end
-      if m == 'describe'
-        set_rspec_ids(cres, fid)
-      end
+      cres = rule_from_check(m, a, b)
+      set_rspec_ids(cres, fid) if m == 'describe'
     end
   end
 
-  private
-
   # merge two rules completely; all defined
   # fields from src will be overwritten in dst
   def self.merge_rules(dst, src)

data/lib/inspec/metadata.rb

@@ -35,14 +35,9 @@ module Inspec
     end
 
     def supports(sth, version = nil)
-      params[:supports] ||= []
-      params[:supports].push(
-        # do not use hash syntax for `-` to work properly with ruby 1.9.3 parser
-        {
-          :'os-name' => sth, # rubocop:disable Style/HashSyntax, Lint/UnneededDisable
-          version: version,
-        },
-      )
+      # Ignore supports with metadata.rb. This file is legacy and the way it
+      # it handles `supports` deprecated. A deprecation warning will be printed
+      # already.
     end
 
     def is_supported(os, entry)

data/lib/inspec/plugins/resource.rb

@@ -22,7 +22,7 @@ module Inspec
       end
 
       def self.__register(name, obj)
-        # rubocop:disable Lint/NestedMethodDefinition
+        # rubocop:disable Lint/NestedMethodDefinition, Lint/DuplicateMethods
         cl = Class.new(obj) do
           # add some common methods
           include Inspec::Plugins::ResourceCommon

data/lib/inspec/profile.rb

@@ -17,6 +17,7 @@ module Inspec
 
     attr_reader :params
     attr_reader :path
+    attr_reader :metadata
 
     def initialize(options = nil)
       @options = options || {}
@@ -104,7 +105,7 @@ module Inspec
       # check if the profile is using the old test directory instead of the
       # new controls directory
       if Pathname.new(path).join('test').exist? && !Pathname.new(path).join('controls').exist?
-        warn.call('Profile uses deprecated `test` directory, rename it to `controls`')
+        warn.call('Profile uses deprecated `test` directory, rename it to `controls`.')
       end
 
       count = rules_count
@@ -147,7 +148,7 @@ module Inspec
 
       profile_name = @params[:name]
 
-      opts[:zip] ? ext='zip' : ext='tar.gz'
+      ext = opts[:zip] ? 'zip' : 'tar.gz'
       slug = profile_name.downcase.strip.tr(' ', '-').gsub(/[^\w-]/, '_')
       archive = Pathname.new(File.dirname(__FILE__)).join('../..', "#{slug}.#{ext}")
 

data/lib/inspec/profile_context.rb

@@ -133,9 +133,9 @@ module Inspec
 
         alias_method :skip_rule, :skip_control
 
-        def only_if(&block)
+        def only_if
           return unless block_given?
-          @skip_profile = !block.call
+          @skip_profile = !yield
         end
       end
       # rubocop:enable all

data/lib/inspec/rule.rb

@@ -138,11 +138,11 @@ module Inspec
         rule.instance_variable_set(:@profile_id, profile_id)
         pid = profile_id
       end
-      if pid.nil? or pid.empty?
-        return rid
-      else
-        return "#{pid}/#{rid}"
-      end
+
+      # if we don't have a profile id, just return the rule's ID
+      return rid if pid.nil? or pid.empty?
+      # otherwise combine them
+      "#{pid}/#{rid}"
     end
 
     private
@@ -155,8 +155,8 @@ module Inspec
     def unindent(text)
       return '' if text.nil?
       text.strip.split("\n").map(&:strip)
-        .map { |x| x.empty? ? "\n" : x }
-        .join(' ')
+          .map { |x| x.empty? ? "\n" : x }
+          .join(' ')
     end
 
     # get the rule's source code

data/lib/inspec/shell.rb

@@ -89,10 +89,8 @@ You are currently running on:
 EOF
       elsif resource == 'resources'
         resources
-      else
-
-        if !Inspec::Resource.registry[resource].nil?
-          puts <<EOF
+      elsif !Inspec::Resource.registry[resource].nil?
+        puts <<EOF
 #{mark 'Name:'} #{resource}
 
 #{mark 'Description:'}
@@ -107,10 +105,9 @@ EOF
 https://github.com/chef/inspec/blob/master/docs/resources.rst##{resource}
 
 EOF
-        else
-          puts 'Only the following resources are available:'
-          resources
-        end
+      else
+        puts 'Only the following resources are available:'
+        resources
       end
     end
 

data/lib/inspec/targets/dir.rb

@@ -28,7 +28,7 @@ module Inspec::Targets
 
       def get_filenames(paths)
         paths.find_all do |path|
-          (path.start_with?('controls') || path.start_with?('test')) && path.end_with?('.rb')
+          path.start_with?('controls', 'test') && path.end_with?('.rb')
         end
       end
 

data/lib/inspec/targets/tar.rb

@@ -9,16 +9,13 @@ require 'inspec/targets/archive'
 module Inspec::Targets
   class TarHelper < ArchiveHelper
     def handles?(target)
-      File.file?(target) and (
-        target.end_with?('.tar.gz') ||
-        target.end_with?('.tgz')
-      )
+      File.file?(target) && target.end_with?('.tar.gz', '.tgz')
     end
 
     def structure(input)
       files = []
       rootdir = ''
-      Gem::Package::TarReader.new(Zlib::GzipReader.open input) do |tar|
+      Gem::Package::TarReader.new(Zlib::GzipReader.open(input)) do |tar|
         files = tar.map(&:full_name)
       end
 
@@ -35,7 +32,7 @@ module Inspec::Targets
 
     def content(input, files, rootdir = nil, opts = {})
       content = []
-      Gem::Package::TarReader.new(Zlib::GzipReader.open input) do |tar|
+      Gem::Package::TarReader.new(Zlib::GzipReader.open(input)) do |tar|
         tar.each do |entry|
           if entry.directory?
             # nothing to do

data/lib/inspec/targets/url.rb

@@ -17,11 +17,12 @@ module Inspec::Targets
 
     def resolve(target, opts = {})
       # abort if the target does not start with http or https
-      return nil unless target.start_with? 'https://' or target.start_with? 'http://'
+      return nil unless target.start_with?('https://', 'http://')
 
-      # support for github https url
-      if target.start_with? 'https://github.com' and target.end_with? '.git'
-        url = target.sub(/.git$/, '') + '/archive/master.tar.gz'
+      # support for github url
+      m = %r{^https?://(www\.)?github\.com/(?<user>[\w-]+)/(?<repo>[\w-]+)(\.git)?$}.match(target)
+      if m
+        url = "https://github.com/#{m[:user]}/#{m[:repo]}/archive/master.tar.gz"
       else
         url = target
       end
@@ -29,10 +30,10 @@ module Inspec::Targets
       resolve_zip(url, opts)
     end
 
-    def resolve_zip(url, opts)
-      archive = Tempfile.new(['inspec-dl-', '.tar.gz'])
+    # download url into archive using opts,
+    # returns File object and content-type from HTTP headers
+    def download_archive(url, archive, opts)
       archive.binmode
-
       remote = open(
         url,
         http_basic_authentication: [opts['user'] || '', opts['password'] || ''],
@@ -43,7 +44,12 @@ module Inspec::Targets
       archive.rewind
       archive.close
 
-      content_type = remote.meta['content-type']
+      [archive, remote.meta['content-type']]
+    end
+
+    def resolve_zip(url, opts)
+      archive, content_type = download_archive(url, Tempfile.new(['inspec-dl-', '.tar.gz']), opts)
+
       # replace extension with zip if we detected a zip content type
       if ['application/x-zip-compressed', 'application/zip'].include?(content_type)
         # rename file for proper detection in DirHelper
@@ -53,8 +59,8 @@ module Inspec::Targets
 
         content = ZipHelper.new.resolve(new_path)
         File.unlink(new_path)
-      # use tar helper as default
       elsif ['application/x-gzip', 'application/gzip'].include?(content_type)
+        # use tar helper as default (otherwise returns nil)
         content = TarHelper.new.resolve(archive.path)
         archive.unlink
       end

data/lib/inspec/targets/url.rb.orig

@@ -0,0 +1,87 @@
+# encoding: utf-8
+# author: Dominik Richter
+# author: Christoph Hartmann
+
+require 'uri'
+require 'tempfile'
+require 'open-uri'
+require 'inspec/targets/zip'
+
+module Inspec::Targets
+  class UrlHelper
+    def handles?(target)
+      uri = URI.parse(target)
+      return false if uri.nil? or uri.scheme.nil?
+      %{ http https }.include? uri.scheme
+    end
+
+    def resolve(target, opts = {})
+      # abort if the target does not start with http or https
+      return nil unless target.start_with?('https://', 'http://')
+
+<<<<<<< a4b7ba89cb8a1c4442908d7a5ca821b2b1617c87
+      # support for github url
+      m = %r{^https?://(www\.)?github\.com/(?<user>[\w-]+)/(?<repo>[\w-]+)(\.git)?$}.match(target)
+      if m
+        url = "https://github.com/#{m[:user]}/#{m[:repo]}/archive/master.tar.gz"
+      else
+        url = target
+      end
+=======
+      # support for github https url
+      url =
+        if target.start_with? 'https://github.com' and target.end_with? '.git'
+          target.sub(/.git$/, '') + '/archive/master.tar.gz'
+        else
+          target
+        end
+>>>>>>> lint
+
+      resolve_zip(url, opts)
+    end
+
+    # download url into archive using opts,
+    # returns File object and content-type from HTTP headers
+    def download_archive(url, archive, opts)
+      archive.binmode
+      remote = open(
+        url,
+        http_basic_authentication: [opts['user'] || '', opts['password'] || ''],
+      )
+
+      # download content
+      archive.write(remote.read)
+      archive.rewind
+      archive.close
+
+      [archive, remote.meta['content-type']]
+    end
+
+    def resolve_zip(url, opts)
+      archive, content_type = download_archive(url, Tempfile.new(['inspec-dl-', '.tar.gz']), opts)
+
+      # replace extension with zip if we detected a zip content type
+      if ['application/x-zip-compressed', 'application/zip'].include?(content_type)
+        # rename file for proper detection in DirHelper
+        pn = Pathname.new(archive.path)
+        new_path = pn.dirname.join(pn.basename.to_s.gsub('tar.gz', 'zip'))
+        File.rename(pn.to_s, new_path.to_s)
+
+        content = ZipHelper.new.resolve(new_path)
+        File.unlink(new_path)
+      elsif ['application/x-gzip', 'application/gzip'].include?(content_type)
+        # use tar helper as default (otherwise returns nil)
+        content = TarHelper.new.resolve(archive.path)
+        archive.unlink
+      end
+
+      content
+    end
+
+    def to_s
+      'URL Loader'
+    end
+  end
+
+  Inspec::Targets.add_module('url', UrlHelper.new)
+end