inspec 0.23 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8531472157b9bbcf1f5cfae47afb58e26768955d
-  data.tar.gz: e11d0a1081f017dedb9a5c207790d6c599286058
+  metadata.gz: cdee2bef2b5cae85b1427243ae5013641ec00de9
+  data.tar.gz: ff0b32c16345ee013475a10254c52afc1780e49e
 SHA512:
-  metadata.gz: ba616285cc0d78bd09a257367933ec1b16ce53c4ef8db770cf5a8a3885ff7fd885589d1b568982bfa0d5fe76d30cacebece6f40622a9e6d66e116759b608b0ad
-  data.tar.gz: 91e3dfc02e260cef1c4d0b518717b40c6068b225748bb8a26f263a709cfd4ea9d60ec5d9e52fcd11e608a31dafe389888ab94cb15ff3838edaef6030693364cd
+  metadata.gz: 0e54f5100590735780ec9815a570f7171c3297a2747c9dbd7c40d7c8fe099acd36000ee74cd05e1269ea4ebb2b06276dc46f0c551547da2a3060b7aa861d7cb3
+  data.tar.gz: eb40755a53b7e4f9d5fa264b92a778829833835ca77d81a8ba91b59fb0b057f6a7981a47ab87336832bed17b691c2b13d70594a83c83d08a83f1b1770ed75716

data/CHANGELOG.md

@@ -1,7 +1,18 @@
 # Change Log
 
