abide_dev_utils 0.1.0

data/lib/abide_dev_utils/cli/jira.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'abide_dev_utils/jira'
+
+module Abide
+  module CLI
+    JIRA = AbideDevUtils::Jira
+
+    class JiraCommand < CmdParse::Command
+      CMD_NAME = 'jira'
+      CMD_SHORT = 'Commands related to Jira tickets'
+      CMD_LONG = 'Namespace for commands related to Jira tickets'
+      def initialize
+        super(CMD_NAME, takes_commands: true)
+        short_desc(CMD_SHORT)
+        long_desc(CMD_LONG)
+        add_command(CmdParse::HelpCommand.new, default: true)
+        add_command(JiraAuthCommand.new)
+        add_command(JiraGetIssueCommand.new)
+        add_command(JiraNewIssueCommand.new)
+        add_command(JiraFromCoverageCommand.new)
+      end
+    end
+
+    class JiraAuthCommand < CmdParse::Command
+      CMD_NAME = 'auth'
+      CMD_SHORT = 'Test authentication with Jira'
+      CMD_LONG = 'Allows you to test authenticating with Jira'
+      def initialize
+        super(CMD_NAME, takes_commands: false)
+        short_desc(CMD_SHORT)
+        long_desc(CMD_LONG)
+      end
+
+      def execute
+        client = JIRA.client
+        myself = JIRA.get_myself(client)
+        Abide::CLI::OUTPUT.simple("Successfully authenticated user #{myself.attrs['name']}!") unless myself.attrs['name'].empty?
+      end
+    end
+
+    class JiraGetIssueCommand < CmdParse::Command
+      CMD_NAME = 'get_issue'
+      CMD_SHORT = 'Gets a specific issue'
+      CMD_LONG = 'Returns JSON of a specific issue from key (<project>-<num>)'
+      def initialize
+        super(CMD_NAME, takes_commands: false)
+        short_desc(CMD_SHORT)
+        long_desc(CMD_LONG)
+        argument_desc(ISSUE: 'A Jira issue key (<PROJECT>-<NUM>)')
+        options.on('-o [FILE]', '--out-file [FILE]', 'Path to save the JSON output') { |o| @data[:file] = o }
+      end
+
+      def execute(issue)
+        client = JIRA.client(options: {})
+        issue = client.Issue.find(issue)
+        console = @data[:file].nil? ? true : false
+        out_json = issue.attrs.select { |_,v| !v.nil? || !v.empty? }
+        Abide::CLI::OUTPUT.json(out_json, console: console, file: @data[:file])
+      end
+    end
+
+    class JiraNewIssueCommand < CmdParse::Command
+      CMD_NAME = 'new_issue'
+      CMD_SHORT = 'Creates a new issue in a project'
+      CMD_LONG = 'Allows you to create a new issue in a project'
+      def initialize
+        super(CMD_NAME, takes_commands: false)
+        short_desc(CMD_SHORT)
+        long_desc(CMD_LONG)
+        argument_desc(
+          PROJECT: 'Jira project name (should be all caps)',
+          SUMMARY: 'Brief summary of the issue',
+          SUBTASKS: 'One or more summaries that become subtasks'
+        )
+      end
+
+      def execute(project, summary, *subtasks)
+        client = JIRA.client(options: {})
+        issue = JIRA.new_issue(client, project, summary)
+        Abide::CLI::OUTPUT.simple("Successfully created #{issue.attrs['key']}")
+        return if subtasks.nil? || subtasks.empty?
+
+        Abide::CLI::OUTPUT.simple('Creatings subtasks...')
+        JIRA.bulk_new_subtask(client, JIRA.issue(client, issue.attrs['key']), subtasks) unless subtasks.empty?
+      end
+    end
+
+    class JiraFromCoverageCommand < CmdParse::Command
+      CMD_NAME = 'from_coverage'
+      CMD_SHORT = 'Creates a parent issue with subtasks from a coverage report'
+      CMD_LONG = 'Creates a parent issue with subtasks for a benchmark and any uncovered controls'
+      def initialize
+        super(CMD_NAME, takes_commands: false)
+        short_desc(CMD_SHORT)
+        long_desc(CMD_LONG)
+        argument_desc(REPORT: 'A JSON coverage report from the abide puppet coverage command', PROJECT: 'A Jira project')
+        options.on('-d', '--dry-run', 'Print to console instead of saving objects') { |_| @data[:dry_run] = true }
+      end
+
+      def execute(report, project)
+        Abide::CLI::VALIDATE.file(report)
+        @data[:dry_run] = false if @data[:dry_run].nil?
+        client = JIRA.client(options: {})
+        proj = JIRA.project(client, project)
+        File.open(report) do |f|
+          JIRA.new_issues_from_coverage(client, proj, JSON.parse(f.read), dry_run: @data[:dry_run])
+        end
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/cli/puppet.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Abide
+  module CLI
+    class PuppetCommand < CmdParse::Command
+      CMD_NAME = 'puppet'
+      CMD_SHORT = 'Commands related to Puppet code'
+      CMD_LONG = 'Namespace for commands related to Puppet code'
+      def initialize
+        super(CMD_NAME, takes_commands: true)
+        short_desc(CMD_SHORT)
+        long_desc(CMD_LONG)
+        add_command(CmdParse::HelpCommand.new, default: true)
+        add_command(PuppetCoverageCommand.new)
+      end
+    end
+
+    class PuppetCoverageCommand < CmdParse::Command
+      CMD_NAME = 'coverage'
+      CMD_SHORT = 'Generates control coverage report'
+      CMD_LONG = 'Generates report of valid Puppet classes that match with Hiera controls'
+      CMD_CLASS_DIR = 'Directory that holds Puppet manifests'
+      CMD_HIERA_FILE = 'Hiera file generated from an XCCDF'
+      def initialize
+        super(CMD_NAME, takes_commands: false)
+        short_desc(CMD_SHORT)
+        long_desc(CMD_LONG)
+        argument_desc(CLASS_DIR: CMD_CLASS_DIR, HIERA_FILE: CMD_HIERA_FILE)
+        options.on('-o [FILE]', '--out-file [FILE]', 'Path to save the coverage report') { |f| @data[:file] = f }
+        options.on('-p [PROFILE]', '--profile [PROFILE]', 'Generate only for profile') { |p| @data[:profile] = p }
+      end
+
+      def help_arguments
+        <<~ARGHELP
+          Arguments:
+              CLASS_DIR        #{CMD_CLASS_DIR}
+              HIERA_FILE       #{CMD_HIERA_FILE}
+
+        ARGHELP
+      end
+
+      def execute(class_dir, hiera_file)
+        require 'abide_dev_utils/ppt'
+        Abide::CLI::VALIDATE.directory(class_dir)
+        Abide::CLI::VALIDATE.file(hiera_file)
+        coverage = AbideDevUtils::Ppt.coverage_report(class_dir, hiera_file, @data[:profile])
+        coverage.each do |k, v|
+          next if ['classes', 'benchmark'].include?(k)
+
+          Abide::CLI::OUTPUT.simple("#{k} coverage: #{v[:coverage]}%")
+        end
+        return if @data[:file].nil?
+
+        Abide::CLI::OUTPUT.json(coverage, file: @data[:file])
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/cli/test.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Abide
+  module CLI
+    class TestCommand < CmdParse::Command
+      CMD_NAME = 'test'
+      CMD_SHORT = 'Run test suites against a Puppet module'
+      CMD_LONG = 'Run various test suites against a Puppet module. Requires PDK to be installed.'
+      CMD_PDK = 'command -v pdk'
+      CMD_LIT_BASE = 'bundle exec rake'
+
+      def initialize
+        super(CMD_NAME, takes_commands: false)
+        short_desc(CMD_SHORT)
+        long_desc(CMD_LONG)
+        argument_desc(SUITE: 'Test suite to run [all, validate, unit, limus]')
+        options.on('-p', '--puppet-version', 'Set Puppet version for unit tests. Takes SemVer string') { |p| @data[:puppet] = p }
+        options.on('-e', '--pe-version', 'Set PE version for unit tests. Takes SemVer String') { |e| @data[:pe] = e }
+        options.on('-n', '--no-teardown', 'Do not tear down Litmus machines after tests') { |_| @data[:no_teardown] = true }
+        options.on('-c [puppet[67]]', '--collection [puppet[67]]', 'Puppet collection to use with litmus tests') { |c| @data[:collection] = c }
+        options.on('-l [LIST]', '--provision-list [LIST]', 'Set the provision list for Litmus') { |l| @data[:provision_list] = l }
+        options.on('-M [PATH]', '--module-dir [PATH]', 'Set a different directory as the module dir (defaults to current dir)') { |m| @data[:module_dir] = m }
+        # Declare and setup commands
+        @validate = ['validate', '--parallel']
+        @unit = ['test', 'unit', '--parallel']
+        # Add unit args if they exist
+        @unit << "--puppet-version #{@data[:puppet]}" unless @data[:puppet].nil? && !@data[:pe].nil?
+        @unit << "--pe-version #{@data[:pe]}" unless @data[:pe].nil?
+        # Get litmus args and supply defaults if necessary
+        litmus_pl = @data[:provision_list].nil? ? 'default' : @data[:provision_list]
+        litmus_co = @data[:collection].nil? ? 'puppet6' : @data[:collection]
+        # Now we craft the litmus commands
+        @litmus_pr = [CMD_LIT_BASE, "'litmus:provision_list[#{litmus_pl}]'"]
+        @litmus_ia = [CMD_LIT_BASE, "'litmus:install_agent[#{litmus_co}]'"]
+        @litmus_im = [CMD_LIT_BASE, "'litmus:install_module'"]
+        @litmus_ap = [CMD_LIT_BASE, "'litmus:acceptance:parallel'"]
+        @litmus_td = [CMD_LIT_BASE, "'litmus:tear_down'"]
+        validate_env_and_opts
+      end
+
+      def execute(suite)
+        case suite.downcase
+        when /^a[A-Za-z]*/
+          run_command(@validate)
+          run_command(@unit)
+          run_litmus
+        when /^v[A-Za-z]*/
+          run_command(@validate)
+        when /^u[A-Za-z]*/
+          run_command(@unit)
+        when /^l[A-Za-z]*/
+          run_litmus
+        else
+          Abide::CLI::OUTPUT.simple("Suite #{suite} in invalid!")
+          Abide::CLI::OUTPUT.simple('Valid options for TEST are [a]ll, [v]alidate, [u]nit, [l]itmus')
+        end
+      end
+
+      private
+
+      def validate_env_and_opts
+        Abide::CLI::VALIDATE.directory(@data[:module_dir]) unless @data[:module_dir].nil?
+        Abide::CLI::VALIDATE.not_empty(`#{CMD_PDK}`, 'PDK is required for running test suites!')
+      end
+
+      def run_litmus
+        run_command(@litmus_pr)
+        run_command(@litmus_ia)
+        run_command(@litmus_im)
+        run_command(@litmus_ap)
+        run_command(@litmus_td) unless @data[:no_teardown]
+      end
+
+      def run_command(*args)
+        arg_str = args.join(' ')
+        if @data[:module_dir]
+          `cd #{@data[:module_dir]} && $(#{CMD_PDK}) #{arg_str}`
+        else
+          `$(#{CMD_PDK}) #{arg_str}`
+        end
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/cli/xccdf.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'abide_dev_utils/xccdf'
+
+module Abide
+  module CLI
+    class XccdfCommand < CmdParse::Command
+      CMD_NAME = 'xccdf'
+      CMD_SHORT = 'Commands related to XCCDF files'
+      CMD_LONG = 'Namespace for commands related to XCCDF files'
+      def initialize
+        super(CMD_NAME, takes_commands: true)
+        short_desc(CMD_SHORT)
+        long_desc(CMD_LONG)
+        add_command(CmdParse::HelpCommand.new, default: true)
+        add_command(XccdfToHieraCommand.new)
+      end
+    end
+
+    class XccdfToHieraCommand < CmdParse::Command
+      CMD_NAME = 'to_hiera'
+      CMD_SHORT = 'Generates control coverage report'
+      CMD_LONG = 'Generates report of valid Puppet classes that match with Hiera controls'
+      def initialize
+        super(CMD_NAME, takes_commands: false)
+        short_desc(CMD_SHORT)
+        long_desc(CMD_LONG)
+        options.on('-b [TYPE]', '--benchmark-type [TYPE]', 'XCCDF Benchmark type') { |b| @data[:type] = b }
+        options.on('-o [FILE]', '--out-file [FILE]', 'Path to save file') { |f| @data[:file] = f }
+        options.on('-p [PREFIX]', '--parent-key-prefix [PREFIX]', 'A prefix to append to the parent key') { |p| @data[:parent_key_prefix] = p }
+      end
+
+      def execute(xccdf_file)
+        @data[:type] = 'cis' if @data[:type].nil?
+
+        to_hiera(xccdf_file)
+      end
+
+      private
+
+      def to_hiera(xccdf_file)
+        xfile = AbideDevUtils::XCCDF.to_hiera(xccdf_file, @data)
+        console = @data[:file].nil? ? true : false
+        Abide::CLI::OUTPUT.yaml(xfile, console: console, file: @data[:file])
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/config.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module AbideDevUtils
+  module Config
+    DEFAULT_PATH = "#{File.expand_path('~')}/.abide_dev.yaml"
+
+    def self.to_h(path = DEFAULT_PATH)
+      h = YAML.safe_load(File.open(path), [Symbol])
+      h.transform_keys(&:to_sym)
+    end
+
+    def self.config_section(section, path = DEFAULT_PATH)
+      h = to_h(path)
+      s = h[section.to_sym]
+      s.transform_keys(&:to_sym)
+    end
+
+    def self.fetch(key, default = nil, path = DEFAULT_PATH)
+      to_h(path).fetch(key, default)
+    end
+  end
+end

