feat(yamllint): include for this repo and apply rules throughout

* Semi-automated using `ssf-formula` (v0.5.0) * Fix errors shown below: ```bash nginx-formula$ $(grep "\- yamllint" .travis.yml | sed -e "s:^\s\+-\s$.*$:\1:") pillar.example 5:1 warning missing document start "---" (document-start) 6:89 error line too long (110 > 88 characters) (line-length) 7:89 error line too long (99 > 88 characters) (line-length) 19:89 error line too long (132 > 88 characters) (line-length) 35:25 warning truthy value should be one of [false, true] (truthy) 36:89 error line too long (106 > 88 characters) (line-length) 40:89 error line too long (115 > 88 characters) (line-length) 43:16 warning truthy value should be one of [false, true] (truthy) 44:89 error line too long (105 > 88 characters) (line-length) 48:16 warning truthy value should be one of [false, true] (truthy) 54:14 warning too few spaces before comment (comments) 57:13 warning truthy value should be one of [false, true] (truthy) 57:18 warning too few spaces before comment (comments) 58:14 warning too few spaces before comment (comments) 60:5 warning missing starting space in comment (comments) 60:89 error line too long (96 > 88 characters) (line-length) 61:89 error line too long (90 > 88 characters) (line-length) 62:89 error line too long (90 > 88 characters) (line-length) 63:89 error line too long (94 > 88 characters) (line-length) 64:5 warning missing starting space in comment (comments) 64:89 error line too long (96 > 88 characters) (line-length) 68:9 error wrong indentation: expected 10 but found 8 (indentation) 76:9 error wrong indentation: expected 10 but found 8 (indentation) 86:9 error wrong indentation: expected 10 but found 8 (indentation) 90:14 warning too few spaces before comment (comments) 90:89 error line too long (104 > 88 characters) (line-length) 92:6 warning missing starting space in comment (comments) 92:89 error line too long (106 > 88 characters) (line-length) 94:89 error line too long (104 > 88 characters) (line-length) 97:6 warning missing starting space in comment (comments) 97:89 error line too long (106 > 88 characters) (line-length) 100:62 warning too few spaces before comment (comments) 100:89 error line too long (121 > 88 characters) (line-length) 101:62 warning comment not indented like content (comments-indentation) 101:89 error line too long (116 > 88 characters) (line-length) 102:89 error line too long (112 > 88 characters) (line-length) 103:89 error line too long (99 > 88 characters) (line-length) 105:89 error line too long (124 > 88 characters) (line-length) 106:8 warning missing starting space in comment (comments) 106:89 error line too long (117 > 88 characters) (line-length) 112:89 error line too long (97 > 88 characters) (line-length) 120:31 warning missing starting space in comment (comments) 123:89 error line too long (95 > 88 characters) (line-length) 127:13 error wrong indentation: expected 14 but found 12 (indentation) 151:33 warning too few spaces before comment (comments) 151:89 error line too long (94 > 88 characters) (line-length) 152:22 warning too few spaces before comment (comments) 152:89 error line too long (90 > 88 characters) (line-length) 153:21 warning too few spaces before comment (comments) 153:89 error line too long (101 > 88 characters) (line-length) 154:22 warning too few spaces before comment (comments) 155:18 warning too few spaces before comment (comments) 155:89 error line too long (103 > 88 characters) (line-length) 163:89 error line too long (100 > 88 characters) (line-length) 164:89 error line too long (106 > 88 characters) (line-length) 165:18 warning truthy value should be one of [false, true] (truthy) 167:89 error line too long (109 > 88 characters) (line-length) 170:10 warning missing starting space in comment (comments) 172:10 warning missing starting space in comment (comments) 172:89 error line too long (120 > 88 characters) (line-length) 173:10 warning missing starting space in comment (comments) 173:89 error line too long (118 > 88 characters) (line-length) 174:89 error line too long (120 > 88 characters) (line-length) 175:20 warning truthy value should be one of [false, true] (truthy) 175:89 error line too long (102 > 88 characters) (line-length) 177:89 error line too long (100 > 88 characters) (line-length) 178:89 error line too long (101 > 88 characters) (line-length) 182:13 error wrong indentation: expected 14 but found 12 (indentation) 184:15 error wrong indentation: expected 16 but found 14 (indentation) 186:15 error wrong indentation: expected 16 but found 14 (indentation) 189:15 error wrong indentation: expected 16 but found 14 (indentation) 193:9 warning comment not indented like content (comments-indentation) 196:13 error wrong indentation: expected 14 but found 12 (indentation) 198:15 error wrong indentation: expected 16 but found 14 (indentation) 202:15 error wrong indentation: expected 16 but found 14 (indentation) 206:9 warning comment not indented like content (comments-indentation) 218:16 warning too few spaces before comment (comments) 218:89 error line too long (96 > 88 characters) (line-length) 219:18 warning truthy value should be one of [false, true] (truthy) 223:57 warning too few spaces before comment (comments) 223:89 error line too long (111 > 88 characters) (line-length) 224:57 warning comment not indented like content (comments-indentation) 224:89 error line too long (118 > 88 characters) (line-length) 226:89 error line too long (90 > 88 characters) (line-length) 236:18 warning truthy value should be one of [false, true] (truthy) 245:89 error line too long (108 > 88 characters) (line-length) 252:89 error line too long (104 > 88 characters) (line-length) 305:89 error line too long (115 > 88 characters) (line-length) 306:32 error trailing spaces (trailing-spaces) test/salt/default/pillar/nginx.sls 1:1 error too many blank lines (1 > 0) (empty-lines) 7:1 warning missing document start "---" (document-start) 11:9 error wrong indentation: expected 10 but found 8 (indentation) 23:18 warning truthy value should be one of [false, true] (truthy) 24:18 warning truthy value should be one of [false, true] (truthy) 28:18 warning truthy value should be one of [false, true] (truthy) 31:13 error wrong indentation: expected 14 but found 12 (indentation) 33:15 error wrong indentation: expected 16 but found 14 (indentation) 36:15 error wrong indentation: expected 16 but found 14 (indentation) 38:1 error too many blank lines (1 > 0) (empty-lines) ```
2019-08-06 20:57:39 +01:00 · 2019-08-06 20:57:39 +01:00 · 6b7d1fe453
commit 6b7d1fe453
parent c00c058076
5 changed files with 189 additions and 128 deletions
--- a/.travis.yml
+++ b/.travis.yml
@ -3,7 +3,7 @@
 ---
 stages:
  - test
