puppet-retrospec 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27cdd72f261a6435b150e84efb8d4c275f331b29874744d7d2951a6aa3a09f29
-  data.tar.gz: 1a129e2fb6b34b42af3fae5caae73e093b8992760f2213a3d78e1c23c7c09fd0
+  metadata.gz: c5281f0e925c582ae6b13d860d21a9121f2544b1817feb8de0bd7ca443f73208
+  data.tar.gz: 256827372f2b26f19ac30c9b9d679a1d419977207fa7ed5141da0d7ae5a05c6a
 SHA512:
-  metadata.gz: f3181062fdb594c444dbe2928b4fbcb5c020566e8c42a415774e01f593bf4fcb6f6f3d5644726955f12452952d2230a3fcb93b295ef57bd594aeaeb8cbb7af9d
-  data.tar.gz: 5d08f7a3dd567eba29f6de1d46313cb7711ce48bd53321ea3390e306d5fbbd93de1ceec13eccf56dad3e1cc4b66ef846f311d4ccbc91b474f7eef7953b74bd47
+  metadata.gz: 847d7ecdb5aa7b16b9855491e174b97e126cb23958698fd5f9c6a08a1855bbe8e47d56aba88ef0f12b45f72bed9228e8f6db7ab191f83d4f0c3ec3de654b509d
+  data.tar.gz: fbb3390ab4b005fcd13f40cc0b05d24974be2bac7db58b4c04b3c04c88da3b9b159b607589088a4388c474df3153c37fcfb42b58b47fde20aa7f6caed602d5af

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/Gemfile

@@ -12,6 +12,7 @@ group :development do
 end
 
 group :test do
+  gem 'rb-readline'
   gem 'bundler', '~> 2.0'
   gem 'fakefs', :require => 'fakefs/safe'
   gem 'json_pure', '= 2.0.1' # force this gem as 2.0.2 requires ruby > 2.0.0

data/Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    puppet-retrospec (1.7.0)
+    puppet-retrospec (1.8.0)
       awesome_print
       facets
       optimist (~> 3.0.0)
@@ -49,6 +49,7 @@ GEM
       method_source (~> 0.9.0)
     rainbow (3.0.0)
     rake (12.3.2)
+    rb-readline (0.5.5)
     rdoc (3.12.2)
       json (~> 1.4)
     rspec (3.8.0)
@@ -91,6 +92,7 @@ DEPENDENCIES
   puppet (= 4.10.8)!
   puppet-retrospec!
   rake
+  rb-readline
   rdoc (~> 3.12)
   retrospec!
   rspec (~> 3.2)

data/lib/retrospec/plugins/v1/plugin/generators/base_generator.rb

@@ -46,6 +46,42 @@ module Retrospec
           raise NotImplementedError
         end
 
+        # generates a file path for spec tests based on the resource name.  An added option
+        # is to generate directory names for each parent resource as a default option
+        def item_spec_path
+          file_name = generate_file_name(item_name.downcase)
+          path = generate_path("#{file_name}_spec.rb", item_name)
+          File.join(spec_path, path )
+        end
+
+        # returns the base filename of the type
+        def generate_file_name(iname)
+          tokens = iname.split('::')
+          file_name = tokens.pop
+        end
+
+        # @return [String] - a generated path
+        # @param file_name - the base name of the file to create
+        # @param iname - the type name or name of item
+        def generate_path(file_name, iname = item_name)
+          tokens = iname.split('::')
+          # if there are only two tokens ie. tomcat::params we dont need to create a subdirectory
+          if tokens.count > 2
+            # this is a deep level resource ie. tomcat::config::server::connector
+            # however we don't need the tomcat directory so we can just remove it
+            # this should leave us with config/server/connector_spec.rb
+            tokens.delete_at(0)
+            # remove the last token since its the class name
+            tokens.pop
+            # so lets make a directory structure out of it
+            dir_name = File.join(tokens) # config/server
+            dir_name = File.join(dir_name, file_name) # spec/classes/tomcat/config/server
+          else
+            dir_name = File.join(file_name)
+          end
+          dir_name.downcase
+        end
+
         # run is the main method that gets called automatically
         def run
           generate_lib_files
@@ -59,10 +95,6 @@ module Retrospec
           File.join(lib_path, "#{item_name}.rb")
         end
 
-        def item_spec_path
-          File.join(spec_path, "#{item_name}_spec.rb")
-        end
-
         def spec_path
           File.join(module_path, 'spec', 'unit', 'puppet', plural_name)
         end

