abide_dev_utils 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e19e043b233c6842331d4c4883a74d8557b163739e041d910b60b953acddc85
-  data.tar.gz: cf425a2b3a0c83ecd5e41cbee5d476fc7444e8984f4f03df12f91b36ad8aeee8
+  metadata.gz: c4ee71223292cc98028db5407eaef69cb2a0a150de9552b4d51d3b1ee17197bf
+  data.tar.gz: 3f56a0ad99e2ae3ccc8478210f7bb1961c4500267bedc1d42612c1947ee7c3fb
 SHA512:
-  metadata.gz: 52e685b3d446b7c6256fd0e45d0542dccc77490b75ccc6408e2ba66e8edbc49d76267446940b997a0e3ab6a7449e1c5a03323c98cc66dd34ca58fa87178d4602
-  data.tar.gz: 558295f45b37110781fcd22bc4cac8a450c520f706933ddc0fe908c4f2ef863b63029603ab3e1df09142a17c6238f3f5514f20e4fefcc1ed6e2a5531abc5a479
+  metadata.gz: 821d519b152ffc0a246939050b2b6117b5f3986fdf094d6333cfef8617b06c1572517a93b96f76039368c860715a4ef7ef39c78c039581369c4e61b484bce0c0
+  data.tar.gz: 6010ad3359da0de05b352e48210f3e4ddbd95b30e942598c6e6cfa77c175a1041ab87491d2a2afa15490a12fc197c549ab5d58dbb4bfc816e569afe5ac66dd9e

data/README.md

@@ -128,6 +128,8 @@ Install the gem:
   * `--absolute-template-dir`, `-A` - Allows you to specify an absolute path with `--template-dir`. This is useful if your template directory is not relative to your module's root directory
   * `--template-name`, `-n` - Allows you to specify a template name if it is different than the `TYPE` parameter
   * `--vars`, `-V` - Comma-separated key=value pairs to pass in to the template renderer. This allows you to pass arbitrary values that can be used in your templates.
+  * `--spec-template`, `-S` - Path to an ERB template to use for rspec test generation instead of the default
+  * `--force`, `-f` - Skips any prompts and executes the command
 
 `abide puppet new` exposes a few variables for you to use in your templates by default:
 
@@ -179,8 +181,10 @@ $ ls manifests
 init.pp
 $ abide puppet new control_class 'test_module::controls::test_new_control'
 Created file /Users/the.dude/test_module/manifests/controls/test_new_control.pp
+Created file /Users/the.dude/test_module/spec/classes/controls/test_new_control_spec.rb
 $ abide puppet new util_class 'test_module::utils::test_new_util' -v 'testvar1=dude,testvar2=sweet'
 Created file /Users/the.dude/test_module/manifests/utils/test_new_util.pp
