abide_dev_utils 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53dde19f67b39702c5430d9e9e9c0003c5e27f3440bcd9d60a575911ae9959dd
-  data.tar.gz: 768c7f2b0ca6d3bfccef663668bfcb01a5c4828593884116ff5580df1ee1f4da
+  metadata.gz: 75678bc1c177a3187619cfec9d2c25e566b08d91439c3b46c578c4202f4d9a7c
+  data.tar.gz: f9749e6c8ad3d5b0439a8fe0fd03ba3ea91e5c0052057eea43b3862c08b45fbd
 SHA512:
-  metadata.gz: 44e2b63c7488ac4bda0ae50ac8f672ba481fe20cb6a1087395921b115b773e96aaf08b08849c9a3dbb08cd03cde712b4d0977978434d1f7619d9f4bda403d758
-  data.tar.gz: 35a1c0755970943435a928414da5f25c9d082372d787c6310d63557875a0ae6c5e9a272928b1073c5aa63d5a0081638ef8e3b9703a49a8900334699881ea41f0
+  metadata.gz: 97ba4b3b0898a40ed6df3facaf3aa03beb2d1375d61e1915c6566e107e6edffa083ab7af93827c2679c14a2503504cafd40d9275b12708f582c3723953b5c9c7
+  data.tar.gz: 2680eb354112e27223d590a645318ea14c4988dd0e331bf5a5f3b347402ead6398c8c07c1b7ded55704d76011522ff790459cf40452ceba8ca15dc2a19a76a7a

data/abide_dev_utils.gemspec

@@ -49,7 +49,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-ast', '~> 1.4'
   spec.add_development_dependency 'rubocop-performance', '~> 1.9'
   spec.add_development_dependency 'rubocop-i18n', '~> 3.0'
-  spec.add_development_dependency 'fast_gettext', '~> 1.1'
+  spec.add_development_dependency 'fast_gettext', '~> 1.8'
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/abide_dev_utils.rb

@@ -2,8 +2,9 @@
 
 require 'abide_dev_utils/version'
 require 'abide_dev_utils/xccdf'
-require 'abide_dev_utils/utils'
-require 'abide_dev_utils/errors'
+require 'abide_dev_utils/ppt'
+require 'abide_dev_utils/jira'
+require 'abide_dev_utils/config'
 
-# Just creates the namespace
+# Root namespace all modules / classes
 module AbideDevUtils; end

data/lib/abide_dev_utils/cli/abstract.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Abide
+  module CLI
+    # @abstract
+    class Command < CmdParse::Command
+      include AbideDevUtils::Config
+      def initialize(cmd_name, cmd_short, cmd_long, **opts)
+        super(cmd_name, **opts)
+        short_desc(cmd_short)
+        long_desc(cmd_long)
+        add_command(CmdParse::HelpCommand.new, default: true) if opts[:takes_commands]
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/cli/jira.rb

@@ -36,7 +36,9 @@ module Abide
       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?
+        return if myself.attrs['name'].empty?
+
+        Abide::CLI::OUTPUT.simple("Successfully authenticated user #{myself.attrs['name']}!")
       end
     end
 

data/lib/abide_dev_utils/cli/puppet.rb

@@ -1,30 +1,28 @@
 # frozen_string_literal: true
 
+require 'abide_dev_utils/cli/abstract'
+
 module Abide
   module CLI
-    class PuppetCommand < CmdParse::Command
+    class PuppetCommand < 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)
+        super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: true)
         add_command(PuppetCoverageCommand.new)
+        add_command(PuppetNewCommand.new)
       end
     end
 
-    class PuppetCoverageCommand < CmdParse::Command
+    class PuppetCoverageCommand < 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)
+        super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: false)
         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 }
@@ -43,7 +41,7 @@ module Abide
         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 = AbideDevUtils::Ppt::CoverageReport.generate(class_dir, hiera_file, @data[:profile])
         coverage.each do |k, v|
           next if ['classes', 'benchmark'].include?(k)
 
@@ -54,5 +52,54 @@ module Abide
         Abide::CLI::OUTPUT.json(coverage, file: @data[:file])
       end
     end
