puppet-retrospec 1.0.0 → 1.1.0

data/spec/fixtures/fixture_modules/sample_module/lib/puppet/functions/awesome_parser.rb

@@ -1,5 +1,19 @@
 # extremely helpful documentation
 # https://github.com/puppetlabs/puppet-specifications/blob/master/language/func-api.md#the-4x-api
+
+# Example Documention for function using puppet strings
+# https://github.com/puppetlabs/puppetlabs-strings
+# When given two numbers, returns the one that is larger.
+# You could have a several line description here if you wanted,
+# but I don't have much to say about this function.
+#
+# @example using two integers
+#   $bigger_int = max(int_one, int_two)
+#
+# @return [Integer] the larger of the two parameters
+#
+# @param num_a [Integer] the first number to be compared
+# @param num_b [Integer] the second number to be compared
 Puppet::Functions.create_function(:awesome_parser) do
   # the function below is called by puppet and and must match
   # the name of the puppet function above. You can set your

data/spec/fixtures/functions/abs.pp

@@ -0,0 +1,4 @@
+function abs(Integer $x) {
+  if $x < 0 { $x * -1 }
+  else { $x }
+}

data/spec/unit/generators/acceptance_generator_spec.rb

@@ -1,17 +1,16 @@
 require 'spec_helper'
 
 describe Retrospec::Puppet::Generators::AcceptanceGenerator do
-
   after(:each) do
-    FileUtils.rm_rf(spec_files_path) if File.exists?(spec_files_path)
+    FileUtils.rm_rf(spec_files_path) if File.exist?(spec_files_path)
   end
 
   let(:sample_file) do
-    File.join(module_path, 'manifests','one_define.pp')
+    File.join(module_path, 'manifests', 'one_define.pp')
   end
 
   let(:generator_opts) do
-    {:manifest_file => sample_file, :template_dir => retrospec_templates_path}
+    { :manifest_file => sample_file, :template_dir => retrospec_templates_path }
   end
 
   let(:spec_files_path) do
@@ -31,14 +30,13 @@ describe Retrospec::Puppet::Generators::AcceptanceGenerator do
   end
 
   describe 'valid context' do
-
     describe 'define' do
       let(:spec_file) do
-        path = File.join(module_path, 'spec', 'acceptance', 'classes','one_define_spec.rb')
+        path = File.join(module_path, 'spec', 'acceptance', 'classes', 'one_define_spec.rb')
       end
 
       let(:sample_file) do
-        File.join(module_path, 'manifests','one_define.pp')
+        File.join(module_path, 'manifests', 'one_define.pp')
       end
       let(:context) do
         generator.load_context_data
@@ -65,7 +63,7 @@ describe Retrospec::Puppet::Generators::AcceptanceGenerator do
 
       it 'should create spec file' do
         expect(generator.run).to eq(spec_file)
-        expect(File.exists?(spec_file)).to eq(true)
+        expect(File.exist?(spec_file)).to eq(true)
       end
 
       it 'should produce correct file name' do
@@ -76,15 +74,14 @@ describe Retrospec::Puppet::Generators::AcceptanceGenerator do
         data = "require 'spec_helper_acceptance'\n\ndescribe 'one_resource::one_define one_resource::one_define' do\n  describe 'running puppet code' do\n    it 'should work with no errors' do\n      pp = <<-EOS\n      one_resource::one_define{'some_value':\n        #:one => \"one_value\",\n\n      }\n      EOS\n\n    # Run it twice and test for idempotency\n      apply_manifest(pp, :catch_failures => true)\n      apply_manifest(pp, :catch_changes => true)\n    end\n\n  end\nend\n"
         expect(spec_file_contents).to eq(data)
       end
-
     end
     describe 'class' do
       let(:spec_file) do