+Created file /Users/the.dude/test_module/spec/classes/utils/test_new_util_spec.rb
 $ cat manifests/controls/test_new_control.pp
 # @api private
 class test_module::controls::test_new_control (
@@ -204,6 +208,9 @@ class test_module::utils::test_new_util (
 
 ```
 
+**NOTE**: You can use two special prefixes on your template files to denote where the rspec test should be generated for that object.
+If the prefix `c-` is used, the test will be generated in the `spec/classes` directory. If the prefix `d-` is used, the test will be generated in the `spec/defines` directory. For example, to create a template for a defined type, name the template something like this: `d-my_defined_type.pp.erb`.
+
 ### XCCDF Command Reference
 
 #### to_hiera

data/lib/abide_dev_utils/cli/puppet.rb

@@ -87,6 +87,16 @@ module Abide
           '--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 }
+        options.on(
+          '-S [PATH]',
+          '--spec-template [PATH]',
+          'Path to an ERB template to use for rspec test generation instead of the default'
+        )
+        options.on(
+          '-f',
+          '--force',
+          'Skips any prompts and executes the command'
+        ) { |_| @data[:force] = true }
       end
 
       def execute(type, name)
@@ -97,8 +107,7 @@ module Abide
           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)
+        builder.build
       end
     end
   end

data/lib/abide_dev_utils/ppt/new_obj.rb

@@ -2,6 +2,7 @@
 
 require 'erb'
 require 'pathname'
+require 'abide_dev_utils/output'
 require 'abide_dev_utils/prompt'
 require 'abide_dev_utils/errors/ppt'
 
@@ -9,6 +10,10 @@ module AbideDevUtils
   module Ppt
     class NewObjectBuilder
       DEFAULT_EXT = '.pp'
+      VALID_EXT = /(\.pp|\.rb)\.erb$/.freeze
+      TMPL_PATTERN = /^[a-zA-Z][^\s]*\.erb$/.freeze
+      OBJ_PREFIX = /^(c-|d-)/.freeze
+      PREFIX_TEST_PATH = { 'c-' => 'classes', 'd-' => 'defines' }.freeze
 
       def initialize(obj_type, obj_name, opts: {}, vars: {})
         @obj_type = obj_type
@@ -19,23 +24,14 @@ module AbideDevUtils
         validate_class_vars
       end
 
-      attr_reader :obj_type, :obj_name, :tmpl_name, :root_dir, :tmpl_dir, :tmpl_path, :type_path_map, :obj_path, :vars
-
-      def render
-        ERB.new(File.read(@tmpl_path.to_s), 0, '<>-').result(binding)
-      end
+      attr_reader :obj_type, :obj_name, :root_dir, :tmpl_dir, :obj_path, :vars
 
       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}"
+        force = @opts.fetch(:force, false)
+        obj_cont = force ? true : continue?(obj_path)
+        spec_cont = force ? true : continue?(@tmpl_data[:spec_path])
+        write_file(obj_path, @tmpl_data[:path]) if obj_cont
+        write_file(@tmpl_data[:spec_path], @spec_tmpl) if spec_cont
       end
 
       # If a method gets called on the Hiera object which is not defined,
@@ -59,42 +55,99 @@ module AbideDevUtils
 
       private
 
+      def continue?(path)
+        continue = if File.exist?(path)
+                     AbideDevUtils::Prompt.yes_no('File exists, would you like to overwrite?')
+                   else
+                     true
+                   end
+        AbideDevUtils::Output.simple("Not overwriting file #{path}") unless continue
+
+        continue
+      end
+
+      def write_file(path, tmpl_path)
+        dir, = Pathname.new(path).split
+        Pathname.new(dir).mkpath unless Dir.exist?(dir)
+        content = render(tmpl_path)
+        File.open(path, 'w') { |f| f.write(content) } unless content.empty?
+        raise AbideDevUtils::Errors::Ppt::FailedToCreateFileError, path unless File.file?(path)
+
+        AbideDevUtils::Output.simple("Created file #{path}")
+      end
+
+      def build_obj; end
+
       def class_vars
-        @tmpl_name = @opts.fetch(:tmpl_name, "#{@obj_type}.erb")
         @root_dir = Pathname.new(@opts.fetch(:root_dir, Dir.pwd))
         @tmpl_dir = if @opts.fetch(:absolute_template_dir, false)
                       @opts.fetch(:tmpl_dir)
                     else
-                      "#{@opts.fetch(:root_dir, Dir.pwd)}/#{@opts.fetch(:tmpl_dir, 'object_templates')}"
+                      "#{@root_dir}/#{@opts.fetch(:tmpl_dir, 'object_templates')}"
                     end
-        @tmpl_path = Pathname.new("#{@tmpl_dir}/#{@opts.fetch(:tmpl_name, "#{@obj_type}.erb")}")
-        @type_path_map = @opts.fetch(:type_path_map, {})
+        @tmpl_data = template_data(@opts.fetch(:tmpl_name, @obj_type))
         @obj_path = new_obj_path
+        @spec_tmpl = @opts.fetch(:spec_template, File.expand_path(File.join(__dir__, '../resources/generic_spec.erb')))
       end
 
       def validate_class_vars
         raise AbideDevUtils::Errors::PathNotDirectoryError, @root_dir unless Dir.exist? @root_dir
         raise AbideDevUtils::Errors::PathNotDirectoryError, @tmpl_dir unless Dir.exist? @tmpl_dir
-        raise AbideDevUtils::Errors::Ppt::TemplateNotFoundError, @tmpl_path.to_s unless @tmpl_path.file?
       end
 
       def basename(obj_name)
         obj_name.split('::')[-1]
       end
 
-      def new_obj_path
-        if obj_type == 'class'
-          obj_path_from_name
-        else
-          custom_obj_path
+      def prefix
+        pfx = basename.match(OBJ_PREFIX)
+        return pfx[1] unless pfx.empty?
+      end
+
+      def templates
+        return [] if Dir.entries(tmpl_dir).empty?
+
+        file_names = Dir.entries(tmpl_dir).select { |f| f.match?(TMPL_PATTERN) }
+        file_names.map { |i| File.join(tmpl_dir, i) }
+      end
+
+      def template_data(query)
+        raise AbideDevUtils::Errors::Ppt::TemplateNotFoundError, @tmpl_dir if Dir.entries(@tmpl_dir).empty?
+
+        data = {}
+        pattern = /#{Regexp.quote(query)}/
+        templates.each do |i|
+          pn = Pathname.new(i)
+          next unless pn.basename.to_s.match?(pattern)
+
+          data[:path] = pn.to_s
+          data[:fname] = pn.basename.to_s
         end
+        raise AbideDevUtils::Errors::Ppt::TemplateNotFoundError, @tmpl_dir unless data.key?(:fname)
+
+        data[:ext] = data[:fname].match?(VALID_EXT) ? data[:fname].match(VALID_EXT)[1] : '.pp'
+        data[:pfx] = data[:fname].match?(OBJ_PREFIX) ? data[:fname].match(OBJ_PREFIX)[1] : 'c-'
+        data[:spec_base] = PREFIX_TEST_PATH[data[:pfx]]
+        data[:obj_name] = normalize_obj_name(data.dup)
+        data[:spec_name] = "#{data[:obj_name].slice(/([^\s]+)(?:#{Regexp.quote(data[:ext])})/, 1)}_spec.rb"
+        data[:spec_path] = spec_path(data[:spec_base], data[:spec_name])
+        data
+      end
+
+      def normalize_obj_name(data)
+        new_name = data[:fname].slice(/^(?:#{Regexp.quote(data[:pfx])})?(?<name>[^\s.]+)(?:#{Regexp.quote(data[:ext])})?\.erb$/, 'name')
+        "#{new_name}#{data[:ext]}"
+      end
+
+      def render(path)
+        ERB.new(File.read(path), 0, '<>-').result(binding)
       end
 
       def namespace_format(name)
         name.split(':').reject(&:empty?).join('::')
       end
 
-      def obj_path_from_name
+      def new_obj_path
         parts = @obj_name.split('::')[1..-2]
         parts.insert(0, 'manifests')
         parts.insert(-1, "#{basename(@obj_name)}#{DEFAULT_EXT}")
@@ -102,27 +155,13 @@ module AbideDevUtils
         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, @obj_name)
-        else
-          abs_path = Pathname.new(map_val).absolute? ? map_val : "#{Dir.pwd}/#{map_val}"
-          "#{abs_path}/#{basename(@obj_name)}#{DEFAULT_EXT}"
-        end
-      end
-
-      def custom_obj_path_from_hash(map_val, obj_name)
-        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}/#{basename(obj_name)}#{map_val[:extension]}"
-        else
-          "#{abs_path}/#{basename(obj_name)}#{DEFAULT_EXT}"
-        end
+      def spec_path(base_dir, spec_name)
+        parts = @obj_name.split('::')[1..-2]
+        parts.insert(0, 'spec')
+        parts.insert(1, base_dir)
+        parts.insert(-1, spec_name)
+        path = @root_dir + Pathname.new(parts.join('/'))
+        path.to_s
       end
     end
   end

data/lib/abide_dev_utils/resources/generic_spec.erb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '<%= @obj_name %>' do
+  on_supported_os.each do |os, os_facts|
+    context "on #{os}" do
+      let(:facts) { os_facts }
+
+      it { is_expected.to compile }
+    end
+  end
+end

data/lib/abide_dev_utils/version.rb

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

data/lib/abide_dev_utils/xccdf/cis/hiera.rb

@@ -114,7 +114,7 @@ module AbideDevUtils
 
         def normalize_str(str)
           nstr = str.downcase
-          nstr.gsub!(/[^a-z]$/, '')
+          nstr.gsub!(/[^a-z0-9]$/, '')
           nstr.gsub!(/^[^a-z]/, '')
           nstr.gsub!(/^(l1_|l2_|ng_)/, '')
           nstr.delete!('(/|\\)')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abide_dev_utils
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Heston Snodgrass
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2021-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -278,6 +278,7 @@ files:
 - 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/resources/generic_spec.erb
 - lib/abide_dev_utils/utils/general.rb
 - lib/abide_dev_utils/validate.rb
 - lib/abide_dev_utils/version.rb