puppet-syntax 3.0.1 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db77920a61d0b8ea3ccbc521c7dad372f382fe897f7cabb6532acb7a154ae49a
-  data.tar.gz: c61d81fc4bb5eb0a655c951c849d0124e3123253ca2fa5de2ecabbe1b524f9e7
+  metadata.gz: 20ff73cbd97aa25a996855fb8e64011c49dad446d646c01739756cbf4070605a
+  data.tar.gz: e63849bf1b733a186913a5e35c045c324a8debeb82d57e5d3506c3a19fc4de14
 SHA512:
-  metadata.gz: d51df8b8a2975e90d44fa9fad4892609b331a95bd459e226af0a7d80589458e059e06149da6412aae6d32de0e0ab058a0517e552be3ab9edf07670c712c3bba7
-  data.tar.gz: 8aa88875e46d83c30eac88b28219f1daef4e905782c6997cb0fe8973c84bbbaec6d891d171ecd66930e1e6ab4a9e7154db63a87f4eef99317f000e7ffcf3667c
+  metadata.gz: d3439e59e3a4bcefec9fb7a5ea454cbea88837cabf2a9ca32baac945fc450f47cfaff97b1220e632fde143a15ad1bc6b8fa145acd431ed246b1db06330a2f72c
+  data.tar.gz: d8005bff08d6eeaf372febbe207de534a47b7ef5598a237ed63002d68304208910c430ffaf3b2a8cd88e249ee54c2e8b92c17c4e23959ecd17d68349873a5e9c

data/.github/workflows/release.yml

@@ -0,0 +1,32 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    if: github.repository_owner == 'voxpupuli'
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Ruby 3.1
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+        env:
+          BUNDLE_WITHOUT: release
+      - name: Build gem
+        run: gem build *.gemspec
+      - name: Publish gem to rubygems.org
+        run: gem push *.gem
+        env:
+          GEM_HOST_API_KEY: '${{ secrets.RUBYGEMS_AUTH_TOKEN }}'
+      - name: Setup GitHub packages access
+        run: |
+          mkdir -p ~/.gem
+          echo ":github: Bearer ${{ secrets.GITHUB_TOKEN }}" >> ~/.gem/credentials
+          chmod 0600 ~/.gem/credentials
+      - name: Publish gem to GitHub packages
+        run: gem push --key github --host https://rubygems.pkg.github.com/${{ github.repository_owner }} *.gem

data/.github/workflows/test.yml