-        path = File.join(module_path, 'spec', 'acceptance', 'classes','another_resource_spec.rb')
+        path = File.join(module_path, 'spec', 'acceptance', 'classes', 'another_resource_spec.rb')
       end
 
       let(:sample_file) do
-        File.join(module_path, 'manifests','another_resource.pp')
+        File.join(module_path, 'manifests', 'another_resource.pp')
       end
       let(:context) do
         generator.load_context_data
@@ -109,7 +106,7 @@ describe Retrospec::Puppet::Generators::AcceptanceGenerator do
 
       it 'should create spec file' do
         expect(generator.run).to eq(spec_file)
-        expect(File.exists?(spec_file)).to eq(true)
+        expect(File.exist?(spec_file)).to eq(true)
       end
 
       it 'should produce correct file name' do
@@ -121,7 +118,6 @@ describe Retrospec::Puppet::Generators::AcceptanceGenerator do
         expect(spec_file_contents).to eq(data)
       end
     end
-
   end
 
   describe 'spec files' do
@@ -131,7 +127,7 @@ describe Retrospec::Puppet::Generators::AcceptanceGenerator do
         File.join(spec_files_path, 'inherits_params_spec.rb'),
         File.join(spec_files_path, 'one_define_spec.rb'),
         File.join(spec_files_path, 'one_resource_spec.rb'),
-        File.join(spec_files_path, 'params_spec.rb'),
+        File.join(spec_files_path, 'params_spec.rb')
 
       ]
     end

data/spec/unit/generators/definition_generator_spec.rb

@@ -1,17 +1,16 @@
 require 'spec_helper'
 
 describe Retrospec::Puppet::Generators::DefinitionGenerator do
-
   after(:each) do
-    FileUtils.rm(spec_file) if File.exists?(spec_file)
+    FileUtils.rm(spec_file) if File.exist?(spec_file)
   end
 
   let(:generator_opts) do
-    {:manifest_file => sample_file, :template_dir => retrospec_templates_path}
+    { :manifest_file => sample_file, :template_dir => retrospec_templates_path }
   end
 
   let(:sample_file) do
-    File.join(module_path, 'manifests','one_define.pp')
+    File.join(module_path, 'manifests', 'one_define.pp')
   end
 
   let(:context) do
@@ -40,7 +39,7 @@ describe Retrospec::Puppet::Generators::DefinitionGenerator do
 
   it 'should create spec file' do
     expect(generator.run).to eq(spec_file)
-    expect(File.exists?(spec_file)).to eq(true)
+    expect(File.exist?(spec_file)).to eq(true)
   end
 
   it 'should produce correct file name' do
