Enable PDK compliance (puppetlabs#389)

* Enable PDK compliance

* Add puppet 6 to travis build matrix

Author: florindragos

.gitattributes

@@ -0,0 +1,5 @@
+*.rb eol=lf
+*.erb eol=lf
+*.pp eol=lf
+*.sh eol=lf
+*.epp eol=lf

.gitignore

@@ -1,14 +1,24 @@
-spec/fixtures/manifests/
-spec/fixtures/modules/
-pkg
-.bundle/
-.vagrant
+.git/
+.*.sw[op]
+.metadata
 .yardoc
-doc
-.idea/
-*.swp
-.ruby-version
-log
-Gemfile.lock
-coverage/*
+.yardwarns
+*.iml
+/.bundle/
+/.idea/
+/.vagrant/
+/coverage/
+/bin/
+/doc/
+/Gemfile.local
+/Gemfile.lock
+/junit/
+/log/
+/pkg/
+/spec/fixtures/manifests/
+/spec/fixtures/modules/
+/tmp/
 /vendor/
+/convert_report.txt
+/update_report.txt
+.DS_Store

.pdkignore

@@ -0,0 +1,24 @@
+.git/
+.*.sw[op]
+.metadata
+.yardoc
+.yardwarns
+*.iml
+/.bundle/
+/.idea/
+/.vagrant/
+/coverage/
+/bin/
+/doc/
+/Gemfile.local
+/Gemfile.lock
+/junit/
+/log/
+/pkg/
+/spec/fixtures/manifests/
+/spec/fixtures/modules/
+/tmp/
+/vendor/
+/convert_report.txt
+/update_report.txt
+.DS_Store

.rspec

@@ -1 +1,2 @@
+--color
 --format documentation

.rubocop.yml

@@ -1,29 +1,38 @@
 ---
-require:
- - rubocop-rspec
- - rubocop-i18n
+require: rubocop-rspec
 AllCops:
-  TargetRubyVersion: '2.1'
+  DisplayCopNames: true
+  TargetRubyVersion: '2.3'
   Include:
   - "./**/*.rb"
   Exclude:
   - bin/*
   - ".vendor/**/*"
-  - Gemfile
-  - Rakefile
+  - "**/Gemfile"
+  - "**/Rakefile"
   - pkg/**/*
   - spec/fixtures/**/*
+  - spec/classes/**/*
+  - spec/acceptance/**/*
+  - spec/acceptance_swarm/**/*
+  - spec/defines/**/*
+  - spec/unit/**/*
   - vendor/**/*
+  - "**/Puppetfile"
+  - "**/Vagrantfile"
+  - "**/Guardfile"
 Metrics/LineLength:
   Description: People have wide screens, use them.
   Max: 200
-  Enabled: false
+GetText/DecorateString:
+  Description: We don't want to decorate test output.
+  Exclude:
+  - spec/*
 RSpec/BeforeAfterAll:
   Description: Beware of using after(:all) as it may cause state to leak between tests.
     A necessary evil in acceptance testing.
   Exclude:
   - spec/acceptance/**/*.rb
-  - spec/acceptance_swarm/**/*.rb
 RSpec/HookArgument:
   Description: Prefer explicit :each argument, matching existing module's style
   EnforcedStyle: each
@@ -40,26 +49,13 @@ Style/EmptyElse:
 Style/FormatString:
   Description: Following the main puppet project's style, prefer the % format format.
   EnforcedStyle: percent
-  Exclude:
-  - lib/puppet/provider/docker_volume/ruby.rb
-  - lib/puppet/provider/docker_network/ruby.rb
-  - lib/puppet/parser/functions/docker_secrets_flags.rb
-  - lib/puppet/parser/functions/docker_run_flags.rb
-  - lib/puppet/type/docker_network.rb
-  - lib/puppet/type/docker_volume.rb
 Style/FormatStringToken:
   Description: Following the main puppet project's style, prefer the simpler template
     tokens over annotated ones.
   EnforcedStyle: template
 Style/Lambda:
   Description: Prefer the keyword for easier discoverability.
   EnforcedStyle: literal
-  Enabled: true
-  Exclude:
-  - lib/puppet/provider/docker_volume/ruby.rb
-  - lib/puppet/parser/functions/docker_secrets_flags.rb
-  - lib/puppet/parser/functions/docker_run_flags.rb
-  - lib/puppet/provider/docker_network/ruby.rb
 Style/RegexpLiteral:
   Description: Community preference. See https://github.com/voxpupuli/modulesync_config/issues/168
   EnforcedStyle: percent_r
@@ -79,18 +75,28 @@ Style/TrailingCommaInLiteral:
 Style/SymbolArray:
   Description: Using percent style obscures symbolic intent of array's contents.
   EnforcedStyle: brackets
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+Style/Documentation:
+  Exclude:
+  - lib/puppet/parser/functions/**/*
+  - spec/**/*
+Style/WordArray:
+  EnforcedStyle: brackets
 Style/CollectionMethods:
   Enabled: true
 Style/MethodCalledOnDoEndBlock:
   Enabled: true
 Style/StringMethods:
   Enabled: true
+Layout/EndOfLine:
+  Enabled: false
+Layout/IndentHeredoc:
+  Enabled: false
 Metrics/AbcSize:
   Enabled: false
 Metrics/BlockLength:
   Enabled: false
-Metrics/LineLength:
-  Enabled: false
 Metrics/ClassLength:
   Enabled: false
 Metrics/CyclomaticComplexity:
@@ -105,34 +111,21 @@ Metrics/PerceivedComplexity:
   Enabled: false
 RSpec/DescribeClass:
   Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
 RSpec/MessageExpectation:
   Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false
 Style/AsciiComments:
   Enabled: false
 Style/IfUnlessModifier:
   Enabled: false
 Style/SymbolProc:
   Enabled: false
-Style/HashSyntax:
-  UseHashRocketsWithSymbolValues: true
-Style/StringLiterals:
-  EnforcedStyle: single_quotes
-  SupportedStyles:
-    - single_quotes
-    - double_quotes
-  Exclude:
-  - lib/puppet/provider/docker_compose/ruby.rb
-GetText/DecorateString:
-  Enabled: true
-  Exclude:
-  - lib/puppet/type/docker_compose.rb
-GetText/DecorateFunctionMessage:
-  Enabled: true
+Style/SafeNavigation:
+  Description: Does not work with all ruby versions
   Exclude:
-  - lib/puppet/type/docker_network.rb
-  - lib/puppet/type/docker_volume.rb
-  - lib/puppet/provider/docker_compose/ruby.rb
-GetText/DecorateStringFormattingUsingInterpolation:
-  Enabled: true 
-GetText/DecorateStringFormattingUsingPercent:
-  Enabled: true 
+  - lib/puppet/parser/functions/docker_exec_flags.rb

.rubocop_todo.yml

@@ -0,0 +1,65 @@
+---
+.travis.yml:
+  bundler_args: ' '
+  branches:
+    - release
+  remove_includes:
+    -
+      env: PUPPET_GEM_VERSION="~> 4.0" CHECK=parallel_spec
+      rvm: 2.1.9
+  includes:
+    -
+      env: PUPPET_GEM_VERSION="~> 4.0" CHECK=parallel_spec
+      rvm: 2.3.3
+
+Gemfile:
+  required:
+    ':development':
+      - gem: 'facter'
+        version: '>= 1.7.0'
+      - gem: "rspec-retry"
+      - gem: 'thor'
+      - gem: 'semantic_puppet'
+      - gem: 'beaker-rspec'
+        from_env: BEAKER_RSPEC_VERSION  
+      - gem: "beaker"
+        version: '~> 2.0'
+        from_env: BEAKER_VERSION
+      - gem: 'puppet-module-posix-system-r#{minor_version}'
+        platforms: ruby
+      - gem: 'rspec'
+        version: '~> 2.0'
+        condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('1.8.7') && Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('1.9')"
+      - gem: 'rake'
+        version: '~> 10.0'
+        condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('1.8.7') && Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('1.9')"
+
+Rakefile:
+  requires:
+    - puppet-lint/tasks/puppet-lint
+    - puppetlabs_spec_helper/rake_tasks
+    - metadata-json-lint/rake_task
+    - rspec_junit_formatter
+    - puppet_pot_generator/rake_tasks
+
+.rubocop.yml:
+  include_todos:
+    inherit_from: '.rubocop_todo.yml'
+  profiles:
+    strict:
+      configs:
+        AllCops:
+          TargetRubyVersion: '2.2'
+          Exclude:
+            - spec/defines/*
+            - spec/classes/*
+            - spec/*
+            - spec/acceptance/*
+            - rakelib/*
+
+
+.gitlab-ci.yml:
+  delete: true
+
+appveyor.yml:
+  delete: true

.sync.yml

@@ -1,21 +1,50 @@
 ---
-language: ruby
-bundler_args: --without development system_tests
-before_install: rm Gemfile.lock || true
 sudo: false
-rvm:
-  - 2.2.5
-  - 2.3.3
+dist: trusty
+language: ruby
+cache: bundler
+before_install:
+  - bundle -v
+  - rm -f Gemfile.lock
+  - gem update --system
+  - gem --version
+  - bundle -v
 script:
-  - bundle exec rake test
-  - bundle exec rubocop lib
-  - bundle exec puppet-lint --no-autoloader_layout-check manifests
+  - 'bundle exec rake $CHECK'
+bundler_args: --without system_tests
+rvm:
+  - 2.5.1
 env:
-  - PUPPET_GEM_VERSION="~> 4.0"
-  - PUPPET_GEM_VERSION="~> 5.0"
-  - PUPPET_GEM_VERSION="~> 6.0"
+  global:
+    - BEAKER_PUPPET_COLLECTION=puppet6 PUPPET_GEM_VERSION="~> 6.0"
 matrix:
   fast_finish: true
-  exclude:
-  - rvm: 2.2.5
-    env: PUPPET_GEM_VERSION="~> 6.0"
+  include:
+    -
+      env: CHECK="syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop"
+    -
+      env: CHECK=parallel_spec
+    -
+      env: PUPPET_GEM_VERSION="~> 6.0" CHECK=parallel_spec
+      rvm: 2.4.4
+    -
+      env: PUPPET_GEM_VERSION="~> 5.0" CHECK=parallel_spec
+      rvm: 2.4.4
+    -
+      env: PUPPET_GEM_VERSION="~> 4.0" CHECK=parallel_spec
+      rvm: 2.1.9
+branches:
+  only:
+    - master
+    - /^v\d/
+notifications:
+  email: false
+deploy:
+  provider: puppetforge
+  user: puppet
+  password:
+    secure: ""
+  on:
+    tags: true
+    all_branches: true
+    condition: "$DEPLOY_TO_FORGE = yes"

.travis.yml

@@ -0,0 +1 @@
+--markup markdown