puppetlabs-syntax 7.2.1

data/spec/fixtures/test_module/templates/pass.epp

@@ -0,0 +1,3 @@
+<%# VALID COMMENT %>
+<% $valid = 'valid' -%>
+This is a <%= $valid %> template.

data/spec/fixtures/test_module/templates/pass.erb

@@ -0,0 +1,2 @@
+<% valid = 'valid' -%>
+This is a <%= valid -%> template.

data/spec/fixtures/test_module/templates/pass_also.epp

@@ -0,0 +1,3 @@
+<%# VALID COMMENT %>
+<% $valid = 'valid' -%>
+This is a <%= $valid %> template.

data/spec/fixtures/test_module/templates/pass_unbound_var.erb

@@ -0,0 +1 @@
+<%= this_variable_has_not_been_bound %>

data/spec/fixtures/test_module/templates/typeerror_shouldwin.erb

@@ -0,0 +1,2 @@
+#this is valid syntax
+<%= File.dirname(@the_path_of_the_file_you_first_thought_of) %>

data/spec/puppetlabs-syntax/hiera_spec.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe PuppetlabsSyntax::Hiera do
+  let(:subject) { described_class.new }
+
+  it 'expects an array of files' do
+    expect { subject.check(nil) }.to raise_error(/Expected an array of files/)
+  end
+
+  it 'returns nothing from valid YAML' do
+    files = fixture_hiera('hiera_good.yaml')
+    res = subject.check(files)
+    expect(res).to eq []
+  end
+
+  it 'returns an error from invalid YAML' do
+    files = fixture_hiera('hiera_bad.yaml')
+    expected = /ERROR: Failed to parse #{files[0]}:/
+    res = subject.check(files)
+    expect(res.size).to eq 1
+    expect(res.first).to match(expected)
+  end
+
+  it 'returns warnings on malformed keys' do
+    files = fixture_hiera('hiera_key_no_value.yaml')
+    expected = /ERROR: #{files[0]} doesn't contain a valid Hash, datatype is/
+    res = subject.check(files)
+    expect(res.size).to eq 1
+    expect(res.first).to match(expected)
+  end
+
+  context 'check_hiera_keys = true' do
+    before do
+      PuppetlabsSyntax.check_hiera_keys = true
+      PuppetlabsSyntax.check_hiera_data = true
+    end
+
+    it 'returns warnings for invalid keys' do
+      hiera_yaml = 'hiera_badkey.yaml'
+      examples = 9
+      files = fixture_hiera(hiera_yaml)
+      res = subject.check(files)
+      (1..examples).each do |n|
+        expect(res).to include(/warning#{n}:/)
+      end
+      expect(res.size).to eq examples
+      expect(res[0]).to match('Key :typical:typo::warning1: Looks like a missing colon')
+      expect(res[1]).to match('Key ::notsotypical::warning2: Puppet automatic lookup will not use leading \'::\'')
+      expect(res[2]).to match('Key :noCamelCase::warning3: Not a valid Puppet variable name for automatic lookup')
+      expect(res[3]).to match('Key :root::noCamelCase::warning4: Not a valid Puppet variable name for automatic lookup')
+      expect(res[4]).to match('Key :Leading_caps_warning5: Not a valid Puppet variable name for automatic lookup')
+      expect(res[5]).to match('Key :namespace::Leading_warning6: Not a valid Puppet variable name for automatic lookup')
+      expect(res[6]).to match('Key :no-hyphens::warning7: Not a valid Puppet variable name for automatic lookup')
+      expect(res[7]).to match('Key :picky::warning8: Puppet automatic lookup will not look up symbols')
+      expect(res[8]).to match('Key :this_is::warning9: string after a function call but before `}` in the value')
+    end
+
+    it 'returns warnings for invalid values' do
+      hiera_yaml = 'hiera_badvalue.yaml'
+      examples = 3
+      files = fixture_hiera(hiera_yaml)
+      res = subject.check(files)
+      (1..examples).each do |n|
+        expect(res).to include(/warning#{n}:/)
+      end
+      expect(res.size).to eq examples
+      expect(res[0]).to match('Key :this_is::warning1: string after a function call but before `}` in the value')
+      expect(res[1]).to match('Key :this_is::warning2: string after a function call but before `}` in the value')
+      expect(res[2]).to match('Key :this_is::warning3: string after a function call but before `}` in the value')
+    end
+
+    it 'returns nothing for good eyaml' do
+      files = fixture_hiera('hiera_good.eyaml')
+      res = subject.check(files)
+      expect(res).to eq []
+    end
+
+    it 'returns warnings for bad eyaml values' do
+      hiera_yaml = 'hiera_bad.eyaml'
+      examples = 9
+      files = fixture_hiera(hiera_yaml)
+      res = subject.check(files)
+      (1..examples).each do |n|
+        expect(res).to include(/::warning#{n}/)
+      end
+      expect(res.size).to eq examples
+      expect(res[0]).to match('Key acme::warning1 has unknown eyaml method unknown-method')
+      expect(res[1]).to match('Key acme::warning2 has unterminated eyaml value')
+      expect(res[2]).to match('Key acme::warning3 has unpadded or truncated base64 data')
+      expect(res[3]).to match('Key acme::warning4 has corrupt base64 data')
+      expect(res[4]).to match('Key acme::warning5\[\'key2\'\] has corrupt base64 data')
+      expect(res[5]).to match('Key acme::warning6\[\'hash_key\'\]\[2\] has corrupt base64 data')
+      expect(res[6]).to match('Key acme::warning7 has invalid eyaml encoded format')
+      expect(res[7]).to match('Key acme::warning8 has unpadded or truncated base64 data')
+      expect(res[8]).to match('Key acme::warning9 has unterminated eyaml value')
+    end
+
+    it 'handles empty files' do
+      hiera_yaml = 'hiera_key_empty.yaml'
+      files = fixture_hiera(hiera_yaml)
+      res = subject.check(files)
+      expect(res).to be_empty
+    end
+  end
+end

data/spec/puppetlabs-syntax/manifests_spec.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'puppet'
+
+describe PuppetlabsSyntax::Manifests do
+  let(:subject) { described_class.new }
+
+  it 'expects an array of files' do
+    expect { subject.check(nil) }.to raise_error(/Expected an array of files/)
+  end
+
+  it 'returns nothing from a valid file' do
+    files = fixture_manifests('pass.pp')
+    output, has_errors = subject.check(files)
+
+    expect(output).to eq([])
+    expect(has_errors).to be(false)
+  end
+
+  it 'returns nothing from a valid file with a class using tag parameter' do
+    files = fixture_manifests('tag_notice.pp')
+    output, has_errors = subject.check(files)
+
+    expect(output).to eq([])
+    expect(has_errors).to be(false)
+  end
+
+  it 'returns nothing from a valid file with a class using schedule parameter' do
+    files = fixture_manifests('schedule_notice.pp')
+    output, has_errors = subject.check(files)
+
+    expect(output).to eq([])
+    expect(has_errors).to be(false)
+  end
+
+  it 'returns an error from an invalid file' do
+    files = fixture_manifests('fail_error.pp')
+    output, has_errors = subject.check(files)
+
+    expect(output.size).to eq(3)
+    expect(output[2]).to match(/2 errors. Giving up/)
+    expect(has_errors).to be(true)
+  end
+
+  it 'returns a warning from an invalid file' do
+    files = fixture_manifests('fail_warning.pp')
+    output, has_errors = subject.check(files)
+
+    expect(output.size).to eq(2)
+    expect(has_errors).to be(true)
+
+    expect(output[0]).to match(/Unrecogni(s|z)ed escape sequence '\\\['/)
+    expect(output[1]).to match(/Unrecogni(s|z)ed escape sequence '\\\]'/)
+  end
+
+  it 'ignores warnings about storeconfigs' do
+    files = fixture_manifests('pass_storeconfigs.pp')
+    output, has_errors = subject.check(files)
+
+    expect(output).to eq([])
+    expect(has_errors).to be(false)
+  end
+
+  it 'reads more than one valid file' do
+    files = fixture_manifests(['pass.pp', 'pass_storeconfigs.pp'])
+    output, has_errors = subject.check(files)
+
+    expect(output).to eq([])
+    expect(has_errors).to be(false)
+  end
+
+  it 'continues after finding an error in the first file' do
+    files = fixture_manifests(['fail_error.pp', 'fail_warning.pp'])
+    output, has_errors = subject.check(files)
+
+    expect(has_errors).to be(true)
+    expect(output.size).to eq(5)
+    expect(output[0]).to match(%r{This Name has no effect. A Host Class Definition can not end with a value-producing expression without other effect \(file: \S*/fail_error.pp, line: 2, column: 32\)$})
+    expect(output[1]).to match(%r{This Name has no effect. A value was produced and then forgotten \(one or more preceding expressions may have the wrong form\) \(file: \S*/fail_error.pp, line: 2, column: 3\)$})
+    expect(output[2]).to match('2 errors. Giving up')
+    expect(output[3]).to match(/Unrecogni(s|z)ed escape sequence '\\\['/)
+    expect(output[4]).to match(/Unrecogni(s|z)ed escape sequence '\\\]'/)
+  end
+
+  describe 'deprecation notices' do
+    it 'insteads be failures' do
+      files = fixture_manifests('deprecation_notice.pp')
+      output, has_errors = subject.check(files)
+
+      expect(has_errors).to be(true)
+      expect(output.size).to eq(1)
+      expect(output[0]).to match(/Node inheritance is not supported in Puppet >= 4.0.0/)
+    end
+  end
+end

data/spec/puppetlabs-syntax/tasks/puppetlabs-syntax_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'puppetlabs-syntax/tasks/puppetlabs-syntax'
+
+known_pp = 'spec/fixtures/test_module/manifests/pass.pp'
+known_erb = 'spec/fixtures/test_module/templates/pass.erb'
+known_yaml = 'spec/fixtures/hiera/data/hiera_1.yaml'
+known_eyaml = 'spec/fixtures/hiera/data/hiera_2.eyaml'
+known_yaml_subdir = 'spec/fixtures/hiera/data/test/hiera_3.yaml'
+known_eyaml_subdir = 'spec/fixtures/hiera/data/test/hiera_4.eyaml'
+
+describe 'PuppetlabsSyntax rake tasks' do
+  describe 'with default excludes' do
+    it 'filters directories' do
+      list = PuppetlabsSyntax::RakeTask.new.filelist(['**/lib', known_pp])
+      expect(list.count).to eq 0
+      expect(list).not_to include(known_pp)
+    end
+  end
+
+  describe 'with custom excludes' do
+    before do
+      list = PuppetlabsSyntax.exclude_paths
+      PuppetlabsSyntax.exclude_paths = list - ['spec/fixtures/**/*']
+    end
+
+    it 'filters directories' do
+      list = PuppetlabsSyntax::RakeTask.new.filelist(['**/lib', known_pp])
+      expect(list.count).to eq 1
+      expect(list).to include(known_pp)
+    end
+
+    it 'generates FileList of manifests relative to Rakefile' do
+      list = PuppetlabsSyntax::RakeTask.new.filelist_manifests
+      expect(list).to include(known_pp)
+      expect(list.count).to eq 9
+    end
+
+    it 'generates FileList of templates relative to Rakefile' do
+      list = PuppetlabsSyntax::RakeTask.new.filelist_templates
+      expect(list).to include(known_erb)
+      expect(list.count).to eq 9
+    end
+
+    it 'generates FileList of Hiera yaml files relative to Rakefile' do
+      list = PuppetlabsSyntax::RakeTask.new.filelist_hiera_yaml
+      expect(list).to include(known_yaml)
+      expect(list).to include(known_eyaml)
+      expect(list).to include(known_yaml_subdir)
+      expect(list).to include(known_eyaml_subdir)
+      expect(list.count).to eq 4
+    end
+  end
+end

data/spec/puppetlabs-syntax/templates_spec.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe PuppetlabsSyntax::Templates do
+  let(:subject) { described_class.new }
+  let(:conditional_warning_regex) do
+    # ruby 3.4 uses '= ,ruby 2.6 to 3.3 uses `=
+    /2: warning: found [`']= literal' in conditional/
+  end
+
+  it 'expects an array of files' do
+    expect { subject.check(nil) }.to raise_error(/Expected an array of files/)
+  end
+
+  it 'returns nothing from a valid file' do
+    files = fixture_templates('pass.erb')
+    res = subject.check(files)
+
+    expect(res[:warnings]).to match([])
+    expect(res[:errors]).to match([])
+  end
+
+  it 'ignores NameErrors from unbound variables' do
+    files = fixture_templates('pass_unbound_var.erb')
+    res = subject.check(files)
+
+    expect(res[:warnings]).to match([])
+    expect(res[:errors]).to match([])
+  end
+
+  it 'catches SyntaxError' do
+    files = fixture_templates('fail_error.erb')
+    res = subject.check(files)
+
+    expect(res[:errors].size).to eq(1)
+    expect(res[:errors][0]).to match(/2: syntax error/)
+  end
+
+  it 'catches Ruby warnings' do
+    files = fixture_templates('fail_warning.erb')
+    res = subject.check(files)
+
+    expect(res[:warnings].size).to eq(1)
+    expect(res[:warnings][0]).to match(conditional_warning_regex)
+  end
+
+  it 'reads more than one valid file' do
+    files = fixture_templates(['pass.erb', 'pass_unbound_var.erb'])
+    res = subject.check(files)
+
+    expect(res[:warnings]).to match([])
+    expect(res[:errors]).to match([])
+  end
+
+  it 'continues after finding an error in the first file' do
+    files = fixture_templates(['fail_error.erb', 'fail_warning.erb'])
+    res = subject.check(files)
+
+    expect(res[:warnings].size).to eq(1)
+    expect(res[:errors].size).to eq(1)
+    expect(res[:errors][0]).to match(/2: syntax error/)
+    expect(res[:warnings][0]).to match(conditional_warning_regex)
+  end
+
+  it 'ignores a TypeError' do
+    files = fixture_templates('typeerror_shouldwin.erb')
+    res = subject.check(files)
+
+    expect(res[:warnings]).to match([])
+    expect(res[:errors]).to match([])
+  end
+
+  it 'ignores files without .erb extension' do
+    files = fixture_templates('ignore.tpl')
+    res = subject.check(files)
+
+    expect(res[:warnings]).to match([])
+    expect(res[:errors]).to match([])
+  end
+
+  it 'returns nothing from a valid file' do
+    files = fixture_templates('pass.epp')
+    res = subject.check(files)
+
+    expect(res[:warnings]).to match([])
+    expect(res[:errors]).to match([])
+  end
+
+  it 'catches SyntaxError' do
+    files = fixture_templates('fail_error.epp')
+    res = subject.check(files)
+
+    expect(res[:errors].size).to eq(1)
+    expect(res[:errors][0]).to match(/This Type-Name has no effect/)
+  end
+
+  it 'reads more than one valid file' do
+    files = fixture_templates(['pass.epp', 'pass_also.epp'])
+    res = subject.check(files)
+
+    expect(res[:warnings]).to match([])
+    expect(res[:errors]).to match([])
+  end
+
+  it 'continues after finding an error in the first file' do
+    files = fixture_templates(['fail_error.epp', 'fail_error_also.epp'])
+    res = subject.check(files)
+
+    expect(res[:errors].size).to eq(2)
+    expect(res[:errors][0]).to match(/This Type-Name has no effect/)
+    expect(res[:errors][1]).to match(/Syntax error at '}' \(file: \S*\/fail_error_also.epp, line: 2, column: 4\)/)
+  end
+
+  context "when the 'epp_only' options is set" do
+    before do
+      PuppetlabsSyntax.epp_only = true
+    end
+
+    it 'processes an ERB as EPP and find an error' do
+      files = fixture_templates('pass.erb')
+      res = subject.check(files)
+
+      expect(res[:errors].size).to eq(1)
+    end
+  end
+end

data/spec/puppetlabs-syntax_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe PuppetlabsSyntax do
+  after do
+    described_class.exclude_paths = []
+  end
+
+  it 'defaults exclude_paths to include the pkg directory' do
+    expect(described_class.exclude_paths).to include('pkg/**/*')
+  end
+
+  it 'supports setting exclude_paths' do
+    described_class.exclude_paths = ['foo', 'bar/baz']
+    expect(described_class.exclude_paths).to eq(['foo', 'bar/baz'])
+  end
+
+  it 'supports appending exclude_paths' do
+    described_class.exclude_paths << 'foo'
+    expect(described_class.exclude_paths).to eq(['foo'])
+  end
+
+  it 'supports a fail_on_deprecation_notices setting' do
+    described_class.fail_on_deprecation_notices = false
+    expect(described_class.fail_on_deprecation_notices).to be(false)
+  end
+
+  it 'supports forcing EPP only templates' do
+    described_class.epp_only = true
+    expect(described_class.epp_only).to be(true)
+  end
+
+  it 'supports setting paths for manifests, templates and hiera' do
+    described_class.hieradata_paths = []
+    expect(described_class.hieradata_paths).to eq([])
+    described_class.manifests_paths = ['**/environments/production/**/*.pp']
+    expect(described_class.manifests_paths).to eq(['**/environments/production/**/*.pp'])
+    described_class.templates_paths = []
+    expect(described_class.templates_paths).to eq([])
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require 'puppetlabs-syntax'
+
+def fixture_hiera(list)
+  fixture_files(list, 'hiera')
+end
+
+def fixture_templates(list)
+  fixture_files(list, 'test_module/templates')
+end
+
+def fixture_manifests(list)
+  fixture_files(list, 'test_module/manifests')
+end
+
+def fixture_files(list, path)
+  list = [list].flatten
+  list.map { |f| File.expand_path("../fixtures/#{path}/#{f}", __FILE__) }
+end
+
+RSpec.configure do |config|
+  config.color     = true
+  config.formatter = 'documentation'
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: puppetlabs-syntax
+version: !ruby/object:Gem::Version
+  version: 7.2.1
+platform: ruby
+authors:
+- Puppet, Inc.
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+- !ruby/object:Gem::Dependency
+  name: voxpupuli-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+description: "    Syntax checks for Puppet manifests and templates.\n"
+email:
+- modules-team@puppet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/mend.yml"
+- ".github/workflows/nightly.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/release_prep.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- CODEOWNERS
+- Gemfile
+- HISTORY.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/puppetlabs-syntax.rb
+- lib/puppetlabs-syntax/hiera.rb
+- lib/puppetlabs-syntax/manifests.rb
+- lib/puppetlabs-syntax/tasks/puppetlabs-syntax.rb
+- lib/puppetlabs-syntax/templates.rb
+- lib/puppetlabs-syntax/version.rb
+- puppetlabs-syntax.gemspec
+- spec/fixtures/hiera/data/hiera_1.yaml
+- spec/fixtures/hiera/data/hiera_2.eyaml
+- spec/fixtures/hiera/data/test/hiera_3.yaml
+- spec/fixtures/hiera/data/test/hiera_4.eyaml
+- spec/fixtures/hiera/hiera_bad.eyaml
+- spec/fixtures/hiera/hiera_bad.yaml
+- spec/fixtures/hiera/hiera_badkey.yaml
+- spec/fixtures/hiera/hiera_badvalue.yaml
+- spec/fixtures/hiera/hiera_good.eyaml
+- spec/fixtures/hiera/hiera_good.yaml
+- spec/fixtures/hiera/hiera_key_empty.yaml
+- spec/fixtures/hiera/hiera_key_no_value.yaml
+- spec/fixtures/test_module/manifests/deprecation_notice.pp
+- spec/fixtures/test_module/manifests/fail_error.pp
+- spec/fixtures/test_module/manifests/fail_warning.pp
+- spec/fixtures/test_module/manifests/future_syntax.pp
+- spec/fixtures/test_module/manifests/pass.pp
+- spec/fixtures/test_module/manifests/pass_storeconfigs.pp
+- spec/fixtures/test_module/manifests/schedule_notice.pp
+- spec/fixtures/test_module/manifests/tag_notice.pp
+- spec/fixtures/test_module/manifests/test_app.pp
+- spec/fixtures/test_module/templates/fail_error.epp
+- spec/fixtures/test_module/templates/fail_error.erb
+- spec/fixtures/test_module/templates/fail_error_also.epp
+- spec/fixtures/test_module/templates/fail_warning.erb
+- spec/fixtures/test_module/templates/ignore.tpl
+- spec/fixtures/test_module/templates/pass.epp
+- spec/fixtures/test_module/templates/pass.erb
+- spec/fixtures/test_module/templates/pass_also.epp
+- spec/fixtures/test_module/templates/pass_unbound_var.erb
+- spec/fixtures/test_module/templates/typeerror_shouldwin.erb
+- spec/puppetlabs-syntax/hiera_spec.rb
+- spec/puppetlabs-syntax/manifests_spec.rb
+- spec/puppetlabs-syntax/tasks/puppetlabs-syntax_spec.rb
+- spec/puppetlabs-syntax/templates_spec.rb
+- spec/puppetlabs-syntax_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/puppetlabs/puppetlabs-syntax/
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Syntax checks for Puppet manifests, templates, and Hiera YAML
+test_files: []