puppet-strings 2.2.0 → 2.3.0

data/spec/spec_helper.rb

@@ -36,6 +36,9 @@ TEST_FUNCTION_RETURN_TYPE = Puppet::Util::Package.versioncmp(Puppet.version, "4.
 # Enable testing of Plans if Puppet version is greater than 5.0.0
 TEST_PUPPET_PLANS = Puppet::Util::Package.versioncmp(Puppet.version, "5.0.0") >= 0
 
+# Enable testing of Data Types if Puppet version is greater than 4.1.0
+TEST_PUPPET_DATATYPES = Puppet::Util::Package.versioncmp(Puppet.version, "4.1.0") >= 0
+
 RSpec.configure do |config|
   config.mock_with :mocha
 

data/spec/spec_helper_acceptance.rb

@@ -1,28 +1,58 @@
-require 'beaker-rspec/spec_helper'
-require 'beaker-rspec/helpers/serverspec'
-$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), 'acceptance/lib'))
-require 'util'
+require 'serverspec'
+require 'puppet_litmus'
+include PuppetLitmus # rubocop:disable Style/MixinUsage This is fine
 
-unless ENV['RS_PROVISION'] == 'no'
-  install_puppet
-end
+if ENV['TARGET_HOST'].nil? || ENV['TARGET_HOST'] == 'localhost'
+  puts 'Running tests against this machine !'
+  if Gem.win_platform?
+    set :backend, :cmd
+  else
+    set :backend, :exec
+  end
+else
+  # load inventory
+  inventory_hash = inventory_hash_from_inventory_file
+  node_config = config_from_node(inventory_hash, ENV['TARGET_HOST'])
 
-RSpec.configure do |c|
-  # Readable test descriptions
-  c.formatter = :documentation
+  if target_in_group(inventory_hash, ENV['TARGET_HOST'], 'docker_nodes')
+    host = ENV['TARGET_HOST']
+    set :backend, :docker
+    set :docker_container, host
+  elsif target_in_group(inventory_hash, ENV['TARGET_HOST'], 'ssh_nodes')
+    set :backend, :ssh
+    options = Net::SSH::Config.for(host)
+    options[:user] = node_config.dig('ssh', 'user') unless node_config.dig('ssh', 'user').nil?
+    options[:port] = node_config.dig('ssh', 'port') unless node_config.dig('ssh', 'port').nil?
+    options[:keys] = node_config.dig('ssh', 'private-key') unless node_config.dig('ssh', 'private-key').nil?
+    options[:password] = node_config.dig('ssh', 'password') unless node_config.dig('ssh', 'password').nil?
+    options[:verify_host_key] = Net::SSH::Verifiers::Null.new unless node_config.dig('ssh', 'host-key-check').nil?
+    host = if ENV['TARGET_HOST'].include?(':')
+             ENV['TARGET_HOST'].split(':').first
+           else
+             ENV['TARGET_HOST']
+           end
+    set :host,        options[:host_name] || host
+    set :ssh_options, options
+    set :request_pty, true
+  elsif target_in_group(inventory_hash, ENV['TARGET_HOST'], 'winrm_nodes')
+    require 'winrm'
 
-  # Configure all nodes in nodeset
-  c.before :suite do
-    extend PuppetStrings::Acceptance::CommandUtils
-    hosts.each do |host|
-      scp_to(host, Dir.glob('puppet-strings*.gem').first, 'puppet-strings.gem')
-      install_ca_certs(host)
-      on host, "#{gem_command(host)} install yard"
-      on host, "#{gem_command(host)} install rgen"
-      on host, "#{gem_command(host)} install puppet-strings.gem"
+    set :backend, :winrm
+    set :os, family: 'windows'
+    user = node_config.dig('winrm', 'user') unless node_config.dig('winrm', 'user').nil?
+    pass = node_config.dig('winrm', 'password') unless node_config.dig('winrm', 'password').nil?
+    endpoint = "http://#{ENV['TARGET_HOST']}:5985/wsman"
 
-      scp_to(host, Dir.glob('spec/fixtures/acceptance/modules/test/pkg/username-test*.gz').first, 'test.tar.gz')
-      on host, puppet('module', 'install', 'test.tar.gz')
-    end
+    opts = {
+      user: user,
+      password: pass,
+      endpoint: endpoint,
+      operation_timeout: 300,
+    }
+
+    winrm = WinRM::Connection.new opts
+    Specinfra.configuration.winrm = winrm
   end
 end
+
+require 'spec_helper_acceptance_local' if File.file?(File.join(File.dirname(__FILE__), 'spec_helper_acceptance_local.rb'))

data/spec/spec_helper_acceptance_local.rb

