inspec 0.12.0 → 0.14.0

data/lib/inspec/targets.rb

@@ -1,10 +0,0 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-require 'inspec/targets/core'
-require 'inspec/targets/file'
-require 'inspec/targets/folder'
-require 'inspec/targets/url'
-require 'inspec/targets/zip'
-require 'inspec/targets/tar'

data/lib/inspec/targets/archive.rb

@@ -1,33 +0,0 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-require 'rubygems/package'
-require 'zlib'
-require 'inspec/targets/dir'
-
-module Inspec::Targets
-  class ArchiveHelper < DirsResolver
-    attr_reader :files
-
-    def initialize(target, _opts = {})
-      @target = target
-      files, @rootdir = structure(target)
-
-      # remove trailing slashes
-      files = files.collect { |f| f.chomp('/') }
-
-      # remove leading directory
-      root = Pathname(@rootdir)
-      @files = files.collect { |f|
-        Pathname(f).relative_path_from(root).to_s
-      }
-    end
-
-    def resolve(path, opts = {})
-      o = (opts || {})
-      o[:base_folder] = @target
-      content(@target, path, @rootdir, o)
-    end
-  end
-end

data/lib/inspec/targets/core.rb

@@ -1,56 +0,0 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-require 'utils/modulator'
-
-module Inspec
-  module Targets
-    extend Modulator
-
-    # Retrieve the resolver for a given target. Resolvers are any type of
-    # instance, that can take a target in the #resolve method, and turn
-    # it into raw InSpec code. It will actually retrieve all file's
-    # contents, including libraries and metadata.
-    #
-    # @param [any] target any target you are pointing to; typically a string
-    # @return [Inspec::Targets::*] the resolver handling this target
-    def self.find_resolver(target)
-      modules.values.find { |m| m.handles?(target) }
-    end
-
-    # Retrieve the target handler, i.e. the component that is going to handle
-    # all aspects of a given target. Unlike the resolver, this provides
-    # access to an object, that understands the target and is able to read
-    # all contents, while providing additional methods which InSpec itself
-    # does not care about (think: plugins).
-    #
-    # There is a special case, where you might be pointing to a URL containing
-    # a ZIP file which has a full InSpec Profile embedded. This will be
-    # resolved to a directory helper (Inspec::Targets::DirsResolver). This
-    # method will retrieve the right handler for this directory and provide it
-    # with full access all contents (i.e. the DirsResolver will be embedded).
-    #
-    # @param [any] target any target you are pointing to; typically a string
-    # @return [Inspec::Targets::*] the handler for this target
-    def self.find_handler(target)
-      resolver = find_resolver(target)
-      return resolver unless resolver.is_a?(Module) &&
-                             resolver.ancestors.include?(DirsResolver)
-      resolver.from_target(target).handler
-    end
-
-    # Turn targets into actionable InSpec code, library-data and metadata.
-    #
-    # @param [any] targets any targets you are pointing to; typically strings
-    # @param [Hash] additional options for loading
-    # @return [Array] an array of resolved data, with :content, :ref, :type
-    def self.resolve(targets, opts = {})
-      Array(targets).map do |target|
-        handler = find_resolver(target) ||
-                  fail("Don't know how to handle target: #{target}")
-        handler.resolve(target, opts)
-      end.flatten
-    end
-  end
-end

data/lib/inspec/targets/dir.rb

@@ -1,144 +0,0 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-module Inspec::Targets
-  # DirsHelper manages resolvers for directories. Wherever directories are,
-  # either a local folder, archive, or remote, this module provides all helpers
-  # than can resolve these.
-  #
-  # Resolvers provide these methods
-  # * handles?(paths)  =>  true if the resolver is responsible for this target
-  # * get_filenames    =>  Array[String] of files where tests/controls are found
-  # * get_metadata     =>  String path with metadata information [optional]
-  # * get_libraries    =>  Array[String] of library files [optional]
-  #
-  # Resolvers must register with this DirsHelper via #add_module .
-  module DirsHelper
-    extend Modulator
-
-    def self.get_handler(paths)
-      modules.values.reverse.find { |x| x.handles?(paths) }
-    end
-  end
-
-  # Base class for all directory resolvers. I.e. any target helper that
-  # takes a directory/archive/... and ultimately calls DirsHelper to resolve it.
-  #
-  # These resolvers must implement the required methods of this class.
-  class DirsResolver
-    def files
-      fail NotImplementedError, "Directory resolver #{self.class} must implement #files"
-    end
-
-    def resolve(_path)
-      fail NotImplementedError, "Directory resolver #{self.class} must implement #content"
-    end
-
-    def handler
-      DirsHelper.get_handler(files) ||
-        fail("Don't know how to handle #{self}")
-    end
-
-    def self.from_target(target)
-      new(target)
-    end
-
-    def self.resolve(target, opts)
-      r = new(target, opts)
-      handler = r.handler
-      files = r.files
-
-      res = []
-      {
-        test:     __collect(handler, :get_filenames, files),
-        library:  __collect(handler, :get_libraries, files),
-        metadata: __collect(handler, :get_metadata, files),
-      }.each do |as, list|
-        Array(list).each { |path|
-          res.push(r.resolve(path, as: as))
-        }
-      end
-
-      return handler.resolve_contents(res) if handler.respond_to?(:resolve_contents)
-      res
-    end
-
-    def self.__collect(handler, getter, files)
-      return [] unless handler.respond_to? getter
-      handler.method(getter).call(files)
-    end
-  end
-
-  # InSpec profile Loader
-  # Previous versions used the `test` directory instead of the new `controls`
-  # directory. Usage of the test directory is deprecated and not recommended
-  # anymore. Support for `test` will be removed in InSpec 1.0
-  # TODO: remove `test` support for InSpec 1.0
-  class ProfileDir
-    def handles?(paths)
-      return true if paths.include?('inspec.yml')
-      (
-        !paths.grep(/^controls/).empty? ||
-        !paths.grep(/^test/).empty?
-      ) && paths.include?('metadata.rb')
-    end
-
-    def get_libraries(paths)
-      paths.find_all do |path|
-        path.start_with?('libraries') && path.end_with?('.rb')
-      end
-    end
-
-    def get_filenames(paths)
-      paths.find_all do |path|
-        path.start_with?('controls', 'test') && path.end_with?('.rb')
-      end
-    end
-
-    def get_metadata(paths)
-      return 'inspec.yml' if paths.include?('inspec.yml')
-      return 'metadata.rb' if paths.include?('metadata.rb')
-    end
-  end
-  DirsHelper.add_module('inspec-profile', ProfileDir.new)
-
-  class ChefAuditDir
-    def handles?(paths)
-      paths.include?('recipes') and paths.include?('metadata.rb')
-    end
-
-    def get_filenames(paths)
-      paths.find_all do |x|
-        x.start_with? 'recipes/' and x.end_with? '.rb'
-      end
-    end
-  end
-  DirsHelper.add_module('chef-cookbook', ChefAuditDir.new)
-
-  class ServerspecDir
-    def handles?(paths)
-      paths.include?('spec')
-    end
-
-    def get_filenames(paths)
-      paths.find_all do |path|
-        path.start_with? 'spec' and path.end_with? '_spec.rb'
-      end
-    end
-  end
-  DirsHelper.add_module('serverspec-folder', ServerspecDir.new)
-
-  class FlatDir
-    def handles?(paths)
-      get_filenames(paths).empty? == false
-    end
-
-    def get_filenames(paths)
-      # TODO: eventually remove the metadata.rb exception here
-      # when we have fully phased out metadata.rb in 1.0
-      paths.find_all { |x| x.end_with?('.rb') && !x.include?('/') && x != 'metadata.rb' }
-    end
-  end
-  DirsHelper.add_module('flat-ruby-folder', FlatDir.new)
-end