data/lib/retrospec/plugins/v1/plugin/generators/data_type_generator.rb

@@ -0,0 +1,59 @@
+# require 'retrospec/plugins/v1/module_helpers'
+# require 'retrospec/plugins/v1'
+require_relative 'resource_base_generator'
+
+module Retrospec
+  module Puppet
+    module Generators
+      class DataTypeGenerator < Retrospec::Puppet::Generators::ResourceBaseGenerator
+
+        def initialize(module_path, spec_object = {})
+          super
+          @singular_name = 'type_alias'
+          @plural_name = 'type_aliases'
+        end
+
+        def self.manifest_files(module_path)
+          Dir.glob(File.join(module_path, 'types', '**', '*.pp'))
+        end
+
+        def spec_template_file
+          'datatype_spec.rb.retrospec.erb'
+        end
+
+        def load_context_data
+          context.content = generate_content
+          context.parameters = parameters
+          context.type_name = type_name
+          context.resource_type = resource_type
+          context.resource_type_name = resource_type_name
+          context
+        end
+
+        def self.generate_spec_files(module_path, config_data)
+          manifest_files(module_path).map do |file|
+            datatype = new(module_path, config_data.merge({:manifest_file => file}))
+            next unless datatype.resource_type == ::Puppet::Pops::Model::TypeAlias
+            datatype.generate_spec_file
+          end.flatten
+        end
+
+        # returns the path to the templates
+        # first looks inside the external templates directory for specific file
+        # then looks inside the gem path templates directory, which is really only useful
+        # when developing new templates.
+        def template_dir
+          if config_data[:template_dir]
+            external_templates = Dir.glob(File.expand_path(File.join(config_data[:template_dir], 'type_aliases', '*.erb')))
+          end
+          if external_templates and external_templates.count > 0
+            File.join(config_data[:template_dir], 'type_aliases')
+          else
+            File.expand_path(File.join(File.dirname(File.dirname(__FILE__)), 'templates', 'type_aliases'))
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/retrospec/plugins/v1/plugin/generators/resource_base_generator.rb

@@ -12,9 +12,16 @@ module Retrospec
         # retrospec will initilalize this class so its up to you
         # to set any additional variables you need to get the job done.
         def initialize(module_path, spec_object = {})
+          spec_object.merge!({:manifest_file => spec_object[:manifest_file],
+            :content => nil, name: spec_object[:name]})
           super
-          raise "NoManifestFileError" unless spec_object[:manifest_file]
-          @context = OpenStruct.new(:manifest_file => spec_object[:manifest_file], :content => nil)
+        end
+
+        def item_spec_path
+          iname = type_name || item_name
+          file_name = generate_file_name(iname.downcase)
+          path = generate_path("#{file_name}_spec.rb", iname)
+          File.join(spec_path, path )
         end
 
         def singular_name
@@ -61,6 +68,7 @@ module Retrospec
         def self.generate_spec_files(module_path, config_data)
           manifests = manifest_files(module_path)
           files = Retrospec::Puppet::Generators::HostClassGenerator.generate_spec_files(module_path, config_data)
+          files << Retrospec::Puppet::Generators::DataTypeGenerator.generate_spec_files(module_path, config_data)
           files << Retrospec::Puppet::Generators::DefinitionGenerator.generate_spec_files(module_path, config_data)
           files.flatten
         end
@@ -158,40 +166,7 @@ module Retrospec
         # for files that have multiple types, we just don't care since it doesn't
         # follow the style guide
         def type_name
-          if ast.eContents.first.respond_to?(:name)
-            ast.eContents.first.name
-          else
-            #ast.eContents.first.host_matches.first
-          end
-        end
-
-        # returns the filename of the type
-        def generate_file_name(type_name)
-          tokens = type_name.split('::')
-          file_name = tokens.pop
-          "#{file_name}_spec.rb"
-        end
-
-        # generates a file path for spec tests based on the resource name.  An added option
-        # is to generate directory names for each parent resource as a default option
-        def item_spec_path
-          file_name = generate_file_name(type_name)
-          tokens = type_name.split('::')
-          # if there are only two tokens ie. tomcat::params we dont need to create a subdirectory
-          if tokens.count > 2
-            # this is a deep level resource ie. tomcat::config::server::connector
-            # however we don't need the tomcat directory so we can just remove it
-            # this should leave us with config/server/connector_spec.rb
-            tokens.delete_at(0)
-            # remove the last token since its the class name
-            tokens.pop
-            # so lets make a directory structure out of it
-            dir_name = File.join(tokens) # config/server
-            dir_name = File.join(spec_path, dir_name, file_name) # spec/classes/tomcat/config/server
-          else
-            dir_name = File.join(spec_path, file_name)
-          end
-          dir_name
+          ast.eContents.first.name if ast.eContents.first.respond_to?(:name)
         end
 
         def ast