@@ -0,0 +1,10 @@
+def sut_module_path(module_regex)
+  modules = JSON.parse(PuppetLitmus::Serverspec.run_shell('puppet module list --render-as json').stdout)
+  test_module_info = modules['modules_by_path'].values.flatten.find { |mod_info| mod_info =~ module_regex }
+  test_module_info.match(/\(([^)]*)\)/)[1]
+end
+
+def sut_tmp_path
+  # TODO: Linux only
+  '/tmp/'
+end

data/spec/unit/puppet-strings/describe_spec.rb

@@ -19,7 +19,7 @@ describe PuppetStrings::Describe do
 Puppet::Type.newtype(:database) do
   desc 'An example database server resource type.'
 end
-SOURCE
+    SOURCE
 
     YARD::Parser::SourceParser.parse_string(<<-SOURCE, :ruby)
 Puppet::ResourceApi.register_type(
@@ -40,9 +40,9 @@ If Puppet is given the location of a key file which looks like an absolute
 path this type will autorequire that file.
   EOS
 )
-SOURCE
+    SOURCE
 
-     YARD::Parser::SourceParser.parse_string(<<-SOURCE, :ruby)
+    YARD::Parser::SourceParser.parse_string(<<-SOURCE, :ruby)
   Puppet::Type.type(:file).newproperty(:content) do
     include Puppet::Util::Checksums
     include Puppet::DataSync
@@ -54,7 +54,7 @@ SOURCE
       exclusive with `source` and `target`.
     EOT
   end
-SOURCE
+    SOURCE
 
     YARD::Parser::SourceParser.parse_string(<<-SOURCE, :ruby)
   Puppet::Type.newtype(:file) do
@@ -78,7 +78,7 @@ SOURCE
     end
 
   end
-SOURCE
+    SOURCE
 
     YARD::Parser::SourceParser.parse_string(<<-SOURCE, :ruby)
 Puppet::Type.type(:file).newproperty(:source) do
@@ -92,7 +92,7 @@ Puppet::Type.type(:file).newproperty(:source) do
     exclusive with `source` and `target`.
   EOT
 end
-SOURCE
+    SOURCE
   end
 
   describe 'rendering DESCRIBE to stdout' do
@@ -134,7 +134,7 @@ exclusive with `source` and `target`.
 
 Providers
 ---------
-DATA
+      DATA
       expect{ PuppetStrings::Describe.render(['file']) }.to output(output).to_stdout
     end
   end

data/spec/unit/puppet-strings/json_spec.rb

@@ -21,7 +21,7 @@ class klass(Integer $param1, $param2, String $param3 = hi) inherits foo::bar {
 # @param param3 Third param.
 define dt(Integer $param1, $param2, String $param3 = hi) {
 }
-SOURCE
+    SOURCE
 
     YARD::Parser::SourceParser.parse_string(<<-SOURCE, :puppet) if TEST_PUPPET_PLANS
 # A simple plan.
@@ -30,7 +30,7 @@ SOURCE
 # @param param3 Third param.
 plan plann(String $param1, $param2, Integer $param3 = 1) {
 }
-SOURCE
+    SOURCE
 
     # Only include Puppet functions for 4.1+
     YARD::Parser::SourceParser.parse_string(<<-SOURCE, :puppet) if TEST_PUPPET_FUNCTIONS
@@ -41,6 +41,20 @@ SOURCE
 # @return [Undef] Returns nothing.
 function func(Integer $param1, $param2, String $param3 = hi) {
 }
+    SOURCE
+
+    # Only include Puppet types for 5.0+
+    YARD::Parser::SourceParser.parse_string(<<-SOURCE, :ruby) if TEST_PUPPET_DATATYPES
+# Basic Puppet Data Type in Ruby
+#
+# @param msg A message parameter
+Puppet::DataTypes.create_type('RubyDataType') do
+  interface <<-PUPPET
+    attributes => {
+      msg => String[1]
+    }
+    PUPPET
+end
 SOURCE
 
     YARD::Parser::SourceParser.parse_string(<<-SOURCE, :json)
@@ -66,7 +80,7 @@ SOURCE
     }
   }
 }
-SOURCE
+    SOURCE
 
     YARD::Parser::SourceParser.parse_string(<<-SOURCE, :ruby)
 Puppet::Parser::Functions.newfunction(:func3x, doc: <<-DOC
@@ -199,7 +213,7 @@ path this type will autorequire that file.
     package: 'apt',
   },
 )
-SOURCE
+    SOURCE
   end
 
   RSpec.shared_examples "correct JSON" do
@@ -209,6 +223,11 @@ SOURCE
       expect(json_output).to include_json(puppet_class_json)
     end
 