-## [0.23](https://github.com/chef/inspec/tree/0.23) (2016-05-31)
-[Full Changelog](https://github.com/chef/inspec/compare/v0.22.1...0.23)
+## [0.24.0](https://github.com/chef/inspec/tree/0.24.0) (2016-06-03)
+[Full Changelog](https://github.com/chef/inspec/compare/v0.23...0.24.0)
+
+**Implemented enhancements:**
+
+- support intra-libraries file referencing + loading [\#780](https://github.com/chef/inspec/pull/780) ([arlimus](https://github.com/arlimus))
+
+**Merged pull requests:**
+
+- Update documentation for matching output of commands [\#777](https://github.com/chef/inspec/pull/777) ([tas50](https://github.com/tas50))
+
+## [v0.23](https://github.com/chef/inspec/tree/v0.23) (2016-05-31)
+[Full Changelog](https://github.com/chef/inspec/compare/v0.22.1...v0.23)
 
 **Implemented enhancements:**
 

data/docs/resources.rst

@@ -628,7 +628,7 @@ The ``stdout`` matcher tests results of the command as returned in standard outp
 
 .. code-block:: ruby
 
-   its('stdout') { should eq '/^1$/' }
+   its('stdout') { should match /^1$/ }
 
 Examples
 -----------------------------------------------------
@@ -639,9 +639,9 @@ The following examples show how to use this InSpec audit resource.
 .. code-block:: ruby
 
    describe command('psql -V') do
-     its('stdout') { should eq '/RC/' }
-     its('stdout') { should_not eq '/DEVEL/' }
-     its('stdout') { should_not eq '/BETA/' }
+     its('stdout') { should match /RC/ }
+     its('stdout') { should_not match /DEVEL/ }
+     its('stdout') { should_not match /BETA/ }
    end
 
 **Test standard output (stdout)**

data/lib/inspec/profile_context.rb

@@ -4,6 +4,7 @@
 
 require 'inspec/rule'
 require 'inspec/dsl'
+require 'inspec/require_loader'
 require 'securerandom'
 
 module Inspec
@@ -19,6 +20,7 @@ module Inspec
       @backend = backend
       @conf = conf.dup
       @rules = {}
+      @require_loader = ::Inspec::RequireLoader.new
 
       reload_dsl
     end
@@ -26,7 +28,30 @@ module Inspec
     def reload_dsl
       resources_dsl = Inspec::Resource.create_dsl(@backend)
       ctx = create_context(resources_dsl, rule_context(resources_dsl))
-      @profile_context = ctx.new(@backend, @conf)
+      @profile_context = ctx.new(@backend, @conf, @require_loader)
+    end
+
+    def load_libraries(libs)
+      lib_prefix = 'libraries' + File::SEPARATOR
+      autoloads = []
+
+      libs.each do |content, source, line|
+        path = source
+        if source.start_with?(lib_prefix)
+          path = source.sub(lib_prefix, '')
+          autoloads.push(path) if File.dirname(path) == '.'
+        end
+
+        @require_loader.add(path, content, source, line)
+      end
+
+      # load all files directly that are flat inside the libraries folder
+      autoloads.each do |path|
+        next unless path.end_with?('.rb')
+        load(*@require_loader.load(path)) unless @require_loader.loaded?(path)
+      end
+
+      reload_dsl
     end
 
     def load(content, source = nil, line = nil)
@@ -100,12 +125,29 @@ module Inspec
         include Inspec::DSL
         include resources_dsl
 
-        def initialize(backend, conf) # rubocop:disable Lint/NestedMethodDefinition, Lint/DuplicateMethods
+        def initialize(backend, conf, require_loader) # rubocop:disable Lint/NestedMethodDefinition, Lint/DuplicateMethods
           @backend = backend
           @conf = conf
+          @require_loader = require_loader
           @skip_profile = false
         end
 
+        # Save the toplevel require method to load all ruby dependencies.
+        # It is used whenever the `require 'lib'` is not in libraries.
+        alias_method :__ruby_require, :require
+
+        def require(path)
+          rbpath = path + '.rb'
+          return __ruby_require(path) if !@require_loader.exists?(rbpath)
+          return false if @require_loader.loaded?(rbpath)
+
+          # This is equivalent to calling `require 'lib'` with lib on disk.
+          # We cannot rely on libraries residing on disk however.
+          # TODO: Sandboxing.
+          content, path, line = @require_loader.load(rbpath)
+          eval(content, TOPLEVEL_BINDING, path, line) # rubocop:disable Lint/Eval
+        end
+
         define_method :title do |arg|
           profile_context_owner.set_header(:title, arg)
         end

data/lib/inspec/require_loader.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+# author: Dominik Richter
+# author: Christoph Hartmann
+
+module Inspec
+  class RequireLoader
+    Item = Struct.new(:content, :ref, :line, :loaded)
+
+    def initialize
+      @contents = {}
+    end
+
+    def add(path, content, ref, line)
+      @contents[path] = Item.new(content, ref, line, false)
+    end
+
+    def load(path)
+      c = @contents[path]
+      c.loaded = true
+      res = [c.content, c.ref, c.line || 1]
+      yield res if block_given?
+      res
+    end
+
+    def exists?(path)
+      @contents.key?(path)
+    end
+
+    def loaded?(path)
+      @contents[path].loaded == true
+    end
+  end
+end

data/lib/inspec/runner.rb

@@ -99,10 +99,7 @@ module Inspec
 
       # load all libraries
       ctx = create_context(options)
-      libs.each do |lib|
-        ctx.load(lib[:content].to_s, lib[:ref], lib[:line] || 1)
-        ctx.reload_dsl
-      end
+      ctx.load_libraries(libs.map { |x| [x[:content], x[:ref], x[:line]] })
 
       # hand the context to the profile for further evaluation
       unless (profile = options['profile']).nil?

data/lib/inspec/version.rb

@@ -3,5 +3,5 @@
 # author: Christoph Hartmann
 
 module Inspec
-  VERSION = '0.23'.freeze
+  VERSION = '0.24.0'.freeze
 end

data/lib/utils/hash_map.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+# author: Dominik Richter
+# author: Christoph Hartmann
+
+class HashMap
+  class << self
+    def [](hash, *keys)
+      return hash if keys.empty? || hash.nil?
+      key = keys.shift
+      if hash.is_a?(Array)
+        map = hash.map { |i| [i, key] }
+      else
+        map = hash[key]
+      end
+      [map, *keys]
+    rescue NoMethodError => _
+      nil
+    end
+  end
+end
+
+class StringMap
+  class << self
+    def [](hash, *keys)
+      return hash if keys.empty? || hash.nil?
+      key = keys.shift
+      if hash.is_a?(Array)
+        map = hash.map { |i| [i, key] }
+      else
+        map = hash[key]
+      end
+      [map, *keys]
+    rescue NoMethodError => _
+      nil
+    end
+  end
+end

data/test/functional/inspec_exec_test.rb

@@ -105,4 +105,12 @@ describe 'inspec exec' do
       out.stderr.must_equal "This profile requires InSpec version >= 99.0.0. You are running InSpec v#{Inspec::VERSION}.\n"
     end
   end
+
+  describe 'with a profile that loads a library and reference' do
+    let(:out) { inspec('exec ' + File.join(profile_path, 'library')) }
+
+    it 'executes the profile without error' do
+      out.exit_status.must_equal 0
+    end
+  end
 end

data/test/unit/mock/profiles/library/controls/filesystem_spec.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+# copyright: 2015, Chef Software, Inc
+# license: All rights reserved
+ 
+describe gordon do
+  it { should be_enabled }
+end

data/test/unit/mock/profiles/library/inspec.yml

@@ -0,0 +1,10 @@
+name: complete
+title: complete example profile
+maintainer: Chef Software, Inc.
+copyright: Chef Software, Inc.
+copyright_email: support@chef.io
+license: Proprietary, All rights reserved
+summary: Testing stub
+version: 1.0.0
+supports:
+- os-family: linux

data/test/unit/mock/profiles/library/libraries/gordonlib.rb

@@ -0,0 +1,2 @@
+module GordonLib
+end

data/test/unit/mock/profiles/library/libraries/testlib.rb

@@ -0,0 +1,12 @@
+# Library resource
+
+require 'gordonlib'
+require 'hashie'
+
+class Gordon < Inspec.resource(1)
+  name 'gordon'
+  include GordonLib
+  def enabled?
+    true
+  end
+end

data/test/unit/mock/profiles/resource-tiny/inspec.yml

@@ -0,0 +1,10 @@
+name: complete
+title: complete example profile
+maintainer: Chef Software, Inc.
+copyright: Chef Software, Inc.
+copyright_email: support@chef.io
+license: Proprietary, All rights reserved
+summary: Testing stub
+version: 1.0.0
+supports:
+- os-family: linux

data/test/unit/mock/profiles/resource-tiny/libraries/resource.rb

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

data/test/unit/profile_context_test.rb

@@ -307,4 +307,39 @@ describe Inspec::ProfileContext do
       end
     end
   end
+
+  describe 'library loading' do
+    it 'supports simple ruby require statements' do
+      # Please note: we do discourage the use of Gems in inspec resources at
+      # this time. Resources should be well packaged whenever possible.
+      proc { profile.load('Net::POP3') }.must_raise NameError
+      profile.load_libraries([['require "net/pop"', 'libraries/a.rb']])
+      profile.load('Net::POP3').to_s.must_equal 'Net::POP3'
+    end
+
+    it 'supports loading across the library' do
+      profile.load_libraries([
+        ["require 'a'\nA", 'libraries/b.rb'],
+        ['module A; end', 'libraries/a.rb']
+      ])
+      profile.load('A').to_s.must_equal 'A'
+    end
+
+    it 'fails loading if reference error occur' do
+      proc {
+        profile.load_libraries([
+          ["require 'a'\nB", 'libraries/b.rb'],
+          ['module A; end', 'libraries/a.rb']
+        ])
+      }.must_raise NameError
+    end
+
+    it 'fails loading if a reference dependency isnt found' do
+      proc {
+        profile.load_libraries([
+          ["require 'a'\nA", 'libraries/b.rb'],
+        ])
+      }.must_raise LoadError
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inspec
 version: !ruby/object:Gem::Version
-  version: '0.23'
+  version: 0.24.0
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-31 00:00:00.000000000 Z
+date: 2016-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: r-train
@@ -282,6 +282,7 @@ files:
 - lib/inspec/polyfill.rb
 - lib/inspec/profile.rb
 - lib/inspec/profile_context.rb
+- lib/inspec/require_loader.rb
 - lib/inspec/resource.rb
 - lib/inspec/rspec_json_formatter.rb
 - lib/inspec/rule.rb
@@ -359,6 +360,7 @@ files:
 - lib/utils/filter_array.rb
 - lib/utils/find_files.rb
 - lib/utils/hash.rb
+- lib/utils/hash_map.rb
 - lib/utils/json_log.rb
 - lib/utils/modulator.rb
 - lib/utils/object_traversal.rb
@@ -551,6 +553,12 @@ files:
 - test/unit/mock/profiles/legacy-empty-metadata/metadata.rb
 - test/unit/mock/profiles/legacy-simple-metadata/metadata.rb
 - test/unit/mock/profiles/legacy-simple-metadata/test/.gitkeep
+- test/unit/mock/profiles/library/controls/filesystem_spec.rb
+- test/unit/mock/profiles/library/inspec.yml
+- test/unit/mock/profiles/library/libraries/gordonlib.rb
+- test/unit/mock/profiles/library/libraries/testlib.rb
+- test/unit/mock/profiles/resource-tiny/inspec.yml
+- test/unit/mock/profiles/resource-tiny/libraries/resource.rb
 - test/unit/mock/profiles/simple-metadata/inspec.yml
 - test/unit/mock/profiles/skippy-profile-os/controls/one.rb
 - test/unit/mock/profiles/skippy-profile-os/inspec.yml
@@ -639,7 +647,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Infrastructure and compliance testing.
@@ -829,6 +837,12 @@ test_files:
 - test/unit/mock/profiles/legacy-empty-metadata/metadata.rb
 - test/unit/mock/profiles/legacy-simple-metadata/metadata.rb
 - test/unit/mock/profiles/legacy-simple-metadata/test/.gitkeep
+- test/unit/mock/profiles/library/controls/filesystem_spec.rb
+- test/unit/mock/profiles/library/inspec.yml
+- test/unit/mock/profiles/library/libraries/gordonlib.rb
+- test/unit/mock/profiles/library/libraries/testlib.rb
+- test/unit/mock/profiles/resource-tiny/inspec.yml
+- test/unit/mock/profiles/resource-tiny/libraries/resource.rb
 - test/unit/mock/profiles/simple-metadata/inspec.yml
 - test/unit/mock/profiles/skippy-profile-os/controls/one.rb
 - test/unit/mock/profiles/skippy-profile-os/inspec.yml