puppet-syntax 2.5.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbbd3aba8d6bec0241405c588e3681c1f1e5a139d760b1ec395f80f7ca7ca121
-  data.tar.gz: 7622c3904efa27007315dd1aa10d9301e103d183faa6abf08d1f3862f85f0f2f
+  metadata.gz: 5d56b393f1a0a60742b7c0600dd39568eb232cee2bae2400b169fee499cb12a6
+  data.tar.gz: 3b641f2e4ad9f5ab9fa8f91853bfc557b6573e871caeae2228b17f2446d96270
 SHA512:
-  metadata.gz: 90baf9b29551b81073c0ded34b3edbc5fd7a77478d5e25fa4f1054a7546505d06fb7e7b5fa0312379686500b5eb986648240e3e433af034b75578716e8720f72
-  data.tar.gz: f88be032866ad40ccd014e43c1acd3b7ac31c4e53c9194b6d41a9141d6a44a3d9749807656d78dced4818c7542fa0a4740898d0e9d25cddd7839f2b8846f866b
+  metadata.gz: e4cf5aff0b7abe2e3dc4f07f6a3fec2704c637c063f076e08d9c4812f8fdb8b68fc4d65277982d12008914dca799cf45e8bf6ec5120827b3485abc569755b6c3
+  data.tar.gz: 63e40dd6206c72b2dfddbc85dd0efff6c4fffcd748277e15cacf1aaa54c79a1d62b67da751842ee190856b01e333c391197e22393372d54851306b67639b12bf

data/.gitignore

@@ -16,4 +16,5 @@ test/tmp
 test/version_tmp
 tmp
 vendor/
-.idea/
+.idea/
+.vendor/

data/.travis.yml

@@ -1,20 +1,25 @@
 ---
+os: linux
+dist: bionic
 language: ruby
 # Workaround https://github.com/bundler/bundler/issues/3558
 before_install: gem install bundler
-install: bundle install --jobs 4 --retry 2 --without development
+install: bundle install --jobs 4 --retry 2 --without development release
 script: bundle exec rake
 rvm:
   - 2.4.4
   - 2.5.1
+  - 2.6.5
+  - 2.7
 env:
   - PUPPET_VERSION="~> 5.5.10"
-  - PUPPET_VERSION="~> 6.1.0"
-  - PUPPET_VERSION="~> 6.2.0"
-  - PUPPET_VERSION="~> 6.5.0"
+  - PUPPET_VERSION="~> 6.5"
   - PUPPET_VERSION=">= 0"
   - PUPPET_VERSION="git://github.com/puppetlabs/puppet.git#master"
-matrix:
+jobs:
+  exclude:
+    - rvm: 2.7
+      env: PUPPET_VERSION="~> 5.5.10"
   allow_failures:
     - env: PUPPET_VERSION=">= 0"
     - env: PUPPET_VERSION="git://github.com/puppetlabs/puppet.git#master"
@@ -29,3 +34,10 @@ deploy:
     tags: true
     all_branches: true
     repo: voxpupuli/puppet-syntax
+notifications:
+  email: false
+  irc:
+    on_success: always
+    on_failure: always
+    channels:
+      - "chat.freenode.org#voxpupuli-notifications"

data/CHANGELOG.md

@@ -2,6 +2,69 @@
 
 All notable changes to this project will be documented in this file.
 
