Merge pull request #58 from puppetlabs/maint-add_acceptance_tests

Maint add acceptance tests

Author: LukasAud

.fixtures.yml

@@ -0,0 +1,6 @@
+fixtures:
+  repositories:
+    facts: 'https://github.com/puppetlabs/puppetlabs-facts.git'
+    provision: 'https://github.com/puppetlabs/provision.git'
+    puppet_agent: 'https://github.com/puppetlabs/puppetlabs-puppet_agent.git'
+  symlinks: []

.github/workflows/ci.yml

@@ -14,7 +14,5 @@ on:
 jobs:
   ci:
     uses: "puppetlabs/cat-github-actions/.github/workflows/gem_ci.yml@main"
-    with:
-      with_acceptance: false
     secrets: "inherit"
 

.gitignore

@@ -11,3 +11,4 @@ coverage/
 /*.pp
 /tmp/
 .vendor/
+spec/fixtures/

Gemfile

@@ -15,10 +15,18 @@ group :test do
   gem 'simplecov', :require => false if ENV['COVERAGE'] == 'yes'
 end
 
+group :acceptance do
+  gem 'serverspec'
+  gem 'puppetlabs_spec_helper'
+  gem 'puppet_litmus'
+end
+
 group :development do
     gem 'github_changelog_generator', require: false
     gem 'faraday-retry', require: false
     gem 'pry', require: false
+    gem 'pry-byebug', require: false
+    gem 'pry-stack_explorer', require: false
 end
 
 group :rubocop do

Rakefile

@@ -20,6 +20,18 @@ else
   end
 end
 
-RSpec::Core::RakeTask.new(:spec)
+begin
+  require 'puppet_litmus/rake_tasks'
+rescue LoadError
+  # Gem not present
+end
+
+require 'puppetlabs_spec_helper/tasks/fixtures'
+
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.exclude_pattern = 'spec/acceptance/**/*_spec.rb'
+end
+
 task :default => :test
 

spec/acceptance/puppet_lint_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'spec_helper_acceptance'
+
+describe 'When executing puppet-lint' do
+  let(:manifest_root) { File.join(File.dirname(__FILE__), '..', 'fixtures', 'test', 'manifests') }
+
+  context 'with no manifest provided' do
+    it 'returns an exit code of 1 with no arguments' do
+      result = puppet_lint
+      expect(result[:exit_code]).to eq(1)
+    end
+
+    it 'returns an exit code of 0 when given a single flag' do
+      result = puppet_lint(['--help'])
+      expect(result[:exit_code]).to eq(0)
+    end
+
+    it 'returns the correct version number with the --version flag' do
+      result = puppet_lint(['--version'])
+      expect(result[:stdout]).to match(PuppetLint::VERSION)
+    end
+  end
+
+  context 'with a manifest provided' do
+    it 'returns one error when there is one problem' do
+      result = puppet_lint([File.join(manifest_root, 'fail.pp')])
+      expect(result[:stdout]).to have_errors(1)
+    end
+
+    it 'returns zero errors when there is an ignore comment present' do
+      result = puppet_lint([File.join(manifest_root, 'ignore.pp')])
+      expect(result[:stdout]).to have_errors(0)
+    end
+
+    it 'returns one warning when there is one problem' do
+      result = puppet_lint([File.join(manifest_root, 'warning.pp')])
+      expect(result[:stdout]).to have_warnings(1)
+    end
+
+    it 'contains two warnings when there are two problems' do
+      result = puppet_lint([File.join(manifest_root, 'two_warnings.pp')])
+      expect(result[:stdout]).to have_warnings(2)
+    end
+  end
+end

spec/spec_helper.rb

@@ -134,7 +134,7 @@ def subject
   config.include(
     RSpec::LintExampleGroup,
     type: :lint,
-    file_path: Regexp.compile(['spec', 'puppet-lint', 'plugins'].join('[\\\/]')),
+    file_path: Regexp.compile(['spec', 'unit', 'puppet-lint', 'plugins'].join('[\\\/]')),
   )
 
   config.expect_with(:rspec) do |c|

spec/spec_helper_acceptance.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'puppet_litmus'
+require 'spec_helper_acceptance_local' if File.file?(File.join(File.dirname(__FILE__), 'spec_helper_acceptance_local.rb'))
+
+PuppetLitmus.configure!

spec/spec_helper_acceptance_local.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'Shellwords'
+require 'open3'
+require 'rspec/expectations'
+
+def puppet_lint(args = [])
+  raise "Parameter 'args' should an Array but it was of type #{args.class}." unless args.is_a?(Array) || args.empty?
+
+  bin_path = File.join(File.dirname(__FILE__), '..', 'bin', 'puppet-lint')
+
+  command = [bin_path]
+  command.concat(args) unless args.empty?
+
+  stdout, stderr, status = Open3.capture3(*command)
+
+  {
+    stdout: stdout.chomp,
+    stderr: stderr.chomp,
+    exit_code: status.exitstatus,
+  }
+end
+
+RSpec::Matchers.define :have_errors do |expected|
+  match do |actual|
+    actual.split("\n").count { |line| line.include?('ERROR') } == expected
+  end
+
+  diffable
+end
+
+RSpec::Matchers.define :have_warnings do |expected|
+  match do |actual|
+    actual.split("\n").count { |line| line.include?('WARNING') } == expected
+  end
+
+  diffable
+end

spec/puppet-lint/bin_spec.rb renamed to spec/unit/puppet-lint/bin_spec.rb

@@ -587,7 +587,7 @@ def initialize(args)
 
       context 'and command-line does not override "--only-checks"' do
         let(:args) do
-          File.join(File.dirname(__FILE__), '..', 'fixtures', 'test', 'manifests', 'two_warnings.pp')
+          File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'test', 'manifests', 'two_warnings.pp')
         end
 
         its(:exitstatus) { is_expected.to eq(0) }
@@ -600,7 +600,7 @@ def initialize(args)
         let(:args) do
           [
             '--only-checks=variable_is_lowercase',
-            File.join(File.dirname(__FILE__), '..', 'fixtures', 'test', 'manifests', 'two_warnings.pp'),
+            File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'test', 'manifests', 'two_warnings.pp'),
           ]
         end