mitre-inspec-objects 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d65c4605033c4239780e56b8a9084d8f7fa9cdb2a971ba9062b9657a788949a
+  data.tar.gz: 226d6194461b806d249dbc188bc1cda532973f60c06d53dd0c1a5c75558a5f5f
+SHA512:
+  metadata.gz: 289530d31dd264f8b2339f09b8ea55858d644fd91cb48420ff4b9e269a2566b726aaee50e6849428b5f2c8fc23ec35cb240d486b6f428868dc83d4cb0918a7d8
+  data.tar.gz: 2468c9a73f7f5bfa729fe0b6b8b2d96a62ebfa1d99e122976d070ce716a41de3839eba843c171de27fab5c985087d5b04a7300a485cd8df2c9e1315318594ed8

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "mitre-inspec-objects", path: "."
+
+group :test do
+  gem "chef-utils", "~> 16.6.14"
+  gem "chefstyle", "0.13.0"
+  gem "minitest", "~> 5.5"
+  gem "rake", ">= 10"
+end

data/README.md

@@ -0,0 +1,16 @@
+# inspec-objects
+[![Gem Version](https://badge.fury.io/rb/mitre-inspec-objects.svg)](https://badge.fury.io/rb/mitre-inspec-objects)
+
+**Umbrella Project**: [InSpec](https://github.com/chef/chef-oss-practices/blob/master/projects/inspec.md)
+
+**Project State**: [Maintained](https://github.com/chef/chef-oss-practices/blob/master/repo-management/repo-states.md#maintained)
+
+**Issues [Response Time Maximum](https://github.com/chef/chef-oss-practices/blob/master/repo-management/repo-states.md)**: None
+
+**Pull Request [Response Time Maximum](https://github.com/chef/chef-oss-practices/blob/master/repo-management/repo-states.md)**: None
+
+These classes were migrated out of InSpec, specifically [inspec/lib/objects](https://github.com/inspec/inspec/tree/master/lib/inspec/objects).
+
+InSpec does not uses these classes directly. They can be used to programmatically create InSpec profiles.
+
+No further documentation or support is available.

data/lib/inspec/objects/control.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Inspec::Object
+  class Control
+    attr_accessor :header, :id, :title, :descriptions, :impact, :tests, :post_body, :tags, :refs, :only_if
+    def initialize
+      @header = ""
+      @tests = []
+      @tags = []
+      @refs = []
+      @descriptions = {}
+      @post_body = ""
+    end
+
+    def add_header(header)
+      @header = header
+    end
+
+    def add_test(t)
+      @tests.push(t)
+    end
+
+    def add_tag(t)
+      @tags.push(t)
+    end
+
+    def add_post_body(post_body)
+      @post_body = post_body
+    end
+
+    def to_hash
+      {
+        header: header,
+        id: id,
+        title: title,
+        descriptions: descriptions,
+        impact: impact,
+        tests: tests.map(&:to_hash),
+        tags: tags.map(&:to_hash),
+        post_body: post_body,
+      }
+    end
+
+    def to_ruby
+      res = []
+      res.push header unless header.nil? || header.empty?
+      res.push "control #{id.inspect} do"
+      res.push "  title #{title.inspect}" unless title.to_s.empty?
+      descriptions.each do |label, text|
+        if label == :default
+          next if text.nil? || (text == "") # don't render empty/nil desc
+
+          res.push "  desc  #{prettyprint_text(text, 2)}"
+        else
+          res.push "  desc  #{label.to_s.inspect}, #{prettyprint_text(text, 2)}"
+        end
+      end
+      res.push "  impact #{impact}" unless impact.nil?
+      tags.each { |t| res.push(indent(t.to_ruby, 2)) }
+      refs.each { |t| res.push("  ref   #{print_ref(t)}") }
+      res.push "  only_if { #{only_if} }" if only_if
+      tests.each { |t| res.push(indent(t.to_ruby, 2)) }
+      res.push(indent(post_body, 2)) unless post_body.nil? || post_body.empty?
+      res.push "end"
+      res.join("\n")
+    end
+
+    private
+
+    def print_ref(x)
+      return x.inspect if x.is_a?(String)
+      raise "Cannot process the ref: #{x}" unless x.is_a?(Hash)
+
+      "(" + x.inspect + ")"
+    end
+
+    # Pretty-print a text block of InSpec code
+    #
+    # @param s [String] should not be empty
+    # @param depth [Int] indentation length for multiline text blocks
+    # @return [String] pretty-printed textblock
+    def prettyprint_text(s, depth)
+      txt = s.to_s.inspect.gsub('\n', "\n")
+      return txt unless txt.include?("\n")
+
+      middle = indent(txt[1..-2], depth + 2)
+      txt[0] + "\n" + middle + "\n" + " " * depth + txt[-1]
+    end
+
+    def indent(txt, d)
+      dt = " " * d
+      dt + txt.gsub("\n", "\n" + dt)
+    end
+  end
+end

data/lib/inspec/objects/describe.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Inspec::Object
+  class Describe
+    # Internal helper to structure test objects.
+    # Should not be exposed to the user as it is hidden behind
+    # `add_test`, `to_hash`, and `to_ruby` in Inspec::Object::Describe
+    Test = Struct.new(:its, :matcher, :expectation, :negated) do
+      def negate!
+        self.negated = !negated
+      end
+
+      def to_ruby
+        itsy = "it"
+        unless its.nil?
+          itsy = if its.is_a? Array
+                   "its(" + its.inspect + ")"
+                 else
+                   "its(" + its.to_s.inspect + ")"
+                 end
+        end
+        naughty = negated ? "_not" : ""
+        xpect = if expectation.nil?
+                  ""
+                elsif expectation.class == Regexp
+                  # without this, xpect values like / \/zones\// will not be parsed properly
+                  "(#{expectation.inspect})"
+                else
+                  " " + expectation.inspect
+                end
+        format("%s { should%s %s%s }", itsy, naughty, matcher, xpect)
+      end
+    end
+
+    # A qualifier describing the resource that will be tested. It may consist
+    # of the resource identification and multiple accessors to pinpoint the data
+    # the user wants to test.
+    attr_accessor :qualifier
+
+    # An array of individual tests for the qualifier. Every entry will be
+    # translated into an `it` or `its` clause.
+    attr_accessor :tests
+
+    # Optional variables which are used by tests.
+    attr_accessor :variables
+
+    # Optional method to skip this describe block altogether. If `skip` is
+    # defined it takes precendence and will print the skip statement instead
+    # of adding other tests.
+    attr_accessor :skip
+
+    include RubyHelper
+
+    def initialize
+      @qualifier = []
+      @tests = []
+      @variables = []
+    end
+
+    def add_test(its, matcher, expectation, opts = {})
+      test = Inspec::Object::Describe::Test.new(its, matcher, expectation, opts[:negated])
+      tests.push(test)
+      test
+    end
+
+    def to_ruby
+      return rb_skip unless skip.nil?
+
+      rb_describe
+    end
+
+    def to_hash
+      { qualifier: qualifier, tests: tests.map(&:to_h), variables: variables, skip: skip }
+    end
+
+    def resource
+      return if qualifier.empty? || qualifier[0].empty? || qualifier[0][0].empty?
+
+      qualifier[0][0]
+    end
+
+    private
+
+    def rb_describe
+      vars = variables.map(&:to_ruby).join("\n")
+      vars += "\n" unless vars.empty?
+
+      objarr = @qualifier
+      objarr = [["unknown object".inspect]] if objarr.nil? || objarr.empty?
+      obj = objarr.map { |q| ruby_qualifier(q) }.join(".")
+
+      rbtests = tests.map(&:to_ruby).join("\n  ")
+      format("%sdescribe %s do\n  %s\nend", vars, obj, rbtests)
+    end
+
+    def rb_skip
+      obj = @qualifier || skip.inspect
+      format("describe %s do\n  skip %s\nend", obj, skip.inspect)
+    end
+  end
+end

data/lib/inspec/objects/each_loop.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Inspec::Object
+  class EachLoop < List
+    attr_reader :variables
+    attr_accessor :tests
+    def initialize
+      super
+      @tests = []
+      @variables = []
+    end
+
+    def add_test(t = nil)
+      t ||= Test.new
+      t.qualifier[0] = ["entry"]
+      @tests.push(t)
+      t
+    end
+
+    def negate!
+      @tests.each(&:negate!)
+    end
+
+    def to_hash
+      { qualifier: qualifier, test: @test }
+    end
+
+    def to_ruby
+      vars = variables.map(&:to_ruby).join("\n")
+      vars += "\n" unless vars.empty?
+      obj = super
+      all_tests = @tests.map(&:to_ruby).join("\n").gsub("\n", "\n  ")
+      format("%s%s.each do |entry|\n  %s\nend", vars, obj, all_tests)
+    end
+  end
+end

data/lib/inspec/objects/header.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Inspec::Object
+  class Header
+    attr_accessor :header
+
+    def initialize(header)
+      @header = header
+    end
+
+    def to_hash
+      {
+        header: header,
+      }
+    end
+
+    def to_ruby
+      header.inspect.to_s
+    end
+
+    def to_s
+      "Header #{header}"
+    end
+  end
+end

data/lib/inspec/objects/input.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "inspec/input"
+
+module Inspec::Object
+  class Input < ::Inspec::Input
+    # NOTE: No initialize method or accessors for the reasons listed above
+
+    #--------------------------------------------------------------------------#
+    #                               Marshalling
+    #--------------------------------------------------------------------------#
+
+    def to_hash
+      as_hash = { name: name, options: {} }
+      %i{description title identifier type required value}.each do |field|
+        val = send(field)
+        next if val.nil?
+
+        as_hash[:options][field] = val
+      end
+      as_hash
+    end
+
+    def ruby_var_identifier
+      identifier || "attr_" + name.downcase.strip.gsub(/\s+/, "-").gsub(/[^\w-]/, "")
+    end
+
+    def to_ruby
+      res = ["#{ruby_var_identifier} = attribute('#{name}',{"]
+      res.push "  title: '#{title}'," unless title.to_s.empty?
+      res.push "  value: #{value.inspect}," unless value.to_s.empty?
+      # to_ruby may generate code that is to be used by older versions of inspec.
+      # Anything older than 3.4 will not recognize the value: option, so
+      # send the default: option as well. See #3759
+      res.push "  default: #{value.inspect}," unless value.to_s.empty?
+      res.push "  description: '#{description}'," unless description.to_s.empty?
+      res.push "})"
+      res.join("\n")
+    end
+  end
+end

data/lib/inspec/objects/list.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Inspec::Object
+  class List < Value
+    def map
+      raise "Inspec::Object::List.map needs to be called with a block" unless block_given?
+
+      t = List.new
+      t.qualifier = [["x"]]
+      yield(t)
+      return if t.qualifier == [["x"]]
+
+      @qualifier.push(["map", "{ |x| #{t.to_ruby} }"])
+      self
+    end
+  end
+end

data/lib/inspec/objects/or_test.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Inspec::Object
+  class OrTest
+    attr_reader :tests
+    def initialize(tests)
+      @tests = tests
+      @negated = false
+    end
+
+    def skip
+      nil
+    end
+
+    def negate!
+      @negated = !@negated
+    end
+
+    def to_ruby
+      if @negated
+        # We don't use the describe.one wrapper when negated because:
+        # !(test1 || test2)     same as    (!test1 && !test2)    where && is implicit in inspec
+        @tests.map do |test|
+          test.negate!
+          test
+        end.map(&:to_ruby).join("\n")
+
+      else
+        all_tests = @tests.map(&:to_ruby).join("\n").gsub("\n", "\n  ")
+
+        format("describe.one do\n  %s\nend", all_tests)
+      end
+    end
+
+    def to_hash
+      { describe_one: @tests.map(&:to_hash) }
+    end
+  end
+end

data/lib/inspec/objects/post_body.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Inspec::Object
+  class PostBody
+    attr_accessor :post_body
+
+    def initialize(post_body)
+      @post_body = post_body
+    end
+
+    def to_hash
+      {
+        post_body: post_body,
+      }
+    end
+
+    def to_ruby
+      post_body.inspect.to_s
+    end
+
+    def to_s
+      "Post Body #{post_body}"
+    end
+  end
+end

data/lib/inspec/objects/ruby_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Inspec::Object
+  module RubyHelper
+    def ruby_qualifier(q)
+      if q.length <= 1
+        q[0]
+      elsif q[0] == "map" && q.length == 2
+        q[0] + " " + q[1]
+      else
+        q[0] + "(" + q[1..-1].map(&:inspect).join(", ") + ")"
+      end
+    end
+  end
+end

data/lib/inspec/objects/tag.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Inspec::Object
+  class Tag
+    attr_accessor :key, :value
+
+    def initialize(key, value)
+      @key = key
+      @value = value
+    end
+
+    def to_hash
+      {
+        name: key,
+        value: value,
+      }
+    end
+
+    def to_ruby
+      "tag #{key}: #{value.inspect}"
+    end
+
+    def to_s
+      "Tag #{key} with #{value}"
+    end
+  end
+end

data/lib/inspec/objects/test.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Inspec::Object
+  class Test
+    attr_accessor :qualifier, :matcher, :expectation, :skip, :negated, :variables, :only_if
+    include RubyHelper
+
+    def initialize
+      @qualifier = []
+      @negated = false
+      @variables = []
+    end
+
+    def negate!
+      @negated = !@negated
+    end
+
+    def to_ruby
+      return rb_skip unless skip.nil?
+
+      rb_describe
+    end
+
+    def to_hash
+      { qualifier: qualifier, matcher: matcher, expectation: expectation, skip: skip, negated: negated }
+    end
+
+    def resource
+      @resource ||=
+        if qualifier.empty? || qualifier[0].empty? || qualifier[0][0].empty?
+          nil
+        else
+          qualifier[0][0]
+        end
+    end
+
+    def remove_expectation
+      remove_instance_variable(:@expectation)
+    end
+
+    private
+
+    def describe_chain
+      return if @qualifier.empty?
+
+      resource = @qualifier.length > 1 ? @qualifier[0..-2] : [@qualifier[0]]
+      res = resource.map { |q| ruby_qualifier(q) }.join(".")
+      xres = nil
+
+      if @qualifier.length > 1
+        last = @qualifier[-1]
+        last_call = last.is_a?(Array) ? last[0].to_s : ""
+        if last.length == 1 && last_call !~ /^to_.$/ && !last_call.include?("[") && !last_call.empty?
+          # this will go in its()
+          xres = last_call
+        else
+          res += "." + ruby_qualifier(last) unless last_call.empty?
+        end
+      end
+
+      [res, xres]
+    end
+
+    def rb_describe
+      only_if_clause = "only_if { #{only_if} }\n" if only_if
+      vars = variables.map(&:to_ruby).join("\n")
+      vars += "\n" unless vars.empty?
+      res, xtra = describe_chain
+      itsy = xtra.nil? ? "it" : "its(" + xtra.to_s.inspect + ")"
+      naughty = @negated ? "_not" : ""
+      xpect = if !defined?(@expectation)
+                ""
+              elsif @expectation.class == Regexp
+                # without this, xpect values like / \/zones\// will not be parsed properly
+                "(#{@expectation.inspect})"
+              elsif xpect != ""
+                " " + expectation.inspect
+              end
+      format("%s%sdescribe %s do\n  %s { should%s %s%s }\nend",
+             only_if_clause, vars, res, itsy, naughty, matcher, xpect)
+    end
+
+    def rb_skip
+      dc = describe_chain
+      obj = dc.nil? ? skip.inspect : dc[0]
+      format("describe %s do\n  skip %s\nend", obj, skip.inspect)
+    end
+  end
+end

data/lib/inspec/objects/value.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Inspec::Object
+  class Value
+    include ::Inspec::Object::RubyHelper
+
+    attr_accessor :qualifier
+    attr_accessor :skip
+    attr_accessor :variable
+
+    def initialize(qualifiers = [])
+      @qualifier = qualifiers
+      @variable = nil
+    end
+
+    def to_ruby
+      res = @variable.nil? ? "" : "#{@variable} = "
+      res + @qualifier.map { |x| ruby_qualifier(x) }.join(".")
+    end
+
+    def name_variable(cache = [])
+      @variable = Array("a".."z").find { |x| !cache.include?(x) }
+      cache.push(@variable)
+      @variable
+    end
+  end
+end

data/lib/inspec/objects.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Inspec
+  module Object
+    require_relative "objects/tag"
+    require_relative "objects/control"
+    require_relative "objects/ruby_helper"
+    require_relative "objects/describe"
+    require_relative "objects/value"
+    require_relative "objects/list"
+    require_relative "objects/each_loop"
+    require_relative "objects/or_test"
+    require_relative "objects/test"
+    require_relative "objects/input"
+    require_relative "objects/post_body"
+    require_relative "objects/header"
+  end
+end

data/lib/mitre-inspec-objects/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module InspecObjects
+  VERSION = "0.3.2"
+end

data/lib/mitre-inspec-objects.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "mitre-inspec-objects/version"
+require_relative "inspec/objects"

data/mitre-inspec-objects.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "mitre-inspec-objects/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mitre-inspec-objects"
+  spec.version       = InspecObjects::VERSION
+  spec.authors       = ["Dominik Richter", "Christoph Hartmann", "Aaron Lippold"]
+  spec.email         = ["dominik.richter@gmail.com", "chris@lollyrock.com"]
+  spec.summary       = "InSpec Objects library"
+  spec.description   = "Library that provides an API for programmatically creating InSpec profiles"
+  spec.homepage      = "https://github.com/mitre/inspec-objects"
+  spec.license       = "Apache-2.0"
+
+  spec.files = %w{
+    README.md mitre-inspec-objects.gemspec Gemfile
+  } + Dir.glob("{lib}/**/*", File::FNM_DOTMATCH).reject { |f| File.directory?(f) }
+
+  spec.require_paths = ["lib"]
+  spec.add_dependency "inspec-core"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: mitre-inspec-objects
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- Dominik Richter
+- Christoph Hartmann
+- Aaron Lippold
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Library that provides an API for programmatically creating InSpec profiles
+email:
+- dominik.richter@gmail.com
+- chris@lollyrock.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- lib/inspec/objects.rb
+- lib/inspec/objects/control.rb
+- lib/inspec/objects/describe.rb
+- lib/inspec/objects/each_loop.rb
+- lib/inspec/objects/header.rb
+- lib/inspec/objects/input.rb
+- lib/inspec/objects/list.rb
+- lib/inspec/objects/or_test.rb
+- lib/inspec/objects/post_body.rb
+- lib/inspec/objects/ruby_helper.rb
+- lib/inspec/objects/tag.rb
+- lib/inspec/objects/test.rb
+- lib/inspec/objects/value.rb
+- lib/mitre-inspec-objects.rb
+- lib/mitre-inspec-objects/version.rb
+- mitre-inspec-objects.gemspec
+homepage: https://github.com/mitre/inspec-objects
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key: 
+specification_version: 4
+summary: InSpec Objects library
+test_files: []