inspec 2.1.0 → 2.1.10

data/lib/bundles/inspec-init.rb

@@ -1,8 +1,8 @@
-# encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
-
-libdir = File.dirname(__FILE__)
-$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
-
-require 'inspec-init/cli'
+# encoding: utf-8
+# author: Christoph Hartmann
+# author: Dominik Richter
+
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require 'inspec-init/cli'

data/lib/bundles/inspec-init/README.md

@@ -1,31 +1,31 @@
-# InSpec Extension to create new profiles
-
-This extensions helps you to easily create a new profile
-
-## Usage
-
-```
-$ inspec init profile examples/new-profile
-Create new profile at /Users/chartmann/Development/compliance/inspec/examples/new-profile
-  * Create directory controls
-  * Create file controls/example.rb
-  * Create file inspec.yml
-  * Create directory libraries
-  * Create file README.md
-  * Create file libraries/.gitkeep
-
-$ inspec check examples/new-profile
-Summary
--------
-Location: examples/new-profile
-Profile: examples/new-profile
-Controls: 2
-Timestamp: 2016-05-06T14:39:47+02:00
-Valid: true
-
-Errors
-------
-
-Warnings
---------
-```
+# InSpec Extension to create new profiles
+
+This extensions helps you to easily create a new profile
+
+## Usage
+
+```
+$ inspec init profile examples/new-profile
+Create new profile at /Users/chartmann/Development/compliance/inspec/examples/new-profile
+  * Create directory controls
+  * Create file controls/example.rb
+  * Create file inspec.yml
+  * Create directory libraries
+  * Create file README.md
+  * Create file libraries/.gitkeep
+
+$ inspec check examples/new-profile
+Summary
+-------
+Location: examples/new-profile
+Profile: examples/new-profile
+Controls: 2
+Timestamp: 2016-05-06T14:39:47+02:00
+Valid: true
+
+Errors
+------
+
+Warnings
+--------
+```

data/lib/bundles/inspec-init/cli.rb

