Skip to content

Commit 6d34960

Browse files
myiimyii
authored
Merge pull request #30 from myii/chore/standardise-structure
feat(semantic-release): complete for this formula
2 parents ae760f0 + d49d3b8 commit 6d34960

File tree

24 files changed

+806
-165
lines changed

24 files changed

+806
-165
lines changed

‎.gitignore‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
env/
12+
build/
13+
develop-eggs/
14+
dist/
15+
downloads/
16+
eggs/
17+
.eggs/
18+
lib/
19+
lib64/
20+
parts/
21+
sdist/
22+
var/
23+
wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
28+
# PyInstaller
29+
# Usually these files are written by a python script from a packager
30+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
31+
*.manifest
32+
*.spec
33+
34+
# Installer logs
35+
pip-log.txt
36+
pip-delete-this-directory.txt
37+
38+
# Unit test / coverage reports
39+
htmlcov/
40+
.tox/
41+
.coverage
42+
.coverage.*
43+
.cache
44+
nosetests.xml
45+
coverage.xml
46+
*.cover
47+
.hypothesis/
48+
.kitchen
49+
.kitchen.local.yml
50+
kitchen.local.yml
51+
junit-*.xml
52+
53+
# Translations
54+
*.mo
55+
*.pot
56+
57+
# Django stuff:
58+
*.log
59+
local_settings.py
60+
61+
# Flask stuff:
62+
instance/
63+
.webassets-cache
64+
65+
# Scrapy stuff:
66+
.scrapy
67+
68+
# Sphinx documentation
69+
docs/_build/
70+
71+
# PyBuilder
72+
target/
73+
74+
# Jupyter Notebook
75+
.ipynb_checkpoints
76+
77+
# pyenv
78+
.python-version
79+
80+
# celery beat schedule file
81+
celerybeat-schedule
82+
83+
# SageMath parsed files
84+
*.sage.py
85+
86+
# dotenv
87+
.env
88+
89+
# virtualenv
90+
.venv
91+
venv/
92+
ENV/
93+
94+
# Spyder project settings
95+
.spyderproject
96+
.spyproject
97+
98+
# Rope project settings
99+
.ropeproject
100+
101+
# mkdocs documentation
102+
/site
103+
104+
# mypy
105+
.mypy_cache/
106+
107+
# Bundler
108+
Gemfile.lock
109+
110+
# copied `.md` files used for conversion to `.rst` using `m2r`
111+
docs/*.md
112+
113+
# Vim
114+
*.sw?
115+
116+
## Collected when centralising formulas (check and sort)
117+
# `collectd-formula`
118+
.pytest_cache/
119+
/.idea/
120+
Dockerfile.*_*
121+
ignore/
122+
tmp/

‎.rubocop.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# -*- coding: utf-8 -*-
2+
# vim: ft=yaml
3+
---
4+
# General overrides used across formulas in the org
5+
Metrics/LineLength:
6+
# Increase from default of `80`
7+
# Based on https://github.com/PyCQA/flake8-bugbear#opinionated-warnings (`B950`)
8+
Max: 88
9+
10+
# Any offenses that should be fixed, e.g. collected via. `rubocop --auto-gen-config`

‎.salt-lint‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# -*- coding: utf-8 -*-
2+
# vim: ft=yaml
3+
---
4+
exclude_paths: []
5+
skip_list:
6+
# Using `salt-lint` for linting other files as well, such as Jinja macros/templates
7+
- 205 # Use ".sls" as a Salt State file extension
8+
# Skipping `207` and `208` because `210` is sufficient, at least for the time-being
9+
# I.e. Allows 3-digit unquoted codes to still be used, such as `644` and `755`
10+
- 207 # File modes should always be encapsulated in quotation marks
11+
- 208 # File modes should always contain a leading zero
12+
tags: []
13+
verbosity: 1

‎.travis.yml‎

Lines changed: 60 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,87 +1,90 @@
11
# -*- coding: utf-8 -*-
22
# vim: ft=yaml
33
---
4+
## Machine config
45
dist: bionic
5-
stages:
6-
- test
7-
- lint
8-
- name: release
9-
if: branch = master AND type != pull_request
10-
116
sudo: required
12-
cache: bundler
13-
language: ruby
14-
157
services:
168
- docker
179

18-
# Make sure the instances listed below match up with
19-
# the `platforms` defined in `kitchen.yml`
20-
# NOTE: Please try to select up to six instances that add some meaningful
21-
# testing of the formula's behaviour. If possible, try to refrain from
22-
# the classical "chosing all the instances because I want to test on
23-
# another/all distro/s" trap: it will just add time to the testing (see
24-
# the discussion on #121). As an example, the set chosen below covers
25-
# the most used distros families, systemd and non-systemd and the latest
26-
# three supported Saltstack versions with python2 and 3.
27-
# As for `kitchen.yml`, that should still contain all of the platforms,
28-
# to allow for comprehensive local testing
29-
# Ref: https://github.com/saltstack-formulas/template-formula/issues/118
30-
# Ref: https://github.com/saltstack-formulas/template-formula/issues/121
31-
env:
32-
matrix:
33-
- INSTANCE: debian-10-develop-py3
34-
# - INSTANCE: default-ubuntu-1804-develop-py3
35-
- INSTANCE: centos-7-develop-py3
36-
# INSTANCE: default-fedora-30-develop-py3
37-
# - INSTANCE: default-opensuse-leap-15-develop-py3
38-
# - INSTANCE: default-amazonlinux-2-develop-py2
39-
# - INSTANCE: default-arch-base-latest-develop-py2
40-
# - INSTANCE: default-debian-9-2019-2-py3
41-
- INSTANCE: ubuntu-1804-2019-2-py3
42-
- INSTANCE: centos-7-2019-2-py3
43-
# - INSTANCE: default-fedora-30-2019-2-py3
44-
- INSTANCE: opensuse-leap-15-2019-2-py3
45-
# INSTANCE: default-amazonlinux-2-2019-2-py2
46-
- INSTANCE: arch-base-latest-2019-2-py2
47-
# - INSTANCE: default-debian-9-2018-3-py2
48-
# - INSTANCE: default-ubuntu-1604-2018-3-py2
49-
# - INSTANCE: default-centos-7-2018-3-py2
50-
# INSTANCE: fedora-29-2018-3-py2
51-
# INSTANCE: default-opensuse-leap-15-2018-3-py2
52-
- INSTANCE: amazonlinux-2-2018-3-py2
53-
# - INSTANCE: default-arch-base-latest-2018-3-py2
54-
# - INSTANCE: default-debian-8-2017-7-py2
55-
# - INSTANCE: default-ubuntu-1604-2017-7-py2
56-
# INSTANCE: centos6-centos-6-2017-7-py2
57-
# - INSTANCE: default-fedora-29-2017-7-py2
58-
# - INSTANCE: default-opensuse-leap-15-2017-7-py2
59-
# - INSTANCE: default-amazonlinux-2-2017-7-py2
60-
# - INSTANCE: default-arch-base-latest-2017-7-py2
10+
## Language and cache config
11+
language: ruby
12+
cache: bundler
6113

14+
## Script to run for the test stage
6215
script:
63-
- bin/kitchen verify ${INSTANCE}
16+
- bin/kitchen verify "${INSTANCE}"
6417

18+
## Stages and jobs matrix
19+
stages:
20+
- test
21+
- name: release
22+
if: branch = master AND type != pull_request
6523
jobs:
6624
include:
67-
# Define the `lint` stage (runs `yamllint` and `commitlint`)
68-
- stage: lint
69-
language: node_js
25+
## Define the test stage that runs the linters (and testing matrix, if applicable)
26+
27+
# Run all of the linters in a single job
28+
- language: node_js
7029
node_js: lts/*
30+
env: Lint
31+
name: 'Lint: salt-lint, yamllint, rubocop & commitlint'
7132
before_install: skip
7233
script:
34+
# Install and run `salt-lint`
35+
- pip install --user salt-lint
36+
- git ls-files | grep '\.sls$\|\.jinja$\|\.j2$\|\.tmpl$'
37+
| xargs -I {} salt-lint {}
7338
# Install and run `yamllint`
7439
# Need at least `v1.17.0` for the `yaml-files` setting
7540
- pip install --user yamllint>=1.17.0
7641
- yamllint -s .
42+
# Install and run `rubocop`
43+
- gem install rubocop
44+
- rubocop -d
7745
# Install and run `commitlint`
7846
- npm install @commitlint/config-conventional -D
7947
- npm install @commitlint/travis-cli -D
8048
- commitlint-travis
81-
# Define the release stage that runs `semantic-release`
49+
50+
## Define the rest of the matrix based on Kitchen testing
51+
# Make sure the instances listed below match up with
52+
# the `platforms` defined in `kitchen.yml`
53+
- env: INSTANCE=default-debian-10-develop-py3
54+
# - env: INSTANCE=default-ubuntu-1804-develop-py3
55+
- env: INSTANCE=centarch-centos-7-develop-py3
56+
# - env: INSTANCE=default-fedora-30-develop-py3
57+
# - env: INSTANCE=default-opensuse-leap-15-develop-py3
58+
# - env: INSTANCE=default-amazonlinux-2-develop-py2
59+
# - env: INSTANCE=centarch-arch-base-latest-develop-py2
60+
# - env: INSTANCE=default-debian-9-2019-2-py3
61+
- env: INSTANCE=default-ubuntu-1804-2019-2-py3
62+
- env: INSTANCE=centarch-centos-7-2019-2-py3
63+
# - env: INSTANCE=default-fedora-30-2019-2-py3
64+
- env: INSTANCE=default-opensuse-leap-15-2019-2-py3
65+
# - env: INSTANCE=default-amazonlinux-2-2019-2-py2
66+
- env: INSTANCE=centarch-arch-base-latest-2019-2-py2
67+
# - env: INSTANCE=default-debian-9-2018-3-py2
68+
# - env: INSTANCE=default-ubuntu-1604-2018-3-py2
69+
# - env: INSTANCE=centarch-centos-7-2018-3-py2
70+
# - env: INSTANCE=default-fedora-29-2018-3-py2
71+
# - env: INSTANCE=default-opensuse-leap-15-2018-3-py2
72+
- env: INSTANCE=default-amazonlinux-2-2018-3-py2
73+
# - env: INSTANCE=centarch-arch-base-latest-2018-3-py2
74+
# - env: INSTANCE=default-debian-8-2017-7-py2
75+
# - env: INSTANCE=default-ubuntu-1604-2017-7-py2
76+
# - env: INSTANCE=centarch-centos-6-2017-7-py2
77+
# - env: INSTANCE=default-fedora-29-2017-7-py2
78+
# - env: INSTANCE=default-opensuse-leap-15-2017-7-py2
79+
# - env: INSTANCE=default-amazonlinux-2-2017-7-py2
80+
# - env: INSTANCE=centarch-arch-base-latest-2017-7-py2
81+
82+
## Define the release stage that runs `semantic-release`
8283
- stage: release
8384
language: node_js
8485
node_js: lts/*
86+
env: Release
87+
name: 'Run semantic-release inc. file updates to AUTHORS, CHANGELOG & FORMULA'
8588
before_install: skip
8689
script:
8790
# Update `AUTHORS.md`

‎.yamllint‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,24 @@ extends: default
77
# Files to ignore completely
88
# 1. All YAML files under directory `node_modules/`, introduced during the Travis run
99
# 2. Any SLS files under directory `test/`, which are actually state files
10+
# 3. Any YAML files under directory `.kitchen/`, introduced during local testing
1011
ignore: |
1112
node_modules/
1213
test/**/states/**/*.sls
14+
.kitchen/
1315
iscsi/oscodename.yaml
1416
1517
yaml-files:
1618
# Default settings
1719
- '*.yaml'
1820
- '*.yml'
21+
- .salt-lint
1922
- .yamllint
2023
# SaltStack Formulas additional settings
2124
- '*.example'
22-
- '*.arch'
2325
- test/**/*.sls
26+
# Formula-specific additional settings
27+
- '*.arch'
2428

