From 920615a0672437abec39cb40aa94219512cf2054 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Wed, 9 Oct 2019 04:12:05 +0100 Subject: [PATCH 1/4] fix(config.sls): fix `salt-lint` errors ```bash Examining bind/config.sls of type state [204] Lines should be no longer that 160 chars bind/config.sls:217 {%- do generate_reverse(zone_records, salt['pillar.get']('bind:available_zones:' + zone + ':generate_reverse:net'), salt['pillar.get']('bind:available_zones:' + zone + ':generate_reverse:for_zones'), salt['pillar.get']('bind:available_zones', {})) %} [206] Jinja variables should have spaces before and after: {{ var_name }} bind/config.sls:225 zones{{ dash_view }}-{{ zone }}{{ '.include' if serial_auto else ''}}: [206] Jinja variables should have spaces before and after: {{ var_name }} bind/config.sls:227 - name: {{ zones_directory }}/{{ file }}{{ '.include' if serial_auto else ''}} [206] Jinja variables should have spaces before and after: {{ var_name }} bind/config.sls:295 - unless: "grep {{ key_flags.zsk }} {{ key_directory }}/K{{zone}}.+{{ key_algorithm_field }}+*.key" [206] Jinja variables should have spaces before and after: {{ var_name }} bind/config.sls:304 - unless: "grep {{ key_flags.ksk }} {{ key_directory }}/K{{zone}}.+{{ key_algorithm_field }}+*.key" ``` --- bind/config.sls | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/bind/config.sls b/bind/config.sls index e351d0b..3e99f05 100644 --- a/bind/config.sls +++ b/bind/config.sls @@ -214,7 +214,12 @@ bind_rndc_client_config: {%- endif %} {%- set zone_records = salt['pillar.get']('bind:available_zones:' + zone + ':records', {}) %} {%- if salt['pillar.get']('bind:available_zones:' + zone + ':generate_reverse') %} -{%- do generate_reverse(zone_records, salt['pillar.get']('bind:available_zones:' + zone + ':generate_reverse:net'), salt['pillar.get']('bind:available_zones:' + zone + ':generate_reverse:for_zones'), salt['pillar.get']('bind:available_zones', {})) %} +{%- do generate_reverse( + zone_records, + salt['pillar.get']('bind:available_zones:' + zone + ':generate_reverse:net'), + salt['pillar.get']('bind:available_zones:' + zone + ':generate_reverse:for_zones'), + salt['pillar.get']('bind:available_zones', {}) + ) %} {%- endif %} {# If we define RRs in pillar, we use the internal template to generate the zone file otherwise, we fallback to the old behaviour and use the declared file @@ -222,9 +227,9 @@ bind_rndc_client_config: {%- set zone_source = 'salt://bind/files/zone.jinja' if zone_records != {} else 'salt://' ~ map.zones_source_dir ~ '/' ~ file %} {%- set serial_auto = salt['pillar.get']('bind:available_zones:' + zone + ':soa:serial', '') == 'auto' %} {% if file and zone_data['type'] == 'master' -%} -zones{{ dash_view }}-{{ zone }}{{ '.include' if serial_auto else ''}}: +zones{{ dash_view }}-{{ zone }}{{ '.include' if serial_auto else '' }}: file.managed: - - name: {{ zones_directory }}/{{ file }}{{ '.include' if serial_auto else ''}} + - name: {{ zones_directory }}/{{ file }}{{ '.include' if serial_auto else '' }} - source: {{ zone_source }} - template: jinja {% if zone_records != {} %} @@ -292,7 +297,7 @@ zsk-{{ zone }}: - cwd: {{ key_directory }} - name: dnssec-keygen -a {{ key_algorithm }} -b {{ key_size }} -n ZONE {{ zone }} - runas: {{ map.user }} - - unless: "grep {{ key_flags.zsk }} {{ key_directory }}/K{{zone}}.+{{ key_algorithm_field }}+*.key" + - unless: "grep {{ key_flags.zsk }} {{ key_directory }}/K{{ zone }}.+{{ key_algorithm_field }}+*.key" - require: - file: bind_key_directory @@ -301,7 +306,7 @@ ksk-{{ zone }}: - cwd: {{ key_directory }} - name: dnssec-keygen -f KSK -a {{ key_algorithm }} -b {{ key_size }} -n ZONE {{ zone }} - runas: {{ map.user }} - - unless: "grep {{ key_flags.ksk }} {{ key_directory }}/K{{zone}}.+{{ key_algorithm_field }}+*.key" + - unless: "grep {{ key_flags.ksk }} {{ key_directory }}/K{{ zone }}.+{{ key_algorithm_field }}+*.key" - require: - file: bind_key_directory {% endif %} From 67736a2fed8c94c7a5f8818038bfaff823d3b077 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Wed, 9 Oct 2019 04:12:50 +0100 Subject: [PATCH 2/4] fix(named.conf.local.jinja): fix `salt-lint` errors ```bash Examining bind/files/named.conf.local.jinja of type state [206] Jinja variables should have spaces before and after: {{ var_name }} bind/files/named.conf.local.jinja:49 allow-update { {{args['allow-update']}}; }; ``` --- bind/files/named.conf.local.jinja | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bind/files/named.conf.local.jinja b/bind/files/named.conf.local.jinja index cf5675c..1176c1f 100644 --- a/bind/files/named.conf.local.jinja +++ b/bind/files/named.conf.local.jinja @@ -46,7 +46,7 @@ zone "{{ key }}" { inline-signing yes; {%- endif %} {%- if args['allow-update'] is defined %} - allow-update { {{args['allow-update']}}; }; + allow-update { {{ args['allow-update'] }}; }; {%- endif %} {%- if args.update_policy is defined %} update-policy { From f220886584f5fc8daf2e66d142e7201519d5866c Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Wed, 9 Oct 2019 04:13:25 +0100 Subject: [PATCH 3/4] fix(named.conf.logging.jinja): fix `salt-lint` errors ```bash Examining bind/files/named.conf.logging.jinja of type state [206] Jinja variables should have spaces before and after: {{ var_name }} bind/files/named.conf.logging.jinja:6 channel {{channel}} { [201] Trailing whitespace bind/files/named.conf.logging.jinja:8 file "{{ map.log_dir }}/{{salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':file')}}" versions {{salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':versions', '3')}} size {{salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':size', '20m')}}; [204] Lines should be no longer that 160 chars bind/files/named.conf.logging.jinja:8 file "{{ map.log_dir }}/{{salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':file')}}" versions {{salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':versions', '3')}} size {{salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':size', '20m')}}; [206] Jinja variables should have spaces before and after: {{ var_name }} bind/files/named.conf.logging.jinja:8 file "{{ map.log_dir }}/{{salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':file')}}" versions {{salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':versions', '3')}} size {{salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':size', '20m')}}; [206] Jinja variables should have spaces before and after: {{ var_name }} bind/files/named.conf.logging.jinja:20 severity {{salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':severity')}}; [206] Jinja variables should have spaces before and after: {{ var_name }} bind/files/named.conf.logging.jinja:23 syslog {{salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':syslog')}}; [206] Jinja variables should have spaces before and after: {{ var_name }} bind/files/named.conf.logging.jinja:29 category {{category}} { {{ salt['pillar.get']('bind:config:use_extensive_logging:category:'+category, []) | join('; ') }}; }; ``` --- bind/files/named.conf.logging.jinja | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/bind/files/named.conf.logging.jinja b/bind/files/named.conf.logging.jinja index ebbb281..53b2856 100644 --- a/bind/files/named.conf.logging.jinja +++ b/bind/files/named.conf.logging.jinja @@ -3,9 +3,12 @@ logging { {% for channel in salt['pillar.get']('bind:config:use_extensive_logging:channel') %} - channel {{channel}} { + channel {{ channel }} { {%- if salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':file', False) %} - file "{{ map.log_dir }}/{{salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':file')}}" versions {{salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':versions', '3')}} size {{salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':size', '20m')}}; +{%- set channel_file = salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':file') %} +{%- set channel_versions = salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':versions', '3') %} +{%- set channel_size = salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':size', '20m') %} + file "{{ map.log_dir }}/{{ channel_file }}" versions {{ channel_versions }} size {{ channel_size }}; {%- endif %} {%- if salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':print-time') %} print-time yes; @@ -17,16 +20,16 @@ logging { print-severity yes; {%- endif %} {%- if salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':severity') %} - severity {{salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':severity')}}; + severity {{ salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':severity') }}; {%- endif %} {%- if salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':syslog') %} - syslog {{salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':syslog')}}; + syslog {{ salt['pillar.get']('bind:config:use_extensive_logging:channel:'+channel+':syslog') }}; {%- endif %} }; {% endfor %} {%- for category in salt['pillar.get']('bind:config:use_extensive_logging:category') %} - category {{category}} { {{ salt['pillar.get']('bind:config:use_extensive_logging:category:'+category, []) | join('; ') }}; }; + category {{ category }} { {{ salt['pillar.get']('bind:config:use_extensive_logging:category:'+category, []) | join('; ') }}; }; {%- endfor %} From 5883c0969ffcba9901e247f118ada861eec19b82 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Wed, 9 Oct 2019 04:15:41 +0100 Subject: [PATCH 4/4] ci: merge travis matrix, add `salt-lint` & `rubocop` to `lint` job * Semi-automated using https://github.com/myii/ssf-formula/pull/60 --- .rubocop.yml | 10 +++++ .salt-lint | 13 ++++++ .travis.yml | 117 +++++++++++++++++++++++++++++++-------------------- .yamllint | 1 + Gemfile | 7 +-- bin/kitchen | 21 +++++---- 6 files changed, 111 insertions(+), 58 deletions(-) create mode 100644 .rubocop.yml create mode 100644 .salt-lint diff --git a/.rubocop.yml b/.rubocop.yml new file mode 100644 index 0000000..bdae9aa --- /dev/null +++ b/.rubocop.yml @@ -0,0 +1,10 @@ +# -*- 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` diff --git a/.salt-lint b/.salt-lint new file mode 100644 index 0000000..a539954 --- /dev/null +++ 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 index 8884a9b..ee1a690 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,64 +1,43 @@ # -*- 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` -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: default-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: + allow_failures: + - env: Lint_rubocop + fast_finish: true 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 (except `rubocop`) + - language: node_js node_js: lts/* + env: Lint + name: 'Lint: salt-lint, yamllint & 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 @@ -67,10 +46,56 @@ jobs: - npm install @commitlint/config-conventional -D - npm install @commitlint/travis-cli -D - commitlint-travis - # Define the release stage that runs `semantic-release` + # Run the `rubocop` linter in a separate job that is allowed to fail + # Once these lint errors are fixed, this can be merged into a single job + - language: node_js + node_js: lts/* + env: Lint_rubocop + name: 'Lint: rubocop' + before_install: skip + script: + # Install and run `rubocop` + - gem install rubocop + - rubocop -d + + ## 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` + - 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=default-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 index 1eae656..faedcd1 100644 --- 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 index 3b36de3..5a232b6 100644 --- 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 index 1cd44f3..dcfdb4c 100755 --- 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')