From 157e1693a45639a98083c0ca6543b81743b6374b Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Wed, 24 Apr 2019 13:14:45 +0100 Subject: [PATCH 01/12] ci(gemfile): prepare for `inspec` testing --- Gemfile | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Gemfile b/Gemfile index 4c95fc1..c13c0a2 100644 --- a/Gemfile +++ b/Gemfile @@ -1,5 +1,5 @@ source "https://rubygems.org" -gem "test-kitchen", "> 1.2.0" -gem "kitchen-vagrant" -gem "kitchen-salt" +gem 'kitchen-docker', '>= 2.9' +gem 'kitchen-salt', '>= 0.6.0' +gem 'kitchen-inspec', '>= 1.1' From 8f7cbdebc753487ae03de825a7d6d80a79ed3959 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Wed, 24 Apr 2019 13:17:52 +0100 Subject: [PATCH 02/12] refactor(kitchen): prefer `kitchen.yml` to `.kitchen.yml` * Quoting from https://kitchen.ci/docs/getting-started/kitchen-yml/: - As of test-kitchen 1.21.0, we now prefer `kitchen.yml` over `.kitchen.yml`. - This preference applies to `kitchen.local.yml` as well. - This is backward compatible so the dot versions continue to work. --- .kitchen.yml => kitchen.yml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .kitchen.yml => kitchen.yml (100%) diff --git a/.kitchen.yml b/kitchen.yml similarity index 100% rename from .kitchen.yml rename to kitchen.yml From 611ec11353fb85640c669d816f894aff99fcecb9 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Wed, 24 Apr 2019 13:23:25 +0100 Subject: [PATCH 03/12] ci(kitchen): use pre-salted images as used in `template-formula` --- kitchen.yml | 93 ++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 81 insertions(+), 12 deletions(-) diff --git a/kitchen.yml b/kitchen.yml index d9c06bf..170b9f2 100644 --- a/kitchen.yml +++ b/kitchen.yml @@ -1,26 +1,95 @@ +# -*- coding: utf-8 -*- +# vim: ft=yaml --- +# For help on this file's format, see https://kitchen.ci/ driver: - name: vagrant - network: - - ["private_network", { ip: "192.168.33.33" }] + name: docker + use_sudo: false + privileged: true + run_command: /lib/systemd/systemd + +# Make sure the platforms listed below match up with +# the `env.matrix` instances defined in `.travis.yml` +platforms: + ## SALT 2019.2 + - name: debian-9-2019-2-py3 + driver: + image: netmanagers/salt-2019.2-py3:debian-9 + - name: ubuntu-1804-2019-2-py3 + driver: + image: netmanagers/salt-2019.2-py3:ubuntu-1804 + - name: centos-7-2019-2-py2 + driver: + image: netmanagers/salt-2019.2-py2:centos-7 + - name: fedora-29-2019-2-py2 + driver: + image: netmanagers/salt-2019.2-py2:fedora-29 + + ## SALT 2018.3 + - name: opensuse-423-2018-3-py2 + driver: + image: netmanagers/salt-2018.3-py2:opensuse-423 + run_command: /usr/lib/systemd/systemd + - name: debian-8-2018-3-py2 + driver: + image: netmanagers/salt-2018.3-py2:debian-8 + - name: ubuntu-1604-2018-3-py2 + driver: + image: netmanagers/salt-2018.3-py2:ubuntu-1604 + - name: fedora-28-2018-3-py2 + driver: + image: netmanagers/salt-2018.3-py2:fedora-28 + + # centos-6 guest fails on Debian hosts due to vsyscall issues, see + # https://hub.docker.com/_/centos, "A note about vsyscall" + # Disabled for `template-formula` because not `systemd` based + # - name: centos-6-2018-3 + # driver: + # image: netmanagers/salt-2018.3-py2:centos-6 + # run_command: /sbin/init + + ##S SALT 2017.7 + - name: debian-8-2017-7-py2 + driver: + image: netmanagers/salt-2017.7-py2:debian-8 + - name: ubuntu-1604-2017-7-py2 + driver: + image: netmanagers/salt-2017.7-py2:ubuntu-1604 + # - name: centos-6-2017-7 + # driver: + # image: netmanagers/salt-2017.7-py2:centos-6 + # run_command: /sbin/init provisioner: name: salt_solo + log_level: info + salt_install: none + require_chef: false formula: postgres - pillars-from-files: - postgres.sls: pillar.example + salt_copy_filter: + - .kitchen + - .git + state_top: + base: + '*': + - postgres pillars: top.sls: base: - "*": + '*': - postgres - state_top: - base: - "*": - - postgres + pillars_from_files: + postgres.sls: pillar.example -platforms: - - name: ubuntu-14.04 +verifier: + # https://www.inspec.io/ + name: inspec + sudo: true + # cli, documentation, html, progress, json, json-min, json-rspec, junit + reporter: + - cli + inspec_tests: + - path: test/integration/default suites: - name: default From 6467df70a080cf8610632ba85e8731153990c350 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Wed, 24 Apr 2019 13:28:59 +0100 Subject: [PATCH 04/12] ci(travis): add `.travis.yml` based on `template-formula` --- .travis.yml | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 .travis.yml diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..6f6f1cd --- /dev/null +++ b/.travis.yml @@ -0,0 +1,67 @@ +stages: + - test + # - commitlint + # - name: release + # if: branch = master AND type != pull_request + +sudo: required +cache: bundler +language: ruby + +services: + - docker + +before_install: + - bundle install + +# Make sure the instances listed below match up with +# the `platforms` defined in `kitchen.yml` +env: + matrix: + - INSTANCE: default-debian-9-2019-2-py3 + - INSTANCE: default-ubuntu-1804-2019-2-py3 + - INSTANCE: default-centos-7-2019-2-py2 + - INSTANCE: default-fedora-29-2019-2-py2 + - INSTANCE: default-opensuse-423-2018-3-py2 + - INSTANCE: default-debian-8-2018-3-py2 + - INSTANCE: default-ubuntu-1604-2018-3-py2 + - INSTANCE: default-fedora-28-2018-3-py2 + - INSTANCE: default-debian-8-2017-7-py2 + - INSTANCE: default-ubuntu-1604-2017-7-py2 + +script: + - bundle exec kitchen verify ${INSTANCE} + +# jobs: +# include: +# # Define the commitlint stage +# - stage: commitlint +# language: node_js +# node_js: lts/* +# before_install: skip +# script: +# - npm install @commitlint/config-conventional -D +# - npm install @commitlint/travis-cli -D +# - commitlint-travis +# # Define the release stage that runs semantic-release +# - stage: release +# language: node_js +# node_js: lts/* +# before_install: skip +# script: +# # Update `AUTHORS.md` +# - export MAINTAINER_TOKEN=${GH_TOKEN} +# - go get github.com/myii/maintainer +# - maintainer contributor +# +# # Install all dependencies required for `semantic-release` +# - npm install @semantic-release/changelog@3 -D +# - npm install @semantic-release/exec@3 -D +# - npm install @semantic-release/git@7 -D +# deploy: +# provider: script +# skip_cleanup: true +# script: +# # Run `semantic-release` +# - npx semantic-release@15 + From c64d9e4ab90b8c6975f8ed75764fc9a89e45c5e7 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Wed, 24 Apr 2019 13:44:57 +0100 Subject: [PATCH 05/12] ci(pillar_from_files): use custom pillar based on `pillar.example` * `pillar.example` will be difficult to get working at this stage * Ideally, work back towards `pillar.example` in the long run --- kitchen.yml | 2 +- test/salt/pillar/postgres.sls | 197 ++++++++++++++++++++++++++++++++++ 2 files changed, 198 insertions(+), 1 deletion(-) create mode 100644 test/salt/pillar/postgres.sls diff --git a/kitchen.yml b/kitchen.yml index 170b9f2..b747d52 100644 --- a/kitchen.yml +++ b/kitchen.yml @@ -79,7 +79,7 @@ provisioner: '*': - postgres pillars_from_files: - postgres.sls: pillar.example + postgres.sls: test/salt/pillar/postgres.sls verifier: # https://www.inspec.io/ diff --git a/test/salt/pillar/postgres.sls b/test/salt/pillar/postgres.sls new file mode 100644 index 0000000..3883775 --- /dev/null +++ b/test/salt/pillar/postgres.sls @@ -0,0 +1,197 @@ +# Port to use for the cluster -- can be used to provide a non-standard port +# NOTE: If already set in the minion config, that value takes priority +postgres.port: '5432' + +postgres: + # UPSTREAM REPO + # Set True to configure upstream postgresql.org repository for YUM/APT/ZYPP + use_upstream_repo: False + # # Version to install from upstream repository (if upstream_repo: True) + # version: '10' + # # Set True to add a file in /etc/profile.d adding the bin dir in $PATH + # # as packages from upstream put them somewhere like /usr/pgsql-10/bin + # add_profile: False + # # If automatic package installation fails, use `fromrepo` to specify the + # # upstream repo to install packages from [#133, #185] (if upstream_repo: True) + # fromrepo: 'jessie-pgdg' + + # ### MACOS + # # Set to 'postgresapp' OR 'homebrew' for MacOS + # # use_upstream_repo: 'postgresapp' + # # use_upstream_repo: 'homebrew' + + # # PACKAGE + # # These pillars are typically never required. + # # pkg: 'postgresql' + # # pkg_client: 'postgresql-client' + # # service: postgresql + # pkgs_extra: + # - postgresql-contrib + # - postgresql-plpython + + # # CLUSTER + # # The default `encoding` is derived from the `locale` so not recommended + # # to provide a value for it unless necessary + # cluster: + # locale: en_GB.UTF-8 + # # encoding: UTF8 + # + # #'Alternatives system' priority incremental. 0 disables feature. + # linux: + # altpriority: 30 + # + # # macos limits + # limits: + # soft: 64000 + # hard: 128000 + + # POSTGRES + # Append the lines under this item to your postgresql.conf file. + # Pay attention to indent exactly with 4 spaces for all lines. + postgresconf: |- + listen_addresses = '*' # listen on all interfaces + + # Path to the `pg_hba.conf` file Jinja template on Salt Fileserver + pg_hba.conf: salt://postgres/templates/pg_hba.conf.j2 + + # This section covers ACL management in the ``pg_hba.conf`` file. + # acls list controls: which hosts are allowed to connect, how clients + # are authenticated, which PostgreSQL user names they can use, which + # databases they can access. Records take one of these forms: + # + # acls: + # - ['local', 'DATABASE', 'USER', 'METHOD'] + # - ['host', 'DATABASE', 'USER', 'ADDRESS', 'METHOD'] + # - ['hostssl', 'DATABASE', 'USER', 'ADDRESS', 'METHOD'] + # - ['hostnossl', 'DATABASE', 'USER', 'ADDRESS', 'METHOD'] + # + # The uppercase items must be replaced by actual values. + # METHOD could be omitted, 'md5' will be appended by default. + # + # If ``acls`` item value is empty ('', [], null), then the contents of + # ``pg_hba.conf`` file will not be touched at all. + acls: + - ['local', 'db0', 'connuser', 'peer map=users_as_appuser'] + - ['local', 'db1', 'localUser'] + - ['host', 'db2', 'remoteUser', '192.168.33.0/24'] + + identity_map: + - ['users_as_appuser', 'jdoe', 'connuser'] + - ['users_as_appuser', 'jsmith', 'connuser'] + + # Backup extension for configuration files, defaults to ``.bak``. + # Set ``False`` to stop creation of backups when config files change. + {%- if salt['status.time']|default(none) is callable %} + config_backup: ".backup@{{ salt['status.time']('%y-%m-%d_%H:%M:%S') }}" + {%- endif %} + + {# {%- if grains['init'] == 'unknown' %} #} + {# #} + {# # If Salt is unable to detect init system running in the scope of state run, #} + {# # probably we are trying to bake a container/VM image with PostgreSQL. #} + {# # Use ``bake_image`` setting to control how PostgreSQL will be started: if set #} + {# # to ``True`` the raw ``pg_ctl`` will be utilized instead of packaged init #} + {# # script, job or unit run with Salt ``service`` state. #} + {# bake_image: True #} + {# #} + {# {%- endif %} #} + + # Create/remove users, tablespaces, databases, schema and extensions. + # Each of these dictionaries contains PostgreSQL entities which + # mapped to the ``postgres_*`` Salt states with arguments. See the Salt + # documentation to get all supported argument for a particular state. + # + # Format is the following: + # + #: + # NAME: + # ensure: # 'present' is the default + # ARGUMENT: VALUE + # ... + # + # where 'NAME' is the state name, 'ARGUMENT' is the kwarg name, and + # 'VALUE' is kwarg value. + # + # For example, the Pillar: + # + # users: + # testUser: + # password: test + # + # will render such state: + # + # postgres_user-testUser: + # postgres_user.present: + # - name: testUser + # - password: test + users: + localUser: + ensure: present + password: '98ruj923h4rf' + createdb: False + createroles: False + inherit: True + replication: False + + remoteUser: + ensure: present + password: '98ruj923h4rf' + createdb: False + createroles: False + inherit: True + replication: False + + absentUser: + ensure: absent + + # tablespaces to be created + tablespaces: + my_space: + directory: /srv/my_tablespace + owner: localUser + + # databases to be created + databases: + db1: + owner: 'localUser' + # template: 'template0' + # lc_ctype: 'en_US.UTF-8' + # lc_collate: 'en_US.UTF-8' + db2: + owner: 'remoteUser' + # template: 'template0' + # lc_ctype: 'en_US.UTF-8' + # lc_collate: 'en_US.UTF-8' + tablespace: 'my_space' + # set custom schema + schemas: + public: + owner: 'localUser' + # enable per-db extension + {%- if grains.os_family == 'Debian' and grains.osfinger != 'Debian-8' %} + extensions: + uuid-ossp: + schema: 'public' + {%- endif %} + + # optional schemas to enable on database + schemas: + uuid-ossp: + dbname: db1 + owner: localUser + + # optional extensions to install in schema + {%- if grains.os_family == 'Debian' and grains.osfinger != 'Debian-8' %} + extensions: + uuid-ossp: + schema: uuid-ossp + maintenance_db: db1 + # postgis: {} + {%- endif %} + + # remove: + # data: True + # multiple_releases: True + # releases: ['9.6', '10',] + +# vim: ft=yaml ts=2 sts=2 sw=2 et From 58ac122d5059bb2ec3532ed47f0c6ed73562f367 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Thu, 25 Apr 2019 03:01:31 +0100 Subject: [PATCH 06/12] test(inspec): replace `serverspec` with `inspec` tests --- .../default/controls/command_spec.rb | 7 ++++++ .../default/controls/config_spec.rb | 10 ++++++++ .../default/controls/services_spec.rb | 13 +++++++++++ test/integration/default/inspec.yml | 11 +++++++++ .../default/serverspec/postgres_spec.rb | 23 ------------------- 5 files changed, 41 insertions(+), 23 deletions(-) create mode 100644 test/integration/default/controls/command_spec.rb create mode 100644 test/integration/default/controls/config_spec.rb create mode 100644 test/integration/default/controls/services_spec.rb create mode 100644 test/integration/default/inspec.yml delete mode 100644 test/integration/default/serverspec/postgres_spec.rb diff --git a/test/integration/default/controls/command_spec.rb b/test/integration/default/controls/command_spec.rb new file mode 100644 index 0000000..9b1b8cb --- /dev/null +++ b/test/integration/default/controls/command_spec.rb @@ -0,0 +1,7 @@ +control 'Postgres command' do + title 'should match desired lines' + + describe command(%q{su - postgres -c 'psql -qtc "\l+ db2"'}) do + its(:stdout) { should match(/db2.*remoteUser.*UTF8.*en_US\.UTF-8.*en_US\.UTF-8.*my_space/) } + end +end diff --git a/test/integration/default/controls/config_spec.rb b/test/integration/default/controls/config_spec.rb new file mode 100644 index 0000000..dc61924 --- /dev/null +++ b/test/integration/default/controls/config_spec.rb @@ -0,0 +1,10 @@ +control 'Postgres configuration' do + title 'should include the directory' + + describe file('/srv/my_tablespace') do + it { should be_directory } + it { should be_owned_by 'postgres' } + it { should be_grouped_into 'postgres' } + its('mode') { should cmp '0700' } + end +end diff --git a/test/integration/default/controls/services_spec.rb b/test/integration/default/controls/services_spec.rb new file mode 100644 index 0000000..f0e9dd5 --- /dev/null +++ b/test/integration/default/controls/services_spec.rb @@ -0,0 +1,13 @@ +control 'Postgres service' do + impact 0.5 + title 'should be running and enabled' + + describe service('postgresql') do + it { should be_enabled } + it { should be_running } + end + + describe port(5432) do + it { should be_listening } + end +end diff --git a/test/integration/default/inspec.yml b/test/integration/default/inspec.yml new file mode 100644 index 0000000..4e5595b --- /dev/null +++ b/test/integration/default/inspec.yml @@ -0,0 +1,11 @@ +name: postgres +title: Postgres Formula +maintainer: Your Name +license: Apache-2.0 +summary: Verify that the postgres formula is setup and configured correctly +supports: + - os-name: debian + - os-name: ubuntu + - os-name: centos + - os-name: fedora + - os-name: opensuse diff --git a/test/integration/default/serverspec/postgres_spec.rb b/test/integration/default/serverspec/postgres_spec.rb deleted file mode 100644 index 768e62f..0000000 --- a/test/integration/default/serverspec/postgres_spec.rb +++ /dev/null @@ -1,23 +0,0 @@ -require 'serverspec' - -set :backend, :exec - -describe service('postgresql') do - it { should be_enabled } - it { should be_running } -end - -describe port('5432') do - it { should be_listening } -end - -describe file('/srv/my_tablespace') do - it { should be_directory } - it { should be_mode 700 } - it { should be_owned_by 'postgres' } - it { should be_grouped_into 'postgres' } -end - -describe command(%q{su - postgres -c 'psql -qtc "\l+ db2"'}) do - its(:stdout) { should match(/db2.*remoteUser.*UTF8.*en_US\.UTF-8.*en_US\.UTF-8.*my_space/) } -end From 3c53684109b8b5b3b8f7db95df0bbf3839cb2fce Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Thu, 25 Apr 2019 03:30:44 +0100 Subject: [PATCH 07/12] test(inspec): use relaxed command output match for the time being * Fix the formula and then revert this eventually --- test/integration/default/controls/command_spec.rb | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/test/integration/default/controls/command_spec.rb b/test/integration/default/controls/command_spec.rb index 9b1b8cb..347e84a 100644 --- a/test/integration/default/controls/command_spec.rb +++ b/test/integration/default/controls/command_spec.rb @@ -2,6 +2,7 @@ control 'Postgres command' do title 'should match desired lines' describe command(%q{su - postgres -c 'psql -qtc "\l+ db2"'}) do - its(:stdout) { should match(/db2.*remoteUser.*UTF8.*en_US\.UTF-8.*en_US\.UTF-8.*my_space/) } + its(:stdout) { should match(/.*db2.*my_space/) } + # its(:stdout) { should match(/db2.*remoteUser.*UTF8.*en_US\.UTF-8.*en_US\.UTF-8.*my_space/) } end end From 7b7aadc472dc881316cf1916ad72686cde530681 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Tue, 30 Apr 2019 12:52:59 +0100 Subject: [PATCH 08/12] ci(kitchen+travis): use newly available pre-salted images --- .travis.yml | 21 +++++++++++++------ kitchen.yml | 58 ++++++++++++++++++++++++++++++++++++++--------------- 2 files changed, 57 insertions(+), 22 deletions(-) diff --git a/.travis.yml b/.travis.yml index 6f6f1cd..b470e28 100644 --- a/.travis.yml +++ b/.travis.yml @@ -19,15 +19,24 @@ before_install: env: matrix: - INSTANCE: default-debian-9-2019-2-py3 - - INSTANCE: default-ubuntu-1804-2019-2-py3 - - INSTANCE: default-centos-7-2019-2-py2 - - INSTANCE: default-fedora-29-2019-2-py2 - - INSTANCE: default-opensuse-423-2018-3-py2 - - INSTANCE: default-debian-8-2018-3-py2 + # TODO: Re-enable this once the `systemd` service can be restarted reliably + # - INSTANCE: default-ubuntu-1804-2019-2-py3 + - INSTANCE: default-centos-7-2019-2-py3 + - INSTANCE: default-fedora-29-2019-2-py3 + - INSTANCE: default-opensuse-leap-15-2019-2-py3 + - INSTANCE: default-debian-9-2018-3-py2 - INSTANCE: default-ubuntu-1604-2018-3-py2 - - INSTANCE: default-fedora-28-2018-3-py2 + - INSTANCE: default-centos-7-2018-3-py2 + - INSTANCE: default-fedora-29-2018-3-py2 + # TODO: Use this when fixed instead of `opensuse-423` + # NOTE: Having to temporarily disable `opensuse-423` due to slow mirror + # - INSTANCE: default-opensuse-leap-15-2018-3-py2 + # - INSTANCE: default-opensuse-423-2018-3-py2 - INSTANCE: default-debian-8-2017-7-py2 - INSTANCE: default-ubuntu-1604-2017-7-py2 + # - INSTANCE: default-centos-7-2017-7-py2 + - INSTANCE: default-fedora-28-2017-7-py2 + - INSTANCE: default-opensuse-leap-42-2017-7-py2 script: - bundle exec kitchen verify ${INSTANCE} diff --git a/kitchen.yml b/kitchen.yml index b747d52..354b384 100644 --- a/kitchen.yml +++ b/kitchen.yml @@ -17,29 +17,42 @@ platforms: image: netmanagers/salt-2019.2-py3:debian-9 - name: ubuntu-1804-2019-2-py3 driver: - image: netmanagers/salt-2019.2-py3:ubuntu-1804 - - name: centos-7-2019-2-py2 + image: netmanagers/salt-2019.2-py3:ubuntu-18.04 + - name: centos-7-2019-2-py3 driver: - image: netmanagers/salt-2019.2-py2:centos-7 - - name: fedora-29-2019-2-py2 + image: netmanagers/salt-2019.2-py3:centos-7 + - name: fedora-29-2019-2-py3 driver: - image: netmanagers/salt-2019.2-py2:fedora-29 + image: netmanagers/salt-2019.2-py3:fedora-29 + - name: opensuse-leap-15-2019-2-py3 + driver: + image: netmanagers/salt-2019.2-py3:opensuse-leap-15 + run_command: /usr/lib/systemd/systemd ## SALT 2018.3 + - name: debian-9-2018-3-py2 + driver: + image: netmanagers/salt-2018.3-py2:debian-9 + - name: ubuntu-1604-2018-3-py2 + driver: + image: netmanagers/salt-2018.3-py2:ubuntu-16.04 + - name: centos-7-2018-3-py2 + driver: + image: netmanagers/salt-2018.3-py2:centos-7 + - name: fedora-29-2018-3-py2 + driver: + image: netmanagers/salt-2018.3-py2:fedora-29 + # TODO: Use this when fixed instead of `opensuse-423` + - name: opensuse-leap-15-2018-3-py2 + driver: + image: netmanagers/salt-2018.3-py2:opensuse-leap-15 + run_command: /usr/lib/systemd/systemd - name: opensuse-423-2018-3-py2 driver: image: netmanagers/salt-2018.3-py2:opensuse-423 + provision_command: + - zypper refresh && zypper install -y net-tools run_command: /usr/lib/systemd/systemd - - name: debian-8-2018-3-py2 - driver: - image: netmanagers/salt-2018.3-py2:debian-8 - - name: ubuntu-1604-2018-3-py2 - driver: - image: netmanagers/salt-2018.3-py2:ubuntu-1604 - - name: fedora-28-2018-3-py2 - driver: - image: netmanagers/salt-2018.3-py2:fedora-28 - # centos-6 guest fails on Debian hosts due to vsyscall issues, see # https://hub.docker.com/_/centos, "A note about vsyscall" # Disabled for `template-formula` because not `systemd` based @@ -54,7 +67,20 @@ platforms: image: netmanagers/salt-2017.7-py2:debian-8 - name: ubuntu-1604-2017-7-py2 driver: - image: netmanagers/salt-2017.7-py2:ubuntu-1604 + image: netmanagers/salt-2017.7-py2:ubuntu-16.04 + - name: centos-6-2017-7-py2 + driver: + image: netmanagers/salt-2017.7-py2:centos-6 + run_command: /sbin/init + - name: fedora-28-2017-7-py2 + driver: + image: netmanagers/salt-2017.7-py2:fedora-28 + - name: opensuse-leap-42-2017-7-py2 + driver: + image: netmanagers/salt-2017.7-py2:opensuse-leap-42 + provision_command: + - zypper refresh && zypper install -y python-pip + run_command: /usr/lib/systemd/systemd # - name: centos-6-2017-7 # driver: # image: netmanagers/salt-2017.7-py2:centos-6 From 4cfde8d6e955224eb88c6c0ca9ef222f77a52c96 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Tue, 30 Apr 2019 17:00:23 +0100 Subject: [PATCH 09/12] docs(readme): update `Testing` section for `inspec` --- README.rst | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 59eab25..d4c86a9 100644 --- a/README.rst +++ b/README.rst @@ -120,28 +120,32 @@ Remove development and python packages. Testing ======= -The ``postgres`` state was tested on MacOS (El Capitan 10.11.6), and ``remove`` states on Ubuntu, Centos, and Fedora. -Linux testing is done with the ``kitchen-salt``. +Linux testing is done with ``kitchen-salt``. ``kitchen converge`` -------------------- -Runs the ``postgres`` main state. +Creates the docker instance and runs the ``postgres`` main state, ready for testing. ``kitchen verify`` ------------------ -Runs ``serverspec`` tests on the actual instance. +Runs the ``inspec`` tests on the actual instance. + +``kitchen destroy`` +---------------- + +Removes the docker instance. ``kitchen test`` ---------------- -Builds and runs tests from scratch. +Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``. ``kitchen login`` ----------------- -Gives you ssh to the vagrant machine for manual testing. +Gives you SSH access to the instance for manual testing. .. vim: fenc=utf-8 spell spl=en cc=100 tw=99 fo=want sts=2 sw=2 et From 49fdd3333b9d8f9962c142cac835badd399b50b7 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Wed, 1 May 2019 14:53:03 +0100 Subject: [PATCH 10/12] test(inspec): enable `use_upstream_repo` for `debian` & `centos-6` * Add new `centos-6` image * Install `9.6` from upstream repo --- .travis.yml | 2 +- kitchen.yml | 13 +------------ test/integration/default/controls/services_spec.rb | 8 +++++++- test/salt/pillar/postgres.sls | 8 ++++++-- 4 files changed, 15 insertions(+), 16 deletions(-) diff --git a/.travis.yml b/.travis.yml index b470e28..b1e9b45 100644 --- a/.travis.yml +++ b/.travis.yml @@ -34,7 +34,7 @@ env: # - INSTANCE: default-opensuse-423-2018-3-py2 - INSTANCE: default-debian-8-2017-7-py2 - INSTANCE: default-ubuntu-1604-2017-7-py2 - # - INSTANCE: default-centos-7-2017-7-py2 + - INSTANCE: default-centos-6-2017-7-py2 - INSTANCE: default-fedora-28-2017-7-py2 - INSTANCE: default-opensuse-leap-42-2017-7-py2 diff --git a/kitchen.yml b/kitchen.yml index 354b384..4e9542e 100644 --- a/kitchen.yml +++ b/kitchen.yml @@ -53,15 +53,8 @@ platforms: provision_command: - zypper refresh && zypper install -y net-tools run_command: /usr/lib/systemd/systemd - # centos-6 guest fails on Debian hosts due to vsyscall issues, see - # https://hub.docker.com/_/centos, "A note about vsyscall" - # Disabled for `template-formula` because not `systemd` based - # - name: centos-6-2018-3 - # driver: - # image: netmanagers/salt-2018.3-py2:centos-6 - # run_command: /sbin/init - ##S SALT 2017.7 + ## SALT 2017.7 - name: debian-8-2017-7-py2 driver: image: netmanagers/salt-2017.7-py2:debian-8 @@ -81,10 +74,6 @@ platforms: provision_command: - zypper refresh && zypper install -y python-pip run_command: /usr/lib/systemd/systemd - # - name: centos-6-2017-7 - # driver: - # image: netmanagers/salt-2017.7-py2:centos-6 - # run_command: /sbin/init provisioner: name: salt_solo diff --git a/test/integration/default/controls/services_spec.rb b/test/integration/default/controls/services_spec.rb index f0e9dd5..3d9f0ae 100644 --- a/test/integration/default/controls/services_spec.rb +++ b/test/integration/default/controls/services_spec.rb @@ -1,8 +1,14 @@ +# Overide by OS +service_name = 'postgresql' +if os[:name] == 'centos' and os[:release].start_with?('6') + service_name = 'postgresql-9.6' +end + control 'Postgres service' do impact 0.5 title 'should be running and enabled' - describe service('postgresql') do + describe service(service_name) do it { should be_enabled } it { should be_running } end diff --git a/test/salt/pillar/postgres.sls b/test/salt/pillar/postgres.sls index 3883775..e803bf3 100644 --- a/test/salt/pillar/postgres.sls +++ b/test/salt/pillar/postgres.sls @@ -5,15 +5,19 @@ postgres.port: '5432' postgres: # UPSTREAM REPO # Set True to configure upstream postgresql.org repository for YUM/APT/ZYPP + {%- if not (grains.os_family == 'Debian' or grains.osfinger == 'CentOS-6') %} use_upstream_repo: False - # # Version to install from upstream repository (if upstream_repo: True) - # version: '10' + {%- else %} + use_upstream_repo: True + # Version to install from upstream repository (if upstream_repo: True) + version: '9.6' # # Set True to add a file in /etc/profile.d adding the bin dir in $PATH # # as packages from upstream put them somewhere like /usr/pgsql-10/bin # add_profile: False # # If automatic package installation fails, use `fromrepo` to specify the # # upstream repo to install packages from [#133, #185] (if upstream_repo: True) # fromrepo: 'jessie-pgdg' + {%- endif %} # ### MACOS # # Set to 'postgresapp' OR 'homebrew' for MacOS From bf6a653e0b143f01944779ad33587b55fa3cbef3 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Thu, 2 May 2019 01:29:47 +0100 Subject: [PATCH 11/12] test(inspec): add tests for multiple ports and postgres versions * Fix `opensuse-leap-15` (enable `suse` and workaround `service` bug) * Use port `5433` for `debian` and `opensuse-leap-15` * Use upstream repo version `10` for `debian` --- test/integration/default/controls/command_spec.rb | 9 ++++++++- test/integration/default/controls/services_spec.rb | 11 ++++++++++- test/integration/default/inspec.yml | 1 + test/salt/pillar/postgres.sls | 9 +++++++++ 4 files changed, 28 insertions(+), 2 deletions(-) diff --git a/test/integration/default/controls/command_spec.rb b/test/integration/default/controls/command_spec.rb index 347e84a..3ab7035 100644 --- a/test/integration/default/controls/command_spec.rb +++ b/test/integration/default/controls/command_spec.rb @@ -1,7 +1,14 @@ +# Overide by OS +pg_port = '5432' +if os[:family] == 'debian' or os[:name] == 'suse' + pg_port = '5433' +end + control 'Postgres command' do title 'should match desired lines' - describe command(%q{su - postgres -c 'psql -qtc "\l+ db2"'}) do + # Can't use `%Q` here due to the `\` + describe command(%q{su - postgres -c 'psql -p} + pg_port + %q{ -qtc "\l+ db2"'}) do its(:stdout) { should match(/.*db2.*my_space/) } # its(:stdout) { should match(/db2.*remoteUser.*UTF8.*en_US\.UTF-8.*en_US\.UTF-8.*my_space/) } end diff --git a/test/integration/default/controls/services_spec.rb b/test/integration/default/controls/services_spec.rb index 3d9f0ae..d70329d 100644 --- a/test/integration/default/controls/services_spec.rb +++ b/test/integration/default/controls/services_spec.rb @@ -1,9 +1,17 @@ # Overide by OS service_name = 'postgresql' +pg_port = 5432 if os[:name] == 'centos' and os[:release].start_with?('6') service_name = 'postgresql-9.6' +elsif os[:family] == 'debian' or os[:name] == 'suse' + pg_port = 5433 end +# Temporary `if` due to `opensuse-leap-15` bug re: `service` +if os[:name] == 'suse' + puts "[Skip `service`-based tests due to `opensuse-leap-15` detection bug (see https://github.com/inspec/train/issues/377)]" + puts "[Skip `service`-based tests due to `opensuse-leap-15` bug]" +else control 'Postgres service' do impact 0.5 title 'should be running and enabled' @@ -13,7 +21,8 @@ control 'Postgres service' do it { should be_running } end - describe port(5432) do + describe port(pg_port) do it { should be_listening } end end +end diff --git a/test/integration/default/inspec.yml b/test/integration/default/inspec.yml index 4e5595b..6fec42b 100644 --- a/test/integration/default/inspec.yml +++ b/test/integration/default/inspec.yml @@ -9,3 +9,4 @@ supports: - os-name: centos - os-name: fedora - os-name: opensuse + - os-name: suse diff --git a/test/salt/pillar/postgres.sls b/test/salt/pillar/postgres.sls index e803bf3..2c55bfb 100644 --- a/test/salt/pillar/postgres.sls +++ b/test/salt/pillar/postgres.sls @@ -1,6 +1,11 @@ # Port to use for the cluster -- can be used to provide a non-standard port # NOTE: If already set in the minion config, that value takes priority + +{%- if not (grains.os_family == 'Debian' or grains.osfinger == 'Leap-15') %} postgres.port: '5432' +{%- else %} +postgres.port: '5433' +{%- endif %} postgres: # UPSTREAM REPO @@ -10,7 +15,11 @@ postgres: {%- else %} use_upstream_repo: True # Version to install from upstream repository (if upstream_repo: True) + {%- if not (grains.os_family == 'Debian') %} version: '9.6' + {%- else %} + version: '10' + {%- endif %} # # Set True to add a file in /etc/profile.d adding the bin dir in $PATH # # as packages from upstream put them somewhere like /usr/pgsql-10/bin # add_profile: False From 7d3aa19b45f9b18bab7062687a871e8d37b57ec7 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Thu, 2 May 2019 17:01:03 +0100 Subject: [PATCH 12/12] feat: implement `semantic-release` --- .gitignore | 113 ++++++++- .travis.yml | 70 +++--- FORMULA | 9 + commitlint.config.js | 3 + docs/CONTRIBUTING.rst | 158 ++++++++++++ README.rst => docs/README.rst | 88 ++++--- docs/TOFS_pattern.rst | 443 +++++++++++++++++++++++++++++++++ postgres/libtofs.jinja | 100 ++++++++ pre-commit_semantic-release.sh | 30 +++ release-rules.js | 18 ++ release.config.js | 106 ++++++++ 11 files changed, 1072 insertions(+), 66 deletions(-) create mode 100644 FORMULA create mode 100644 commitlint.config.js create mode 100644 docs/CONTRIBUTING.rst rename README.rst => docs/README.rst (67%) create mode 100644 docs/TOFS_pattern.rst create mode 100644 postgres/libtofs.jinja create mode 100755 pre-commit_semantic-release.sh create mode 100644 release-rules.js create mode 100644 release.config.js diff --git a/.gitignore b/.gitignore index ab1b3b9..901d948 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,110 @@ -.kitchen/ -*.swp -*.swo +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a packager +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +.hypothesis/ +.kitchen +.kitchen.local.yml +kitchen.local.yml + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# SageMath parsed files +*.sage.py + +# dotenv +.env + +# virtualenv +.venv +venv/ +ENV/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ + +# copied `.md` files used for conversion to `.rst` using `m2r` +docs/*.md + +# Vim +*.sw[nop] \ No newline at end of file diff --git a/.travis.yml b/.travis.yml index b1e9b45..5b4d585 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,8 +1,8 @@ stages: - test - # - commitlint - # - name: release - # if: branch = master AND type != pull_request + - commitlint + - name: release + if: branch = master AND type != pull_request sudo: required cache: bundler @@ -41,36 +41,36 @@ env: script: - bundle exec kitchen verify ${INSTANCE} -# jobs: -# include: -# # Define the commitlint stage -# - stage: commitlint -# language: node_js -# node_js: lts/* -# before_install: skip -# script: -# - npm install @commitlint/config-conventional -D -# - npm install @commitlint/travis-cli -D -# - commitlint-travis -# # Define the release stage that runs semantic-release -# - stage: release -# language: node_js -# node_js: lts/* -# before_install: skip -# script: -# # Update `AUTHORS.md` -# - export MAINTAINER_TOKEN=${GH_TOKEN} -# - go get github.com/myii/maintainer -# - maintainer contributor -# -# # Install all dependencies required for `semantic-release` -# - npm install @semantic-release/changelog@3 -D -# - npm install @semantic-release/exec@3 -D -# - npm install @semantic-release/git@7 -D -# deploy: -# provider: script -# skip_cleanup: true -# script: -# # Run `semantic-release` -# - npx semantic-release@15 +jobs: + include: + # Define the commitlint stage + - stage: commitlint + language: node_js + node_js: lts/* + before_install: skip + script: + - npm install @commitlint/config-conventional -D + - npm install @commitlint/travis-cli -D + - commitlint-travis + # Define the release stage that runs semantic-release + - stage: release + language: node_js + node_js: lts/* + before_install: skip + script: + # Update `AUTHORS.md` + - export MAINTAINER_TOKEN=${GH_TOKEN} + - go get github.com/myii/maintainer + - maintainer contributor + + # Install all dependencies required for `semantic-release` + - npm install @semantic-release/changelog@3 -D + - npm install @semantic-release/exec@3 -D + - npm install @semantic-release/git@7 -D + deploy: + provider: script + skip_cleanup: true + script: + # Run `semantic-release` + - npx semantic-release@15 diff --git a/FORMULA b/FORMULA new file mode 100644 index 0000000..2200fad --- /dev/null +++ b/FORMULA @@ -0,0 +1,9 @@ +name: postgres +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.36.0 +release: 1 +minimum_version: 2016.11 +summary: Postgres formula +description: Formula to install and configure PostgreSQL +top_level_dir: postgres diff --git a/commitlint.config.js b/commitlint.config.js new file mode 100644 index 0000000..2f9d1aa --- /dev/null +++ b/commitlint.config.js @@ -0,0 +1,3 @@ +module.exports = { + extends: ['@commitlint/config-conventional'], +}; diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst new file mode 100644 index 0000000..5da9ae8 --- /dev/null +++ b/docs/CONTRIBUTING.rst @@ -0,0 +1,158 @@ +.. _contributing: + +How to contribute +================= + +This document will eventually outline all aspects of guidance to make your contributing experience a fruitful and enjoyable one. +What it already contains is information about *commit message formatting* and how that directly affects the numerous automated processes that are used for this repo. +It also covers how to contribute to this *formula's documentation*. + +.. contents:: **Table of Contents** + +Overview +-------- + +Submitting a pull request is more than just code! +To achieve a quality product, the *tests* and *documentation* need to be updated as well. +An excellent pull request will include these in the changes, wherever relevant. + +Commit message formatting +------------------------- + +Since every type of change requires making Git commits, +we will start by covering the importance of ensuring that all of your commit +messages are in the correct format. + +Automation of multiple processes +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This formula uses `semantic-release `_ for automating numerous processes such as bumping the version number appropriately, creating new tags/releases and updating the changelog. +The entire process relies on the structure of commit messages to determine the version bump, which is then used for the rest of the automation. + +Full details are available in the upstream docs regarding the `Angular Commit Message Conventions `_. +The key factor is that the first line of the commit message must follow this format: + +.. code-block:: + + type(scope): subject + + +* E.g. ``docs(contributing): add commit message formatting instructions``. + +Besides the version bump, the changelog and release notes are formatted accordingly. +So based on the example above: + +.. + + .. raw:: html + +