@@ -1,97 +1,97 @@
-# encoding: utf-8
-# author: Christoph Hartmann
-
-require 'pathname'
-
-module Init
-  class CLI < Inspec::BaseCLI
-    namespace 'init'
-
-    # TODO: find another solution, once https://github.com/erikhuda/thor/issues/261 is fixed
-    def self.banner(command, _namespace = nil, _subcommand = false)
-      "#{basename} #{subcommand_prefix} #{command.usage}"
-    end
-
-    def self.subcommand_prefix
-      namespace
-    end
-
-    # read template directoy
-    template_dir = File.join(File.dirname(__FILE__), 'templates')
-    Dir.glob(File.join(template_dir, '*')) do |template|
-      relative = Pathname.new(template).relative_path_from(Pathname.new(template_dir))
-
-      # register command for the template
-      desc "#{relative} NAME", "Create a new #{relative}"
-      option :overwrite, type: :boolean, default: false,
-         desc: 'Overwrites existing directory'
-      define_method relative.to_s.to_sym do |name|
-        generator(relative.to_s, { name: name }, options)
-      end
-    end
-
-    private
-
-    # 1. iterate over all files
-    # 2. read content in erb
-    # 3. write to target
-    def generator(type, attributes = {}, options = {}) # rubocop:disable Metrics/AbcSize
-      # path of this script
-      dir = File.dirname(__FILE__)
-      # look for template directory
-      base_dir = File.join(dir, 'templates', type)
-      # prepare glob for all subdirectories and files
-      template = File.join(base_dir, '**', '{*,.*}')
-      # generate target path
-      target = Pathname.new(Dir.pwd).join(attributes[:name])
-      puts "Create new #{type} at #{mark_text(target)}"
-
-      # check that the directory does not exist
-      if File.exist?(target) && !options['overwrite']
-        error "#{mark_text(target)} exists already, use --overwrite"
-        exit 1
-      end
-
-      # ensure that target directory is available
-      FileUtils.mkdir_p(target)
-
-      # iterate over files and write to target path
-      Dir.glob(template) do |file|
-        relative = Pathname.new(file).relative_path_from(Pathname.new(base_dir))
-        destination = Pathname.new(target).join(relative)
-        if File.directory?(file)
-          li "Create directory #{mark_text(relative)}"
-          FileUtils.mkdir_p(destination)
-        elsif File.file?(file)
-          li "Create file #{mark_text(relative)}"
-          # read & render content
-          content = render(File.read(file), attributes)
-          # write file content
-          File.write(destination, content)
-        else
-          puts "Ignore #{file}, because its not an file or directoy"
-        end
-      end
-    end
-
-    # This is a render helper to bind hash values to a ERB template
-    def render(content, hash)
-      # create a new binding class
-      cls = Class.new do
-        hash.each do |key, value|
-          define_method key.to_sym do
-            value
-          end
-        end
-        # expose binding
-        define_method :bind do
-          binding
-        end
-      end
-      ERB.new(content).result(cls.new.bind)
-    end
-  end
-
-  # register the subcommand to Inspec CLI registry
-  Inspec::Plugins::CLI.add_subcommand(Init::CLI, 'init', 'init TEMPLATE ...', 'Scaffolds a new project', {})
-end
+# encoding: utf-8
+# author: Christoph Hartmann
+
+require 'pathname'
+
+module Init
+  class CLI < Inspec::BaseCLI
+    namespace 'init'
+
+    # TODO: find another solution, once https://github.com/erikhuda/thor/issues/261 is fixed
+    def self.banner(command, _namespace = nil, _subcommand = false)
+      "#{basename} #{subcommand_prefix} #{command.usage}"
+    end
+
+    def self.subcommand_prefix
+      namespace
+    end
+
+    # read template directoy
+    template_dir = File.join(File.dirname(__FILE__), 'templates')
+    Dir.glob(File.join(template_dir, '*')) do |template|
+      relative = Pathname.new(template).relative_path_from(Pathname.new(template_dir))
+
+      # register command for the template
+      desc "#{relative} NAME", "Create a new #{relative}"
+      option :overwrite, type: :boolean, default: false,
+         desc: 'Overwrites existing directory'
+      define_method relative.to_s.to_sym do |name|
+        generator(relative.to_s, { name: name }, options)
+      end
+    end
+
+    private
+
+    # 1. iterate over all files
+    # 2. read content in erb
+    # 3. write to target
+    def generator(type, attributes = {}, options = {}) # rubocop:disable Metrics/AbcSize
+      # path of this script
+      dir = File.dirname(__FILE__)
+      # look for template directory
+      base_dir = File.join(dir, 'templates', type)
+      # prepare glob for all subdirectories and files
+      template = File.join(base_dir, '**', '{*,.*}')
+      # generate target path
+      target = Pathname.new(Dir.pwd).join(attributes[:name])
+      puts "Create new #{type} at #{mark_text(target)}"
+
+      # check that the directory does not exist
+      if File.exist?(target) && !options['overwrite']
+        error "#{mark_text(target)} exists already, use --overwrite"
+        exit 1
+      end
+
+      # ensure that target directory is available
+      FileUtils.mkdir_p(target)
+
+      # iterate over files and write to target path
+      Dir.glob(template) do |file|
+        relative = Pathname.new(file).relative_path_from(Pathname.new(base_dir))
+        destination = Pathname.new(target).join(relative)
+        if File.directory?(file)
+          li "Create directory #{mark_text(relative)}"
+          FileUtils.mkdir_p(destination)
+        elsif File.file?(file)
+          li "Create file #{mark_text(relative)}"
+          # read & render content
+          content = render(File.read(file), attributes)
+          # write file content
+          File.write(destination, content)
+        else
+          puts "Ignore #{file}, because its not an file or directoy"
+        end
+      end
+    end
+
+    # This is a render helper to bind hash values to a ERB template
+    def render(content, hash)
+      # create a new binding class
+      cls = Class.new do
+        hash.each do |key, value|
+          define_method key.to_sym do
+            value
+          end
+        end
+        # expose binding
+        define_method :bind do
+          binding
+        end
+      end
+      ERB.new(content).result(cls.new.bind)
+    end
+  end
+
+  # register the subcommand to Inspec CLI registry
+  Inspec::Plugins::CLI.add_subcommand(Init::CLI, 'init', 'init TEMPLATE ...', 'Scaffolds a new project', {})
+end

data/lib/bundles/inspec-init/templates/profile/README.md

@@ -1,3 +1,3 @@
-# Example InSpec Profile
-
-This example shows the implementation of an InSpec profile.
+# Example InSpec Profile
+
+This example shows the implementation of an InSpec profile.

data/lib/bundles/inspec-init/templates/profile/controls/example.rb

@@ -1,19 +1,19 @@
-# encoding: utf-8
-# copyright: 2018, The Authors
-
-title 'sample section'
-
-# you can also use plain tests
-describe file('/tmp') do
-  it { should be_directory }
-end
-
-# you add controls here
-control 'tmp-1.0' do                        # A unique ID for this control
-  impact 0.7                                # The criticality, if this control fails.
-  title 'Create /tmp directory'             # A human-readable title
-  desc 'An optional description...'
-  describe file('/tmp') do                  # The actual test
-    it { should be_directory }
-  end
-end
+# encoding: utf-8
+# copyright: 2018, The Authors
+
+title 'sample section'
+
+# you can also use plain tests
+describe file('/tmp') do
+  it { should be_directory }
+end
+
+# you add controls here
+control 'tmp-1.0' do                        # A unique ID for this control
+  impact 0.7                                # The criticality, if this control fails.
+  title 'Create /tmp directory'             # A human-readable title
+  desc 'An optional description...'
+  describe file('/tmp') do                  # The actual test
+    it { should be_directory }
+  end
+end