@@ -79,10 +78,8 @@ describe Retrospec::Puppet::Generators::DefinitionGenerator do
       expect(spec_file_contents).to match(data)
       expect(spec_file_contents).to match(/#:one => "one_value",/)
     end
-
   end
 
-
   describe 'spec files' do
     let(:generated_files) do
       [File.join(spec_files_path, 'one_define_spec.rb')]
@@ -92,5 +89,4 @@ describe Retrospec::Puppet::Generators::DefinitionGenerator do
       expect(files).to eq(generated_files)
     end
   end
-
 end

data/spec/unit/generators/fact_generater_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
-describe "fact generator" do
-
+describe 'fact generator' do
   before :all do
     initialize_templates
   end
@@ -23,11 +22,11 @@ describe "fact generator" do
   end
 
   let(:context) do
-    {:name => 'datacenter', :template_dir => retrospec_templates_path }
+    { :name => 'datacenter', :template_dir => retrospec_templates_path }
   end
 
   let(:generator) do
-    Retrospec::Puppet::Generators::FactGenerator.new(module_path, context )
+    Retrospec::Puppet::Generators::FactGenerator.new(module_path, context)
   end
 
   describe :datacenter do
@@ -37,7 +36,7 @@ describe "fact generator" do
     end
 
     let(:context) do
-      {:name => 'datacenter', :template_dir => retrospec_templates_path}
+      { :name => 'datacenter', :template_dir => retrospec_templates_path }
     end
     it 'returns facter dir' do
       expect(generator.facter_dir).to eq(fixtures_facts_path)
@@ -53,7 +52,7 @@ describe "fact generator" do
 
     it 'can generate a fact file' do
       expect(generator.generate_fact_file.count).to eq(6)
-      expect(File.exists?(File.join(generator.facter_dir, "#{generator.fact_name}.rb")))
+      expect(File.exist?(File.join(generator.facter_dir, "#{generator.fact_name}.rb")))
     end
 
     it 'can generate a spec file' do
@@ -68,7 +67,7 @@ describe "fact generator" do
     end
 
     let(:context) do
-      {:name => 'oracle_controls',:template_dir => retrospec_templates_path}
+      { :name => 'oracle_controls', :template_dir => retrospec_templates_path }
     end
 
     it 'can generate a spec file' do

data/spec/unit/generators/function_generator_spec.rb

@@ -28,6 +28,10 @@ describe 'function_generator' do
     retrospec_templates_path
   end
 
+  let(:native_function_file) do
+    File.join(fixtures_path, 'functions', 'abs.pp')
+  end
+
   let(:function_name) do
     'awesome_parser'
   end
@@ -63,11 +67,9 @@ describe 'function_generator' do
 
     it 'generate spec files' do
       files = [File.join(generator.v3_spec_dir, 'defined_spec.rb'),
-        File.join(generator.v3_spec_dir, 'sha1_spec.rb'),
-        File.join(generator.v4_spec_dir, 'reduce_spec.rb'),
-        File.join(generator.v4_spec_dir, 'awesome_parser_spec.rb')
-
-      ]
+               File.join(generator.v3_spec_dir, 'sha1_spec.rb'),
+               File.join(generator.v4_spec_dir, 'reduce_spec.rb'),
+               File.join(generator.v4_spec_dir, 'awesome_parser_spec.rb')]
       expect(generator.generate_spec_files).to match_array(files)
     end
 
@@ -77,7 +79,7 @@ describe 'function_generator' do
         File.join(module_path, 'lib', 'puppet', 'functions', 'reduce.rb'),
         File.join(module_path, 'lib', 'puppet', 'parser', 'functions', 'bad_sha1.rb'),
         File.join(module_path, 'lib', 'puppet', 'parser', 'functions', 'defined.rb'),
-        File.join(module_path, 'lib', 'puppet', 'parser', 'functions', 'sha1.rb'),
+        File.join(module_path, 'lib', 'puppet', 'parser', 'functions', 'sha1.rb')
       ]
       expect(generator.discovered_functions).to match_array(files)
     end
@@ -118,14 +120,19 @@ describe 'function_generator' do
 
       it 'return true when v3 function' do
         path = File.join(module_path, 'lib', 'puppet', 'parser', 'functions', 'bad_sha1.rb')
-        expect(generator.is_v3_function?(path)).to eq (true)
+        expect(generator.v3_function?(path)).to eq true
       end
 
       it 'return v3 template path when context is changed' do
         generator.template_dir  # uses v4
         generator.context.function_type = 'v3'
         expect(generator.template_dir).to match(/functions\/v3/)
+      end
 
+      it 'return false when v3 function' do
+        path = File.join(module_path, 'lib', 'puppet', 'parser', 'functions', 'reduce.rb')
+        expect(generator.v4_function?(path)).to eq false
+        expect(generator.native_function?(path)).to eq false
       end
     end
 
@@ -140,7 +147,8 @@ describe 'function_generator' do
 
       it 'return false when v4 function' do
         path = File.join(module_path, 'lib', 'puppet', 'functions', 'reduce.rb')
-        expect(generator.is_v3_function?(path)).to eq (false)
+        expect(generator.v3_function?(path)).to eq false
+        expect(generator.native_function?(path)).to eq false
       end
 
       it 'return v4 template path' do