data/lib/abide_dev_utils/constants.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module AbideDevUtils
+  module CliConstants
+    require 'abide_dev_utils/config'
+    require 'abide_dev_utils/errors'
+    require 'abide_dev_utils/output'
+    require 'abide_dev_utils/prompt'
+    require 'abide_dev_utils/validate'
+
+    CONFIG = AbideDevUtils::Config
+    ERRORS = AbideDevUtils::Errors
+    OUTPUT = AbideDevUtils::Output
+    PROMPT = AbideDevUtils::Prompt
+    VALIDATE = AbideDevUtils::Validate
+  end
+end

data/lib/abide_dev_utils/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'abide_dev_utils/errors/general'
+require 'abide_dev_utils/errors/jira'
+require 'abide_dev_utils/errors/xccdf'

data/lib/abide_dev_utils/errors/base.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module AbideDevUtils
+  module Errors
+    # Generic error class. Errors in AbideDevUtil all follow the
+    # same format: "<msg> <subject>". Each error has a default
+    # error message relating to error class name. Subjects should
+    # always be the thing that failed (file, class, data, etc.).
+    # @param subject [String] what failed
+    # @param msg [String] an error message to override the default
+    class GenericError < StandardError
+      @default = 'Generic error:'
+      class << self
+        attr_reader :default
+      end
+
+      attr_reader :subject
+
+      def initialize(subject = nil, msg: self.class.default)
+        @msg = msg
+        @subject = subject
+        message = subject.nil? ? @msg : "#{@msg} #{@subject}"
+        super(message)
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/errors/general.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'abide_dev_utils/errors/base'
+
+module AbideDevUtils
+  module Errors
+    # Raised when something is empty and it shouldn't be
+    class ObjectEmptyError < GenericError
+      @default = 'Object is empty and should not be:'
+    end
+
+    # Raised when a an object is initialized with a nil param
+    class NewObjectParamNilError < GenericError
+      @default = 'Object init parameter is nil and should not be:'
+    end
+
+    # Raised when a file path does not exist
+    class FileNotFoundError < GenericError
+      @default = 'File not found:'
+    end
+
+    # Raised when a file path is not a regular file
+    class PathNotFileError < GenericError
+      @default = 'Path is not a regular file:'
+    end
+
+    # Raised when the path is not a directory
+    class PathNotDirectoryError < GenericError
+      @default = 'Path is not a directory:'
+    end
+
+    # Raised when a searched for service is not found in the parser
+    class ServiceNotFoundError < GenericError
+      @default = 'Service not found:'
+    end
+
+    # Raised when getting an InetdConfConfig object that does not exist
+    class ConfigObjectNotFoundError < GenericError
+      @default = 'Config object not found:'
+    end
+
+    # Raised when adding an InetdConfConfig object that already exists
+    class ConfigObjectExistsError < GenericError
+      @default = 'Config object already exists:'
+    end
+
+    # Raised when an object should respond to :to_hash or :to_h and doesn't
+    class NotHashableError < GenericError
+      @default = 'Object does not respond to #to_hash or #to_h:'
+    end
+  end
+end

data/lib/abide_dev_utils/errors/jira.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'abide_dev_utils/errors/base'
+
+module AbideDevUtils
+  module Errors
+    module Jira
+      class CreateIssueError < GenericError
+        @default = 'Failed to create Jira issue:'
+      end
+
+      class CreateSubtaskError < GenericError
+        @default = 'Failed to create Jira subtask for issue:'
+      end
+
+      class FindIssueError < GenericError
+        @default = 'Failed to find Jira issue:'
+      end
+    end
+  end
+end