data/lib/retrospec/plugins/v1/plugin/generators/task_generator.rb

@@ -58,10 +58,6 @@ module Retrospec
           File.join(module_path, 'tasks', "#{item_name}.json")
         end
 
-        def item_spec_path
-          File.join(spec_path, plural_name, "#{item_name}_spec.rb")
-        end
-
         def enable_beaker_tasks?
           false
         end

data/lib/retrospec/plugins/v1/plugin/generators/type_generator.rb

@@ -29,7 +29,7 @@ module Retrospec
           if CORE_TYPES.include?(spec_object[:name])
             raise Retrospec::Puppet::Generators::CoreTypeException
           end
-          @context = OpenStruct.new(:type_name => spec_object[:name], :parameters => spec_object[:parameters],
+          @context = OpenStruct.new(:type_name => spec_object[:name], name: spec_object[:name], :parameters => spec_object[:parameters],
                                     :properties => spec_object[:properties], :providers => spec_object[:providers])
         end
 

data/lib/retrospec/plugins/v1/plugin/version.rb

@@ -1,5 +1,5 @@
 module Retrospec
   module Puppet
-    VERSION = '1.7.0'
+    VERSION = '1.8.0'
   end
 end

data/spec/fixtures/fixture_modules/one_resource_module/types/ext/sudoers_entry.pp

@@ -0,0 +1 @@
+type Sample_module::Ext::Sudoers_entry = Variant[String, Array[String]]

data/spec/fixtures/fixture_modules/one_resource_module/types/sudoers_entry.pp

@@ -0,0 +1 @@
+type Sample_module::Sudoers_entry = Variant[String, Array[String]]

data/spec/fixtures/fixture_modules/sample_module/types/ext/sudoers_entry.pp

@@ -0,0 +1 @@
+type Sample_module::Ext::Sudoers_entry = Variant[String, Array[String]]

data/spec/fixtures/fixture_modules/sample_module/types/sudoers_entry.pp

@@ -0,0 +1 @@
+type Sample_module::Sudoers_entry = Variant[String, Array[String]]

data/spec/unit/generators/data_type_generator_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe 'datatype_generator' do
+  before(:each) do
+    FileUtils.rm_rf(spec_files_path) if File.exist?(spec_files_path)
+  end
+
+  let(:generator_opts) do
+    { :name => 'sudoers_entry', :puppet_context => puppet_context, :template_dir => retrospec_templates_path
+    }
+  end
+
+  let(:generator_opts) do
+    { :manifest_file => sample_file, :template_dir => retrospec_templates_path }
+  end
+
+  let(:sample_file) do
+    File.join(fixtures_path, 'manifests', 'sql.pp')
+  end
+
+  let(:module_path) do
+    sample_module_path
+  end
+
+  let(:spec_files_path) do
+    File.join(module_path, 'spec', 'type_aliases')
+  end
+
+  let(:datatypes_path) do
+    File.join(module_path, 'types')
+  end
+
+  let(:puppet_context) do
+    path = File.join(fixture_modules_path, 'tomcat')
+    opts = { :module_path => path, :enable_beaker_tests => false, :name => 'name-test123',
+             :enable_user_templates => false, :template_dir => retrospec_templates_path }
+    mod = Retrospec::Plugins::V1::Puppet.new(opts[:module_path], opts)
+    mod.post_init
+    mod.context
+  end
+
+  let(:generator) do
+    Retrospec::Puppet::Generators::DataTypeGenerator.new(module_path, generator_opts)
+  end
+
+  it 'should create datatype spec file' do
+    Retrospec::Puppet::Generators::DataTypeGenerator.generate_spec_files(module_path, generator_opts)
+    expect(File.exist?(File.join(spec_files_path, 'sudoers_entry_spec.rb'))).to eq(true)
+  end
+
+  it 'should create datatype ext spec file' do
+    Retrospec::Puppet::Generators::DataTypeGenerator.generate_spec_files(module_path, generator_opts)
+    expect(File.exist?(File.join(spec_files_path, 'ext','sudoers_entry_spec.rb'))).to eq(true)
+  end
+
+  it '#self.manifest_files' do
+    files = Retrospec::Puppet::Generators::DataTypeGenerator.manifest_files(module_path)
+    expect(files.count).to be > 0
+  end
+
+end

data/spec/unit/generators/hostclass_generator_spec.rb

@@ -37,8 +37,6 @@ describe 'HostClassGenerator' do
     File.read(generator.generate_spec_file)
   end
 
-
-
   it 'should create spec file' do
     expect(generator.run).to eq(spec_file)
     expect(File.exist?(spec_file)).to eq(true)

data/spec/unit/generators/resource_base_generator_spec.rb

@@ -34,7 +34,12 @@ describe Retrospec::Puppet::Generators::ResourceBaseGenerator do
      File.join(spec_files_path, 'classes', 'sub', 'settings_spec.rb'),
      File.join(spec_files_path, 'defines', 'sub', 'settings_define_spec.rb'),
      File.join(spec_files_path, 'classes', 'parameter_logic_spec.rb'),
-    File.join(spec_files_path, 'defines', 'one_define_spec.rb')]
+    File.join(spec_files_path, 'defines', 'one_define_spec.rb'),
+    File.join(spec_files_path, 'type_aliases', 'ext', 'sudoers_entry_spec.rb'),
+    File.join(spec_files_path, 'type_aliases','sudoers_entry_spec.rb')
+
+
+  ]
   end
 
   it 'should generate a bunch of files' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-retrospec
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Corey Osman
@@ -112,6 +112,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - DEVELOPMENT.md
 - Dockerfile
