inspec/examples/profile/libraries/example_config.rb

require "yaml"

# Custom resource based on the InSpec resource DSL
class ExampleConfig < Inspec.resource(1)
  name "example_config"

  supports platform: "unix"
  supports platform: "windows"

  desc "
    Example's resource description ...
  "

  example "
    describe example_config do
      its('version') { should eq('1.0') }
      its('file_size') { should > 1 }
    end
  "

  # Load the configuration file on initialization
  def initialize
    @params = {}
    @path = "/tmp/example/config.yaml"
    @file = inspec.file(@path)

    unless @file.file?
      raise Inspec::Exceptions::ResourceSkipped, "Can't find file `#{@path}`"
    end

    # Protect from invalid YAML content
    begin
      @params = YAML.load(@file.content)
      # Add two extra matchers
      @params["file_size"] = @file.size
      @params["file_path"] = @path
      @params["ruby"] = "RUBY IS HERE TO HELP ME!"
    rescue StandardError => e
      raise Inspec::Exceptions::ResourceSkipped, "#{@file}: #{e.message}"
    end
  end

  # Example method called by 'it { should exist }'
  # Returns true or false from the 'File.exist?' method
  def exists?
    File.exist?(@path)
  end

  # Example matcher for the number of commas in the file
  def comma_count
    text = @file.content
    text.count(",")
  end

  # Expose all parameters
  def method_missing(name)
    @params[name.to_s]
  end
end