@@ -190,11 +198,9 @@ describe 'function_generator' do
 
     it 'generate spec files' do
       files = [File.join(generator.v3_spec_dir, 'defined_spec.rb'),
-        File.join(generator.v3_spec_dir, 'sha1_spec.rb'),
-        File.join(generator.v4_spec_dir, 'reduce_spec.rb'),
-        File.join(generator.v4_spec_dir, 'awesome_parser_spec.rb')
-
-      ]
+               File.join(generator.v3_spec_dir, 'sha1_spec.rb'),
+               File.join(generator.v4_spec_dir, 'reduce_spec.rb'),
+               File.join(generator.v4_spec_dir, 'awesome_parser_spec.rb')]
       expect(generator.generate_spec_files).to match_array(files)
     end
 
@@ -204,7 +210,7 @@ describe 'function_generator' do
         File.join(module_path, 'lib', 'puppet', 'functions', 'reduce.rb'),
         File.join(module_path, 'lib', 'puppet', 'parser', 'functions', 'bad_sha1.rb'),
         File.join(module_path, 'lib', 'puppet', 'parser', 'functions', 'defined.rb'),
-        File.join(module_path, 'lib', 'puppet', 'parser', 'functions', 'sha1.rb'),
+        File.join(module_path, 'lib', 'puppet', 'parser', 'functions', 'sha1.rb')
       ]
       expect(generator.discovered_functions).to match_array(files)
     end
@@ -245,7 +251,7 @@ describe 'function_generator' do
 
       it 'return true when v3 function' do
         path = File.join(module_path, 'lib', 'puppet', 'parser', 'functions', 'bad_sha1.rb')
-        expect(generator.is_v3_function?(path)).to eq (true)
+        expect(generator.v3_function?(path)).to eq true
       end
 
       it 'return v3 template path when context is changed' do
@@ -266,7 +272,7 @@ describe 'function_generator' do
 
       it 'return false when v4 function' do
         path = File.join(module_path, 'lib', 'puppet', 'functions', 'reduce.rb')
-        expect(generator.is_v3_function?(path)).to eq (false)
+        expect(generator.v3_function?(path)).to eq false
       end
 
       it 'return v4 template path' do
@@ -299,7 +305,67 @@ describe 'function_generator' do
         expect(generator.generate_function_file).to eq(function_path)
       end
     end
-  end
 
+    describe 'native' do
+      let(:type_name) do
+        'native'
+      end
+
+      let(:function_path) do
+        File.join(module_path, 'functions', "#{function_name}.pp")
+      end
+
+      it 'return false when native function' do
+        path = File.join(module_path, 'functions', 'reduce.pp')
+        expect(generator.v3_function?(path)).to eq false
+        expect(generator.v4_function?(path)).to eq false
+      end
+
+      it 'return native template path' do
+        allow(generator).to receive(:function_type).and_return('native')
+        expect(generator.template_dir).to match(/functions\/native/)
+      end
+
+      it 'return v4 template path when context is changed' do
+        generator.template_dir
+        generator.context.function_type = 'native'
+        expect(generator.template_dir).to match(/functions\/native/)
+      end
+
+      it 'returns function path' do
+        path = File.join(module_path, 'functions', "#{function_name}.pp")
+        expect(generator.function_path).to eq(path)
+      end
+
+      it 'returns spec file directory' do
+        path = File.join(module_path, 'spec', 'functions')
+        expect(generator.spec_file_dir).to eq(path)
+      end
+
+      it 'returns function directory' do
+        path = File.join(module_path, 'functions')
+        expect(generator.function_dir).to eq(path)
+      end
+
+      it 'generate spec file' do
+        allow(generator).to receive(:discovered_functions).and_return([native_function_file])
+        path = File.join(generator.module_path, 'spec', 'functions', 'abs_spec.rb')
+        expect(generator.generate_spec_files).to eq([path])
+      end
+
+      it 'generate spec file content' do
+        allow(generator).to receive(:discovered_functions).and_return([native_function_file])
+        path = File.join(generator.module_path, 'spec', 'functions', 'abs_spec.rb')
+        expect(generator.generate_spec_files).to eq([path])
+        test_file_content = File.read(path)
+        result = "require 'spec_helper'\n\nlet(:x) do\n  'some_value_goes_here'\nend\n\ndescribe 'abs' do\n  it { is_expected.to run.with_params(x).and_return('some_value') }\nend\n"
+        expect(test_file_content).to eq(result)
+      end
 