+## [v3.1.0](https://github.com/voxpupuli/puppet-syntax/tree/v3.1.0) (2020-06-24)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-syntax/compare/v3.0.1...v3.1.0)
+
+**Implemented enhancements:**
+
+- print actual template errors on $stderr [\#125](https://github.com/voxpupuli/puppet-syntax/pull/125) ([foxxx0](https://github.com/foxxx0))
+
+**Merged pull requests:**
+
+- Add ruby2.7 testing, replacing multiple obsolete puppet6 versions [\#124](https://github.com/voxpupuli/puppet-syntax/pull/124) ([DavidS](https://github.com/DavidS))
+
+## [v3.0.1](https://github.com/voxpupuli/puppet-syntax/tree/v3.0.1) (2020-05-27)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-syntax/compare/v3.0.0...v3.0.1)
+
+**Merged pull requests:**
+
+- Avoid failure on schedule metaparameter warning [\#122](https://github.com/voxpupuli/puppet-syntax/pull/122) ([ffapitalle](https://github.com/ffapitalle))
+
+## [v3.0.0](https://github.com/voxpupuli/puppet-syntax/tree/v3.0.0) (2020-05-09)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-syntax/compare/v2.6.1...v3.0.0)
+
+**Breaking changes:**
+
+- Drop legacy code to support Puppet \< 5 and Ruby \< 2.4 [\#120](https://github.com/voxpupuli/puppet-syntax/pull/120) ([ekohl](https://github.com/ekohl))
+
+**Implemented enhancements:**
+
+- Migrate Changelog to GCG [\#93](https://github.com/voxpupuli/puppet-syntax/issues/93)
+
+**Merged pull requests:**
+
+- cleanup README.md / fix markdown linter warnings [\#119](https://github.com/voxpupuli/puppet-syntax/pull/119) ([bastelfreak](https://github.com/bastelfreak))
+
+## [v2.6.1](https://github.com/voxpupuli/puppet-syntax/tree/v2.6.1) (2020-01-11)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-syntax/compare/v2.6.0...v2.6.1)
+
+**Fixed bugs:**
+
+- Add `puppet` gem as runtime dependency [\#116](https://github.com/voxpupuli/puppet-syntax/pull/116) ([bastelfreak](https://github.com/bastelfreak))
+
+**Merged pull requests:**
+
+- traivs: run tests on Ubuntu 18.04 [\#117](https://github.com/voxpupuli/puppet-syntax/pull/117) ([bastelfreak](https://github.com/bastelfreak))
+- travis: enable irc / disable email notifications [\#114](https://github.com/voxpupuli/puppet-syntax/pull/114) ([bastelfreak](https://github.com/bastelfreak))
+
+## [v2.6.0](https://github.com/voxpupuli/puppet-syntax/tree/v2.6.0) (2019-10-05)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-syntax/compare/v2.5.0...v2.6.0)
+
+**Implemented enhancements:**
+
+- add support for validating puppet plans \(fixes \#95, fixes \#96\) [\#97](https://github.com/voxpupuli/puppet-syntax/pull/97) ([slauger](https://github.com/slauger))
+- Allow specifying file paths for manifests and templates too [\#87](https://github.com/voxpupuli/puppet-syntax/pull/87) ([lavagetto](https://github.com/lavagetto))
+
+**Merged pull requests:**
+
+- Test on ruby 2.6 [\#111](https://github.com/voxpupuli/puppet-syntax/pull/111) ([alexjfisher](https://github.com/alexjfisher))
+- Adding KMS tags to allowed EYAML methods [\#105](https://github.com/voxpupuli/puppet-syntax/pull/105) ([craigwatson](https://github.com/craigwatson))
+
 ## [v2.5.0](https://github.com/voxpupuli/puppet-syntax/tree/v2.5.0) (2019-07-07)
 
 [Full Changelog](https://github.com/voxpupuli/puppet-syntax/compare/v2.4.3...v2.5.0)

data/Gemfile

@@ -18,15 +18,13 @@ end
 gemspec
 
 # Override gemspec for CI matrix builds.
-gem 'puppet', *location_for(ENV['PUPPET_VERSION'] || '>2.7.0')
-
-# older version required for ruby 1.9 compat, as it is pulled in as dependency of puppet, this has to be carried by the module
-gem 'json_pure', '<= 2.0.1'
+# But only if the environment variable is set
+gem 'puppet', *location_for(ENV['PUPPET_VERSION'] || '>= 5') if ENV['PUPPET_VERSION']
 
 group :test do
   gem 'rspec'
 end
 
 group :release do
-  gem 'github_changelog_generator',  :require => false, :git => 'https://github.com/github-changelog-generator/github-changelog-generator' if RUBY_VERSION >= '2.2.2'
+  gem 'github_changelog_generator',  :require => false, :git => 'https://github.com/github-changelog-generator/github-changelog-generator'
 end

data/README.md

@@ -4,36 +4,40 @@
 
 # Puppet::Syntax
 
-Puppet::Syntax checks for correct syntax in Puppet manifests, templates, and Hiera YAML.
+Puppet::Syntax checks for correct syntax in Puppet manifests, templates, and
+Hiera YAML.
 
 ## Version support
 
 Puppet::Syntax is supported with:
 
-- Puppet >= 2.7 that provides the `validate` face.
-- Ruby >= 1.8 with `erb` from Ruby stdlib.
+- Puppet >= 5.0 that provides the `validate` face.
+- Ruby >= 2.4
 
 For the specific versions that we test against, see the [TravisCI config](.travis.yml).
 
-If you're using `puppetlabs_spec_helper/rake_tasks` and getting unexpected non-zero exit codes, upgrade to [puppetlabs_spec_helper][psh] version 0.8.0 or greater. Versions of `puppetlabs_spec_helper` prior to 0.8.0 conflicted with Puppet::Syntax.
-
-[psh]: https://github.com/puppetlabs/puppetlabs_spec_helper
-
 ## Installation
 
-To install Puppet::Syntax, either add it to your module's Gemfile or install the gem manually.
+To install Puppet::Syntax, either add it to your module's Gemfile or install
+the gem manually.
 
 * To install with the Gemfile, add:
 
-        gem 'puppet-syntax'
+```ruby
+gem 'puppet-syntax'
+```
 
   And then execute:
 
-        $ bundle install
+```sh
+bundle install
+```
 
 * To install the gem yourself, run:
 
-        $ gem install puppet-syntax
+```sh
+gem install puppet-syntax
+```
 
 ## Configuration
 
@@ -41,70 +45,85 @@ To configure Puppet::Syntax, add any of the following settings to your `Rakefile
 
 * To exclude certain paths from the syntax checks, set:
 
-        PuppetSyntax.exclude_paths = ["vendor/**/*"]
-
-* To use the Puppet 4 ("future") parser in Puppet 3.2 through 3.8, set:
-
-        PuppetSyntax.future_parser = true
+```ruby
+PuppetSyntax.exclude_paths = ["vendor/**/*"]
+```
 
 * To configure specific paths for the Hiera syntax check, specify `hieradata_paths`. This is useful if you use Hiera data inside your module.
 
-        PuppetSyntax.hieradata_paths = ["**/data/**/*.yaml", "hieradata/**/*.yaml", "hiera*.yaml"]
-
-* To validate the syntax of code written for application orchestration, enable `app_management`:
+```ruby
+PuppetSyntax.hieradata_paths = ["**/data/**/*.yaml", "hieradata/**/*.yaml", "hiera*.yaml"]
+```
 
-        PuppetSyntax.app_management = true
+* To configure specific paths for the Puppet syntax checks or for the templates checks, specify `manifests_paths` or `templates_paths` respectively. This is useful if you want to check specific paths only.
 
-  The `app_management` setting is supported with Puppet 4.3 or greater and is off by default. In Puppet 5, app_management is always enabled.
+```ruby
+PuppetSyntax.manifests_paths = ["**/environments/future/*.pp"]
+PuppetSyntax.templates_paths = ["**/modules/**/templates/*.erb"]
+```
 
 * To ignore deprecation warnings, disable `fail_on_deprecation_notices`. By default, `puppet-syntax` fails if it encounters Puppet deprecation notices. If you are working with a legacy code base and want to ignore such non-fatal warnings, you might want to override the default behavior.
 
-        PuppetSyntax.fail_on_deprecation_notices = false
+```ruby
+PuppetSyntax.fail_on_deprecation_notices = false
+```
 
 * To enable a syntax check on Hiera keys, set:
 
-        PuppetSyntax.check_hiera_keys = true
+```ruby
+PuppetSyntax.check_hiera_keys = true
+```
 
-   This reports common mistakes in key names in Hiera files, such as:
+This reports common mistakes in key names in Hiera files, such as:
 
-  - Leading `::` in keys, such as: `::notsotypical::warning2: true`.
-  - Single colon scope separators, such as: `:picky::warning5: true`.
-  - Invalid camel casing, such as: `noCamelCase::warning3: true`.
-  - Use of hyphens, such as: `no-hyphens::warning4: true`.
+* Leading `::` in keys, such as: `::notsotypical::warning2: true`.
+* Single colon scope separators, such as: `:picky::warning5: true`.
+* Invalid camel casing, such as: `noCamelCase::warning3: true`.
+* Use of hyphens, such as: `no-hyphens::warning4: true`.
 
 ## Usage
 
 * To enable Puppet::Syntax, include the following in your module's `Rakefile`:
 
-        require 'puppet-syntax/tasks/puppet-syntax'
+```ruby
+require 'puppet-syntax/tasks/puppet-syntax'
+```
 
-  For Continuous Integration, use Puppet::Syntax in conjunction with `puppet-lint` and spec tests. Add the following to your module's `Rakefile`:
+For Continuous Integration, use Puppet::Syntax in conjunction with `puppet-lint`
+and spec tests. Add the following to your module's `Rakefile`:
 
-        task :test => [
-          :syntax,
-          :lint,
-          :spec,
-        ]
+```ruby
+task :test => [
+  :syntax,
+  :lint,
+  :spec,
+]
+```
 
 * To test all manifests and templates, relative to the location of the `Rakefile`, run:
 
-        $ bundle exec rake syntax
-        ---> syntax:manifests
-        ---> syntax:templates
-        ---> syntax:hiera:yaml
+```
+$ bundle exec rake syntax
+---> syntax:manifests
+---> syntax:templates
+---> syntax:hiera:yaml
+```
 
 * To return a non-zero exit code and an error message on any failures, run:
 
-        $ bundle exec rake syntax
-        ---> syntax:manifests
-        rake aborted!
-        Could not parse for environment production: Syntax error at end of file at demo.pp:2
-        Tasks: TOP => syntax => syntax:manifests
-        (See full trace by running task with --trace)
+```
+$ bundle exec rake syntax
+---> syntax:manifests
+rake aborted!
+Could not parse for environment production: Syntax error at end of file at demo.pp:2
+Tasks: TOP => syntax => syntax:manifests
+(See full trace by running task with --trace)
+```
 
 ## Checks
 
-Puppet::Syntax makes the following checks in the directories and subdirectories of the module, relative to the location of the `Rakefile`.
+Puppet::Syntax makes the following checks in the directories and subdirectories
+of the module, relative to the location of the `Rakefile`.
 
 ### Hiera
 
@@ -130,7 +149,8 @@ Checks `.erb` files in the module for syntax errors.
 
 Checks `.epp` files in the module for syntax errors.
 
-EPP checks are supported in Puppet 4 or greater, or in Puppet 3 with the future parser enabled.
+EPP checks are supported in Puppet 4 or greater, or in Puppet 3 with the future
+parser enabled.
 
 ## Contributing
 

data/lib/puppet-syntax.rb

@@ -6,28 +6,28 @@ require "puppet/version"
 
 module PuppetSyntax
   @exclude_paths = []
-  @future_parser = false
   @hieradata_paths = [
     "**/data/**/*.*{yaml,yml}",
     "hieradata/**/*.*{yaml,yml}",
     "hiera*.*{yaml,yml}"
   ]
+  @manifests_paths = [
+    '**/*.pp'
+  ]
+  @templates_paths = [
+    '**/templates/**/*.erb',
+    '**/templates/**/*.epp'
+  ]
   @fail_on_deprecation_notices = true
-  @app_management = Puppet.version.to_i >= 5 ? true : false
   @check_hiera_keys = false
 
   class << self
     attr_accessor :exclude_paths,
-                  :future_parser,
                   :hieradata_paths,
+                  :manifests_paths,
+                  :templates_paths,
                   :fail_on_deprecation_notices,
                   :epp_only,
                   :check_hiera_keys
-    attr_reader :app_management
-
-    def app_management=(app_management)
-      raise 'app_management cannot be disabled on Puppet 5 or higher' if Puppet.version.to_i >= 5 && !app_management
-      @app_management = app_management
-    end
   end
 end

data/lib/puppet-syntax/hiera.rb

@@ -56,7 +56,7 @@ module PuppetSyntax
           method = 'PKCS7'
         end
 
-        return "has unknown eyaml method #{method}" unless ['PKCS7','GPG'].include? method
+        return "has unknown eyaml method #{method}" unless ['PKCS7','GPG','GKMS','KMS'].include? method
         return "has unpadded or truncated base64 data" unless base64.length % 4 == 0
 
         # Base64#decode64 will silently ignore characters outside the alphabet,

data/lib/puppet-syntax/manifests.rb

@@ -8,9 +8,7 @@ module PuppetSyntax
 
       output = []
 
-      if Puppet::Test::TestHelper.respond_to?(:initialize) # 3.1+
-        Puppet::Test::TestHelper.initialize
-      end
+      Puppet::Test::TestHelper.initialize
       Puppet::Test::TestHelper.before_all_tests
       called_before_all_tests = true
 
@@ -43,9 +41,9 @@ module PuppetSyntax
         e =~ /^You cannot collect( exported resources)? without storeconfigs being set/
       }
 
-      # tag parameter in class raise warnings notice in output that prevent from succeed
+      # tag and schedule parameters in class raise warnings notice in output that prevent from succeed
       output.reject! { |e|
-        e =~ /^tag is a metaparam; this value will inherit to all contained resources in the /
+        e =~ /^(tag|schedule) is a metaparam; this value will inherit to all contained resources in the /
       }
 
       deprecations = output.select { |e|
@@ -62,8 +60,7 @@ module PuppetSyntax
 
     private
     def validate_manifest(file)
-      Puppet[:parser] = 'future' if PuppetSyntax.future_parser and Puppet.version.to_i < 4
-      Puppet[:app_management] = true if PuppetSyntax.app_management && (Puppet::Util::Package.versioncmp(Puppet.version, '4.3.0') >= 0 && Puppet.version.to_i < 5)
+      Puppet[:tasks] = true if Puppet::Util::Package.versioncmp(Puppet.version, '5.4.0') >= 0 and file.match(/.*plans\/.*\.pp$/)
       Puppet::Face[:parser, :current].validate(file)
     end
   end

data/lib/puppet-syntax/tasks/puppet-syntax.rb

@@ -13,11 +13,11 @@ module PuppetSyntax
     end
 
     def filelist_manifests
-      filelist("**/*.pp")
+      filelist(PuppetSyntax.manifests_paths)
     end
 
     def filelist_templates
-      filelist(["**/templates/**/*.erb", "**/templates/**/*.epp"])
+      filelist(PuppetSyntax.templates_paths)
     end
 
     def filelist_hiera_yaml
@@ -27,42 +27,14 @@ module PuppetSyntax
     def initialize(*args)
       desc 'Syntax check Puppet manifests and templates'
       task :syntax => [
-        'syntax:check_puppetlabs_spec_helper',
         'syntax:manifests',
         'syntax:templates',
         'syntax:hiera',
       ]
 
       namespace :syntax do
-        task :check_puppetlabs_spec_helper do
-          psh_present = task(:syntax).actions.any? { |a|
-            a.inspect.match(/puppetlabs_spec_helper\/rake_tasks\.rb:\d+/)
-          }
-
-          if psh_present
-            $stderr.puts <<-EOS
-[WARNING] A conflicting :syntax rake task has been defined by
-puppetlabs_spec_helper/rake_tasks. You should either disable this or upgrade
-to puppetlabs_spec_helper >= 0.8.0 which now uses puppet-syntax.
-            EOS
-          end
-        end
-
         desc 'Syntax check Puppet manifests'
         task :manifests do |t|
-          if Puppet.version.to_i >= 4 and PuppetSyntax.future_parser
-            $stderr.puts <<-EOS
-[INFO] Puppet 4 has been detected and `future_parser` has been set to
-'true'. The `future_parser setting will be ignored.
-            EOS
-          end
-          if Puppet::Util::Package.versioncmp(Puppet.version, '4.3.0') < 0 and PuppetSyntax.app_management
-            $stderr.puts <<-EOS
-[WARNING] Puppet `app_management` has been detected but the Puppet
-version is less then 4.3.  The `app_management` setting will be ignored.
-            EOS
-          end
-
           $stderr.puts "---> #{t.name}"
 
           c = PuppetSyntax::Manifests.new
@@ -76,9 +48,16 @@ version is less then 4.3.  The `app_management` setting will be ignored.
           $stderr.puts "---> #{t.name}"
 
           c = PuppetSyntax::Templates.new
-          errors = c.check(filelist_templates)
-          $stdout.puts "#{errors.join("\n")}\n" unless errors.empty?
-          exit 1 unless errors.empty?
+          result = c.check(filelist_templates)
+          unless result[:warnings].empty?
+            $stdout.puts "WARNINGS:"
+            $stdout.puts result[:warnings].join("\n")
+          end
+          unless result[:errors].empty?
+            $stderr.puts "ERRORS:"
+            $stderr.puts result[:errors].join("\n")
+            exit 1
+          end
         end
 
         desc 'Syntax check Hiera config files'

data/lib/puppet-syntax/templates.rb

@@ -9,42 +9,64 @@ module PuppetSyntax
 
       # We now have to redirect STDERR in order to capture warnings.
       $stderr = warnings = StringIO.new()
-      errors = []
+      result = { warnings: [], errors: [] }
 
       filelist.each do |file|
         if File.extname(file) == '.epp' or PuppetSyntax.epp_only
-          errors.concat validate_epp(file)
+          tmp = validate_epp(file)
         elsif File.extname(file) == '.erb'
-          errors.concat validate_erb(file)
+          tmp = validate_erb(file)
         end
+        result.merge!(tmp) { |k, a, b| a.concat(b) } unless tmp.nil?
       end
 
       $stderr = STDERR
-      errors << warnings.string unless warnings.string.empty?
-      errors.map! { |e| e.to_s }
+      result[:warnings] << warnings.string unless warnings.string.empty?
 
-      errors
+      result[:errors].map! { |e| e.to_s }
+      result[:warnings].map! { |w| w.to_s }
+
+      result
     end
 
     def validate_epp(filename)
-      if Puppet.version.to_f < 3.7
-        raise "Cannot validate EPP without Puppet 4 or future parser (3.7+)"
-      end
-
       require 'puppet/pops'
-      errors = []
+      result = { warnings: [], errors: [] }
+      formatter = Puppet::Pops::Validation::DiagnosticFormatterPuppetStyle.new
+      evaluating_parser = Puppet::Pops::Parser::EvaluatingParser::EvaluatingEppParser.new()
+      parser = evaluating_parser.parser()
       begin
-        parser = Puppet::Pops::Parser::EvaluatingParser::EvaluatingEppParser.new()
-        parser.parse_file(filename)
-      rescue => detail
-        errors << detail
+        parse_result = parser.parse_file(filename)
+        validation_result = evaluating_parser.validate(parse_result.model)
+
+        # print out any warnings
+        validation_result.warnings.each do |warn|
+          message = formatter.format_message(warn)
+          file = warn.file
+          line = warn.source_pos.line
+          column = warn.source_pos.pos
+          result[:warnings] << "#{file}:#{line}:#{column}: #{message}"
+        end
+
+        # collect errors and return them in order to indicate validation failure
+        validation_result.errors.each do |err|
+          message = formatter.format_message(err)
+          file = err.file
+          line = err.source_pos.line
+          column = err.source_pos.pos
+          result[:errors] << "#{file}:#{line}:#{column}: #{message}"
+        end
+      rescue Puppet::ParseError, SyntaxError => exc
+        result[:errors] << exc
+      rescue => exc
+        result[:errors] << exc
       end
 
-      errors
+      result
     end
 
     def validate_erb(filename)
-      errors = []
+      result = { warnings: [], errors: [] }
 
       begin
         erb = ERB.new(File.read(filename), nil, '-')
@@ -57,10 +79,10 @@ module PuppetSyntax
         # This is normal because we don't have the variables that would
         # ordinarily be bound by the parent Puppet manifest.
       rescue SyntaxError => error
-        errors << error
+        result[:errors] << error
       end
 
-      errors
+      result
     end
   end
 end

data/lib/puppet-syntax/version.rb

@@ -1,3 +1,3 @@
 module PuppetSyntax
-  VERSION = '2.5.0'
+  VERSION = '3.1.0'
 end

data/puppet-syntax.gemspec

@@ -18,7 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.4"
+
   spec.add_dependency "rake"
+  spec.add_dependency "puppet", ">= 5"
 
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rb-readline"

data/spec/fixtures/test_module/manifests/schedule_notice.pp

@@ -0,0 +1,5 @@
+class schedule_parameter_test ($schedule=undef){
+  notify { 'schedule_should pass':
+    message => 'with flying colours',
+  }
+}

data/spec/puppet-syntax/manifests_spec.rb

@@ -24,19 +24,21 @@ describe PuppetSyntax::Manifests do
     expect(has_errors).to eq(false)
   end
 
+  it 'should return 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 eq(false)
+  end
+
   it 'should return an error from an invalid file' do
     files = fixture_manifests('fail_error.pp')
     output, has_errors = subject.check(files)
 
-    if Puppet.version.to_i >= 4
-      expect(output.size).to eq(3)
-      expect(output[2]).to match(/2 errors. Giving up/)
-      expect(has_errors).to eq(true)
-    else
-      expect(output.size).to eq(1)
-      expect(output[0]).to match(/Syntax error at .*:3$/)
-      expect(has_errors).to eq(true)
-    end
+    expect(output.size).to eq(3)
+    expect(output[2]).to match(/2 errors. Giving up/)
+    expect(has_errors).to eq(true)
   end
 
   it 'should return a warning from an invalid file' do
@@ -72,181 +74,22 @@ describe PuppetSyntax::Manifests do
     output, has_errors = subject.check(files)
 
     expect(has_errors).to eq(true)
-    if Puppet.version.to_i >= 4
-      expect(output.size).to eq(5)
-      expect(output[0]).to match(/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(/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 '\\\]'/)
-    else
-      expect(output.size).to eq(3)
-      expect(output[0]).to match(/Syntax error at '\}' .*:3$/)
-      expect(output[1]).to match(/Unrecogni(s|z)ed escape sequence '\\\['/)
-      expect(output[2]).to match(/Unrecogni(s|z)ed escape sequence '\\\]'/)
-    end
+    expect(output.size).to eq(5)
+    expect(output[0]).to match(/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(/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
-    case Puppet.version.to_f
-    when 4.0..4.99
-      context 'on puppet 4.0.0 and above' do
-        it 'should instead be failures' do
-          files = fixture_manifests('deprecation_notice.pp')
-          output, has_errors = subject.check(files)
-
-          expect(has_errors).to eq(true)
-          expect(output.size).to eq(1)
-          expect(output[0]).to match (/Node inheritance is not supported in Puppet >= 4.0.0/)
-        end
-      end
-    when 3.7, 3.8
-      context 'on puppet 3.7 and 3.8' do
-        it 'should return deprecation notices as warnings' do
-          files = fixture_manifests('deprecation_notice.pp')
-          output, has_errors = subject.check(files)
-
-          expect(has_errors).to eq(false)
-          expect(output.size).to eq(2)
-          expect(output[0]).to match(/The use of 'import' is deprecated/)
-          expect(output[1]).to match(/Deprecation notice:/)
-        end
-      end
-    when 3.5, 3.6
-      context 'on puppet 3.5 and 3.6' do
-        it 'should return deprecation notices as warnings' do
-          files = fixture_manifests('deprecation_notice.pp')
-          output, has_errors = subject.check(files)
-
-          expect(has_errors).to eq(false)
-          expect(output.size).to eq(1)
-          expect(output[0]).to match(/The use of 'import' is deprecated/)
-        end
-      end
-    when 3.0..3.4
-      context 'on puppet 3.0 to 3.4' do
-        it 'should not print deprecation notices' do
-          files = fixture_manifests('deprecation_notice.pp')
-          output, has_errors = subject.check(files)
-
-          expect(output).to eq([])
-          expect(has_errors).to eq(false)
-        end
-      end
-    end
-  end
-
-  describe 'app_management' do
-    after do
-      PuppetSyntax.app_management = false if Puppet.version.to_i < 5
-    end
+    it 'should instead be failures' do
+      files = fixture_manifests('deprecation_notice.pp')
+      output, has_errors = subject.check(files)
 
-    context 'app_management = false (default)', :if => (Puppet.version.to_i < 5) do
-      it 'should fail to parse an application manifest' do
-
-        files = fixture_manifests(['test_app.pp'])
-        output,has_errors = subject.check(files)
-
-        expect(has_errors).to eq(true)
-        expect(output).to include(/error/)
-      end
-    end
-    context 'app_management = true' do
-      before(:each) {
-        PuppetSyntax.app_management = true
-      }
-      if Puppet::Util::Package.versioncmp(Puppet.version, '4.3.0') >= 0
-        it 'should successfully parse an application manifest on Puppet >= 4.3.0' do
-          expect(PuppetSyntax.app_management).to eq(true)
-
-          files = fixture_manifests(['test_app.pp'])
-          output,has_errors = subject.check(files)
-
-          expect(output.size).to eq(0)
-          expect(has_errors).to eq(false)
-        end
-      else
-        it 'should fail to parse an application manifest on Puppet < 4.3.0' do
-          expect(PuppetSyntax.app_management).to eq(true)
-
-          files = fixture_manifests(['test_app.pp'])
-          output,has_errors = subject.check(files)
-
-          expect(output).to include(/error/)
-          expect(has_errors).to eq(true)
-        end
-      end
-    end
-  end
-
-
-  describe 'future_parser' do
-    context 'future_parser = false (default)' do
-      if Puppet::Util::Package.versioncmp(Puppet.version, '4.0') < 0
-        it 'should fail without setting future option to true on future manifest on Puppet < 4.0.0' do
-          expect(PuppetSyntax.future_parser).to eq(false)
-
-          files = fixture_manifests(['future_syntax.pp'])
-          output, has_errors = subject.check(files)
-
-          expect(output.size).to eq(1)
-          expect(output[0]).to match(/Syntax error at '='; expected '\}' .*:2$/)
-          expect(has_errors).to eq(true)
-        end
-      else
-        it 'should succeed on Puppet >= 4.0.0' do
-          expect(PuppetSyntax.future_parser).to eq(false)
-
-          files = fixture_manifests(['future_syntax.pp'])
-          output, has_errors = subject.check(files)
-
-          expect(output.size).to eq(0)
-          expect(has_errors).to eq(false)
-        end
-      end
-    end
-
-    context 'future_parser = true' do
-      before(:each) {
-        PuppetSyntax.future_parser = true
-      }
-
-      if Puppet::Util::Package.versioncmp(Puppet.version, '3.2') >= 0 and Puppet.version.to_i < 4
-        context 'Puppet >= 3.2 < 4' do
-          it 'should pass with future option set to true on future manifest' do
-            files = fixture_manifests(['future_syntax.pp'])
-            output, has_errors = subject.check(files)
-
-            expect(output).to eq([])
-            expect(has_errors).to eq(false)
-          end
-        end
-        context 'Puppet >= 3.7 < 4' do
-          # Certain elements of the future parser weren't added until 3.7
-          if Puppet::Util::Package.versioncmp(Puppet.version, '3.7') >= 0
-            it 'should fail on what were deprecation notices in the non-future parser' do
-              files = fixture_manifests('deprecation_notice.pp')
-              output, has_errors = subject.check(files)
-
-              expect(output.size).to eq(1)
-              expect(output[0]).to match(/Node inheritance is not supported/)
-              expect(has_errors).to eq(true)
-            end
-          end
-        end
-      elsif Puppet::Util::Package.versioncmp(Puppet.version, '3.2') < 0
-        context 'Puppet < 3.2' do
-          it 'should return an error that the parser option is not supported' do
-            files = fixture_manifests(['future_syntax.pp'])
-            output, has_errors = subject.check(files)
-
-            expect(output.size).to eq(1)
-            expect(output[0]).to match("Attempt to assign a value to unknown configuration parameter :parser")
-            expect(has_errors).to eq(true)
-          end
-        end
-      end
+      expect(has_errors).to eq(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/puppet-syntax/tasks/puppet-syntax_spec.rb

@@ -18,7 +18,7 @@ describe 'PuppetSyntax rake tasks' do
   it 'should generate FileList of manifests relative to Rakefile' do
     list = PuppetSyntax::RakeTask.new.filelist_manifests
     expect(list).to include(known_pp)
-    expect(list.count).to eq 8
+    expect(list.count).to eq 9
   end
 
   it 'should generate FileList of templates relative to Rakefile' do

data/spec/puppet-syntax/templates_spec.rb

@@ -2,6 +2,13 @@ require 'spec_helper'
 
 describe PuppetSyntax::Templates do
   let(:subject) { PuppetSyntax::Templates.new }
+  let(:conditional_warning_regex) do
+    if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.6.0')
+      %r{2: warning: found `= literal' in conditional}
+    else
+      %r{2: warning: found = in conditional}
+    end
+  end
 
   it 'should expect an array of files' do
     expect { subject.check(nil) }.to raise_error(/Expected an array of files/)
@@ -11,127 +18,111 @@ describe PuppetSyntax::Templates do
     files = fixture_templates('pass.erb')
     res = subject.check(files)
 
-    expect(res).to match([])
+    expect(res[:warnings]).to match([])
+    expect(res[:errors]).to match([])
   end
 
   it 'should ignore NameErrors from unbound variables' do
     files = fixture_templates('pass_unbound_var.erb')
     res = subject.check(files)
 
-    expect(res).to match([])
+    expect(res[:warnings]).to match([])
+    expect(res[:errors]).to match([])
   end
 
   it 'should catch SyntaxError' do
     files = fixture_templates('fail_error.erb')
     res = subject.check(files)
 
-    expect(res.size).to eq(1)
-    expect(res[0]).to match(/2: syntax error, unexpected/)
+    expect(res[:errors].size).to eq(1)
+    expect(res[:errors][0]).to match(/2: syntax error, unexpected/)
   end
 
   it 'should catch Ruby warnings' do
     files = fixture_templates('fail_warning.erb')
     res = subject.check(files)
 
-    expect(res.size).to eq(1)
-    expect(res[0]).to match(/2: warning: found = in conditional/)
+    expect(res[:warnings].size).to eq(1)
+    expect(res[:warnings][0]).to match(conditional_warning_regex)
   end
 
   it 'should read more than one valid file' do
     files = fixture_templates(['pass.erb', 'pass_unbound_var.erb'])
     res = subject.check(files)
 
-    expect(res).to match([])
+    expect(res[:warnings]).to match([])
+    expect(res[:errors]).to match([])
   end
 
   it 'should continue after finding an error in the first file' do
     files = fixture_templates(['fail_error.erb', 'fail_warning.erb'])
     res = subject.check(files)
 
-    expect(res.size).to eq(2)
-    expect(res[0]).to match(/2: syntax error, unexpected/)
-    expect(res[1]).to match(/2: warning: found = in conditional/)
+    expect(res[:warnings].size).to eq(1)
+    expect(res[:errors].size).to eq(1)
+    expect(res[:errors][0]).to match(/2: syntax error, unexpected/)
+    expect(res[:warnings][0]).to match(conditional_warning_regex)
   end
 
   it 'should ignore a TypeError' do
     files = fixture_templates('typeerror_shouldwin.erb')
     res = subject.check(files)
 
-    expect(res).to match([])
+    expect(res[:warnings]).to match([])
+    expect(res[:errors]).to match([])
   end
 
   it 'should ignore files without .erb extension' do
     files = fixture_templates('ignore.tpl')
     res = subject.check(files)
 
-    expect(res).to match([])
-  end
-
-  if Puppet.version.to_f < 3.7
-    context 'on Puppet < 3.7' do
-      it 'should throw an exception when parsing EPP files' do
-        file = fixture_templates('pass.epp')
-        expect{ subject.check(file) }.to raise_error(/Cannot validate EPP without Puppet 4/)
-      end
-
-      context "when the 'epp_only' options is set" do
-        before(:each) {
-          PuppetSyntax.epp_only = true
-        }
-
-        it 'should throw an exception for any file' do
-          file = fixture_templates('pass.erb')
-          expect{ subject.check(file) }.to raise_error(/Cannot validate EPP without Puppet 4/)
-        end
-      end
-    end
+    expect(res[:warnings]).to match([])
+    expect(res[:errors]).to match([])
   end
 
-  if Puppet.version.to_f >= 3.7
-    context 'on Puppet >= 3.7' do
-      it 'should return nothing from a valid file' do
-        files = fixture_templates('pass.epp')
-        res = subject.check(files)
+  it 'should return nothing from a valid file' do
+    files = fixture_templates('pass.epp')
+    res = subject.check(files)
 
-        expect(res).to match([])
-      end
+    expect(res[:warnings]).to match([])
+    expect(res[:errors]).to match([])
+  end
 
-      it 'should catch SyntaxError' do
-        files = fixture_templates('fail_error.epp')
-        res = subject.check(files)
+  it 'should catch SyntaxError' do
+    files = fixture_templates('fail_error.epp')
+    res = subject.check(files)
 
-        expect(res.size).to eq(1)
-        expect(res[0]).to match(/This Type-Name has no effect/)
-      end
+    expect(res[:errors].size).to eq(1)
+    expect(res[:errors][0]).to match(/This Type-Name has no effect/)
+  end
 
-      it 'should read more than one valid file' do
-        files = fixture_templates(['pass.epp', 'pass_also.epp'])
-        res = subject.check(files)
+  it 'should read more than one valid file' do
+    files = fixture_templates(['pass.epp', 'pass_also.epp'])
+    res = subject.check(files)
 
-        expect(res).to match([])
-      end
+    expect(res[:warnings]).to match([])
+    expect(res[:errors]).to match([])
+  end
 
-      it 'should continue after finding an error in the first file' do
-        files = fixture_templates(['fail_error.epp', 'fail_error_also.epp'])
-        res = subject.check(files)
+  it 'should continue 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.size).to eq(2)
-        expect(res[0]).to match(/This Type-Name has no effect/)
-        expect(res[1]).to match(/Syntax error at '}' \(file: \S*\/fail_error_also.epp, line: 2, column: 4\)/)
-      end
+    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(:each) {
-          PuppetSyntax.epp_only = true
-        }
+  context "when the 'epp_only' options is set" do
+    before(:each) {
+      PuppetSyntax.epp_only = true
+    }
 
-        it 'should process an ERB as EPP and find an error' do
-          files = fixture_templates('pass.erb')
-          res = subject.check(files)
+    it 'should process an ERB as EPP and find an error' do
+      files = fixture_templates('pass.erb')
+      res = subject.check(files)
 
-          expect(res.size).to eq(1)
-        end
-      end
+      expect(res[:errors].size).to eq(1)
     end
   end
 end

data/spec/puppet-syntax_spec.rb

@@ -3,7 +3,6 @@ require 'spec_helper'
 describe PuppetSyntax do
   after do
     PuppetSyntax.exclude_paths = []
-    PuppetSyntax.app_management = false if Puppet.version.to_i < 5
   end
 
   it 'should default exclude_paths to include the pkg directory' do
@@ -20,20 +19,6 @@ describe PuppetSyntax do
     expect(PuppetSyntax.exclude_paths).to eq(["foo"])
   end
 
-  it 'should support future parser setting' do
-    PuppetSyntax.future_parser = true
-    expect(PuppetSyntax.future_parser).to eq(true)
-  end
-
-  it 'should support app_management setting setting' do
-    PuppetSyntax.app_management = true
-    expect(PuppetSyntax.app_management).to eq(true)
-  end
-
-  it 'should raise error when app_management is disabled on 5.x', :if => (Puppet.version.to_i >= 5) do
-    expect { PuppetSyntax.app_management = false }.to raise_error(/app_management cannot be disabled on Puppet 5 or higher/)
-  end
-
   it 'should support a fail_on_deprecation_notices setting' do
     PuppetSyntax.fail_on_deprecation_notices = false
     expect(PuppetSyntax.fail_on_deprecation_notices).to eq(false)
@@ -44,4 +29,12 @@ describe PuppetSyntax do
     expect(PuppetSyntax.epp_only).to eq(true)
   end
 
+  it 'should support setting paths for manifests, templates and hiera' do
+    PuppetSyntax.hieradata_paths = []
+    expect(PuppetSyntax.hieradata_paths).to eq([])
+    PuppetSyntax.manifests_paths = ["**/environments/production/**/*.pp"]
+    expect(PuppetSyntax.manifests_paths).to eq(["**/environments/production/**/*.pp"])
+    PuppetSyntax.templates_paths = []
+    expect(PuppetSyntax.templates_paths).to eq([])
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-syntax
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-07 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: puppet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +95,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- jenkins.sh
 - lib/puppet-syntax.rb
 - lib/puppet-syntax/hiera.rb
 - lib/puppet-syntax/manifests.rb
@@ -105,6 +118,7 @@ files:
 - 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
@@ -135,14 +149,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Syntax checks for Puppet manifests, templates, and Hiera YAML
@@ -163,6 +177,7 @@ test_files:
 - 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

data/jenkins.sh

@@ -1,10 +0,0 @@
-#!/usr/bin/env bash
-set -eu
-
-# Avoid Psych bug in Ruby 1.9.3p0 on Ubuntu 12.04
-export RBENV_VERSION="1.9.3"
-
-rm -f Gemfile.lock
-bundle install --path "${HOME}/bundles/${JOB_NAME}" --shebang ruby
-bundle exec rake
-bundle exec rake publish_gem