Merge pull request #175 from myii/ci/merge-matrix-and-add-salt-lint-and-rubocop

myii · web-flow · commit 9436192606bb · 2019-10-08T22:51:27.000+01:00
ci: merge travis matrix, add `salt-lint` &amp; `rubocop` to `lint` job
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+# vim: ft=yaml
+---
+# General overrides used across formulas in the org
+Metrics/LineLength:
+  # Increase from default of `80`
+  # Based on https://github.com/PyCQA/flake8-bugbear#opinionated-warnings (`B950`)
+  Max: 88
+
+# Any offenses that should be fixed, e.g. collected via. `rubocop --auto-gen-config`
+Metrics/BlockLength:
+  Max: 36
diff --git a/.salt-lint b/.salt-lint
@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+# vim: ft=yaml
+---
+exclude_paths: []
+skip_list:
+  # Using `salt-lint` for linting other files as well, such as Jinja macros/templates
+  - 205  # Use ".sls" as a Salt State file extension
+  # Skipping `207` and `208` because `210` is sufficient, at least for the time-being
+  # I.e. Allows 3-digit unquoted codes to still be used, such as `644` and `755`
+  - 207  # File modes should always be encapsulated in quotation marks
+  - 208  # File modes should always contain a leading zero
+tags: []
+verbosity: 1
diff --git a/.travis.yml b/.travis.yml
@@ -1,87 +1,101 @@
 # -*- coding: utf-8 -*-
 # vim: ft=yaml
 ---
+## Machine config
 dist: bionic
-stages:
-  - test
-  - lint
-  - name: release
-    if: branch = master AND type != pull_request
-
 sudo: required
-cache: bundler
-language: ruby
-
 services:
   - docker
 
-# Make sure the instances listed below match up with
-# the `platforms` defined in `kitchen.yml`
-# NOTE: Please try to select up to six instances that add some meaningful
-#       testing of the formula's behaviour. If possible, try to refrain from
-#       the classical "chosing all the instances because I want to test on
-#       another/all distro/s" trap: it will just add time to the testing (see
-#       the discussion on #121).  As an example, the set chosen below covers
-#       the most used distros families, systemd and non-systemd and the latest
-#       three supported Saltstack versions with python2 and 3.
-#       As for `kitchen.yml`, that should still contain all of the platforms,
-#       to allow for comprehensive local testing
-#       Ref: https://github.com/saltstack-formulas/template-formula/issues/118
-#       Ref: https://github.com/saltstack-formulas/template-formula/issues/121
-env:
-  matrix:
-    - INSTANCE: default-debian-10-develop-py3
-    # - INSTANCE: default-ubuntu-1804-develop-py3
-    # - INSTANCE: default-centos-7-develop-py3
-    # - INSTANCE: default-fedora-30-develop-py3
-    # - INSTANCE: default-opensuse-leap-15-develop-py3
-    # - INSTANCE: default-amazonlinux-2-develop-py2
-    # - INSTANCE: default-arch-base-latest-develop-py2
-    # - INSTANCE: default-debian-9-2019-2-py3
-    - INSTANCE: default-ubuntu-1804-2019-2-py3
-    # - INSTANCE: default-centos-7-2019-2-py3
-    # - INSTANCE: default-fedora-30-2019-2-py3
-    # - INSTANCE: default-opensuse-leap-15-2019-2-py3
-    - INSTANCE: default-amazonlinux-2-2019-2-py2
-    - INSTANCE: default-arch-base-latest-2019-2-py2
-    # - INSTANCE: default-debian-9-2018-3-py2
-    # - INSTANCE: default-ubuntu-1604-2018-3-py2
-    # - INSTANCE: default-centos-7-2018-3-py2
-    - INSTANCE: default-fedora-29-2018-3-py2
-    - INSTANCE: default-opensuse-leap-15-2018-3-py2
-    # - INSTANCE: default-amazonlinux-2-2018-3-py2
-    # - INSTANCE: default-arch-base-latest-2018-3-py2
-    # - INSTANCE: default-debian-8-2017-7-py2
-    # - INSTANCE: default-ubuntu-1604-2017-7-py2
-    - INSTANCE: centos6-centos-6-2017-7-py2
-    # - INSTANCE: default-fedora-29-2017-7-py2
-    # - INSTANCE: default-opensuse-leap-15-2017-7-py2
-    # - INSTANCE: default-amazonlinux-2-2017-7-py2
-    # - INSTANCE: default-arch-base-latest-2017-7-py2
+## Language and cache config
+language: ruby
+cache: bundler
 
+## Script to run for the test stage
 script:
-  - bin/kitchen verify ${INSTANCE}
+  - bin/kitchen verify "${INSTANCE}"
 
+## Stages and jobs matrix
+stages:
+  - test
+  - name: release
+    if: branch = master AND type != pull_request
 jobs:
   include:
