inspec-core 3.7.11 → 3.9.0

data/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/test/fixtures/README.md

@@ -1,24 +0,0 @@
-# Test Fixtures Area
-
-In this directory, you would place things that you need during testing.  For example, if you were making a plugin that counts the number of controls in a profile, you might have a directory tree like this:
-
-```
-  fixtures/
-    profiles/
-      zero-controls/
-        inspec.yml
-        controls/
-      twelve-controls/
-        inspec.yml
-        controls/
-          nine.rb
-          three.rb
-```
-
-When writing your functional tests, you can point InSpec at the various test fixture profiles, and know that when it points at the zero-controls profile, it should find no controls; and when pointed at the twelve-controls profile, it should find 12.
-
-## Using test fixtures provided with the `inspec` source code
-
-InSpec itself ships with many test fixtures - not just profiles, but attribute files, configuration directories, and more.  Examine them at [the fixtures directory](https://github.com/inspec/inspec/tree/master/test/unit/mock)
-
-To use them, see the helper.rb file included in the example at test/helper.rb .

data/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/test/functional/README.md

@@ -1,12 +0,0 @@
-# Functional Testing Area for Plugins
-
-## What are functional tests?
-
-Functional tests are tests that verify that your plugin works _as would be seen by a user_. Functional tests generally do not have inside knowledge about the inner workings of the plugin.  However a functional test is very interested in changes that your plugin makes to the outside world: exit codes, command output, changes to files on the filesystem, etc.
-
-To be picked up by the Rake tasks as tests, each test file should end in `_test.rb`.
-
-## Unit vs Functional Tests
-
-A practical difference between unit tests and functional tests is that unit tests all run within one process, while functional tests might exercise a CLI plugin by shelling out to an `inspec` invocation in a subprocess, and examining the results.
-

data/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/test/functional/inspec_plugin_template_test.rb

@@ -1,110 +0,0 @@
-# Functional Tests for Example Plugin, Resource Lister
-
-# Functional tests are used to verify the behavior of the plugin are as expected, to a user.
-# Functional tests generally do not have inside knowledge of how the plugin works.
-
-# Include our test harness
-require_relative '../helper'
-
-# Because InSpec is a Spec-style test suite, we're going to use MiniTest::Spec
-# here, for familiar look and feel. However, this isn't InSpec (or RSpec) code.
-describe 'inspec list-resources core' do
-  # Our helper.rb locates this library from the InSpec install that
-  # Bundler installed for us. If we want its methods, we still must
-  # import it.  Including it here will make it available in all child
-  # 'describe' blocks.
-  include CorePluginFunctionalHelper
-
-  # When thinking up scenarios to test, start with the simplest.
-  # Then think of each major feature, and exercise them.
-  # Running combinations of features makes sense if it is very likely,
-  # or a difficult / dangerous case.  You can always add more tests
-  # here as users find subtle problems.  In fact, having a user submit
-  # a PR that creates a failing functional test is a great way to
-  # capture the reproduction case.
-  # The simplest case:
-  describe "when run without an argument" do
-
-    # run_inspec_process_with_this_plugin is a helper provided by
-    # CoreFunctionalHelper. It makes the InSpec that Bundler installed
-    # think that this plugin we are currently testing is installed as a
-    # user plugin, by writing a plugin config file in a temp dir.
-    # To use it, just provide a command line, minus the word `inspec`.
-    let (:outcome) { run_inspec_process_with_this_plugin('listresources core') }
-
-    # Some tests through here use minitest Expectations, which attach to all
-    # Objects, and begin with 'must' (positive) or 'wont' (negative)
-    # See https://ruby-doc.org/stdlib-2.1.0/libdoc/minitest/rdoc/MiniTest/Expectations.html
-    it("should exit successfully") { outcome.exit_status.must_equal(0) }
-    it("should be silent on stderr") { outcome.stderr.must_be_empty }
-
-    # A selection of core resources, just spot checking.
-    # This is an example of using Ruby to define sets of tests.
-    ['process', 'service', 'user', 'file'].each do |resource_name|
-      it "should mention the '#{resource_name}' resource" do
-        outcome.stdout.must_include(resource_name)
-      end
-    end
-
-    # Check for the summary
-    it "should mention the summary" do
-      outcome.stdout.must_include('resources total')
-    end
-  end
-
-  # Test the search pattern feature, in a couple of ways.
-  describe "when run with a search pattern that matches things" do
-    # Notice that the command line is changed here:
-    # "list all resources that have the word user in them"
-    let (:outcome) { run_inspec_process_with_this_plugin('listresources core user') }
-
-    # Should be well-behaved...
-    it("should exit successfully") { outcome.exit_status.must_equal(0) }
-    it("should be silent on stderr") { outcome.stderr.must_be_empty }
-
-    # Here, we want to know it DID match some things, and NOT some others.
-    ['user', 'users'].each do |resource_name|
-      it "should mention the '#{resource_name}' resource" do
-        outcome.stdout.must_include(resource_name)
-      end
-    end
-    ['process', 'service', 'file'].each do |resource_name|
-      it "should NOT mention the '#{resource_name}' resource" do
-        outcome.stdout.wont_include(resource_name)
-      end
-    end
-  end
-  describe "when run with a search pattern that matches nothing" do
-    # Unlikely we'll have a resource with the string 'autogyro' in it.
-    let (:outcome) { run_inspec_process_with_this_plugin('listresources core autogyro') }
-
-    # Should be well-behaved...
-    it("should exit successfully") { outcome.exit_status.must_equal(0) }
-    it("should be silent on stderr") { outcome.stderr.must_be_empty }
-
-    # Output lines should be just two, for the summary.
-    it "should only have two output lines" do
-      outcome.stdout.split("\n").count.must_equal(2)
-    end
-
-    # Check for the summary
-    it "should mention a zero-resource summary" do
-      outcome.stdout.must_include('0 resources total')
-    end
-  end
-
-  # Exercise the summary option, which defaults to 'true'.
-  describe "when run with the no-summary flag" do
-    # Alter the command string to include the no-summary option
-    let(:outcome) { run_inspec_process_with_this_plugin('listresources core --no-summary') }
-
-    # Should be well-behaved...
-    it("should exit successfully") { outcome.exit_status.must_equal(0) }
-    it("should be silent on stderr") { outcome.stderr.must_be_empty }
-
-    # Check for the summary
-    it "should NOT mention summary" do
-      outcome.stdout.wont_include('0 resources total')
-    end
-  end
-end

data/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/test/helper.rb

@@ -1,26 +0,0 @@
-# Test helper file for non-core plugins
-
-# This file's job is to collect any libraries needed for testing, as well as provide
-# any utilities to make testing a plugin easier.
-
-# InSpec core provides a number of such libraries and facilities, in the file
-# lib/plugins/shared/core_plugin_test_helper.rb . So, one job in this file is
-# to locate and load that file.
-require 'inspec/../plugins/shared/core_plugin_test_helper'
-
-# Also load the InSpec plugin system. We need this so we can unit-test the plugin
-# classes, which will rely on the plugin system.
-require 'inspec/plugin/v2'
-
-# Caution: loading all of InSpec (i.e. require 'inspec') may cause interference with
-# minitest/spec; one symptom would be appearing to have no tests.
-# See https://github.com/inspec/inspec/issues/3380
-
-# You can select from a number of test harnesses.  Since InSpec uses Spec-style controls
-# in profile code, you will probably want to use something like minitest/spec, which provides
-# Spec-style tests.
-require 'minitest/spec'
-require 'minitest/autorun'
-
-# You might want to put some debugging tools here.  We run tests to find bugs, after all.
-require 'byebug'

data/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/test/unit/README.md

@@ -1,17 +0,0 @@
-# Unit Testing Area for Plugins
-
-## What Tests are Provided?
-
- * plugin_def_test.rb - Would be useful in any plugin.  Verifies that the plugin is properly detected and registered.
- <% if hooks.key?(:cli_command) %>
- * cli_args_test.rb - Tests the CLI options for a CLI Command plugin
- <% end %>
-
-## What are Unit Tests?
-
-Unit tests are tests that verify that the individual components of your plugin work as intended.  To be picked up by the Rake tasks as tests, each test file should end in `_test.rb`.
-
-## Unit vs Functional Tests
-
-A practical difference between unit tests and functional tests is that unit tests all run within one process, while functional tests might exercise a CLI plugin by shelling out to an inspec command in a subprocess, and examining the results.
-

data/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/test/unit/cli_args_test.rb

@@ -1,67 +0,0 @@
-# This unit test performs some tests to verify that the command line options for
-# <%= plugin_name %> are correct.
-
-# Include our test harness
-require_relative '../helper'
-
-# Load the class under test, the CliCommand definition.
-require '<%= plugin_name %>/cli_command'
-
-# Because InSpec is a Spec-style test suite, we're going to use MiniTest::Spec
-# here, for familiar look and feel. However, this isn't InSpec (or RSpec) code.
-describe InspecPlugins::<%= module_name %>::CliCommand do
-
-  # When writing tests, you can use `let` to create variables that you
-  # can reference easily.
-
-  # This is the CLI Command implementation class.
-  # It is a subclass of Thor, which is a CLI framework.
-  # This unit test file is mostly about verifying the Thor settings.
-  let(:cli_class) { InspecPlugins::<%= module_name %>::CliCommand }
-
-  # From this point onwards, this test file assumes you did not rename
-  # the provided 'do_something' subcommand.  As you implement your plugin,
-  # modify and add to the lines below to test your actual options.
-
-  # This is a Hash of Structs that tells us details of options for the 'do_something' subcommand.
-  let(:do_something_options) { cli_class.all_commands['do_something'].options }
-
-  # To group tests together, you can nest 'describe' in minitest/spec
-  describe 'the do-something subcommand' do
-
-    # Some tests through here use minitest Expectations, which attach to all
-    # Objects, and begin with 'must' (positive) or 'wont' (negative)
-    # See https://ruby-doc.org/stdlib-2.1.0/libdoc/minitest/rdoc/MiniTest/Expectations.html
-
-    # Option count OK?
-    it "should take one option" do
-      do_something_options.count.must_equal(1)
-    end
-
-    # Summary option
-    describe "the summary option" do
-      it "should be present" do
-        do_something_options.keys.must_include(:summary)
-      end
-      it "should have a description" do
-        do_something_options[:summary].description.wont_be_nil
-      end
-      it "should not be required" do
-        do_something_options[:summary].required.wont_equal(true)
-      end
-      it "should have a single-letter alias" do
-        do_something_options[:summary].aliases.must_include(:s)
-      end
-    end
-
-    # Argument count
-    # The 'do-something' command takes one optional argument. According to the
-    # metaprogramming rules of Ruby, the do_something() method should thus have an
-    # arity of -1. See http://ruby-doc.org/core-2.5.1/Method.html#method-i-arity
-    # for how that number is caclulated.
-    it "should take one optional argument" do
-      cli_class.instance_method(:do_something).arity.must_equal(-1)
-    end
-
-  end
-end

data/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/test/unit/plugin_def_test.rb

@@ -1,51 +0,0 @@
-# This unit test performs some tests to verify that
-# the inspec-resource-lister plugin is configured correctly.
-
-# Include our test harness
-require_relative '../helper'
-
-# Load the class under test, the Plugin definition.
-require '<%= plugin_name %>/plugin'
-
-# Because InSpec is a Spec-style test suite, we're going to use MiniTest::Spec
-# here, for familiar look and feel. However, this isn't InSpec (or RSpec) code.
-
-describe InspecPlugins::<%= module_name %>::Plugin do
-
-  # When writing tests, you can use `let` to create variables that you
-  # can reference easily.
-
-  # Internally, plugins are always known by a Symbol name. Convert here.
-  let(:plugin_name) { :'<%= plugin_name %>' }
-
-  # The Registry knows about all plugins that ship with InSpec by
-  # default, as well as any that are installed by the user. When a
-  # plugin definition is loaded, it will also self-register.
-  let(:registry) { Inspec::Plugin::V2::Registry.instance }
-
-  # The plugin status record tells us what the Registry knows.
-  # Note that you can use previously-defined 'let's.
-  let(:status) { registry[plugin_name] }
-
-  # OK, actual tests!
-
-  # Does the Registry know about us at all?
-  it "should be registered" do
-    registry.known_plugin?(plugin_name)
-  end
-
-  # Some tests through here use minitest Expectations, which attach to all
-  # Objects, and begin with 'must' (positive) or 'wont' (negative)
-  # See https://ruby-doc.org/stdlib-2.1.0/libdoc/minitest/rdoc/MiniTest/Expectations.html
-
-  # The plugin system had an undocumented v1 API; this should be a v2 example.
-  it "should be an api-v2 plugin" do
-    status.api_generation.must_equal(2)
-  end
-
-  # Plugins can support several different activator hooks, each of which has a type.
-  # Since this is (primarily) a CliCommand plugin, we'd expect to see that among our types.
-  it "should include a cli_command activator hook" do
-    status.plugin_types.must_include(:cli_command)
-  end
-end

data/lib/plugins/inspec-init/test/functional/inspec_init_plugin_test.rb

@@ -1,173 +0,0 @@
-require_relative '../../../shared/core_plugin_test_helper.rb'
-
-class InitPluginCli < MiniTest::Test
-  include CorePluginFunctionalHelper
-
-  def test_generating_inspec_plugin_correct_prefix_required
-    Dir.mktmpdir do |dir|
-      plugin = 'wacky-name'
-      run_result = run_inspec_process("init plugin --no-prompt #{plugin} ", prefix: "cd #{dir} &&")
-      assert_equal 1, run_result.exit_status
-      assert_empty run_result.stderr
-      assert_includes run_result.stdout, 'ERROR'
-      assert_includes run_result.stdout, 'Plugin names must begin with'
-    end
-  end
-
-  def test_generating_inspec_plugin_with_default_options
-    Dir.mktmpdir do |dir|
-      plugin = 'inspec-test-generated-plugin'
-      snake_case = plugin.tr('-', '_')
-      module_name = plugin.sub(/^inspec\-/, '').split('-').map(&:capitalize).join('')
-
-      run_result = run_inspec_process("init plugin --no-prompt #{plugin}", prefix: "cd #{dir} &&")
-      assert_empty run_result.stderr
-
-      assert_equal 0, run_result.exit_status
-      assert_includes run_result.stdout, 'Creating new inspec plugin at'
-      assert_includes run_result.stdout, plugin
-
-      # Check generated files and contents.
-      # Each file must exist, and its contents must match each of the regexen given.
-      {
-        File.join(plugin, 'README.md') => [
-          /#{plugin}/
-        ],
-        File.join(plugin, 'LICENSE') => [
-          /(?!opyright)/, # No copyright by default
-          /Apache License/,
-        ],
-        File.join(plugin, 'Gemfile') => [], # No interpolation
-        File.join(plugin, 'Rakefile') => [], # No interpolation
-        File.join(plugin, plugin + '.gemspec') => [
-          /require '#{plugin}\/version'/,
-          /spec\.name\s+=\s+'#{plugin}'/,
-          /spec\.version\s+=\s+InspecPlugins::#{module_name}::VERSION/,
-          /README\.md\s+#{snake_case}\.gemspec\s+Gemfile/,
-          /spec\.authors\s+=\s+\['Your Name'\]/,
-          /spec\.email\s+=\s+\['you@example\.com'\]/,
-          /spec\.summary\s+=\s+'A plugin with a default summary'/,
-          /spec\.description\s+=\s+''/,
-          /spec\.homepage\s+=\s+'https:\/\/github.com\/you\/#{plugin}'/,
-          /spec\.license\s+=\s+'Apache-2\.0'/,
-        ],
-        File.join(plugin, 'lib', plugin + '.rb') => [
-          /require\s'#{plugin}\/plugin'/,
-        ],
-        File.join(plugin, 'lib', plugin, 'plugin.rb') => [
-          /require\s'#{plugin}\/version'/,
-          /\#\s#{plugin}\s=>\s#{module_name}/,
-          /module\s#{module_name}/,
-          /plugin_name\s+:'#{plugin}'/,
-          # Default assumes one cli hook
-          /cli_command :my_command/,
-          /require\s'#{plugin}\/cli_command'/,
-          /InspecPlugins::#{module_name}::CliCommand/,
-        ],
-        File.join(plugin, 'lib', plugin, 'version.rb') => [
-          /module\s#{module_name}/,
-        ],
-        File.join(plugin, 'lib', plugin, 'cli_command.rb') => [
-          /module\sInspecPlugins::#{module_name}/,
-          /\#\smakes\s`inspec\smy-command\s\.\.\.`\swork\./,
-          /subcommand_desc\s'my_command\s\[COMMAND\]'/,
-          /\#\sas\s`inspec\smy-command\sdo-something/,
-          /\#\sin\s`inspec\shelp\smy-command`/,
-          /\#\sruns\s`inspec\smy-command\sdo-something`./,
-          /Edit\slib\/#{plugin}\/cli_command\.rb\sto\smake\sit\sdo/,
-        ],
-        File.join(plugin, 'test', 'helper.rb') => [], # No interpolation
-        File.join(plugin, 'test', 'functional', 'README.md') => [], # No interpolation
-        File.join(plugin, 'test', 'functional', snake_case + '_test.rb') => [
-          # Whatever goes here
-        ],
-        File.join(plugin, 'test', 'unit', 'plugin_def_test.rb') => [
-          /require\s'#{plugin}\/plugin'/,
-          /describe InspecPlugins::#{module_name}::Plugin\sdo/,
-          /let\(:plugin_name\) \{ \:'#{plugin}\' \}/,
-        ],
-        File.join(plugin, 'test', 'unit', 'cli_args_test.rb') => [
-          /require '#{plugin}\/cli_command'/,
-          /describe InspecPlugins::#{module_name}::CliCommand do/,
-          /let\(\:cli_class\) \{ InspecPlugins::#{module_name}::CliCommand \}/,
-        ],
-        File.join(plugin, 'test', 'unit', 'README.md') => [
-          /cli_args_test\.rb/,
-        ],
-      }.each do |path, regexen|
-        full_path = File.join(dir, path)
-        assert(File.exist?(full_path), "#{path} should have been generated")
-        next if regexen.empty?
-        contents = File.read(full_path)
-        regexen.each do |re|
-          assert_match re, contents, "#{path} should match #{re}"
-        end
-      end
-    end
-  end
-
-  def test_generating_inspec_plugin_with_custom_options
-    Dir.mktmpdir do |dir|
-      plugin = 'inspec-test-generated-plugin'
-      snake_case = plugin.tr('-', '_')
-      camel_case = plugin.sub(/^inspec\-/, '').split('-').map(&:capitalize).join('')
-
-      opts = ''
-      opts += ' --author-email bob@example.com '
-      opts += ' --author-name Bob '
-      opts += ' --copyright "Copyright © 2018 Bob" '
-      opts += ' --description "That you will really like" '
-      opts += ' --license-name BSD-3-Clause '
-      opts += ' --summary "A fantastic plugin" '
-
-      opts += ' --homepage http://example.com '
-      opts += ' --module_name FunPlugin'
-
-      run_result = run_inspec_process("init plugin #{plugin} --no-prompt #{opts}", prefix: "cd #{dir} &&")
-      assert_empty run_result.stderr
-      assert_equal 0, run_result.exit_status
-      assert_includes run_result.stdout, 'Creating new inspec plugin at'
-      assert_includes run_result.stdout, plugin
-
-      # Check generated files and contents.
-      # Each file must exist, and its contents must match each of the regexen given.
-      {
-        File.join(plugin, 'README.md') => [],
-        File.join(plugin, 'LICENSE') => [
-          /Copyright © 2018 Bob/,
-          /used to endorse or promote/,
-        ],
-        File.join(plugin, 'Gemfile') => [],
-        File.join(plugin, 'Rakefile') => [],
-        File.join(plugin, plugin + '.gemspec') => [
-          /spec\.version\s+=\s+InspecPlugins::FunPlugin::VERSION/,
-          /spec\.authors\s+=\s+\['Bob'\]/,
-          /spec\.email\s+=\s+\['bob@example\.com'\]/,
-          /spec\.summary\s+=\s+'A fantastic plugin'/,
-          /spec\.description\s+=\s+'That you will really like'/,
-          /spec\.homepage\s+=\s+'http:\/\/example.com'/,
-          /spec\.license\s+=\s+'BSD-3-Clause'/,
-        ],
-        File.join(plugin, 'lib', plugin + '.rb') => [],
-        File.join(plugin, 'lib', plugin, 'plugin.rb') => [],
-        File.join(plugin, 'lib', plugin, 'version.rb') => [],
-        File.join(plugin, 'lib', plugin, 'cli_command.rb') => [],
-        File.join(plugin, 'test', 'helper.rb') => [],
-        File.join(plugin, 'test', 'functional', snake_case + '_test.rb') => [],
-        File.join(plugin, 'test', 'unit', 'plugin_def_test.rb') => [],
-        File.join(plugin, 'test', 'unit', 'cli_args_test.rb') => [],
-      }.each do |path, regexen|
-        full_path = File.join(dir, path)
-        assert(File.exist?(full_path), "#{path} should have been generated")
-        next if regexen.empty?
-        contents = File.read(full_path)
-        regexen.each do |re|
-          assert_match re, contents, "#{path} should match #{re}"
-        end
-      end
-    end
-  end
-
-
-
-end