-  - commitlint
+  - lint
  - name: release
    if: branch = master AND type != pull_request

@ -45,16 +45,21 @@ script:

 jobs:
  include:
-    # Define the commitlint stage
-    - stage: commitlint
+    # Define the `lint` stage (runs `yamllint` and `commitlint`)
+    - stage: lint
      language: node_js
      node_js: lts/*
      before_install: skip
      script:
+        # Install and run `yamllint`
+        - pip install --user yamllint
+        # yamllint disable-line rule:line-length
+        - yamllint -s . .yamllint pillar.example test/salt/default/pillar/nginx.sls
+        # Install and run `commitlint`
        - npm install @commitlint/config-conventional -D
        - npm install @commitlint/travis-cli -D
        - commitlint-travis
-    # Define the release stage that runs semantic-release
+    # Define the release stage that runs `semantic-release`
    - stage: release
      language: node_js
      node_js: lts/*
--- a/.yamllint
+++ b/.yamllint
@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+# vim: ft=yaml
+---
+# Extend the `default` configuration provided by `yamllint`
+extends: default
+
+# Files to ignore completely
+# 1. All YAML files under directory `node_modules/`, introduced during the Travis run
+ignore: |
+  node_modules/
+
+rules:
+  line-length:
+    # Increase from default of `80`
+    # Based on https://github.com/PyCQA/flake8-bugbear#opinionated-warnings (`B950`)
+    max: 88
--- a/pillar.example
+++ b/pillar.example
@ -1,11 +1,15 @@
+# -*- coding: utf-8 -*-
+# vim: ft=yaml
+---
 # ========
 # nginx (previously named nginx:ng)
 # ========

 nginx:
-  # The following three `install_from_` options are mutually exclusive. If none is used, the distro's provided
-  # package will be installed. If one of the `install_from` option is set to `True`, the state will
-  # make sure the other two repos are removed.
+  # The following three `install_from_` options are mutually exclusive. If none
+  # is used, the distro's provided package will be installed. If one of the
+  # `install_from` option is set to `true`, the state will make sure the other
+  # two repos are removed.

  # Use the official's nginx repo binaries
  install_from_repo: false
@ -16,7 +20,8 @@ nginx:

  # PPA install
  install_from_ppa: false
-  # Set to 'stable', 'development' (mainline), 'community', or 'nightly' for each build accordingly ( https://launchpad.net/~nginx )
+  # Set to 'stable', 'development' (mainline), 'community', or 'nightly' for
+  # each build accordingly ( https://launchpad.net/~nginx )
  ppa_version: 'stable'

  # Source install
@ -32,20 +37,23 @@ nginx:
    conf_file: /etc/nginx/nginx.conf
    server_available: /etc/nginx/sites-available
    server_enabled: /etc/nginx/sites-enabled
-    server_use_symlink: True
-    # If you install nginx+passenger from phusionpassenger in Debian, these values will probably be needed
+    server_use_symlink: true
+    # If you install nginx+passenger from phusionpassenger in Debian, these
+    # values will probably be needed
    passenger_package: libnginx-mod-http-passenger
    passenger_config_file: /etc/nginx/conf.d/mod-http-passenger.conf

-    # This is required for RedHat like distros (Amazon Linux) that don't follow semantic versioning for $releasever
+    # This is required for RedHat like distros (Amazon Linux) that don't follow
+    # semantic versioning for $releasever
    rh_os_releasever: '6'
    # Currently it can be used on rhel/centos/suse when installing from repo
-    gpg_check: True
-    pid_file: /var/run/nginx.pid   ### prevents rendering SLS error nginx.server.config.pid undefined ###
+    gpg_check: true
+    ### prevents rendering SLS error nginx.server.config.pid undefined ###
+    pid_file: /var/run/nginx.pid


  # Source compilation is not currently a part of nginx
-  from_source: False
+  from_source: false

  source:
    opts: {}
@ -54,14 +62,15 @@ nginx:
    opts: {}  # this partially exposes parameters of pkg.installed

  service:
-    enable: True # Whether or not the service will be enabled/running or dead
+    enable: true  # Whether or not the service will be enabled/running or dead
    opts: {}  # this partially exposes parameters of service.running / service.dead

-  ##--- --- - - - - - - -- - - - - -- - - --- -- - -- - - - -- - - - - -- - - - -- - - - -- - ##
-  ## You can use snippets to define often repeated configuration once and include it later
-  ## The letsencrypt example below is consumed by "- include: 'snippets/letsencrypt.conf'"
-  ## Files or Templates can be retrieved by TOFS with snippet name ( Fallback to server.conf )
-  ##--- --- - - - - - - --  - - -- -- - - --- -- - -- - - - -- - - - - -- - - - -- - - - -- - ##
+  ## - - --  - - -- -- - - --- -- - -- - - - -- - - - - -- - - - -- - - - -- - ##
+  ## You can use snippets to define often repeated configuration once and
+  ## include it later # The letsencrypt example below is consumed by "- include:
+  ## 'snippets/letsencrypt.conf'" # Files or Templates can be retrieved by TOFS
+  ## with snippet name ( Fallback to server.conf )
+  ## - - --  - - -- -- - - --- -- - -- - - - -- - - - - -- - - - -- - - - -- - ##
  snippets:
    letsencrypt.conf:
      - location ^~ /.well-known/acme-challenge/:
@ -87,29 +96,34 @@ nginx:
          - keepalive: 64

  server:
-    opts: {} # this partially exposes file.managed parameters as they relate to the main nginx.conf file
+    # this partially exposes file.managed parameters as they relate to the main
+    # nginx.conf file
+    opts: {}

-    #-- - - - - -- - - -- - - - - -- - - -- - - - -- - - - - - -- - - - - - -- - - - - -- - - - - -- - - #
-    # nginx.conf (main server) declarations
-    # dictionaries map to blocks {} and lists cause the same declaration to repeat with different values
-    # see also http://nginx.org/en/docs/example.html
-    # Nginx config file or template can be retrieved by TOFS ( Fallback to nginx.conf )
-    #-- - - - - -- - - -- - - - - -- - - -- - - - -- - - - - - -- - - - - - -- - - - - -- - - - - -- - - #
+    ## - - --  - - -- -- - - --- -- - -- - - - -- - - - - -- - - - -- - - - -- - ##
+    # nginx.conf (main server) declarations dictionaries map to blocks {} and
+    # lists cause the same declaration to repeat with different values see also
+    # http://nginx.org/en/docs/example.html Nginx config file or template can
+    # be retrieved by TOFS ( Fallback to nginx.conf )
+    ## - - --  - - -- -- - - --- -- - -- - - - -- - - - - -- - - - -- - - - -- - ##
    config:
      include: 'snippets/letsencrypt.conf'
-      source_path: salt://path_to_nginx_conf_file/nginx.conf # IMPORTANT: This option is mutually exclusive with TOFS and
-                                                             # the rest of the options; if it is found other options
-                                                             # (worker_processes: 4 and so on) are not processed
-                                                             # and just upload the file from source
+      # IMPORTANT: This option is mutually exclusive with TOFS and the rest of
+      # the options; if it is found other options (worker_processes: 4 and so
+      # on) are not processed and just upload the file from source
+      source_path: salt://path_to_nginx_conf_file/nginx.conf
      worker_processes: 4
-      load_module: modules/ngx_http_lua_module.so  # pass as very first in configuration; otherwise nginx will fail to start
-      #pid: /var/run/nginx.pid                     # Directory location must exist (i.e. it's  /run/nginx.pid on EL7)
+      # pass as very first in configuration; otherwise nginx will fail to start
+      load_module: modules/ngx_http_lua_module.so
+      # Directory location must exist (i.e. it's  /run/nginx.pid on EL7)
+      # pid: /var/run/nginx.pid
      events:
        worker_connections: 1024
      http:
        sendfile: 'on'
        include:
-          #### Note: Syntax issues in these files generate nginx [emerg] errors on startup.  ####
+          #### Note: Syntax issues in these files generate nginx [emerg] errors
+          #### on startup.
          - /etc/nginx/mime.types

        ### module ngx_http_log_module example
@ -119,8 +133,9 @@ nginx:
                              '"$http_user_agent" "$http_x_forwarded_for"'
        access_log: []  # suppress default access_log option from being added

-      ### module nngx_stream_core_module
-      ### https://docs.nginx.com/nginx/admin-guide/load-balancer/tcp-udp-load-balancer/#example
+      # module nngx_stream_core_module
+      # yamllint disable-line rule:line-length
+      # https://docs.nginx.com/nginx/admin-guide/load-balancer/tcp-udp-load-balancer/#example
      stream:
        upstream lb-1000:
          - server:
@ -148,11 +163,17 @@ nginx:


  servers:
-    disabled_postfix: .disabled # a postfix appended to files when doing non-symlink disabling
-    symlink_opts: {} # partially exposes file.symlink params when symlinking enabled sites
-    rename_opts: {} # partially exposes file.rename params when not symlinking disabled/enabled sites
-    managed_opts: {} # partially exposes file.managed params for managed server files
-    dir_opts: {} # partially exposes file.directory params for site available/enabled and snippets dirs
+    # a postfix appended to files when doing non-symlink disabling
+    disabled_postfix: .disabled
+    # partially exposes file.symlink params when symlinking enabled sites
+    symlink_opts: {}
+    # partially exposes file.rename params when not symlinking disabled/enabled sites
+    rename_opts: {}
+    # partially exposes file.managed params for managed server files
+    managed_opts: {}
+    # partially exposes file.directory params for site available/enabled and
+    # snippets dirs
+    dir_opts: {}


    #####################
@ -160,24 +181,46 @@ nginx:
    #####################
    managed:

-      mysite:  # relative filename of server file  (defaults to '/etc/nginx/sites-available/mysite')
-        # may be True, False, or None where True is enabled, False, disabled, and None indicates no action
-        enabled: True
+      # relative filename of server file
+      # (defaults to '/etc/nginx/sites-available/mysite')
+      mysite:
+        # may be true, false, or None where true is enabled, false, disabled,
+        # and None indicates no action
+        enabled: true

-        # Remove the site config file shipped by nginx (i.e. '/etc/nginx/sites-available/default' by default)
+        # Remove the site config file shipped by nginx
+        # (i.e. '/etc/nginx/sites-available/default' by default)
        # It also remove the symlink (if it is exists).
-        # The site MUST be disabled before delete it (if not the nginx is not reloaded).
-        #deleted: True
+        # The site MUST be disabled before delete it (if not the nginx is not
+        # reloaded).
+        # deleted: true

-        #available_dir: /etc/nginx/sites-available-custom   # custom directory (not sites-available) for server filename
-        #enabled_dir: /etc/nginx/sites-enabled-custom       # custom directory (not sites-enabled) for server filename
-        disabled_name: mysite.aint_on                       # an alternative disabled name to be use when not symlinking
-        overwrite: True                                     # overwrite an existing server file or not
+        # custom directory (not sites-available) for server filename
+        # available_dir: /etc/nginx/sites-available-custom
+        # custom directory (not sites-enabled) for server filename
+        # enabled_dir: /etc/nginx/sites-enabled-custom
+        # an alternative disabled name to be use when not symlinking
+        disabled_name: mysite.aint_on
+        # overwrite an existing server file or not
+        overwrite: true

-        # May be a list of config options or None, if None, no server file will be managed/templated
-        # Take server directives as lists of dictionaries. If the dictionary value is another list of
-        # dictionaries a block {} will be started with the dictionary key name
+        # May be a list of config options or None, if None, no server file will
+        # be managed/templated Take server directives as lists of dictionaries.
+        # If the dictionary value is another list of dictionaries a block {}
+        # will be started with the dictionary key name
        config:
+          # both of the methods below lead to the output:
+          # server {
+          #    server_name localhost;
+          #    listen 80 default_server;
+          #    listen 443 ssl;
+          #    index index.html index.htm;
+          #    location ~ .htm {
+          #        try_files $uri $uri/ =404;
+          #        test something else;
+          #    }
+          # }
+
          - server:
              - server_name: localhost
              - listen:
@ -191,7 +234,6 @@ nginx:
              - include: 'snippets/letsencrypt.conf'

          # Or a slightly more compact alternative syntax:
-
          - server:
              - server_name: localhost
              - listen:
@ -203,29 +245,20 @@ nginx:
                  - test: something else
              - include: 'snippets/letsencrypt.conf'

-        # both of those output:
-        # server {
-        #    server_name localhost;
-        #    listen 80 default_server;
-        #    listen 443 ssl;
-        #    index index.html index.htm;
-        #    location ~ .htm {
-        #        try_files $uri $uri/ =404;
-        #        test something else;
-        #    }
-        # }

-      mysite2: # Using source_path options to upload the file instead of templating all the file
-        enabled: True
+      # Using source_path options to upload the file instead of templating all the file
+      mysite2:
+        enabled: true
        available_dir: /etc/nginx/sites-available
        enabled_dir: /etc/nginx/sites-enabled
        config:
-          source_path: salt://path-to-site-file/mysite2 # IMPORTANT: This field is mutually exclusive with TOFS
-                                                        # and other config options, it just uploads the specified file
+          # IMPORTANT: This field is mutually exclusive with TOFS and other
+          # config options, it just uploads the specified file
+          source_path: salt://path-to-site-file/mysite2

-      # Below configuration becomes handy if you want to create custom configuration files
-      # for example if you want to create /usr/local/etc/nginx/http_options.conf with
-      # the following content:
+      # Below configuration becomes handy if you want to create custom
+      # configuration files for example if you want to create
+      # /usr/local/etc/nginx/http_options.conf with the following content:

      # sendfile on;
      # tcp_nopush on;
@ -233,7 +266,7 @@ nginx:
      # send_iowait 12000;

      http_options.conf:
-        enabled: True
+        enabled: true
        available_dir: /usr/local/etc/nginx
        enabled_dir: /usr/local/etc/nginx
        config:
@ -242,14 +275,16 @@ nginx:
          - tcp_nodelay: 'on'
          - send_iowait: 12000

-  certificates_path: '/etc/nginx/ssl'  # Use this if you need to deploy below certificates in a custom path.
+  # Use this if you need to deploy below certificates in a custom path.
+  certificates_path: '/etc/nginx/ssl'
  # If you're doing SSL termination, you can deploy certificates this way.
  # The private one(s) should go in a separate pillar file not in version
  # control (or use encrypted pillar data).
  certificates:
    'www.example.com':

-      # choose one of: deploying this cert by pillar (e.g. in combination with ext_pillar and file_tree)
+      # choose one of: deploying this cert by pillar (e.g. in combination with
+      # ext_pillar and file_tree)
      # public_cert_pillar: certs:example.com:fullchain.pem
      # private_key_pillar: certs:example.com:privkey.pem
      # or directly pasting the cert
@ -302,7 +337,8 @@ nginx:
    #
    # All aspects of path/file resolution are customisable using the options below.
    # This is unnecessary in most cases; there are sensible defaults.
-    # Path pattern: salt://{{ path_prefix or 'nginx' }}/{{ dirs.files or 'files' }}/{{ dirs.default or 'default' }}
+    # Default path: salt://{{ path_prefix }}/{{ dirs.files }}/{{ dirs.default }}
+    #         I.e.: salt://nginx/files/default
    # path_prefix: template_alt
    # dirs:
    #   files: files_alt
--- a/test/integration/default/inspec.yml
+++ b/test/integration/default/inspec.yml
@ -1,3 +1,6 @@
+# -*- coding: utf-8 -*-
+# vim: ft=yaml
+---
 name: default
 title: nginx formula
 maintainer: SaltStack Formulas
--- a/test/salt/default/pillar/nginx.sls
+++ b/test/salt/default/pillar/nginx.sls
@ -1,4 +1,6 @@
-
+# -*- coding: utf-8 -*-
+# vim: ft=yaml
+---
 # Simple pillar setup
 # - snippet letsencrypt
 # - remove 'default' site
@ -20,12 +22,12 @@ nginx:
  servers:
    managed:
      default:
-        deleted: True
-        enabled: False
+        deleted: true
+        enabled: false
        config: {}

      mysite:
-        enabled: True
+        enabled: true
        config:
          - server:
              - server_name: localhost
@ -35,4 +37,3 @@ nginx:
              - location ~ .htm:
                  - try_files: '$uri $uri/ =404'
              - include: 'snippets/letsencrypt.conf'
-