@@ -125,6 +126,7 @@ files:
 - lib/retrospec/plugins/v1/plugin/generators.rb
 - lib/retrospec/plugins/v1/plugin/generators/acceptance_generator.rb
 - lib/retrospec/plugins/v1/plugin/generators/base_generator.rb
+- lib/retrospec/plugins/v1/plugin/generators/data_type_generator.rb
 - lib/retrospec/plugins/v1/plugin/generators/definition_generator.rb
 - lib/retrospec/plugins/v1/plugin/generators/fact_generator.rb
 - lib/retrospec/plugins/v1/plugin/generators/function_generator.rb
@@ -168,6 +170,8 @@ files:
 - spec/fixtures/fixture_modules/one_resource_module/manifests/params.pp
 - spec/fixtures/fixture_modules/one_resource_module/manifests/sub/settings.pp
 - spec/fixtures/fixture_modules/one_resource_module/manifests/sub/settings_define.pp
+- spec/fixtures/fixture_modules/one_resource_module/types/ext/sudoers_entry.pp
+- spec/fixtures/fixture_modules/one_resource_module/types/sudoers_entry.pp
 - spec/fixtures/fixture_modules/required_parameters/manifests/init.pp
 - spec/fixtures/fixture_modules/sample_module/lib/facter/fix_installed.rb
 - spec/fixtures/fixture_modules/sample_module/lib/puppet/functions/awesome_parser.rb
@@ -178,6 +182,8 @@ files:
 - spec/fixtures/fixture_modules/sample_module/lib/puppet/reports/test
 - spec/fixtures/fixture_modules/sample_module/manifests/init.pp
 - spec/fixtures/fixture_modules/sample_module/spec/unit/facter/fix_installed_spec.rb
+- spec/fixtures/fixture_modules/sample_module/types/ext/sudoers_entry.pp
+- spec/fixtures/fixture_modules/sample_module/types/sudoers_entry.pp
 - spec/fixtures/fixture_modules/zero_resource_module/manifests/empty_class.pp
 - spec/fixtures/fixture_modules/zero_resource_module/manifests/not_a_resource_defination.pp
 - spec/fixtures/fixture_modules/zero_resource_module/metadata.json
@@ -415,6 +421,7 @@ files:
 - spec/integration/retrospec_spec.rb
 - spec/spec_helper.rb
 - spec/unit/generators/acceptance_generator_spec.rb
+- spec/unit/generators/data_type_generator_spec.rb
 - spec/unit/generators/definition_generator_spec.rb
 - spec/unit/generators/fact_generater_spec.rb
 - spec/unit/generators/function_generator_spec.rb