+    it 'should include data for Puppet Data Types' do
+      data_types_json = YARD::Registry.all(:puppet_data_type).sort_by!(&:name).map!(&:to_hash).to_json
+      expect(json_output).to include_json(data_types_json)
+    end
+
     it 'should include data for Puppet Defined Types' do
       defined_types_json = YARD::Registry.all(:puppet_defined_type).sort_by!(&:name).map!(&:to_hash).to_json
 

data/spec/unit/puppet-strings/markdown/base_spec.rb

@@ -12,7 +12,7 @@ describe PuppetStrings::Markdown::Base do
 # @param param3 Third param.
 class klass(Integer $param1, $param2, String $param3 = hi) inherits foo::bar {
 }
-SOURCE
+      SOURCE
     end
 
     let(:reg) { YARD::Registry.all(:puppet_class).sort_by!(&:name).map!(&:to_hash)[0] }
@@ -24,7 +24,7 @@ SOURCE
       end
     end
 
-    [ 'examples',
+    ['examples',
       'see',
       'since',
       'return_val',
@@ -85,7 +85,7 @@ class klass::yeah(
 ) inherits foo::bar {
 
 }
-SOURCE
+      SOURCE
     end
 
     let(:reg) { YARD::Registry.all(:puppet_class).sort_by!(&:name).map!(&:to_hash)[0] }

data/spec/unit/puppet-strings/markdown_spec.rb

@@ -4,7 +4,7 @@ require 'puppet-strings/markdown/table_of_contents'
 require 'tempfile'
 
 describe PuppetStrings::Markdown do
-  before :each do
+  def parse_shared_content
     # Populate the YARD registry with both Puppet and Ruby source
     YARD::Parser::SourceParser.parse_string(<<-SOURCE, :puppet)
 # An overview for a simple class.
@@ -65,15 +65,7 @@ define klass::dt (
   Boolean $param4 = true
 ) {
 }
-SOURCE
-    YARD::Parser::SourceParser.parse_string(<<-SOURCE, :puppet) if TEST_PUPPET_PLANS
-# A simple plan.
-# @param param1 First param.
-# @param param2 Second param.
-# @param param3 Third param.
-plan plann(String $param1, $param2, Integer $param3 = 1) {
-}
-SOURCE
+    SOURCE
 
     YARD::Parser::SourceParser.parse_string(<<-SOURCE, :json)
 {
@@ -98,7 +90,7 @@ SOURCE
     }
   }
 }
-SOURCE
+    SOURCE
 
     YARD::Parser::SourceParser.parse_string(<<-SOURCE, :puppet)
 # A simple Puppet function.
@@ -112,7 +104,7 @@ SOURCE
 #   $result = func(1, 2)
 function func(Integer $param1, $param2, String $param3 = hi) {
 }
-SOURCE
+    SOURCE
 
     YARD::Parser::SourceParser.parse_string(<<-SOURCE, :ruby)
 # An example 4.x function.
@@ -272,24 +264,93 @@ path this type will autorequire that file.
     package: 'apt',
   },
 )
-SOURCE
+    SOURCE
   end
 
-  let(:filename) do
-    if TEST_PUPPET_PLANS
-      'output_with_plan.md'
-    else
-      'output.md'
-    end
+  def parse_plan_content
+    YARD::Parser::SourceParser.parse_string(<<-SOURCE, :puppet)
+# A simple plan.
+# @param param1 First param.
+# @param param2 Second param.
+# @param param3 Third param.
+plan plann(String $param1, $param2, Integer $param3 = 1) {
+}
+    SOURCE
+  end
+
+  def parse_data_type_content
+    YARD::Parser::SourceParser.parse_string(<<-SOURCE, :ruby)
+# An example Puppet Data Type in Ruby.
+#
+# @param param1 A variant parameter.
+# @param param2 Optional String parameter.
+Puppet::DataTypes.create_type('UnitDataType') do
+  interface <<-PUPPET
+    attributes => {
+      param1 => Variant[Numeric, String[1,2]],
+      param2 => { type => Optional[String[1]], value => "param2" }
+    }
+    PUPPET
+end
+    SOURCE
+
+    YARD::Parser::SourceParser.parse_string(<<-SOURCE, :puppet)
+# Documentation for Amodule::SimpleAlias
+type Amodule::SimpleAlias = Variant[Numeric,String[1,20]]
+
+# Documentation for Amodule::ComplexAlias
+type Amodule::ComplexAlias = Struct[{
+  value_type => Optional[ValueType],
+  merge      => Optional[MergeType]
+}]
+    SOURCE
   end
   let(:baseline_path) { File.join(File.dirname(__FILE__), "../../fixtures/unit/markdown/#{filename}") }
   let(:baseline) { File.read(baseline_path) }
 
   describe 'rendering markdown to a file' do