-    # Define the `lint` stage (runs `yamllint` and `commitlint`)
-    - stage: lint
-      language: node_js
+    ## Define the test stage that runs the linters (and testing matrix, if applicable)
+
+    # Run all of the linters in a single job
+    - language: node_js
       node_js: lts/*
+      env: Lint
+      name: 'Lint: salt-lint, yamllint, rubocop & commitlint'
       before_install: skip
       script:
+        # Install and run `salt-lint`
+        - pip install --user salt-lint
+        - git ls-files | grep '\.sls$\|\.jinja$\|\.j2$\|\.tmpl$'
+                       | xargs -I {} salt-lint {}
         # Install and run `yamllint`
         # Need at least `v1.17.0` for the `yaml-files` setting
         - pip install --user yamllint>=1.17.0
         - yamllint -s .
+        # Install and run `rubocop`
+        - gem install rubocop
+        - rubocop -d
         # Install and run `commitlint`
         - npm install @commitlint/config-conventional -D
         - npm install @commitlint/travis-cli -D
         - commitlint-travis
-    # Define the release stage that runs `semantic-release`
+
+    ## Define the rest of the matrix based on Kitchen testing
+    # Make sure the instances listed below match up with
+    # the `platforms` defined in `kitchen.yml`
+    # NOTE: Please try to select up to six instances that add some meaningful
+    #       testing of the formula's behaviour. If possible, try to refrain from
+    #       the classical "chosing all the instances because I want to test on
+    #       another/all distro/s" trap: it will just add time to the testing (see
+    #       the discussion on #121).  As an example, the set chosen below covers
+    #       the most used distros families, systemd and non-systemd and the latest
+    #       three supported Saltstack versions with python2 and 3.
+    #       As for `kitchen.yml`, that should still contain all of the platforms,
+    #       to allow for comprehensive local testing
+    #       Ref: https://github.com/saltstack-formulas/template-formula/issues/118
+    #       Ref: https://github.com/saltstack-formulas/template-formula/issues/121
+    - env: INSTANCE=default-debian-10-develop-py3
+    # - env: INSTANCE=default-ubuntu-1804-develop-py3
+    # - env: INSTANCE=default-centos-7-develop-py3
+    # - env: INSTANCE=default-fedora-30-develop-py3
+    # - env: INSTANCE=default-opensuse-leap-15-develop-py3
+    # - env: INSTANCE=default-amazonlinux-2-develop-py2
+    # - env: INSTANCE=default-arch-base-latest-develop-py2
+    # - env: INSTANCE=default-debian-9-2019-2-py3
+    - env: INSTANCE=default-ubuntu-1804-2019-2-py3
+    # - env: INSTANCE=default-centos-7-2019-2-py3
+    # - env: INSTANCE=default-fedora-30-2019-2-py3
+    # - env: INSTANCE=default-opensuse-leap-15-2019-2-py3
+    - env: INSTANCE=default-amazonlinux-2-2019-2-py2
+    - env: INSTANCE=default-arch-base-latest-2019-2-py2
+    # - env: INSTANCE=default-debian-9-2018-3-py2
+    # - env: INSTANCE=default-ubuntu-1604-2018-3-py2
+    # - env: INSTANCE=default-centos-7-2018-3-py2
+    - env: INSTANCE=default-fedora-29-2018-3-py2
+    - env: INSTANCE=default-opensuse-leap-15-2018-3-py2
+    # - env: INSTANCE=default-amazonlinux-2-2018-3-py2
+    # - env: INSTANCE=default-arch-base-latest-2018-3-py2
+    # - env: INSTANCE=default-debian-8-2017-7-py2
+    # - env: INSTANCE=default-ubuntu-1604-2017-7-py2
+    - env: INSTANCE=centos6-centos-6-2017-7-py2
+    # - env: INSTANCE=default-fedora-29-2017-7-py2
+    # - env: INSTANCE=default-opensuse-leap-15-2017-7-py2
+    # - env: INSTANCE=default-amazonlinux-2-2017-7-py2
+    # - env: INSTANCE=default-arch-base-latest-2017-7-py2
+
+    ## Define the release stage that runs `semantic-release`
     - stage: release
       language: node_js
       node_js: lts/*
+      env: Release
+      name: 'Run semantic-release inc. file updates to AUTHORS, CHANGELOG & FORMULA'
       before_install: skip
       script:
         # Update `AUTHORS.md`
diff --git a/.yamllint b/.yamllint
@@ -17,6 +17,7 @@ yaml-files:
   # Default settings
   - '*.yaml'
   - '*.yml'
+  - .salt-lint
   - .yamllint
   # SaltStack Formulas additional settings
   - '*.example'
diff --git a/Gemfile b/Gemfile
@@ -1,6 +1,7 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 gem 'kitchen-docker', '>= 2.9'
-gem 'kitchen-salt', '>= 0.6.0'
 gem 'kitchen-inspec', '>= 1.1'
-
+gem 'kitchen-salt', '>= 0.6.0'
diff --git a/bin/kitchen b/bin/kitchen
@@ -8,22 +8,25 @@
 # this file is here to facilitate running it.
 #
 
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
 
-bundle_binstub = File.expand_path("../bundle", __FILE__)
+bundle_binstub = File.expand_path('bundle', __dir__)
 
 if File.file?(bundle_binstub)
   if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
     load(bundle_binstub)
   else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+    abort(
+      'Your `bin/bundle` was not generated by Bundler, '\
+      'so this binstub cannot run.  Replace `bin/bundle` by running '\
+      '`bundle binstubs bundler --force`, then run this command again.'
+    )
   end
 end
 
-require "rubygems"
-require "bundler/setup"
+require 'rubygems'
+require 'bundler/setup'
 
-load Gem.bin_path("test-kitchen", "kitchen")
+load Gem.bin_path('test-kitchen', 'kitchen')
diff --git a/test/integration/default/controls/config_spec.rb b/test/integration/default/controls/config_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 control 'template configuration' do
   title 'should match desired lines'
 
@@ -6,15 +8,27 @@
     it { should be_owned_by 'root' }
     it { should be_grouped_into 'root' }
     its('mode') { should cmp '0644' }
-    its('content') { should include 'This is another example file from SaltStack template-formula.' }
+    its('content') do
+      should include(
+        'This is another example file from SaltStack template-formula.'
+      )
+    end
     its('content') { should include '"added_in_pillar": "pillar_value"' }
     its('content') { should include '"added_in_defaults": "defaults_value"' }
     its('content') { should include '"added_in_lookup": "lookup_value"' }
     its('content') { should include '"config": "/etc/template-formula.conf"' }
     its('content') { should include '"lookup": {"added_in_lookup": "lookup_value",' }
     its('content') { should include '"pkg": {"name": "' }
     its('content') { should include '"service": {"name": "' }
-    its('content') { should include '"tofs": {"files_switch": ["any/path/can/be/used/here", "id", "roles", "osfinger", "os", "os_family"], "source_files": {"template-config-file-file-managed": ["example.tmpl.jinja"], "template-subcomponent-config-file-file-managed": ["subcomponent-example.tmpl.jinja"]}' }
+    its('content') do
+      should include(
+        '"tofs": {"files_switch": ["any/path/can/be/used/here", "id", '\
+        '"roles", "osfinger", "os", "os_family"], "source_files": '\
+        '{"template-config-file-file-managed": ["example.tmpl.jinja"], '\
+        '"template-subcomponent-config-file-file-managed": '\
+        '["subcomponent-example.tmpl.jinja"]}'
+      )
+    end
     its('content') { should include '"arch": "amd64"' }
     its('content') { should include '"winner": "pillar"}' }
     its('content') { should include 'winner of the merge: pillar' }
diff --git a/test/integration/default/controls/packages_spec.rb b/test/integration/default/controls/packages_spec.rb
@@ -1,8 +1,8 @@
+# frozen_string_literal: true
+
 # Overide by OS
 package_name = 'bash'
-if os[:name] == 'centos' and os[:release].start_with?('6')
-  package_name = 'cronie'
-end
+package_name = 'cronie' if (os[:name] == 'centos') && os[:release].start_with?('6')
 
 control 'template package' do
   title 'should be installed'
diff --git a/test/integration/default/controls/services_spec.rb b/test/integration/default/controls/services_spec.rb
@@ -1,8 +1,8 @@
+# frozen_string_literal: true
+
 # Overide by OS
 service_name = 'systemd-udevd'
-if os[:name] == 'centos' and os[:release].start_with?('6')
-  service_name = 'crond'
-end
+service_name = 'crond' if (os[:name] == 'centos') && os[:release].start_with?('6')
 
 control 'template service' do
   impact 0.5
diff --git a/test/integration/default/controls/subcomponent_config_spec.rb b/test/integration/default/controls/subcomponent_config_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 control 'template subcomponent configuration' do
   title 'should match desired lines'
 
@@ -6,7 +8,18 @@
     it { should be_owned_by 'root' }
     it { should be_grouped_into 'root' }
     its('mode') { should cmp '0644' }
-    its('content') { should include '# File managed by Salt at <salt://template/subcomponent/config/files/default/subcomponent-example.tmpl.jinja>.' }
-    its('content') { should include 'This is another subcomponent example file from SaltStack template-formula.' }
+    its('content') do
+      should include(
+        '# File managed by Salt at '\
+        '<salt://template/subcomponent/config/files/default/'\
+        'subcomponent-example.tmpl.jinja>.'
+      )
+    end
+    its('content') do
+      should include(
+        'This is another subcomponent example file from SaltStack '\
+        'template-formula.'
+      )
+    end
   end
 end