Documentation

+ + * **contributing:** add commit message formatting instructions + + +* The ``type`` translates into a ``Documentation`` sub-heading. +* The ``(scope):`` will be shown in bold text without the brackets. +* The ``subject`` follows the ``scope`` as standard text. + +Linting commit messages in Travis CI +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This formula uses `commitlint `_ for checking commit messages during CI testing. +This ensures that they are in accordance with the ``semantic-release`` settings. + +For more details about the default settings, refer back to the ``commitlint`` `reference rules `_. + +Relationship between commit type and version bump +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This formula applies some customisations to the defaults, as outlined in the table below, +based upon the `type `_ of the commit: + +.. list-table:: + :name: commit-type-vs-version-bump + :header-rows: 1 + :stub-columns: 0 + :widths: 1,2,3,1,1 + + * - Type + - Heading + - Description + - Bump (default) + - Bump (custom) + * - ``build`` + - Build System + - Changes related to the build system + - – + - + * - ``chore`` + - – + - Changes to the build process or auxiliary tools and libraries such as + documentation generation + - – + - + * - ``ci`` + - Continuous Integration + - Changes to the continuous integration configuration + - – + - + * - ``docs`` + - Documentation + - Documentation only changes + - – + - 0.0.1 + * - ``feat`` + - Features + - A new feature + - 0.1.0 + - + * - ``fix`` + - Bug Fixes + - A bug fix + - 0.0.1 + - + * - ``perf`` + - Performance Improvements + - A code change that improves performance + - 0.0.1 + - + * - ``refactor`` + - Code Refactoring + - A code change that neither fixes a bug nor adds a feature + - – + - 0.0.1 + * - ``revert`` + - Reverts + - A commit used to revert a previous commit + - – + - 0.0.1 + * - ``style`` + - Styles + - Changes that do not affect the meaning of the code (white-space, + formatting, missing semi-colons, etc.) + - – + - 0.0.1 + * - ``test`` + - Tests + - Adding missing or correcting existing tests + - – + - 0.0.1 + +Use ``BREAKING CHANGE`` to trigger a ``major`` version change +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Adding ``BREAKING CHANGE`` to the footer of the extended description of the commit message will **always** trigger a ``major`` version change, no matter which type has been used. +This will be appended to the changelog and release notes as well. +To preserve good formatting of these notes, the following format is prescribed: + +* ``BREAKING CHANGE: .`` + +An example of that: + +.. code-block:: git + + ... + + BREAKING CHANGE: With the removal of all of the `.sls` files under + `template package`, this formula no longer supports the installation of + packages. diff --git a/README.rst b/docs/README.rst similarity index 67% rename from README.rst rename to docs/README.rst index d4c86a9..11f2c0a 100644 --- a/README.rst +++ b/docs/README.rst @@ -1,42 +1,74 @@ -======== -postgres -======== +.. _readme: -.. note:: - - See the full `Salt Formulas installation and usage instructions - `_. - -Available states +postgres-formula ================ +|img_travis| |img_sr| + +.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/template-formula.svg?branch=master + :alt: Travis CI Build Status + :scale: 100% + :target: https://travis-ci.com/saltstack-formulas/template-formula +.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg + :alt: Semantic Release + :scale: 100% + :target: https://github.com/semantic-release/semantic-release + +A formula to install and configure PostgreSQL server. + +.. contents:: **Table of Contents** + +General notes +------------- + +See the full `SaltStack Formulas installation and usage instructions +`_. + +If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section +`_. + +If you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``, +which contains the currently released version. This formula is versioned according to `Semantic Versioning `_. + +See `Formula Versioning Section `_ for more details. + +Contributing to this repo +------------------------- + +**Commit message formatting is significant!!** + +Please see :ref:`How to contribute ` for more details. + +Available states +---------------- + .. contents:: - :local: + :local: ``postgres`` ------------- +^^^^^^^^^^^^ Installs and configures both PostgreSQL server and client with creation of various DB objects in the cluster. This state applies to both Linux and MacOS. ``postgres.client`` -------------------- +^^^^^^^^^^^^^^^^^^^ Installs the PostgreSQL client binaries and libraries on Linux. ``postgres.manage`` -------------------- +^^^^^^^^^^^^^^^^^^^ Creates such DB objects as: users, tablespaces, databases, schemas and extensions. See ``pillar.example`` file for details. ``postgres.python`` ----------------------- +^^^^^^^^^^^^^^^^^^^^^^ Installs the PostgreSQL adapter for Python on Linux. ``postgres.server`` -------------------- +^^^^^^^^^^^^^^^^^^^ Installs the PostgreSQL server package on Linux, prepares the DB cluster and starts the server using packaged init script, job or unit. @@ -52,7 +84,7 @@ packaged init script, job or unit. ``postgres.server.image`` -------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^ Installs the PostgreSQL server package on Linux, prepares the DB cluster and starts the server by issuing raw ``pg_ctl`` command. The ``postgres:bake_image`` Pillar toggles this behaviour. For example: @@ -78,7 +110,7 @@ If a lookup dictionary or Pillar has ``postgres:bake_image`` set ``False`` (this equivalent of applying ``postgres.server`` state. ``postgres.upstream`` ---------------------- +^^^^^^^^^^^^^^^^^^^^^ Configures the PostgreSQL Official (upstream) repository on target system if applicable. @@ -95,56 +127,56 @@ installed from the upstream Linux repository. Defaults to ``9.5``. Removal states -=============== +-------------- ``postgres.dropped`` --------------------- +^^^^^^^^^^^^^^^^^^^^ Meta state to remove Postgres software. By default the release installed by formula is targeted only. To target multiple releases, set pillar ``postgres.remove.multiple_releases: True``. ``postgres.server.remove`` ------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^ Remove server, lib, and contrib packages. The ``postgres.server.remove`` will retain data by default (no data loss) - set pillar ``postgres.remove.data: True`` to remove data and configuration directories also. ``postgres.client.remove`` ------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^ Remove client package. ``postgres.dev.remove`` ----------------------- +^^^^^^^^^^^^^^^^^^^^^^ Remove development and python packages. Testing -======= +------- Linux testing is done with ``kitchen-salt``. ``kitchen converge`` --------------------- +^^^^^^^^^^^^^^^^^^^^ Creates the docker instance and runs the ``postgres`` main state, ready for testing. ``kitchen verify`` ------------------- +^^^^^^^^^^^^^^^^^^ Runs the ``inspec`` tests on the actual instance. ``kitchen destroy`` ----------------- +^^^^^^^^^^^^^^^^ Removes the docker instance. ``kitchen test`` ----------------- +^^^^^^^^^^^^^^^^ Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``. ``kitchen login`` ------------------ +^^^^^^^^^^^^^^^^^ Gives you SSH access to the instance for manual testing. diff --git a/docs/TOFS_pattern.rst b/docs/TOFS_pattern.rst new file mode 100644 index 0000000..13c01e9 --- /dev/null +++ b/docs/TOFS_pattern.rst @@ -0,0 +1,443 @@ +.. _tofs_pattern: + +TOFS: A pattern for using SaltStack +=================================== + +.. list-table:: + :name: tofs-authors + :header-rows: 1 + :stub-columns: 1 + :widths: 2,2,3,2 + + * - + - Person + - Contact + - Date + * - Authored by + - Roberto Moreda + - moreda@allenta.com + - 29/12/2014 + * - Modified by + - Daniel Dehennin + - daniel.dehennin@baby-gnu.org + - 07/02/2019 + * - Modified by + - Imran Iqbal + - https://github.com/myii + - 23/02/2019 + +All that follows is a proposal based on my experience with `SaltStack `_. The good thing of a piece of software like this is that you can "bend it" to suit your needs in many possible ways, and this is one of them. All the recommendations and thoughts are given "as it is" with no warranty of any type. + +.. contents:: **Table of Contents** + +Usage of values in pillar vs templates in ``file_roots`` +-------------------------------------------------------- + +Among other functions, the *master* (or *salt-master*) serves files to the *minions* (or *salt-minions*). The `file_roots `_ is the list of directories used in sequence to find a file when a minion requires it: the first match is served to the minion. Those files could be `state files `_ or configuration templates, among others. + +Using SaltStack is a simple and effective way to implement configuration management, but even in a `non-multitenant `_ scenario, it is not a good idea to generally access some data (e.g. the database password in our `Zabbix `_ server configuration file or the private key of our `Nginx `_ TLS certificate). + +To avoid this situation we can use the `pillar mechanism `_, which is designed to provide controlled access to data from the minions based on some selection rules. As pillar data could be easily integrated in the `Jinja `_ templates, it is a good mechanism to store values to be used in the final rendering of state files and templates. + +There are a variety of approaches on the usage of pillar and templates as seen in the `saltstack-formulas `_' repositories. `Some `_ `developments `_ stress the initial purpose of pillar data into a storage for most of the possible variables for a determined system configuration. This, in my opinion, is shifting too much load from the original template files approach. Adding up some `non-trivial Jinja `_ code as essential part of composing the state file definitely makes SaltStack state files (hence formulas) more difficult to read. The extreme of this approach is that we could end up with a new render mechanism, implemented in Jinja, storing everything needed in pillar data to compose configurations. Additionally, we are establishing a strong dependency with the Jinja renderer. + +In opposition to the *put the code in file_roots and the data in pillars* approach, there is the *pillar as a store for a set of key-values* approach. A full-blown configuration file abstracted in pillar and jinja is complicated to develop, understand and maintain. I think a better and simpler approach is to keep a configuration file templated using just a basic (non-extensive but extensible) set of pillar values. + +On the reusability of SaltStack state files +------------------------------------------- + +There is a brilliant initiative of the SaltStack community called `salt-formulas `_. Their goal is to provide state files, pillar examples and configuration templates ready to be used for provisioning. I am a contributor for two small ones: `zabbix-formula `_ and `varnish-formula `_. + +The `design guidelines `_ for formulas are clear in many aspects and it is a recommended reading for anyone willing to write state files, even non-formulaic ones. + +In the next section, I am going to describe my proposal to extend further the reusability of formulas, suggesting some patterns of usage. + +The Template Override and Files Switch (TOFS) pattern +----------------------------------------------------- + +I understand a formula as a **complete, independent set of SaltStack state and configuration template files sufficient to configure a system**. A system could be something as simple as an NTP server or some other much more complex service that requires many state and configuration template files. + +The customization of a formula should be done mainly by providing pillar data used later to render either the state or the configuration template files. + +Example: NTP before applying TOFS +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Let's work with the NTP example. A basic formula that follows the `design guidelines `_ has the following files and directories tree: + +.. code-block:: + + /srv/saltstack/salt-formulas/ntp-saltstack-formula/ + ntp/ + map.jinja + init.sls + conf.sls + files/ + default/ + etc/ + ntp.conf.jinja + +In order to use it, let's assume a `masterless configuration `_ and this relevant section of ``/etc/salt/minion``: + +.. code-block:: yaml + + pillar_roots: + base: + - /srv/saltstack/pillar + file_client: local + file_roots: + base: + - /srv/saltstack/salt + - /srv/saltstack/salt-formulas/ntp-saltstack-formula + +.. code-block:: jinja + + {#- /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/map.jinja #} + {%- set ntp = salt['grains.filter_by']({ + 'default': { + 'pkg': 'ntp', + 'service': 'ntp', + 'config': '/etc/ntp.conf', + }, + }, merge=salt['pillar.get']('ntp:lookup')) %} + +In ``init.sls`` we have the minimal states required to have NTP configured. In many cases ``init.sls`` is almost equivalent to an ``apt-get install`` or a ``yum install`` of the package. + +.. code-block:: sls + + ## /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/init.sls + {%- from 'ntp/map.jinja' import ntp with context %} + + Install NTP: + pkg.installed: + - name: {{ ntp.pkg }} + + Enable and start NTP: + service.running: + - name: {{ ntp.service }} + - enabled: True + - require: + - pkg: Install NTP package + +In ``conf.sls`` we have the configuration states. In most cases, that is just managing configuration file templates and making them to be watched by the service. + +.. code-block:: sls + + ## /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/conf.sls + include: + - ntp + + {%- from 'ntp/map.jinja' import ntp with context %} + + Configure NTP: + file.managed: + - name: {{ ntp.config }} + - template: jinja + - source: salt://ntp/files/default/etc/ntp.conf.jinja + - watch_in: + - service: Enable and start NTP service + - require: + - pkg: Install NTP package + +Under ``files/default``, there is a structure that mimics the one in the minion in order to avoid clashes and confusion on where to put the needed templates. There you can find a mostly standard template for the configuration file. + +.. code-block:: jinja + + {#- /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/files/default/etc/ntp.conf.jinja #} + {#- Managed by saltstack #} + {#- Edit pillars or override this template in saltstack if you need customization #} + {%- set settings = salt['pillar.get']('ntp', {}) %} + {%- set default_servers = ['0.ubuntu.pool.ntp.org', + '1.ubuntu.pool.ntp.org', + '2.ubuntu.pool.ntp.org', + '3.ubuntu.pool.ntp.org'] %} + + driftfile /var/lib/ntp/ntp.drift + statistics loopstats peerstats clockstats + filegen loopstats file loopstats type day enable + filegen peerstats file peerstats type day enable + filegen clockstats file clockstats type day enable + + {%- for server in settings.get('servers', default_servers) %} + server {{ server }} + {%- endfor %} + + restrict -4 default kod notrap nomodify nopeer noquery + restrict -6 default kod notrap nomodify nopeer noquery + + restrict 127.0.0.1 + restrict ::1 + +With all this, it is easy to install and configure a simple NTP server by just running ``salt-call state.sls ntp.conf``: the package will be installed, the service will be running and the configuration should be correct for most of cases, even without pillar data. + +Alternatively, you can define a highstate in ``/srv/saltstack/salt/top.sls`` and run ``salt-call state.highstate``. + +.. code-block:: sls + + ## /srv/saltstack/salt/top.sls + base: + '*': + - ntp.conf + +**Customizing the formula just with pillar data**, we have the option to define the NTP servers. + +.. code-block:: sls + + ## /srv/saltstack/pillar/top.sls + base: + '*': + - ntp + +.. code-block:: sls + + ## /srv/saltstack/pillar/ntp.sls + ntp: + servers: + - 0.ch.pool.ntp.org + - 1.ch.pool.ntp.org + - 2.ch.pool.ntp.org + - 3.ch.pool.ntp.org + +Template Override +^^^^^^^^^^^^^^^^^ + +If the customization based on pillar data is not enough, we can override the template by creating a new one in ``/srv/saltstack/salt/ntp/files/default/etc/ntp.conf.jinja`` + +.. code-block:: jinja + + {#- /srv/saltstack/salt/ntp/files/default/etc/ntp.conf.jinja #} + {#- Managed by saltstack #} + {#- Edit pillars or override this template in saltstack if you need customization #} + + {#- Some bizarre configurations here #} + {#- ... #} + + {%- for server in settings.get('servers', default_servers) %} + server {{ server }} + {%- endfor %} + +This way we are locally **overriding the template files** offered by the formula in order to make a more complex adaptation. Of course, this could be applied as well to any of the files, including the state files. + +Files Switch +^^^^^^^^^^^^ + +To bring some order into the set of template files included in a formula, as we commented, we suggest having a similar structure to a normal final file system under ``files/default``. + +We can make different templates coexist for different minions, classified by any `grain `_ value, by simply creating new directories under ``files``. This mechanism is based on **using values of some grains as a switch for the directories under** ``files/``. + +If we decide that we want ``os_family`` as switch, then we could provide the formula template variants for both the ``RedHat`` and ``Debian`` families. + +.. code-block:: + + /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/files/ + default/ + etc/ + ntp.conf.jinja + RedHat/ + etc/ + ntp.conf.jinja + Debian/ + etc/ + ntp.conf.jinja + +To make this work we need a ``conf.sls`` state file that takes a list of possible files as the configuration template. + +.. code-block:: sls + + ## /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/conf.sls + include: + - ntp + + {%- from 'ntp/map.jinja' import ntp with context %} + + Configure NTP: + file.managed: + - name: {{ ntp.config }} + - template: jinja + - source: + - salt://ntp/files/{{ grains.get('os_family', 'default') }}/etc/ntp.conf.jinja + - salt://ntp/files/default/etc/ntp.conf.jinja + - watch_in: + - service: Enable and start NTP service + - require: + - pkg: Install NTP package + +If we want to cover the possibility of a special template for a minion identified by ``node01`` then we could have a specific template in ``/srv/saltstack/salt/ntp/files/node01/etc/ntp.conf.jinja``. + +.. code-block:: jinja + + {#- /srv/saltstack/salt/ntp/files/node01/etc/ntp.conf.jinja #} + {#- Managed by saltstack #} + {#- Edit pillars or override this template in saltstack if you need customization #} + + {#- Some crazy configurations here for node01 #} + {#- ... #} + +To make this work we could write a specially crafted ``conf.sls``. + +.. code-block:: sls + + ## /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/conf.sls + include: + - ntp + + {%- from 'ntp/map.jinja' import ntp with context %} + + Configure NTP: + file.managed: + - name: {{ ntp.config }} + - template: jinja + - source: + - salt://ntp/files/{{ grains.get('id') }}/etc/ntp.conf.jinja + - salt://ntp/files/{{ grains.get('os_family') }}/etc/ntp.conf.jinja + - salt://ntp/files/default/etc/ntp.conf.jinja + - watch_in: + - service: Enable and start NTP service + - require: + - pkg: Install NTP package + +Using the ``files_switch`` macro +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +We can simplify the ``conf.sls`` with the new ``files_switch`` macro to use in the ``source`` parameter for the ``file.managed`` state. + +.. code-block:: sls + + ## /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/conf.sls + include: + - ntp + + {%- set tplroot = tpldir.split('/')[0] %} + {%- from 'ntp/map.jinja' import ntp with context %} + {%- from 'ntp/libtofs.jinja' import files_switch %} + + Configure NTP: + file.managed: + - name: {{ ntp.config }} + - template: jinja + - source: {{ files_switch(['/etc/ntp.conf.jinja'], + lookup='Configure NTP' + ) + }} + - watch_in: + - service: Enable and start NTP service + - require: + - pkg: Install NTP package + + +* This uses ``config.get``, searching for ``ntp:tofs:source_files:Configure NTP`` to determine the list of template files to use. +* If this does not yield any results, the default of ``['/etc/ntp.conf.jinja']`` will be used. + +In ``libtofs.jinja``, we define this new macro ``files_switch``. + +.. literalinclude:: ../template/libtofs.jinja + :caption: /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/libtofs.jinja + :language: jinja + +How to customise the ``source`` further +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The examples below are based on an ``Ubuntu`` minion called ``theminion`` being configured via. pillar. + +Using the default settings of the ``files_switch`` macro above, +the ``source`` will be: + +.. code-block:: sls + + - source: + - salt://ntp/files/theminion/etc/ntp.conf.jinja + - salt://ntp/files/Debian/etc/ntp.conf.jinja + - salt://ntp/files/default/etc/ntp.conf.jinja + +Customise ``files`` +~~~~~~~~~~~~~~~~~~~ + +The ``files`` portion can be customised: + +.. code-block:: sls + + ntp: + tofs: + dirs: + files: files_alt + +Resulting in: + +.. code-block:: sls + + - source: + - salt://ntp/files_alt/theminion/etc/ntp.conf.jinja + - salt://ntp/files_alt/Debian/etc/ntp.conf.jinja + - salt://ntp/files_alt/default/etc/ntp.conf.jinja + +Customise the use of grains +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Grains can be customised and even arbitrary paths can be supplied: + +.. code-block:: sls + + ntp: + tofs: + files_switch: + - any/path/can/be/used/here + - id + - os + - os_family + +Resulting in: + +.. code-block:: sls + + - source: + - salt://ntp/files/any/path/can/be/used/here/etc/ntp.conf.jinja + - salt://ntp/files/theminion/etc/ntp.conf.jinja + - salt://ntp/files/Ubuntu/etc/ntp.conf.jinja + - salt://ntp/files/Debian/etc/ntp.conf.jinja + - salt://ntp/files/default/etc/ntp.conf.jinja + +Customise the ``default`` path +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The ``default`` portion of the path can be customised: + +.. code-block:: sls + + ntp: + tofs: + dirs: + default: default_alt + +Resulting in: + +.. code-block:: sls + + - source: + ... + - salt://ntp/files/default_alt/etc/ntp.conf.jinja + +Customise the list of ``source_files`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The list of ``source_files`` can be given: + +.. code-block:: sls + + ntp: + tofs: + source_files: + Configure NTP: + - '/etc/ntp.conf.jinja' + - '/etc/ntp.conf_alt.jinja' + +Resulting in: + +.. code-block:: sls + + - source: + - salt://ntp/files/theminion/etc/ntp.conf.jinja + - salt://ntp/files/theminion/etc/ntp.conf_alt.jinja + - salt://ntp/files/Debian/etc/ntp.conf.jinja + - salt://ntp/files/Debian/etc/ntp.conf_alt.jinja + - salt://ntp/files/default/etc/ntp.conf.jinja + - salt://ntp/files/default/etc/ntp.conf_alt.jinja + diff --git a/postgres/libtofs.jinja b/postgres/libtofs.jinja new file mode 100644 index 0000000..ab0d0f6 --- /dev/null +++ b/postgres/libtofs.jinja @@ -0,0 +1,100 @@ +{%- macro files_switch(source_files, + lookup=None, + default_files_switch=['id', 'os_family'], + indent_width=6, + v1_path_prefix='') %} + {#- + Returns a valid value for the "source" parameter of a "file.managed" + state function. This makes easier the usage of the Template Override and + Files Switch (TOFS) pattern. + + Params: + * source_files: ordered list of files to look for + * lookup: key under ':tofs:source_files' to override + list of source files + * default_files_switch: if there's no config (e.g. pillar) + ':tofs:files_switch' this is the ordered list of grains to + use as selector switch of the directories under + "/files" + * indent_witdh: indentation of the result value to conform to YAML + * v1_path_prefix: (deprecated) only used for injecting a path prefix into + the source, to support older TOFS configs + + Example (based on a `tplroot` of `xxx`): + + If we have a state: + + Deploy configuration: + file.managed: + - name: /etc/yyy/zzz.conf + - source: {{ files_switch(['/etc/yyy/zzz.conf', '/etc/yyy/zzz.conf.jinja'], + lookup='Deploy configuration' + ) }} + - template: jinja + + In a minion with id=theminion and os_family=RedHat, it's going to be + rendered as: + + Deploy configuration: + file.managed: + - name: /etc/yyy/zzz.conf + - source: + - salt://xxx/files/theminion/etc/yyy/zzz.conf + - salt://xxx/files/theminion/etc/yyy/zzz.conf.jinja + - salt://xxx/files/RedHat/etc/yyy/zzz.conf + - salt://xxx/files/RedHat/etc/yyy/zzz.conf.jinja + - salt://xxx/files/default/etc/yyy/zzz.conf + - salt://xxx/files/default/etc/yyy/zzz.conf.jinja + - template: jinja + #} + {#- Get the `tplroot` from `tpldir` #} + {%- set tplroot = tpldir.split('/')[0] %} + {%- set path_prefix = salt['config.get'](tplroot ~ ':tofs:path_prefix', tplroot) %} + {%- set files_dir = salt['config.get'](tplroot ~ ':tofs:dirs:files', 'files') %} + {%- set files_switch_list = salt['config.get']( + tplroot ~ ':tofs:files_switch', + default_files_switch + ) %} + {#- Lookup source_files (v2), files (v1), or fallback to source_files parameter #} + {%- set src_files = salt['config.get']( + tplroot ~ ':tofs:source_files:' ~ lookup, + salt['config.get']( + tplroot ~ ':tofs:files:' ~ lookup, + source_files + ) + ) %} + {#- Only add to [''] when supporting older TOFS implementations #} + {%- set path_prefix_exts = [''] %} + {%- if v1_path_prefix != '' %} + {%- do path_prefix_exts.append(v1_path_prefix) %} + {%- endif %} + {%- for path_prefix_ext in path_prefix_exts %} + {%- set path_prefix_inc_ext = path_prefix ~ path_prefix_ext %} + {#- For older TOFS implementation, use `files_switch` from the config #} + {#- Use the default, new method otherwise #} + {%- set fsl = salt['config.get']( + tplroot ~ path_prefix_ext|replace('/', ':') ~ ':files_switch', + files_switch_list + ) %} + {#- Append an empty value to evaluate as `default` in the loop below #} + {%- if '' not in fsl %} + {%- do fsl.append('') %} + {%- endif %} + {%- for fs in fsl %} + {%- for src_file in src_files %} + {%- if fs %} + {%- set fs_dir = salt['config.get'](fs, fs) %} + {%- else %} + {%- set fs_dir = salt['config.get'](tplroot ~ ':tofs:dirs:default', 'default') %} + {%- endif %} + {%- set url = '- salt://' ~ '/'.join([ + path_prefix_inc_ext, + files_dir, + fs_dir, + src_file.lstrip('/') + ]) %} +{{ url | indent(indent_width, true) }} + {%- endfor %} + {%- endfor %} + {%- endfor %} +{%- endmacro %} diff --git a/pre-commit_semantic-release.sh b/pre-commit_semantic-release.sh new file mode 100755 index 0000000..9d34d74 --- /dev/null +++ b/pre-commit_semantic-release.sh @@ -0,0 +1,30 @@ +#!/bin/sh + +############################################################################### +# (A) Update `FORMULA` with `${nextRelease.version}` +############################################################################### +sed -i -e "s_^\(version:\).*_\1 ${1}_" FORMULA + + +############################################################################### +# (B) Use `m2r` to convert automatically produced `.md` docs to `.rst` +############################################################################### + +# Install `m2r` +sudo -H pip install m2r + +# Copy and then convert the `.md` docs +cp *.md docs/ +cd docs/ +m2r --overwrite *.md + +# Change excess `H1` headings to `H2` in converted `CHANGELOG.rst` +sed -i -e '/^=.*$/s/=/-/g' CHANGELOG.rst +sed -i -e '1,4s/-/=/g' CHANGELOG.rst + +# Use for debugging output, when required +# cat AUTHORS.rst +# cat CHANGELOG.rst + +# Return back to the main directory +cd .. diff --git a/release-rules.js b/release-rules.js new file mode 100644 index 0000000..c63c850 --- /dev/null +++ b/release-rules.js @@ -0,0 +1,18 @@ +// No release is triggered for the types commented out below. +// Commits using these types will be incorporated into the next release. +// +// NOTE: Any changes here must be reflected in `CONTRIBUTING.md`. +module.exports = [ + {breaking: true, release: 'major'}, + // {type: 'build', release: 'patch'}, + // {type: 'chore', release: 'patch'}, + // {type: 'ci', release: 'patch'}, + {type: 'docs', release: 'patch'}, + {type: 'feat', release: 'minor'}, + {type: 'fix', release: 'patch'}, + {type: 'perf', release: 'patch'}, + {type: 'refactor', release: 'patch'}, + {type: 'revert', release: 'patch'}, + {type: 'style', release: 'patch'}, + {type: 'test', release: 'patch'}, +]; diff --git a/release.config.js b/release.config.js new file mode 100644 index 0000000..afa0cb1 --- /dev/null +++ b/release.config.js @@ -0,0 +1,106 @@ +module.exports = { + branch: 'master', + plugins: [ + ['@semantic-release/commit-analyzer', { + preset: 'angular', + releaseRules: './release-rules.js', + }], + '@semantic-release/release-notes-generator', + ['@semantic-release/changelog', { + changelogFile: 'CHANGELOG.md', + changelogTitle: '# Changelog', + }], + ['@semantic-release/exec', { + prepareCmd: 'sh ./pre-commit_semantic-release.sh ${nextRelease.version}', + }], + ['@semantic-release/git', { + assets: ['*.md', 'docs/*.rst', 'FORMULA'], + }], + '@semantic-release/github', + ], + generateNotes: { + preset: 'angular', + writerOpts: { + // Required due to upstream bug preventing all types being displayed. + // Bug: https://github.com/conventional-changelog/conventional-changelog/issues/317 + // Fix: https://github.com/conventional-changelog/conventional-changelog/pull/410 + transform: (commit, context) => { + const issues = [] + + commit.notes.forEach(note => { + note.title = `BREAKING CHANGES` + }) + + // NOTE: Any changes here must be reflected in `CONTRIBUTING.md`. + if (commit.type === `feat`) { + commit.type = `Features` + } else if (commit.type === `fix`) { + commit.type = `Bug Fixes` + } else if (commit.type === `perf`) { + commit.type = `Performance Improvements` + } else if (commit.type === `revert`) { + commit.type = `Reverts` + } else if (commit.type === `docs`) { + commit.type = `Documentation` + } else if (commit.type === `style`) { + commit.type = `Styles` + } else if (commit.type === `refactor`) { + commit.type = `Code Refactoring` + } else if (commit.type === `test`) { + commit.type = `Tests` + } else if (commit.type === `build`) { + commit.type = `Build System` + // } else if (commit.type === `chore`) { + // commit.type = `Maintenance` + } else if (commit.type === `ci`) { + commit.type = `Continuous Integration` + } else { + return + } + + if (commit.scope === `*`) { + commit.scope = `` + } + + if (typeof commit.hash === `string`) { + commit.hash = commit.hash.substring(0, 7) + } + + if (typeof commit.subject === `string`) { + let url = context.repository + ? `${context.host}/${context.owner}/${context.repository}` + : context.repoUrl + if (url) { + url = `${url}/issues/` + // Issue URLs. + commit.subject = commit.subject.replace(/#([0-9]+)/g, (_, issue) => { + issues.push(issue) + return `[#${issue}](${url}${issue})` + }) + } + if (context.host) { + // User URLs. + commit.subject = commit.subject.replace(/\B@([a-z0-9](?:-?[a-z0-9/]){0,38})/g, (_, username) => { + if (username.includes('/')) { + return `@${username}` + } + + return `[@${username}](${context.host}/${username})` + }) + } + } + + // remove references that already appear in the subject + commit.references = commit.references.filter(reference => { + if (issues.indexOf(reference.issue) === -1) { + return true + } + + return false + }) + + return commit + }, + }, + }, +};