mirror of
https://github.com/inspec/inspec
synced 2024-11-13 08:27:08 +00:00
Update inspec init plugin:
1. To use double quotes as per chefstyle 2. Template files renamed to .erb Signed-off-by: Vasu1105 <vasundhara.jagdale@chef.io>
This commit is contained in:
Vasu1105
parent
9922dc0504
commit
bc15deab93
14 changed files with 79 additions and 75 deletions
|
|
@ -71,12 +71,15 @@ module InspecPlugins
|
|||
{
|
||||
"inspec-plugin-template.gemspec" => plugin_name + ".gemspec",
|
||||
File.join("lib", "inspec-plugin-template") => File.join("lib", plugin_name),
|
||||
File.join("lib", "inspec-plugin-template.rb") => File.join("lib", plugin_name + ".rb"),
|
||||
File.join("lib", "inspec-plugin-template", "cli_command.rb") => File.join("lib", plugin_name, "cli_command.rb"),
|
||||
File.join("lib", "inspec-plugin-template", "reporter.rb") => File.join("lib", plugin_name, "reporter.rb"),
|
||||
File.join("lib", "inspec-plugin-template", "plugin.rb") => File.join("lib", plugin_name, "plugin.rb"),
|
||||
File.join("lib", "inspec-plugin-template", "version.rb") => File.join("lib", plugin_name, "version.rb"),
|
||||
File.join("test", "functional", "inspec_plugin_template_test.rb") => File.join("test", "functional", snake_case + "_test.rb"),
|
||||
File.join("lib", "inspec-plugin-template.erb") => File.join("lib", plugin_name + ".rb"),
|
||||
File.join("lib", "inspec-plugin-template", "cli_command.erb") => File.join("lib", plugin_name, "cli_command.rb"),
|
||||
File.join("lib", "inspec-plugin-template", "reporter.erb") => File.join("lib", plugin_name, "reporter.rb"),
|
||||
File.join("lib", "inspec-plugin-template", "plugin.erb") => File.join("lib", plugin_name, "plugin.rb"),
|
||||
File.join("lib", "inspec-plugin-template", "version.erb") => File.join("lib", plugin_name, "version.rb"),
|
||||
File.join("test", "functional", "inspec_plugin_template_test.erb") => File.join("test", "functional", snake_case + "_test.rb"),
|
||||
File.join("test", "unit", "cli_args_test.erb") => File.join("test", "unit", "cli_args_test.rb"),
|
||||
File.join("test", "unit", "plugin_def_test.erb") => File.join("test", "unit", "plugin_def_test.rb"),
|
||||
File.join("test", "helper.erb") => File.join("test", "helper.rb"),
|
||||
}
|
||||
end
|
||||
|
||||
|
|
@ -230,13 +233,13 @@ module InspecPlugins
|
|||
"Rakefile",
|
||||
File.join("test", "fixtures", "README.md"),
|
||||
File.join("test", "fixtures"),
|
||||
File.join("test", "functional", "inspec_plugin_template_test.rb"),
|
||||
File.join("test", "functional", "inspec_plugin_template_test.erb"),
|
||||
File.join("test", "functional", "README.md"),
|
||||
File.join("test", "unit", "cli_args_test.rb"),
|
||||
File.join("test", "unit", "plugin_def_test.rb"),
|
||||
File.join("test", "unit", "cli_args_test.erb"),
|
||||
File.join("test", "unit", "plugin_def_test.erb"),
|
||||
File.join("test", "unit", "README.md"),
|
||||
File.join("test", "unit"),
|
||||
File.join("test", "helper.rb"),
|
||||
File.join("test", "helper.erb"),
|
||||
File.join("test"),
|
||||
]
|
||||
else
|
||||
|
|
@ -247,14 +250,14 @@ module InspecPlugins
|
|||
# Remove hook-specific files
|
||||
unless requested_hooks.include?(:cli_command)
|
||||
skips += [
|
||||
File.join("lib", "inspec-plugin-template", "cli_command.rb"),
|
||||
File.join("test", "unit", "cli_args_test.rb"),
|
||||
File.join("test", "functional", "inspec_plugin_template_test.rb"),
|
||||
File.join("lib", "inspec-plugin-template", "cli_command.erb"),
|
||||
File.join("test", "unit", "cli_args_test.erb"),
|
||||
File.join("test", "functional", "inspec_plugin_template_test.erb"),
|
||||
]
|
||||
end
|
||||
unless requested_hooks.include?(:reporter)
|
||||
skips += [
|
||||
File.join("lib", "inspec-plugin-template", "reporter.rb"),
|
||||
File.join("lib", "inspec-plugin-template", "reporter.erb"),
|
||||
]
|
||||
end
|
||||
|
||||
|
|
|
|||
|
|
@ -65,6 +65,7 @@ module InspecPlugins
|
|||
# read & render content
|
||||
content = render(File.read(source_file), template_values)
|
||||
# write file content
|
||||
|
||||
File.write(full_destination_item_path, content)
|
||||
else
|
||||
ui.warning "Ignoring #{ui.emphasis(source_file)}, because its not an file or directoy"
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
source 'https://rubygems.org'
|
||||
source "https://rubygems.org"
|
||||
|
||||
gemspec
|
||||
|
||||
group :development do
|
||||
gem 'bundler'
|
||||
gem 'byebug'
|
||||
gem 'minitest'
|
||||
gem 'rake'
|
||||
gem 'rubocop', '= 0.49.1' # Need to keep in sync with main InSpec project, so config files will work
|
||||
gem "bundler"
|
||||
gem "byebug"
|
||||
gem "minitest"
|
||||
gem "rake"
|
||||
gem "rubocop", "= 0.49.1" # Need to keep in sync with main InSpec project, so config files will work
|
||||
end
|
||||
|
|
|
|||
|
|
@ -7,13 +7,13 @@
|
|||
|
||||
# This task template will make a task named 'test', and run
|
||||
# the tests that it finds.
|
||||
require 'rake/testtask'
|
||||
require "rake/testtask"
|
||||
|
||||
Rake::TestTask.new do |t|
|
||||
t.libs.push 'lib'
|
||||
t.libs.push "lib"
|
||||
t.test_files = FileList[
|
||||
'test/unit/*_test.rb',
|
||||
'test/functional/*_test.rb',
|
||||
"test/unit/*_test.rb",
|
||||
"test/functional/*_test.rb",
|
||||
]
|
||||
t.verbose = true
|
||||
# Ideally, we'd run tests with warnings enabled,
|
||||
|
|
@ -26,15 +26,15 @@ end
|
|||
#------------------------------------------------------------------#
|
||||
# Code Style Tasks
|
||||
#------------------------------------------------------------------#
|
||||
require 'rubocop/rake_task'
|
||||
require "rubocop/rake_task"
|
||||
|
||||
RuboCop::RakeTask.new(:lint) do |t|
|
||||
# Choices of RuboCop rules to enforce are deeply personal.
|
||||
# Here, we set things up so that your plugin will use the Bundler-installed
|
||||
# inspec gem's copy of the InSpec project's rubocop.yml file (which
|
||||
# is indeed packaged with the inspec gem).
|
||||
require 'inspec/globals'
|
||||
inspec_rubocop_yml = File.join(Inspec.src_root, '.rubocop.yml')
|
||||
require "inspec/globals"
|
||||
inspec_rubocop_yml = File.join(Inspec.src_root, ".rubocop.yml")
|
||||
|
||||
t.options = ['--display-cop-names', '--config', inspec_rubocop_yml]
|
||||
t.options = ["--display-cop-names", "--config", inspec_rubocop_yml]
|
||||
end
|
||||
|
|
|
|||
|
|
@ -4,23 +4,23 @@
|
|||
|
||||
# It is traditional in a gemspec to dynamically load the current version
|
||||
# from a file in the source tree. The next three lines make that happen.
|
||||
lib = File.expand_path('../lib', __FILE__)
|
||||
lib = File.expand_path("../lib", __FILE__)
|
||||
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
||||
require '<%= plugin_name %>/version'
|
||||
require "<%= plugin_name %>/version"
|
||||
|
||||
Gem::Specification.new do |spec|
|
||||
# Importantly, all InSpec plugins must be prefixed with `inspec-` (most
|
||||
# plugins) or `train-` (plugins which add new connectivity features).
|
||||
spec.name = '<%= plugin_name %>'
|
||||
spec.name = "<%= plugin_name %>"
|
||||
|
||||
# It is polite to namespace your plugin under InspecPlugins::YourPluginInCamelCase
|
||||
spec.version = InspecPlugins::<%= module_name %>::VERSION
|
||||
spec.authors = ['<%= author_name %>']
|
||||
spec.email = ['<%= author_email %>']
|
||||
spec.summary = '<%= summary %>'
|
||||
spec.description = '<%= description %>'
|
||||
spec.homepage = '<%= homepage %>'
|
||||
spec.license = '<%= license_name %>'
|
||||
spec.authors = ["<%= author_name %>"]
|
||||
spec.email = ["<%= author_email %>"]
|
||||
spec.summary = "<%= summary %>"
|
||||
spec.description = "<%= description %>"
|
||||
spec.homepage = "<%= homepage %>"
|
||||
spec.license = "<%= license_name %>"
|
||||
|
||||
# Though complicated-looking, this is pretty standard for a gemspec.
|
||||
# It just filters what will actually be packaged in the gem (leaving
|
||||
|
|
@ -28,9 +28,9 @@ Gem::Specification.new do |spec|
|
|||
spec.files = %w{
|
||||
README.md <%= snake_case %>.gemspec Gemfile
|
||||
} + Dir.glob(
|
||||
'lib/**/*', File::FNM_DOTMATCH
|
||||
"lib/**/*", File::FNM_DOTMATCH
|
||||
).reject { |f| File.directory?(f) }
|
||||
spec.require_paths = ['lib']
|
||||
spec.require_paths = ["lib"]
|
||||
|
||||
# If you rely on any other gems, list them here with any constraints.
|
||||
# This is how `inspec plugin install` is able to manage your dependencies.
|
||||
|
|
@ -39,5 +39,5 @@ Gem::Specification.new do |spec|
|
|||
|
||||
# All plugins should mention inspec, > 2.2.78
|
||||
# 2.2.78 included the v2 Plugin API
|
||||
spec.add_dependency 'inspec', '>=2.2.78', '<4.0.0'
|
||||
spec.add_dependency "inspec", ">= 2.2.78", "< 4.0.0"
|
||||
end
|
||||
|
|
|
|||
|
|
@ -11,4 +11,4 @@
|
|||
libdir = File.dirname(__FILE__)
|
||||
$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
|
||||
|
||||
require '<%= plugin_name %>/plugin'
|
||||
require "<%= plugin_name %>/plugin"
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
require 'inspec/resource'
|
||||
require "inspec/resource"
|
||||
|
||||
module InspecPlugins::<%= module_name %>
|
||||
# This class will provide the actual CLI implementation.
|
||||
|
|
@ -21,31 +21,31 @@ module InspecPlugins::<%= module_name %>
|
|||
# Note: if you want your command (or subcommand) to have dashes in it,
|
||||
# use underscores where you want a dash, and Thor will convert them.
|
||||
# Thor will fail to find a command that is directly named with dashes.
|
||||
subcommand_desc '<%= command_name_snake %> [COMMAND]', 'Your Usage Message Here'
|
||||
subcommand_desc "<%= command_name_snake %> [COMMAND]", "Your Usage Message Here"
|
||||
|
||||
# The usual rhythm for a Thor CLI file is description, options, command method.
|
||||
# Thor just has you call DSL methods in sequence prior to each command.
|
||||
|
||||
# Let's make a command, 'do_something'. This will then be available
|
||||
# as `inspec <%= command_name_dashes %> do-something
|
||||
# as `inspec <%= command_name_dashes %> do-something`
|
||||
# (Change this method name to be something sensible for your plugin.)
|
||||
|
||||
# First, provide a usage / description. This will appear
|
||||
# in `inspec help <%= command_name_dashes %>`.
|
||||
# As this is a usage message, you should write the command as it should appear
|
||||
# to the user (if you want it to have dashes, use dashes)
|
||||
desc 'do-something WHAT [OPTIONS]', 'Does something'
|
||||
desc "do-something WHAT [OPTIONS]", "Does something"
|
||||
|
||||
# Let's include an option, -s, to summarize
|
||||
# Refer to the Thors docs; there is a lot you can do here.
|
||||
option :summary, desc: 'Include a total at the bottom', \
|
||||
option :summary, desc: "Include a total at the bottom", \
|
||||
type: :boolean, default: true, aliases: [:s]
|
||||
|
||||
# OK, now the actual method itself. If you provide params, you're telling Thor that
|
||||
# OK, now the actual method itself. If you provide params, you're telling Thor that
|
||||
# you accept CLI arguments after all options have been consumed.
|
||||
# Note again that the method name has an underscore, but when invoked
|
||||
# on the CLI, use a dash.
|
||||
def do_something(what = 'nothing')
|
||||
def do_something(what = "nothing")
|
||||
# The code here will *only* be executed if someone actually
|
||||
# runs `inspec <%= command_name_dashes %> do-something`.
|
||||
|
||||
|
|
@ -55,7 +55,7 @@ module InspecPlugins::<%= module_name %>
|
|||
# Talk to the user using the `ui` object (see Inspec::UI)
|
||||
# ui.error('Whoops!')
|
||||
|
||||
ui.warning('This is a generated plugin with a default implementation. Edit lib/<%= plugin_name %>/cli_command.rb to make it do what you want.')
|
||||
ui.warning("This is a generated plugin with a default implementation. Edit lib/<%= plugin_name %>/cli_command.rb to make it do what you want.")
|
||||
ui.exit(:success) # or :usage_error
|
||||
end
|
||||
end
|
||||
|
|
@ -7,13 +7,13 @@
|
|||
# fast and light by only loading heavy things when they are needed.
|
||||
|
||||
# Presumably this is light
|
||||
require '<%= plugin_name %>/version'
|
||||
require "<%= plugin_name %>/version"
|
||||
|
||||
# The InspecPlugins namespace is where all plugins should declare themselves.
|
||||
# The 'Inspec' capitalization is used throughout the InSpec source code; yes, it's
|
||||
# The "Inspec" capitalization is used throughout the InSpec source code; yes, it's
|
||||
# strange.
|
||||
module InspecPlugins
|
||||
# Pick a reasonable namespace here for your plugin. A reasonable choice
|
||||
# Pick a reasonable namespace here for your plugin. A reasonable choice
|
||||
# would be the CamelCase version of your plugin gem name.
|
||||
# <%= plugin_name %> => <%= module_name %>
|
||||
module <%= module_name %>
|
||||
|
|
@ -26,7 +26,7 @@ module InspecPlugins
|
|||
# major versions.
|
||||
class Plugin < ::Inspec.plugin(2)
|
||||
# Internal machine name of the plugin. InSpec will use this in errors, etc.
|
||||
plugin_name :'<%= plugin_name %>'
|
||||
plugin_name :"<%= plugin_name %>"
|
||||
|
||||
<% if hooks[:cli_command] %>
|
||||
# Define a new CLI subcommand.
|
||||
|
|
@ -43,7 +43,7 @@ module InspecPlugins
|
|||
# functionality.
|
||||
# For example, InSpec will activate this hook when `inspec help` is
|
||||
# executed, so that this plugin's usage message will be included in the help.
|
||||
require '<%= plugin_name %>/cli_command'
|
||||
require "<%= plugin_name %>/cli_command"
|
||||
|
||||
# Having loaded our functionality, return a class that will let the
|
||||
# CLI engine tap into it.
|
||||
|
|
@ -59,7 +59,7 @@ module InspecPlugins
|
|||
# Calling this hook doesn't mean the reporter is being executed - just
|
||||
# that we should be ready to do so. So, load the file that defines the
|
||||
# functionality.
|
||||
require '<%= plugin_name %>/reporter'
|
||||
require "<%= plugin_name %>/reporter"
|
||||
|
||||
# Having loaded our functionality, return a class that will let the
|
||||
# reporting engine tap into it.
|
||||
|
|
@ -3,6 +3,6 @@
|
|||
# to learn the current version.
|
||||
module InspecPlugins
|
||||
module <%= module_name %>
|
||||
VERSION = '0.1.0'.freeze
|
||||
VERSION = "0.1.0".freeze
|
||||
end
|
||||
end
|
||||
|
|
@ -4,11 +4,11 @@
|
|||
# Functional tests generally do not have inside knowledge of how the plugin works.
|
||||
|
||||
# Include our test harness
|
||||
require_relative '../helper'
|
||||
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
|
||||
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
|
||||
|
|
@ -40,7 +40,7 @@ describe 'inspec list-resources core' do
|
|||
|
||||
# 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|
|
||||
%w(process service user file).each do |resource_name|
|
||||
it "should mention the '#{resource_name}' resource" do
|
||||
outcome.stdout.must_include(resource_name)
|
||||
end
|
||||
|
|
@ -48,7 +48,7 @@ describe 'inspec list-resources core' do
|
|||
|
||||
# Check for the summary
|
||||
it "should mention the summary" do
|
||||
outcome.stdout.must_include('resources total')
|
||||
outcome.stdout.must_include("resources total")
|
||||
end
|
||||
end
|
||||
|
||||
|
|
@ -63,12 +63,12 @@ describe 'inspec list-resources core' do
|
|||
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|
|
||||
%w(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|
|
||||
%w(process service file).each do |resource_name|
|
||||
it "should NOT mention the '#{resource_name}' resource" do
|
||||
outcome.stdout.wont_include(resource_name)
|
||||
end
|
||||
|
|
@ -89,14 +89,14 @@ describe 'inspec list-resources core' do
|
|||
|
||||
# Check for the summary
|
||||
it "should mention a zero-resource summary" do
|
||||
outcome.stdout.must_include('0 resources total')
|
||||
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') }
|
||||
let(:outcome) { run_inspec_process_with_this_plugin("listresources core --no-summary") }
|
||||
|
||||
# Should be well-behaved...
|
||||
it("should exit successfully") { assert_exit_code 0, outcome }
|
||||
|
|
@ -104,7 +104,7 @@ describe 'inspec list-resources core' do
|
|||
|
||||
# Check for the summary
|
||||
it "should NOT mention summary" do
|
||||
outcome.stdout.wont_include('0 resources total')
|
||||
outcome.stdout.wont_include("0 resources total")
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
@ -6,11 +6,11 @@
|
|||
# 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'
|
||||
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'
|
||||
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.
|
||||
|
|
@ -19,6 +19,6 @@ require 'inspec/plugin/v2'
|
|||
# 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/autorun' # loads all styles and runs tests automatically
|
||||
require "minitest/autorun" # loads all styles and runs tests automatically
|
||||
|
||||
# You might want to put some debugging tools here. We run tests to find bugs, after all.
|
||||
|
|
@ -2,10 +2,10 @@
|
|||
# <%= plugin_name %> are correct.
|
||||
|
||||
# Include our test harness
|
||||
require_relative '../helper'
|
||||
require_relative "../helper"
|
||||
|
||||
# Load the class under test, the CliCommand definition.
|
||||
require '<%= plugin_name %>/cli_command'
|
||||
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.
|
||||
|
|
@ -24,10 +24,10 @@ describe InspecPlugins::<%= module_name %>::CliCommand do
|
|||
# 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 }
|
||||
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
|
||||
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)
|
||||
|
|
@ -2,10 +2,10 @@
|
|||
# the inspec-resource-lister plugin is configured correctly.
|
||||
|
||||
# Include our test harness
|
||||
require_relative '../helper'
|
||||
require_relative "../helper"
|
||||
|
||||
# Load the class under test, the Plugin definition.
|
||||
require '<%= plugin_name %>/plugin'
|
||||
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.
|
||||
|
|
@ -16,7 +16,7 @@ describe InspecPlugins::<%= module_name %>::Plugin do
|
|||
# can reference easily.
|
||||
|
||||
# Internally, plugins are always known by a Symbol name. Convert here.
|
||||
let(:plugin_name) { :'<%= plugin_name %>' }
|
||||
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
|
||||
Loading…
Reference in a new issue