@@ -0,0 +1,68 @@
+name: Test
+
+on:
+  pull_request: {}
+  push:
+    branches: master
+
+env:
+  BUNDLE_WITHOUT: development:release
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "3.1"
+          - "3.0"
+          - "2.7"
+          - "2.6"
+          - "2.5"
+          - "2.4"
+        puppet:
+          - "~> 7.0"
+          - "~> 6.5"
+          - "~> 5.5.10"
+          - "https://github.com/puppetlabs/puppet.git#main"
+        exclude:
+          - ruby: "2.6"
+            puppet: "~> 7.0"
+          - ruby: "2.5"
+            puppet: "~> 7.0"
+          - ruby: "2.4"
+            puppet: "~> 7.0"
+
+          - ruby: "3.1"
+            puppet: "~> 6.5"
+          - ruby: "3.0"
+            puppet: "~> 6.5"
+
+          - ruby: "3.1"
+            puppet: "~> 5.5.10"
+          - ruby: "3.0"
+            puppet: "~> 5.5.10"
+          - ruby: "2.7"
+            puppet: "~> 5.5.10"
+          - ruby: "2.6"
+            puppet: "~> 5.5.10"
+
+          - ruby: "2.6"
+            puppet: "https://github.com/puppetlabs/puppet.git#main"
+          - ruby: "2.5"
+            puppet: "https://github.com/puppetlabs/puppet.git#main"
+          - ruby: "2.4"
+            puppet: "https://github.com/puppetlabs/puppet.git#main"
+    name: "Ruby ${{ matrix.ruby }} - Puppet ${{ matrix.puppet }}"
+    env:
+      PUPPET_VERSION: ${{ matrix.puppet }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake

data/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 All notable changes to this project will be documented in this file.
 
+## [v3.2.0](https://github.com/voxpupuli/puppet-syntax/tree/v3.2.0) (2022-05-16)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-syntax/compare/v3.1.0...v3.2.0)
+
+**Implemented enhancements:**
+
+- Remove AppVeyor testing [\#94](https://github.com/voxpupuli/puppet-syntax/issues/94)
+- Convert from Travis CI to GitHub Actions [\#130](https://github.com/voxpupuli/puppet-syntax/pull/130) ([ekohl](https://github.com/ekohl))
+
+**Fixed bugs:**
+
+- Add missing `$` in github action [\#132](https://github.com/voxpupuli/puppet-syntax/pull/132) ([bastelfreak](https://github.com/bastelfreak))
+
+## [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)

data/Gemfile

@@ -5,7 +5,7 @@ source 'https://rubygems.org'
 # `git://somewhere.git#branch`. You can also use a file source location, which
 # is specified as `file://some/location/on/disk`.
 def location_for(place_or_version, fake_version = nil)
-  if place_or_version =~ /^(git[:@][^#]*)#(.*)/
+  if place_or_version =~ /^(https[:@][^#]*)#(.*)/
     [fake_version, { :git => $1, :branch => $2, :require => false }].compact
   elsif place_or_version =~ /^file:\/\/(.*)/
     ['>= 0', { :path => File.expand_path($1), :require => false }]
@@ -19,12 +19,12 @@ gemspec
 
 # Override gemspec for CI matrix builds.
 # But only if the environment variable is set
-gem 'puppet', *location_for(ENV['PUPPET_VERSION'] || '>= 5') if ENV['PUPPET_VERSION']
+gem 'puppet', *location_for(ENV['PUPPET_VERSION']) 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'
+  gem 'github_changelog_generator', require: false
 end

data/README.md

@@ -1,6 +1,9 @@
-[![Build Status](https://travis-ci.org/voxpupuli/puppet-syntax.svg?branch=master)](https://travis-ci.org/voxpupuli/puppet-syntax)
-[![Gem Version](https://img.shields.io/gem/v/puppet-syntax.svg)](https://rubygems.org/gems/puppet-syntax)
-[![Gem Downloads](https://img.shields.io/gem/dt/puppet-syntax.svg)](https://rubygems.org/gems/puppet-syntax)
+# puppet-syntax
+
+[![License](https://img.shields.io/github/license/voxpupuli/puppet-syntax.svg)](https://github.com/voxpupuli/puppet-syntax/blob/master/LICENSE.txt)
+[![Release](https://github.com/voxpupuli/puppet-syntax/actions/workflows/syntax.yml/badge.svg)](https://github.com/voxpupuli/puppet-syntax/actions/workflows/syntax.yml)
+[![RubyGem Version](https://img.shields.io/gem/v/puppet-syntax.svg)](https://rubygems.org/gems/puppet-syntax)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/puppet-syntax.svg)](https://rubygems.org/gems/puppet-syntax)
 
 # Puppet::Syntax
 
@@ -14,7 +17,7 @@ Puppet::Syntax is supported with:
 - 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).
+For the specific versions that we test against, see the [GitHub Actions workflow](.github/workflows/test.yml).
 
 ## Installation
 
@@ -159,3 +162,12 @@ parser enabled.
 3. Commit your changes (`git commit -am 'Add some feature'`).
 4. Push to the branch (`git push origin my-new-feature`).
 5. Create new Pull Request.
+
+## Making a new Release
+
+* Update version in `lib/puppet-syntax/version.rb`
+* Run the changelog rake task (bundle exec rake changelog)
+* Create a PR
+* Get it reviewed and merged
+* update the local repo, create a signed git tag, prefixed with a v, matching the new version (git tag -s v1.2.3)
+* GitHub action will publish to GitHub Packages and Rubygems

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

@@ -7,6 +7,7 @@ module PuppetSyntax
     def filelist(paths)
       excludes = PuppetSyntax.exclude_paths
       excludes.push('pkg/**/*')
+      excludes.push('vendor/**/*')
       files = FileList[paths]
       files.reject! { |f| File.directory?(f) }
       files.exclude(*excludes)
@@ -48,9 +49,16 @@ module PuppetSyntax
           $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,41 +9,72 @@ 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)
       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, '-')
+        template = File.read(filename)
+        erb = if RUBY_VERSION >= '2.6'
+                ERB.new(template, trim_mode: '-')
+              else
+                ERB.new(template, nil, '-')
+              end
         erb.filename = filename
         erb.result
       rescue NameError => error
@@ -53,10 +84,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 = '3.0.1'
+  VERSION = '3.2.1'
 end

data/puppet-syntax.gemspec

@@ -25,5 +25,4 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rb-readline"
-  spec.add_development_dependency "gem_publisher", "~> 1.3"
 end

data/spec/puppet-syntax/templates_spec.rb

@@ -18,91 +18,99 @@ 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(conditional_warning_regex)
+    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(conditional_warning_regex)
+    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([])
+    expect(res[:warnings]).to match([])
+    expect(res[:errors]).to match([])
   end
 
   it 'should return nothing from a valid file' do
     files = fixture_templates('pass.epp')
     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.epp')
     res = subject.check(files)
 
-    expect(res.size).to eq(1)
-    expect(res[0]).to match(/This Type-Name has no effect/)
+    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)
 
-    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.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\)/)
+    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
@@ -114,7 +122,7 @@ describe PuppetSyntax::Templates do
       files = fixture_templates('pass.erb')
       res = subject.check(files)
 
-      expect(res.size).to eq(1)
+      expect(res[:errors].size).to eq(1)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-syntax
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.2.1
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-27 00:00:00.000000000 Z
+date: 2022-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: gem_publisher
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
 description: Syntax checks for Puppet manifests and templates
 email:
 - voxpupuli@groups.io
@@ -87,8 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - HISTORY.md
@@ -156,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Syntax checks for Puppet manifests, templates, and Hiera YAML

data/.travis.yml

@@ -1,40 +0,0 @@
----
-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 release
-script: bundle exec rake
-rvm:
-  - 2.4.4
-  - 2.5.1
-  - 2.6.5
-env:
-  - PUPPET_VERSION="~> 5.5.10"
-  - PUPPET_VERSION="~> 6.1.0"
-  - PUPPET_VERSION="~> 6.2.0"
-  - PUPPET_VERSION="~> 6.5.0"
-  - PUPPET_VERSION=">= 0"
-  - PUPPET_VERSION="git://github.com/puppetlabs/puppet.git#master"
-matrix:
-  allow_failures:
-    - env: PUPPET_VERSION=">= 0"
-    - env: PUPPET_VERSION="git://github.com/puppetlabs/puppet.git#master"
-deploy:
-  provider: rubygems
-  api_key:
-    secure: "kwxryZZ/t9EkWuYxhz3G1v+U3ZK4WdsiN0UFHDjijnAGPxqe/n+oBcNA8hOiNhjZeTFo8bADEZkL7JtdKQo9RvgStipyaS5gDHB/C1c4LOBWv4Tga21NNCAuBcE2CDtAH3+TzrZV5vv2+SpOrhKZpzZoAoR6PR1MWVWMUie/rE0="
-  gem: puppet-syntax
-  on:
-    rvm: 2.5.1
-    condition: '"$PUPPET_VERSION" = "~> 5.5.10"'
-    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"