data/lib/inspec/targets/file.rb

@@ -1,33 +0,0 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-module Inspec::Targets
-  class FileHelper
-    def handles?(target)
-      File.file?(target) and target.end_with?('.rb')
-    end
-
-    def resolve(target, opts = {})
-      base = opts[:base_folder]
-      path = base.nil? ? target : File.join(base, target)
-      {
-        content: File.read(path),
-        type: opts[:as] || :test,
-        ref: path,
-      }
-    end
-
-    def resolve_all(targets, opts = {})
-      Array(targets).map do |target|
-        resolve(target, opts)
-      end
-    end
-
-    def to_s
-      'File Loader'
-    end
-  end
-
-  Inspec::Targets.add_module('file', FileHelper.new)
-end

data/lib/inspec/targets/folder.rb

@@ -1,38 +0,0 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-require 'inspec/targets/dir'
-require 'inspec/targets/file'
-
-module Inspec::Targets
-  class FolderHelper < DirsResolver
-    def self.handles?(target)
-      File.directory?(target)
-    end
-
-    attr_reader :files
-
-    def initialize(target, _opts = {})
-      @base_folder = target
-      # find all files in the folder
-      files = Dir[File.join(target, '**', '*')]
-      # remove the prefix
-      prefix = File.join(target, '')
-      @files = files.map { |x| x.sub(prefix, '') }
-      @file_handler = Inspec::Targets.modules['file']
-    end
-
-    def resolve(path, opts = {})
-      o = (opts || {})
-      o[:base_folder] = @base_folder
-      @file_handler.resolve(path, o)
-    end
-
-    def to_s
-      'Folder Loader'
-    end
-  end
-
-  Inspec::Targets.add_module('folder', FolderHelper)
-end

data/lib/inspec/targets/tar.rb

@@ -1,61 +0,0 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-require 'rubygems/package'
-require 'zlib'
-require 'inspec/targets/archive'
-
-module Inspec::Targets
-  class TarHelper < ArchiveHelper
-    def self.handles?(target)
-      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|
-        files = tar.map(&:full_name)
-      end
-
-      # find root dir of profile
-      files.each { |f|
-        pn = Pathname(f)
-        rootdir = pn.dirname.to_s if pn.basename.to_s == 'inspec.yml' || pn.basename.to_s == 'metadata.rb'
-      }
-
-      # stores the rootdir of metadata.rb or inspec.yml
-      rootdir += '/' if !rootdir.empty?
-      [files, rootdir]
-    end
-
-    def content(input, path, rootdir = nil, opts = {})
-      content = nil
-      Gem::Package::TarReader.new(Zlib::GzipReader.open(input)) do |tar|
-        tar.each do |entry|
-          if entry.directory?
-            # nothing to do
-          elsif entry.file?
-            next unless path == entry.full_name.gsub(rootdir, '')
-            content = {
-              # NB if some file is empty, return empty-string, not nil
-              content: entry.read || '',
-              type: opts[:as] || :test,
-              ref: entry.full_name,
-            }
-          elsif entry.header.typeflag == '2'
-            # ignore symlinks for now
-          end
-        end
-      end
-      content
-    end
-
-    def to_s
-      'tar.gz Loader'
-    end
-  end
-
-  Inspec::Targets.add_module('tar', TarHelper)
-end

data/lib/inspec/targets/url.rb

@@ -1,78 +0,0 @@
-# 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
-    rescue URI::Error => _e
-      false
-    end
-
-    def resolve(target, opts = {})
-      # abort if the target does not start with http or https
-      return nil unless target.start_with?('https://', 'http://')
-
-      # 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
-      resolve_archive(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_archive(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