inspec-containerd-docs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8317beeaf0e084478957e42680e112d0aaef220c7a728498798411a1acd51928
+  data.tar.gz: 015f3c3cb7948affd4d9a0924dd73b53d7a80bcd0c0d881fc5ef5ffb401bf3fc
+SHA512:
+  metadata.gz: a3c32082172b61884e623a598e75de33fdb9c04ea39fdd4a4c5da9f37eba112d453e1d97471706d1ef8320b6276b4d2276671663865a6acf8564a6474902192a
+  data.tar.gz: d26d4949e246325c7a179365ec402dc5670ad0e7b2c3595a016a0b6206604e8f5121dead52414c929938bedd609d25048106a3a3cb3a6b37b33dac40de876f1d

data/Gemfile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+source "https://rubygems.org"
+
+gemspec
+
+gem "inspec-bin"
+
+group :development do
+  gem "chefstyle", "0.13.0"
+  gem "m"
+  gem "bundler"
+  gem "minitest"
+  gem "rake"
+  gem "rubocop"
+end

data/README.md

@@ -0,0 +1,33 @@
+# inspec-containerd-docs
+
+InSpec plugin to retrieve Test Kitchen data as inputs.
+
+## Use Case
+
+In some cases you want to get info about the Test Kitchen environment that
+your InSpec verifier is running in. This plugin offers some insight into
+instance name, platform name and suite name.
+
+## Installation
+
+Simply execute `inspec plugin install inspec-containerd-docs`, which will get
+the plugin from RubyGems and install/register it with InSpec.
+
+You can verify successful installation via `inspec plugin list`
+
+## Usage
+
+You have three input names available:
+- KITCHEN_INSTANCE_NAME ('default-amazon2')
+- KITCHEN_SUITE_NAME ('default')
+- KITCHEN_PLATFORM_NAME ('amazon2')
+
+Use them in your InSpec tests like this:
+
+```ruby
+instance_name = input('KITCHEN_INSTANCE_NAME')
+
+describe file("/etc/#{instance_name}") do
+  it { should exist }
+end
+```

data/inspec-containerd-docs.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+# As plugins are usually packaged and distributed as a RubyGem,
+# we have to provide a .gemspec file, which controls the gembuild
+# and publish process.  This is a fairly generic gemspec.
+
+# 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__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "inspec-containerd-docs/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          = "inspec-containerd-docs"
+
+  # It is polite to namespace your plugin under InspecPlugins::YourPluginInCamelCase
+  spec.version       = InspecPlugins::ContainerdDocs::VERSION
+  spec.authors       = ["Ian Brinkerhoff"]
+  spec.email         = ["ianbrink10@gmail.com"]
+  spec.summary       = "InSpec plugin"
+  spec.description   = "Containerd Support"
+  spec.homepage      = "https://github.com/tecracer-theinen/inspec-containerd-docs"
+  spec.license       = "Apache-2.0"
+
+  # Though complicated-looking, this is pretty standard for a gemspec.
+  # It just filters what will actually be packaged in the gem (leaving
+  # out tests, etc)
+  spec.files = %w{
+    README.md inspec-containerd-docs.gemspec Gemfile
+  } + Dir.glob(
+    "lib/**/*", File::FNM_DOTMATCH
+  ).reject { |f| File.directory?(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bump", "~> 0.8"
+  spec.add_development_dependency "minitest", "~> 5.11"
+end

data/lib/inspec-containerd-docs/cli.rb

@@ -0,0 +1,9 @@
+# lib/inspec-containerd-docs/cli.rb
+
+module InspecPlugin::ContainerdDocs
+  # Class name doesn't matter, but this is a reasonable default name
+  class CliCommand < Inspec.plugin(2, :cli_command) # Note two-arg form
+    # Implement API or use DSL as dictated by cli_command plugin type
+    # ...
+  end
+end

data/lib/inspec-containerd-docs/plugin.rb

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+
+# Plugin Definition file
+# The purpose of this file is to declare to InSpec what plugin_types (capabilities)
+# are included in this plugin, and provide hooks that will load them as needed.
+
+# It is important that this file load successfully and *quickly*.
+# Your plugin's functionality may never be used on this InSpec run; so we keep things
+# fast and light by only loading heavy things when they are needed.
+
+require "inspec-containerd-docs/version"
+module InspecPlugins
+  module ContainerdDocs
+    class Plugin < ::Inspec.plugin(2)
+      # Internal machine name of the plugin. InSpec will use this in errors, etc.
+      plugin_name :'inspec-containerd-docs'
+
+      # Define an Input plugin type.
+      cli_command :'containerd' do
+        require_relative 'cli'
+        InspecPlugins::ContainerdDocs::CliCommand
+      end
+    end
+  end
+end

data/lib/inspec-containerd-docs/version.rb

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+
+# This file simply makes it easier for CI engines to update
+# the version stamp, and provide a clean way for the gemspec
+# to learn the current version.
+module InspecPlugins
+  module ContainerdDocs
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/inspec-containerd-docs.rb

@@ -0,0 +1,4 @@
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require "inspec-containerd-docs/plugin"

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: inspec-containerd-docs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ian Brinkerhoff
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+description: Containerd Support
+email:
+- ianbrink10@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- inspec-containerd-docs.gemspec
+- lib/inspec-containerd-docs.rb
+- lib/inspec-containerd-docs/cli.rb
+- lib/inspec-containerd-docs/plugin.rb
+- lib/inspec-containerd-docs/version.rb
+homepage: https://github.com/tecracer-theinen/inspec-containerd-docs
+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.3.26
+signing_key:
+specification_version: 4
+summary: InSpec plugin
+test_files: []