+
+    class PuppetNewCommand < Command
+      CMD_NAME = 'new'
+      CMD_SHORT = 'Generates a new Puppet object from templates'
+      CMD_LONG = 'Generates a new Puppet object (class, test, etc.) from templates stored in the module repo'
+      CMD_TYPE_ARG = 'The type of object to generate. This value must be the name of a template (without .erb) file in <template dir>'
+      CMD_NAME_ARG = 'The fully namespaced name of the new object'
+      def initialize
+        super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: false)
+        argument_desc(TYPE: CMD_TYPE_ARG, NAME: CMD_NAME_ARG)
+        options.on(
+          '-t [DIR]',
+          '--template-dir [DIR]',
+          'Path to the directory holding your ERB templates for custom objects. Defaults to "object_templates" in the root dir.'
+        ) { |t| @data[:tmpl_dir] = t }
+        options.on(
+          '-r [DIR]',
+          '--root-dir [DIR]',
+          'Path to the root directory of the module. Defaults to the current working directory.'
+        ) { |r| @data[:root_dir] = r }
+        options.on(
+          '-A',
+          '--absolute-template-dir',
+          'Use this flage if the template dir is an absolute path'
+        ) { |a| @data[:absolute_template_dir] = a }
+        options.on(
+          '-n [NAME]',
+          '--template-name [NAME]',
+          'Allows you to specify a name for the template if it is different from the basename (last segment) of the object name.'
+        )
+        options.on(
+          '-V [VARNAME=VALUE]',
+          '--vars [VARNAME=VALUE]',
+          'Allows you to specify comma-separated variable names and values that will be converted into a hash that is available for you to use in your templates'
+        ) { |v| @data[:vars] = v }
+      end
+
+      def execute(type, name)
+        require 'abide_dev_utils/ppt/new_obj'
+        builder = AbideDevUtils::Ppt::NewObjectBuilder.new(
+          type,
+          name,
+          opts: @data,
+          vars: @data.fetch(:vars, '').split(',').map { |i| i.split('=') }.to_h # makes the str a hash
+        )
+        result = builder.build
+        Abide::CLI::OUTPUT.simple(result)
+      end
+    end
   end
 end

data/lib/abide_dev_utils/errors.rb

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

data/lib/abide_dev_utils/errors/ppt.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'abide_dev_utils/errors/base'
+
+module AbideDevUtils
+  module Errors
+    module Ppt
+      class ObjClassPathError < GenericError
+        @default = 'Invalid path for class:'
+      end
+
+      class CustomObjPathKeyError < GenericError
+        @default = 'Custom Object value hash does not have :path key: '
+      end
+
+      class CustomObjNotFoundError < GenericError
+        @default = 'Could not find custom object in map:'
+      end
+
+      class TemplateNotFoundError < GenericError
+        @default = 'Template does not exist at:'
+      end
+
+      class FailedToCreateFileError < GenericError
+        @default = 'Failed to create file:'
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/jira.rb

@@ -148,7 +148,7 @@ module AbideDevUtils
       false
     end
 
-    def self.summaries_from_coverage_report(report)
+    def self.summaries_from_coverage_report(report) # rubocop:disable Metrics/CyclomaticComplexity
       summaries = {}
       benchmark = nil
       report.each do |k, v|

data/lib/abide_dev_utils/ppt.rb

@@ -1,57 +1,15 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'pathname'
-require 'yaml'
-require 'puppet_pal'
+require 'abide_dev_utils/ppt/coverage'
+require 'abide_dev_utils/ppt/new_obj'
 
 module AbideDevUtils
   module Ppt