+      it 'generate function file path' do
+        file = File.join(generator.template_dir, 'function_template.pp.retrospec.erb')
+        expect(generator.function_file_path).to eq file
+      end
+    end
   end
+end

data/spec/unit/generators/function_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe 'function' do
-
   describe 'v3 function' do
     let(:function_file) do
       File.join(sample_module_path, 'lib', 'puppet', 'parser', 'functions', 'sha1.rb')
@@ -23,7 +22,7 @@ describe 'function' do
         File.join(sample_module_path, 'lib', 'puppet', 'parser', 'functions', 'bad_sha1.rb')
       end
       it 'should raise error' do
-        expect{models.name}.to raise_error SyntaxError
+        expect { models.name }.to raise_error SyntaxError
       end
     end
   end
@@ -62,6 +61,5 @@ describe 'function' do
     it 'returns required methods' do
       expect(Retrospec::Puppet::Functions.find_required_methods(:reduce)).to eq([:reduce])
     end
-
   end
 end

data/spec/unit/generators/hostclass_generator_spec.rb

@@ -1,9 +1,8 @@
 require 'spec_helper'
 
 describe 'HostClassGenerator' do
-
   before(:each) do
-    FileUtils.rm(spec_file) if File.exists?(spec_file)
+    FileUtils.rm(spec_file) if File.exist?(spec_file)
   end
 
   let(:spec_files_path) do
@@ -11,7 +10,7 @@ describe 'HostClassGenerator' do
   end
 
   let(:generator_opts) do
-    {:manifest_file => sample_file, :template_dir => retrospec_templates_path}
+    { :manifest_file => sample_file, :template_dir => retrospec_templates_path }
   end
 
   let(:sample_file) do
@@ -40,7 +39,7 @@ describe 'HostClassGenerator' do
 
   it 'should create spec file' do
     expect(generator.run).to eq(spec_file)
-    expect(File.exists?(spec_file)).to eq(true)
+    expect(File.exist?(spec_file)).to eq(true)
   end
 
   it 'should produce correct file name' do
@@ -72,16 +71,15 @@ describe 'HostClassGenerator' do
     resources = ''
 
     expect(context.resources[1]).to eq(resources)
-    expect(context.resources[0]).to eq( "  it do\n    is_expected.to contain_notify(\"$value\")\n  end\n  ")
+    expect(context.resources[0]).to eq("  it do\n    is_expected.to contain_notify(\"$value\")\n  end\n  ")
   end
 
   describe 'spec files' do
-
     let(:generated_files) do
       [File.join(spec_files_path, 'another_resource_spec.rb'),
-        File.join(spec_files_path, 'inherits_params_spec.rb'),
-        File.join(spec_files_path, 'one_resource_spec.rb'),
-        File.join(spec_files_path, 'params_spec.rb')]
+       File.join(spec_files_path, 'inherits_params_spec.rb'),
+       File.join(spec_files_path, 'one_resource_spec.rb'),
+       File.join(spec_files_path, 'params_spec.rb')]
     end
 
     it 'should generate a bunch of files' do
@@ -100,5 +98,4 @@ describe 'HostClassGenerator' do
       expect(generator.generate_content).to eq(data)
     end
   end
-
 end