diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 1cc8c26..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '[BUG] ' -labels: 'bug' -assignees: '' - ---- - - - -## Your setup -### Formula commit hash / release tag - - - - -### Versions reports (master & minion) - - - - -### Pillar / config used - - - - ---- - -## Bug details -### Describe the bug - - - - -### Steps to reproduce the bug - - - - - - -### Expected behaviour - - - - -### Attempts to fix the bug - - - - -### Additional context - - - - ---- - -### Meta: How can this template be improved? - - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index be8be36..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '[FEATURE] ' -labels: 'enhancement' -assignees: '' - ---- - - - -### Is your feature request related to a problem? - - - - -### Describe the solution you'd like - - - - -### Describe alternatives you've considered - - - - -### Additional context - - - - ---- - -### Meta: How can this template be improved? - - - 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..26216b6 --- /dev/null +++ b/.salt-lint @@ -0,0 +1,17 @@ +# -*- coding: utf-8 -*- +# vim: ft=yaml +--- +exclude_paths: + # This is actually a Python file + - _pillar/known_hosts_salt_ssh.sls + # Violation: [204] Lines should be no longer that 160 chars + - test/salt/pillar/default.sls +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/AUTHORS.md b/AUTHORS.md index c8f2ed3..3f1a699 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -7,11 +7,11 @@ Avatar|Contributor|Contributions @alxwr|[@alxwr](https://github.com/alxwr)|37 @gravyboat|[@gravyboat](https://github.com/gravyboat)|28 @aboe76|[@aboe76](https://github.com/aboe76)|23 +@myii|[@myii](https://github.com/myii)|19 @nmadhok|[@nmadhok](https://github.com/nmadhok)|15 @whiteinge|[@whiteinge](https://github.com/whiteinge)|9 @rfairburn|[@rfairburn](https://github.com/rfairburn)|8 @amendlik|[@amendlik](https://github.com/amendlik)|8 -@myii|[@myii](https://github.com/myii)|8 @amontalban|[@amontalban](https://github.com/amontalban)|7 @kennydo|[@kennydo](https://github.com/kennydo)|7 @ek9|[@ek9](https://github.com/ek9)|7 @@ -67,7 +67,6 @@ Avatar|Contributor|Contributions @tibold|[@tibold](https://github.com/tibold)|1 @brandonparsons|[@brandonparsons](https://github.com/brandonparsons)|1 @elfixit|[@elfixit](https://github.com/elfixit)|1 -@jvblasco|[@jvblasco](https://github.com/jvblasco)|1 @ketzacoatl|[@ketzacoatl](https://github.com/ketzacoatl)|1 @omltorg|[@omltorg](https://github.com/omltorg)|1 @reschl|[@reschl](https://github.com/reschl)|1 @@ -76,4 +75,4 @@ Avatar|Contributor|Contributions --- -Auto-generated by a [forked version](https://github.com/myii/maintainer) of [gaocegege/maintainer](https://github.com/gaocegege/maintainer) on 2019-09-16. +Auto-generated by a [forked version](https://github.com/myii/maintainer) of [gaocegege/maintainer](https://github.com/gaocegege/maintainer) on 2019-10-09. diff --git a/CHANGELOG.md b/CHANGELOG.md index df0a796..88a232f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,22 @@ # Changelog +## [0.42.2](https://github.com/saltstack-formulas/openssh-formula/compare/v0.42.1...v0.42.2) (2019-10-09) + + +### Bug Fixes + +* **config.sls:** fix `salt-lint` errors ([](https://github.com/saltstack-formulas/openssh-formula/commit/7e35335)) +* **map.jinja:** fix `salt-lint` errors ([](https://github.com/saltstack-formulas/openssh-formula/commit/55560a6)) + + +### Continuous Integration + +* **kitchen:** change `log_level` to `debug` instead of `info` ([](https://github.com/saltstack-formulas/openssh-formula/commit/4ca3ca1)) +* **kitchen:** install required packages to bootstrapped `opensuse` [skip ci] ([](https://github.com/saltstack-formulas/openssh-formula/commit/1b236db)) +* **kitchen:** use bootstrapped `opensuse` images until `2019.2.2` [skip ci] ([](https://github.com/saltstack-formulas/openssh-formula/commit/32dd705)) +* **platform:** add `arch-base-latest` (commented out for now) [skip ci] ([](https://github.com/saltstack-formulas/openssh-formula/commit/4644018)) +* merge travis matrix, add `salt-lint` & `rubocop` to `lint` job ([](https://github.com/saltstack-formulas/openssh-formula/commit/72ade05)) + ## [0.42.1](https://github.com/saltstack-formulas/openssh-formula/compare/v0.42.0...v0.42.1) (2019-09-16) diff --git a/FORMULA b/FORMULA index 031ab3d..ad79011 100644 --- a/FORMULA +++ b/FORMULA @@ -1,7 +1,7 @@ name: openssh os: Debian, Ubuntu, Raspbian, RedHat, Fedora, CentOS, Suse, openSUSE, Gentoo, Funtoo, Arch, Manjaro, Alpine, FreeBSD, OpenBSD, Solaris, SmartOS, Windows, MacOS os_family: Debian, RedHat, Suse, Gentoo, Arch, Alpine, FreeBSD, OpenBSD, Solaris, Windows, MacOS -version: 0.42.1 +version: 0.42.2 release: 1 minimum_version: 2017.7 summary: openssh formula 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') diff --git a/docs/AUTHORS.rst b/docs/AUTHORS.rst index 2ed342d..70ac9b1 100644 --- a/docs/AUTHORS.rst +++ b/docs/AUTHORS.rst @@ -22,6 +22,9 @@ This list is sorted by the number of commits per contributor in *descending* ord * - :raw-html-m2r:`@aboe76` - `@aboe76 `_ - 23 + * - :raw-html-m2r:`@myii` + - `@myii `_ + - 19 * - :raw-html-m2r:`@nmadhok` - `@nmadhok `_ - 15 @@ -34,9 +37,6 @@ This list is sorted by the number of commits per contributor in *descending* ord * - :raw-html-m2r:`@amendlik` - `@amendlik `_ - 8 - * - :raw-html-m2r:`@myii` - - `@myii `_ - - 8 * - :raw-html-m2r:`@amontalban` - `@amontalban `_ - 7 @@ -202,9 +202,6 @@ This list is sorted by the number of commits per contributor in *descending* ord * - :raw-html-m2r:`@elfixit` - `@elfixit `_ - 1 - * - :raw-html-m2r:`@jvblasco` - - `@jvblasco `_ - - 1 * - :raw-html-m2r:`@ketzacoatl` - `@ketzacoatl `_ - 1 @@ -224,4 +221,4 @@ This list is sorted by the number of commits per contributor in *descending* ord ---- -Auto-generated by a `forked version `_ of `gaocegege/maintainer `_ on 2019-09-16. +Auto-generated by a `forked version `_ of `gaocegege/maintainer `_ on 2019-10-09. diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst index 385bee6..ba072a0 100644 --- a/docs/CHANGELOG.rst +++ b/docs/CHANGELOG.rst @@ -2,6 +2,26 @@ Changelog ========= +`0.42.2 `_ (2019-10-09) +------------------------------------------------------------------------------------------------------------ + +Bug Fixes +^^^^^^^^^ + + +* **config.sls:** fix ``salt-lint`` errors (\ ` `_\ ) +* **map.jinja:** fix ``salt-lint`` errors (\ ` `_\ ) + +Continuous Integration +^^^^^^^^^^^^^^^^^^^^^^ + + +* **kitchen:** change ``log_level`` to ``debug`` instead of ``info`` (\ ` `_\ ) +* **kitchen:** install required packages to bootstrapped ``opensuse`` [skip ci] (\ ` `_\ ) +* **kitchen:** use bootstrapped ``opensuse`` images until ``2019.2.2`` [skip ci] (\ ` `_\ ) +* **platform:** add ``arch-base-latest`` (commented out for now) [skip ci] (\ ` `_\ ) +* merge travis matrix, add ``salt-lint`` & ``rubocop`` to ``lint`` job (\ ` `_\ ) + `0.42.1 `_ (2019-09-16) ------------------------------------------------------------------------------------------------------------ diff --git a/openssh/config.sls b/openssh/config.sls index dde58a2..4ea7563 100644 --- a/openssh/config.sls +++ b/openssh/config.sls @@ -100,7 +100,7 @@ ssh_host_{{ keyType }}_key: # set permissions file.managed: - name: {{ keyFile }} - replace: false - - mode: 0600 + - mode: '0600' - require: - cmd: ssh_generate_host_{{ keyType }}_key {%- if sshd_config %} diff --git a/openssh/map.jinja b/openssh/map.jinja index a907f5e..8926e06 100644 --- a/openssh/map.jinja +++ b/openssh/map.jinja @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # vim: ft=jinja -{## Start imports as ##} +{#- Start imports as #} {% import_yaml 'openssh/defaults.yaml' as default_settings %} {% import_yaml 'openssh/osfamilymap.yaml' as osfamilymap %} {% import_yaml 'openssh/osmap.yaml' as osmap %} @@ -16,7 +16,7 @@ ) ) %} -{## merge the openssh pillar ##} +{#- merge the openssh pillar #} {% set openssh = salt['pillar.get']('openssh', default=defaults['openssh'], merge=True) %} {% set ssh_config = salt['pillar.get']('ssh_config', default=defaults['ssh_config'], merge=True) %} {% set sshd_config = salt['pillar.get']('sshd_config', default=defaults['sshd_config'], merge=True) %}