-    def self.coverage_report(puppet_class_dir, hiera_path, profile = nil)
-      coverage = {}
-      coverage['classes'] = {}
-      all_cap = find_all_classes_and_paths(puppet_class_dir)
-      invalid_classes = find_invalid_classes(all_cap)
-      valid_classes = all_cap.dup.transpose[0] - invalid_classes
-      coverage['classes']['invalid'] = invalid_classes
-      coverage['classes']['valid'] = valid_classes
-      hiera = YAML.safe_load(File.open(hiera_path))
-      matcher = profile.nil? ? /^profile_/ : /^profile_#{profile}/
-      hiera.each do |k, v|
-        key_base = k.split('::')[-1]
-        coverage['benchmark'] = v if key_base == 'title'
-        next unless key_base.match?(matcher)
-
-        coverage[key_base] = generate_uncovered_data(v, valid_classes)
-      end
-      coverage
-    end
-
-    def self.generate_uncovered_data(ctrl_list, valid_classes)
-      out_hash = {}
-      out_hash[:num_total] = ctrl_list.length
-      out_hash[:uncovered] = []
-      out_hash[:covered] = []
-      ctrl_list.each do |c|
-        if valid_classes.include?(c)
-          out_hash[:covered] << c
-        else
-          out_hash[:uncovered] << c
-        end
-      end
-      out_hash[:num_covered] = out_hash[:covered].length
-      out_hash[:num_uncovered] = out_hash[:uncovered].length
-      out_hash[:coverage] = Float(
-        (Float(out_hash[:num_covered]) / Float(out_hash[:num_total])) * 100.0
-      ).floor(3)
-      out_hash
-    end
-
     # Given a directory holding Puppet manifests, returns
     # the full namespace for all classes in that directory.
     # @param puppet_class_dir [String] path to a dir containing Puppet manifests
     # @return [String] The namespace for all classes in manifests in the dir
-    def self.find_class_namespace(puppet_class_dir)
+    def find_class_namespace(puppet_class_dir)
       path = Pathname.new(puppet_class_dir)
       mod_root = nil
       ns_parts = []
@@ -76,7 +34,7 @@ module AbideDevUtils
     # metadata.json, if it exists, or by using the parent directory name.
     # @param pathname [Pathname] A Pathname object of the module's manifests dir
     # @return [String] The module's namespace root
-    def self.find_mod_root(pathname)
+    def find_mod_root(pathname)
       metadata_file = nil
       pathname.entries.each do |e|
         metadata_file = "#{pathname}/metadata.json" if File.basename(e) == 'metadata.json'
@@ -94,7 +52,7 @@ module AbideDevUtils
 
     # @return [Array] An array of frozen arrays where each sub-array's
     #   index 0 is class_name and index 1 is the full path to the file.
-    def self.find_all_classes_and_paths(puppet_class_dir)
+    def find_all_classes_and_paths(puppet_class_dir)
       all_cap = []
       Dir.each_child(puppet_class_dir) do |c|
         path = "#{puppet_class_dir}/#{c}"
@@ -104,32 +62,5 @@ module AbideDevUtils
       end
       all_cap
     end
-
-    def self.find_valid_classes(all_cap)
-      all_classes = all_cap.dup.transpose[0]
-      all_classes - find_invalid_classes(all_cap)
-    end
-
-    def self.find_invalid_classes(all_cap)
-      invalid_classes = []
-      all_cap.each do |cap|
-        invalid_classes << cap[0] unless class_valid?(cap[1])
-      end
-      invalid_classes
-    end
-
-    def self.class_valid?(manifest_path)
-      compiler = Puppet::Pal::Compiler.new(nil)
-      ast = compiler.parse_file(manifest_path)
-      ast.body.body.statements.each do |s|
-        next unless s.respond_to?(:arguments)
-        next unless s.arguments.respond_to?(:each)
-
-        s.arguments.each do |i|
-          return false if i.value == 'Not implemented'
-        end
-      end
-      true
-    end
   end
 end