data/lib/bundles/inspec-init/templates/profile/inspec.yml

@@ -1,8 +1,8 @@
-name: <%= name %>
-title: InSpec Profile
-maintainer: The Authors
-copyright: The Authors
-copyright_email: you@example.com
-license: Apache-2.0
-summary: An InSpec Compliance Profile
-version: 0.1.0
+name: <%= name %>
+title: InSpec Profile
+maintainer: The Authors
+copyright: The Authors
+copyright_email: you@example.com
+license: Apache-2.0
+summary: An InSpec Compliance Profile
+version: 0.1.0

data/lib/bundles/inspec-supermarket.rb

@@ -1,13 +1,13 @@
-# encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
-
-libdir = File.dirname(__FILE__)
-$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
-
-module Supermarket
-  autoload :API, 'inspec-supermarket/api'
-end
-
-require 'inspec-supermarket/cli'
-require 'inspec-supermarket/target'
+# encoding: utf-8
+# author: Christoph Hartmann
+# author: Dominik Richter
+
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+module Supermarket
+  autoload :API, 'inspec-supermarket/api'
+end
+
+require 'inspec-supermarket/cli'
+require 'inspec-supermarket/target'

data/lib/bundles/inspec-supermarket/README.md

@@ -1,45 +1,45 @@
-# InSpec Extension for Chef Supermarket
-
-To use the CLI, this InSpec add-on adds the following commands:
-
- * `$ inspec supermarket configure` - configures the supermarket server
- * `$ inspec supermarket search` - searches for a compliance profile on supermarket
- * `$ inspec supermarket exec nathenharvey/tmp-compliance-profile` - extends execute to load the profile
-
- Compliance profiles from Supermarket can be executed in two mays:
-
- - via supermarket exec: `inspec supermarket exec nathenharvey/tmp-compliance-profile`
- - via supermarket scheme: `inspec exec supermarket://nathenharvey/tmp-compliance-profile`
-
-## Usage
-
-```
-$ inspec supermarket
-Commands:
-  inspec supermarket exec PROFILE    # execute a Supermarket profile
-  inspec supermarket help [COMMAND]  # Describe subcommands or one specific subcommand
-  inspec supermarket info PROFILE    # display Supermarket profile details
-  inspec supermarket profiles        # list all available profiles in Chef Supermarket
-
-$ inspec supermarket profiles
-Available profiles:
--------------------
- * nathenharvey/tmp-compliance-profile
- * hardening/os-hardening
- * hardening/ssh-hardening
-
-$ inspec supermarket info hardening/os-hardening
-name:   os-hardening
-owner:  hardening
-url:    https://github.com/dev-sec/tests-os-hardening
-
-description:   Base Linux Compliance profile, used for Security + DevOps. More Information is available at http://dev-sec.io/
-
-$ inspec exec supermarket://hardening/os-hardening
-........F.F.................F......FFF.....FFFF.F........FF....FFFFFFF...FF.FFFFFF.FFFFFFFFFFF.F...
-
-...
-
-Finished in 3.81 seconds (files took 5.69 seconds to load)
-99 examples, 40 failures
-```
+# InSpec Extension for Chef Supermarket
+
+To use the CLI, this InSpec add-on adds the following commands:
+
+ * `$ inspec supermarket configure` - configures the supermarket server
+ * `$ inspec supermarket search` - searches for a compliance profile on supermarket
+ * `$ inspec supermarket exec nathenharvey/tmp-compliance-profile` - extends execute to load the profile
+
+ Compliance profiles from Supermarket can be executed in two ways:
+
+ - via supermarket exec: `inspec supermarket exec nathenharvey/tmp-compliance-profile`
+ - via supermarket scheme: `inspec exec supermarket://nathenharvey/tmp-compliance-profile`
+
+## Usage
+
+```
+$ inspec supermarket
+Commands:
+  inspec supermarket exec PROFILE    # execute a Supermarket profile
+  inspec supermarket help [COMMAND]  # Describe subcommands or one specific subcommand
+  inspec supermarket info PROFILE    # display Supermarket profile details
+  inspec supermarket profiles        # list all available profiles in Chef Supermarket
+
+$ inspec supermarket profiles
+Available profiles:
+-------------------
+ * nathenharvey/tmp-compliance-profile
+ * hardening/os-hardening
+ * hardening/ssh-hardening
+
+$ inspec supermarket info hardening/os-hardening
+name:   os-hardening
+owner:  hardening
+url:    https://github.com/dev-sec/tests-os-hardening
+
+description:   Base Linux Compliance profile, used for Security + DevOps. More Information is available at http://dev-sec.io/
+
+$ inspec exec supermarket://hardening/os-hardening
+........F.F.................F......FFF.....FFFF.F........FF....FFFFFFF...FF.FFFFFF.FFFFFFFFFFF.F...
+
+...
+
+Finished in 3.81 seconds (files took 5.69 seconds to load)
+99 examples, 40 failures
+```