2529
rules:
2630
empty-values:
@@ -30,3 +34,6 @@ rules:
3034
# Increase from default of `80`
3135
# Based on https://github.com/PyCQA/flake8-bugbear#opinionated-warnings (`B950`)
3236
max: 88
37+
octal-values:
38+
forbid-implicit-octal: true
39+
forbid-explicit-octal: true

‎Gemfile‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
source "https://rubygems.org"
1+
# frozen_string_literal: true
2+
3+
source 'https://rubygems.org'
24

35
gem 'kitchen-docker', '>= 2.9'
4-
gem 'kitchen-salt', '>= 0.6.0'
56
gem 'kitchen-inspec', '>= 1.1'
6-
7+
gem 'kitchen-salt', '>= 0.6.0'

‎bin/kitchen‎

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,25 @@
88
# this file is here to facilitate running it.
99
#
1010

11-
require "pathname"
12-
ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
13-
Pathname.new(__FILE__).realpath)
11+
require 'pathname'
12+
ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
13+
Pathname.new(__FILE__).realpath)
1414

15-
bundle_binstub = File.expand_path("../bundle", __FILE__)
15+
bundle_binstub = File.expand_path('bundle', __dir__)
1616

1717
if File.file?(bundle_binstub)
1818
if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
1919
load(bundle_binstub)
2020
else
21-
abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
22-
Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
21+
abort(
22+
'Your `bin/bundle` was not generated by Bundler, '\
23+
'so this binstub cannot run. Replace `bin/bundle` by running '\
24+
'`bundle binstubs bundler --force`, then run this command again.'
25+
)
2326
end
2427
end
2528

26-
require "rubygems"
27-
require "bundler/setup"
29+
require 'rubygems'
30+
require 'bundler/setup'
2831

29-
load Gem.bin_path("test-kitchen", "kitchen")
32+
load Gem.bin_path('test-kitchen', 'kitchen')

0 commit comments

Comments
 (0)