data/lib/abide_dev_utils/ppt/coverage.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'pathname'
+require 'yaml'
+require 'puppet_pal'
+require 'abide_dev_utils/ppt'
+
+module AbideDevUtils
+  module Ppt
+    class CoverageReport
+      include AbideDevUtils::Ppt
+      def self.generate(puppet_class_dir, hiera_path, profile = nil)
+        coverage = {}
+        coverage['classes'] = {}
+        all_cap = find_all_classes_and_paths(puppet_class_dir)
+        invalid_classes = find_invalid_classes(all_cap)
+        valid_classes = all_cap.dup.transpose[0] - invalid_classes
+        coverage['classes']['invalid'] = invalid_classes
+        coverage['classes']['valid'] = valid_classes
+        hiera = YAML.safe_load(File.open(hiera_path))
+        matcher = profile.nil? ? /^profile_/ : /^profile_#{profile}/
+        hiera.each do |k, v|
+          key_base = k.split('::')[-1]
+          coverage['benchmark'] = v if key_base == 'title'
+          next unless key_base.match?(matcher)
+
+          coverage[key_base] = generate_uncovered_data(v, valid_classes)
+        end
+        coverage
+      end
+
+      def self.generate_uncovered_data(ctrl_list, valid_classes)
+        out_hash = {}
+        out_hash[:num_total] = ctrl_list.length
+        out_hash[:uncovered] = []
+        out_hash[:covered] = []
+        ctrl_list.each do |c|
+          if valid_classes.include?(c)
+            out_hash[:covered] << c
+          else
+            out_hash[:uncovered] << c
+          end
+        end
+        out_hash[:num_covered] = out_hash[:covered].length
+        out_hash[:num_uncovered] = out_hash[:uncovered].length
+        out_hash[:coverage] = Float(
+          (Float(out_hash[:num_covered]) / Float(out_hash[:num_total])) * 100.0
+        ).floor(3)
+        out_hash
+      end
+
+      def self.find_valid_classes(all_cap)
+        all_classes = all_cap.dup.transpose[0]
+        all_classes - find_invalid_classes(all_cap)
+      end
+
+      def self.find_invalid_classes(all_cap)
+        invalid_classes = []
+        all_cap.each do |cap|
+          invalid_classes << cap[0] unless class_valid?(cap[1])
+        end
+        invalid_classes
+      end
+
+      def self.class_valid?(manifest_path)
+        compiler = Puppet::Pal::Compiler.new(nil)
+        ast = compiler.parse_file(manifest_path)
+        ast.body.body.statements.each do |s|
+          next unless s.respond_to?(:arguments)
+          next unless s.arguments.respond_to?(:each)
+
+          s.arguments.each do |i|
+            return false if i.value == 'Not implemented'
+          end
+        end
+        true
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/ppt/new_obj.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'pathname'
+require 'abide_dev_utils/prompt'
+require 'abide_dev_utils/errors/ppt'
+
+module AbideDevUtils
+  module Ppt
+    class NewObjectBuilder
+      DEFAULT_EXT = '.pp'
+
+      def initialize(obj_type, obj_name, opts: {}, vars: {})
+        @obj_type = obj_type
+        @obj_name = obj_name.split(':').reject(&:empty?).join('::') # removes 
+        @obj_basename = obj_name.split('::')[-1]
+        @root_dir = Pathname.new(opts.fetch(:root_dir, Dir.pwd))
+        @tmpl_dir = if opts.fetch(:absolute_template_dir, false)
+                      opts.fetch(:tmpl_dir)
+                    else
+                      "#{@root_dir}/#{opts.fetch(:tmpl_dir, 'object_templates')}"
+                    end
+        @tmpl_name = opts.fetch(:tmpl_name, "#{@obj_type}.erb")
+        @tmpl_path = Pathname.new("#{@tmpl_dir}/#{@tmpl_name}")
+        @type_path_map = opts.fetch(:type_path_map, {})
+        @vars = vars
+      end
+
+      def obj_path
+        case @obj_type
+        when 'class'
+          obj_path_from_name
+        else
+          custom_obj_path
+        end
+      end
+
+      def template?
+        @tmpl_path.file?
+      end
+
+      def render
+        raise AbideDevUtils::Errors::Ppt::TemplateNotFoundError, @tmpl_path.to_s unless template?
+
+        ERB.new(File.read(@tmpl_path.to_s), 0, '<>-').result(binding)
+      end
+
+      def build
+        continue = File.exist?(obj_path) ? AbideDevUtils::Prompt.yes_no('File exists, would you like to overwrite?') : true
+        return "Not overwriting file #{obj_path}" unless continue
+
+        dir, = Pathname.new(obj_path).split
+        Pathname.new(dir).mkpath unless Dir.exist?(dir)
+        content = render
+        File.open(obj_path, 'w') { |f| f.write(render) } unless content.empty?
+        raise AbideDevUtils::Errors::Ppt::FailedToCreateFileError, obj_path unless File.file?(obj_path)
+
+        "Created file #{obj_path}"
+      end
+
+      # If a method gets called on the Hiera object which is not defined,
+      # this sends that method call to hash, then doc, then super.
+      def method_missing(method, *args, &block)
+        return true if ['exist?', 'exists?'].include?(method.to_s)
+
+        return @hash.send(method, *args, &block) if @hash.respond_to?(method)
+
+        return @doc.send(method, *args, &block) if @doc.respond_to?(method)
+
+        super(method, *args, &block)
+      end
+
+      # Checks the respond_to? of hash, doc, or super
+      def respond_to_missing?(method_name, include_private = false)
+        return true if ['exist?', 'exists?'].include?(method_name.to_s)
+
+        @hash || @doc || super
+      end
+
+      private
+
+      def obj_path_from_name
+        parts = @obj_name.split('::')[1..-2]
+        parts.insert(0, 'manifests')
+        parts.insert(-1, "#{@obj_basename}#{DEFAULT_EXT}")
+        path = @root_dir + Pathname.new(parts.join('/'))
+        path.to_s
+      end
+
+      def custom_obj_path
+        map_val = @type_path_map.fetch(@obj_type.to_sym, nil)
+        return obj_path_from_name if map_val.nil?
+
+        if map_val.respond_to?(:key?)
+          custom_obj_path_from_hash(map_val)
+        else
+          abs_path = Pathname.new(map_val).absolute? ? map_val : "#{Dir.pwd}/#{map_val}"
+          "#{abs_path}/#{@obj_basename}#{DEFAULT_EXT}"
+        end
+      end
+
+      def custom_obj_path_from_hash(map_val)
+        raise AbideDevUtils::Errors::Ppt::CustomObjPathKeyError, map_val unless map_val.key?(:path)
+
+        abs_path = Pathname.new(map_val[:path]).absolute? ? map_val[:path] : "#{Dir.pwd}/#{map_val[:path]}"
+        if map_val.key?(:extension)
+          "#{abs_path}/#{@obj_basename}#{map_val[:extension]}"
+        else
+          "#{abs_path}/#{@obj_basename}#{DEFAULT_EXT}"
+        end
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AbideDevUtils
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abide_dev_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Heston Snodgrass
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-26 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -226,14 +226,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.8'
 description: Provides a CLI with helpful utilities for developing Abide
 email:
 - hsnodgrass3@gmail.com
@@ -258,6 +258,7 @@ files:
 - exe/abide
 - lib/abide_dev_utils.rb
 - lib/abide_dev_utils/cli.rb
+- lib/abide_dev_utils/cli/abstract.rb
 - lib/abide_dev_utils/cli/jira.rb
 - lib/abide_dev_utils/cli/puppet.rb
 - lib/abide_dev_utils/cli/test.rb
@@ -268,11 +269,14 @@ files:
 - lib/abide_dev_utils/errors/base.rb
 - lib/abide_dev_utils/errors/general.rb
 - lib/abide_dev_utils/errors/jira.rb
+- lib/abide_dev_utils/errors/ppt.rb
 - lib/abide_dev_utils/errors/xccdf.rb
 - lib/abide_dev_utils/files.rb
 - lib/abide_dev_utils/jira.rb
 - lib/abide_dev_utils/output.rb
 - lib/abide_dev_utils/ppt.rb
+- lib/abide_dev_utils/ppt/coverage.rb
+- lib/abide_dev_utils/ppt/new_obj.rb
 - lib/abide_dev_utils/prompt.rb
 - lib/abide_dev_utils/utils/general.rb
 - lib/abide_dev_utils/validate.rb