-    it 'should output the expected markdown content' do
-      Tempfile.open('md') do |file|
-        PuppetStrings::Markdown.render(file.path)
-        expect(File.read(file.path)).to eq(baseline)
+    before(:each) do
+      parse_shared_content
+    end
+
+    context 'with common Puppet and ruby content' do
+      let(:filename) { 'output.md' }
+
+      it 'should output the expected markdown content' do
+        Tempfile.open('md') do |file|
+          PuppetStrings::Markdown.render(file.path)
+          expect(File.read(file.path)).to eq(baseline)
+        end
+      end
+    end
+
+    describe 'with Puppet Plans', :if => TEST_PUPPET_PLANS do
+      let(:filename) { 'output_with_plan.md' }
+
+      before(:each) do
+        parse_plan_content
+      end
+
+      it 'should output the expected markdown content' do
+        Tempfile.open('md') do |file|
+          PuppetStrings::Markdown.render(file.path)
+          expect(File.read(file.path)).to eq(baseline)
+        end
+      end
+    end
+
+    describe 'with Puppet Data Types', :if => TEST_PUPPET_DATATYPES do
+      let(:filename) { 'output_with_data_types.md' }
+
+      before(:each) do
+        parse_data_type_content
+      end
+
+      it 'should output the expected markdown content' do
+        Tempfile.open('md') do |file|
+          PuppetStrings::Markdown.render(file.path)
+          expect(File.read(file.path)).to eq(baseline)
+        end
       end
     end
   end

data/spec/unit/puppet-strings/yard/code_objects/task_spec.rb

@@ -26,7 +26,7 @@ describe PuppetStrings::Yard::CodeObjects::Task do
     }
   }
 }
-SOURCE
+  SOURCE
   }
   let(:json) { JSON.parse(source) }
   let(:statement) { PuppetStrings::Yard::Parsers::JSON::TaskStatement.new(json, source, "test.json") }

data/spec/unit/puppet-strings/yard/handlers/json/task_handler_spec.rb

@@ -18,7 +18,7 @@ describe PuppetStrings::Yard::Handlers::JSON::TaskHandler do
     }
   }
 }
-SOURCE
+    SOURCE
     }
 
     it 'should log an error' do
@@ -50,7 +50,7 @@ SOURCE
     }
   }
 }
-SOURCE
+    SOURCE
     }
 
     it 'should log a warning' do
@@ -83,7 +83,7 @@ SOURCE
   }
 }
 
-SOURCE
+    SOURCE
     }
 
     it 'should register a task object' do
@@ -105,7 +105,7 @@ SOURCE
     }
   }
 }
-SOURCE
+    SOURCE
     }
 
     it 'should output a warning' do

data/spec/unit/puppet-strings/yard/handlers/puppet/class_handler_spec.rb

@@ -43,7 +43,7 @@ class foo(Integer $param1, $param2, String $param3 = hi) inherits foo::bar {
     ensure => present
   }
 }
-SOURCE
+    SOURCE
     }
 
     it 'should register a class object' do
@@ -85,7 +85,7 @@ class foo(Integer $param1, $param2, String $param3 = hi) inherits foo::bar {
     ensure => present
   }
 }
-SOURCE
+    SOURCE
     }
 
     it 'should output a warning' do
@@ -103,7 +103,7 @@ class foo(Integer $param1, $param2, String $param3 = hi) inherits foo::bar {
     ensure => present
   }
 }
-SOURCE
+    SOURCE
     }
 
     it 'should output a warning' do
@@ -122,7 +122,7 @@ class foo(Integer $param1, $param2, String $param3 = hi) inherits foo::bar {
     ensure => present
   }
 }
-SOURCE
+    SOURCE
     }
 
     it 'should respect the type that was documented' do
@@ -145,7 +145,7 @@ class foo(Integer $param1, $param2, String $param3 = hi) inherits foo::bar {
     ensure => present
   }
 }
-SOURCE
+    SOURCE
     }
 
     it 'should output a warning' do
@@ -164,7 +164,7 @@ class foo(Integer $param1, $param2, String $param3 = hi) inherits foo::bar {
     ensure => present
   }
 }
-SOURCE
+    SOURCE
     }
 
     it 'should respect the type that was documented' do
@@ -186,7 +186,7 @@ SOURCE
       ensure => present
     }
   }
-  SOURCE
+      SOURCE
       }
 
       it 'should parse the summary' do
@@ -206,7 +206,7 @@ SOURCE
       ensure => present
     }
   }
-  SOURCE
+      SOURCE
       }
 
       it 'should log a warning' do