Add basic assertions (#319)

Author: alessfg

.github/ISSUE_TEMPLATE/bug_report.md

@@ -20,7 +20,7 @@ Steps to reproduce the behavior:
 A clear and concise description of what you expected to happen.
 
 **Your environment:**
--   Version of the NGINX Role or specific commit
+-   Version of the NGINX role or specific commit
 -   Version of Ansible
 -   Target deployment platform
 

.github/pull_request_template.md

@@ -4,7 +4,7 @@ Describe the use case and detail of the change. If this PR addresses an issue on
 ### Checklist
 Before creating a PR, run through this checklist and mark each as complete.
 
--   [ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/ansible-role-nginx/blob/master/CONTRIBUTING.md) document
+-   [ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/ansible-role-nginx/blob/main/CONTRIBUTING.md) document
 -   [ ] I have added Molecule tests that prove my fix is effective or that my feature works
 -   [ ] I have checked that all Molecule tests pass after adding my changes
 -   [ ] I have updated any relevant documentation (`defaults/main/*.yml`, `README.md` and `CHANGELOG.md`)

.travis.yml

@@ -6,7 +6,7 @@ jobs:
     - name: "(Debian/Ubuntu) Install Specific Version"
       env:
         scenario: default
-    - name: "(Alpine) Install Specific Version"
+    - name: "(Alpine Linux) Install Specific Version"
       env:
         scenario: default_alpine
     - name: "(CentOS) Install Specific Version"
@@ -15,7 +15,7 @@ jobs:
     - name: "(Debian/Ubuntu) Install Modules"
       env:
         scenario: module
-    - name: "(Alpine) Install Modules"
+    - name: "(Alpine Linux) Install Modules"
       env:
         scenario: module_alpine
     - name: "(CentOS) Install Modules"
@@ -24,7 +24,7 @@ jobs:
     - name: "(Debian/Ubuntu) Install Stable Branch and Push Configuration"
       env:
         scenario: stable_push
-    - name: "(Alpine) Install Stable Branch and Push Configuration"
+    - name: "(Alpine Linux) Install Stable Branch and Push Configuration"
       env:
         scenario: stable_push_alpine
     - name: "(CentOS) Install Stable Branch and Push Configuration"
@@ -33,7 +33,7 @@ jobs:
     - name: "(Debian/Ubuntu) Use Template Setting"
       env:
         scenario: template
-    - name: "(Alpine) Use Template Setting"
+    - name: "(Alpine Linux) Use Template Setting"
       env:
         scenario: template_alpine
     - name: "(CentOS) Use Template Setting"
@@ -42,7 +42,7 @@ jobs:
     - name: "(Debian/Ubuntu) Install NGINX Unit"
       env:
         scenario: unit
-    - name: "(Alpine) Install NGINX Unit"
+    - name: "(Alpine Linux) Install NGINX Unit"
       env:
         scenario: unit_alpine
     - name: "(CentOS) Install NGINX Unit"
@@ -51,7 +51,7 @@ jobs:
     - name: "(Debian/Ubuntu) Install from Source"
       env:
         scenario: source
-    - name: "(Alpine) Install from Source"
+    - name: "(Alpine Linux) Install from Source"
       env:
         scenario: source_alpine
     - name: "(CentOS) Install from Source"

CHANGELOG.md

@@ -4,21 +4,32 @@
 
 BREAKING CHANGES:
 
-*   The process to install modules has changed. You will now have to use a list variable, `nginx_modules`, instead of manually setting the modules you want to install to `true` or `false`. This change will also simplify adding future supported modules to this role. You can find a list of supported modules for NGINX and NGINX Plus in [`vars/main.yml`](https://github.com/nginxinc/ansible-role-nginx/blob/master/vars/main.yml).
+*   The process to install modules has changed. You will now have to use a list variable, `nginx_modules`, instead of manually setting the modules you want to install to `true` or `false`. This change will also simplify adding future supported modules to this role. You can find a list of supported modules for NGINX and NGINX Plus in [`vars/main.yml`](https://github.com/nginxinc/ansible-role-nginx/blob/main/vars/main.yml).
 *   Modules can no longer be added to your NGINX config using this role. Please use the [`nginx_config`](https://github.com/nginxinc/ansible-role-nginx-config) role instead.
+*   Changed `nginx_configure` default value from `true` to `false` to further promote the adoption of the [NGINX config](https://github.com/nginxinc/ansible-role-nginx-config) role.
 
 FEATURES:
 
-*   Add Alpine 3.12 to the list of supported platforms
-*   Remove Alpine 3.8 from the list of supported platforms
+*   Two new variables have been introduced:
+    *   `nginx_setup_license` -- Determine whether you want to use this role to upload your NGINX license to your target host.
+    *   `nginx_debug_tasks` -- Print task related information to give you a better insight into the current progress of the role.
+*   The role will now fail automatically if you try to deploy NGINX from an official repository in an unsupported distribution. You can find a list of supported distributions for NGINX and NGINX Plus in [`vars/main.yml`](https://github.com/nginxinc/ansible-role-nginx/blob/main/vars/main.yml)
+*   Three new tags have been introduced -- `nginx_setup_license`, `nginx_install` and `nginx_check_support`.
+*   Add Alpine 3.12 to the list of supported platforms.
+*   Remove Alpine 3.8 from the list of supported platforms.
 
 ENHANCEMENTS:
 
+*   Major backend refactoring to reduce the number of files and tasks.
+*   You can now specify an `nginx_repository` for NGINX Plus too.
+*   Moved "constant" variables to `vars/main.yml`.
+*   Included deprecation warnings in task names and files.
+*   Improved tasks naming conventions.
 *   Update Ansible to `2.9.13` and Ansible Lint to `4.3.4`.
 
 BUG FIXES:
 
-*   NGINX Plus repository data for RedHat based distros is now appropriately set.
+*   NGINX Plus repository data for RHEL based distros is now appropriately set.
 
 ## 0.16.0 (August 28, 2020)
 
@@ -47,7 +58,7 @@ DEPRECATION WARNING:
 With the advent of Ansible collections and to reduce the overhead of this role, the decision has been made to split this role into three smaller roles:
 *   The NGINX Ansible role will keep working as is and be used to install and setup NGINX.
 *   There now is a separate role to manage and create NGINX configurations available [here](https://github.com/nginxinc/ansible-role-nginx-config). Any new issues or PRs related to configuring NGINX should be submitted in the new NGINX Config repository. New issues or PRs related to configuring NGINX submitted in this repository will not be worked on. The NGINX configuration functionalities included in this role will be removed in an upcoming release.
-*   NGINX Unit has a separate role available [here](https://github.com/nginxinc/ansible-role-nginx-unit). Any new issues or PRs related to NGINX Unit should be submitted in the new NGINX Unit repository. New issues or PRs related to NGINX Unit submitted in this repository will not be worked on. The NGINX Unit functionalities included in this role will be removed in an upcoming release.
+*   NGINX Unit now has a separate role available [here](https://github.com/nginxinc/ansible-role-nginx-unit). Any new issues or PRs related to NGINX Unit should be submitted in the new NGINX Unit repository. New issues or PRs related to NGINX Unit submitted in this repository will not be worked on. The NGINX Unit functionalities included in this role will be removed in an upcoming release.
 
 BREAKING CHANGES:
 

CONTRIBUTING.md

@@ -14,25 +14,26 @@ The following is a set of guidelines for contributing to the NGINX Ansible role.
 *   [Git Guidelines](#git-guidelines)
 *   [Ansible Guidelines](#ansible-guidelines)
 
-[Code of Conduct](https://github.com/nginxinc/ansible-role-nginx/blob/master/CODE_OF_CONDUCT.md)
+[Code of Conduct](https://github.com/nginxinc/ansible-role-nginx/blob/main/CODE_OF_CONDUCT.md)
 
 ## Ask a Question
 
-Don't know how something works? Curious if the role can achieve your desired functionality. Please open an Issue on GitHub with the label `question`.
+Don't know how something works? Curious if the role can achieve your desired functionality? Please open an Issue on GitHub with the label `question`.
 
 ## Getting Started
 
-Follow our [Installation Guide](https://github.com/nginxinc/ansible-role-nginx/blob/master/README.md#Installation) to install Ansible and Molecule and get ready to use the NGINX Ansible role.
+Follow our [Installation Guide](https://github.com/nginxinc/ansible-role-nginx/blob/main/README.md#Installation) to install Ansible and Molecule and get ready to use the NGINX Ansible role.
 
 ### Project Structure
 
 *   The NGINX Ansible role is written in `yaml` and supports NGINX Open Source, NGINX Plus, NGINX Amplify, and NGINX Unit.
-*   The project follows the standard [Ansible role directory structure](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html)
-    *   The main code is found in `tasks/`
-    *   The main variables can be found in `defaults/main/*.yml`
-    *   Configuration templates for NGINX can be found in `templates/`
+*   The project follows the standard [Ansible role directory structure](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html):
+    *   The main code is found in `tasks/`.
+    *   Variables can be found in `defaults/main/*.yml`.
+    *   "Constant" variables can be found in `vars/main.yml`.
+    *   Configuration templates for NGINX can be found in `templates/`.
     *   [Molecule](https://molecule.readthedocs.io/) tests can be found in `molecule/`.
-    *   CI/CD is done via Travis using `.travis.yml` deployment yaml files
+    *   CI/CD is done via Travis using `.travis.yml` deployment `yaml` files.
 
 ## Contributing
 
@@ -46,8 +47,8 @@ To suggest an enhancement, please create an issue on GitHub with the label `enha
 
 ### Open a Pull Request
 
-*   Fork the repo, create a branch, submit a PR when your changes are **tested** (ideally using Molecule) and ready for review
-*   Fill in [our pull request template](https://github.com/nginxinc/ansible-role-nginx/blob/master/.github/PULL_REQUEST_TEMPLATE.md)
+*   Fork the repo, create a branch, submit a PR when your changes are **tested** (ideally using Molecule) and ready for review.
+*   Fill in [our pull request template](https://github.com/nginxinc/ansible-role-nginx/blob/main/.github/PULL_REQUEST_TEMPLATE.md).
 
 Note: if you’d like to implement a new feature, please consider creating a feature request issue first to start a discussion about the feature.
 
@@ -63,10 +64,10 @@ Note: if you’d like to implement a new feature, please consider creating a fea
 
 ### Git Guidelines
 
-*   Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR
-*   Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarised in the next few points
-    *   In the subject line, use the present tense ("Add feature" not "Added feature")
-    *   In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...")
-    *   Limit the subject line to 72 characters or less
-    *   Reference issues and pull requests liberally after the subject line
-    *   Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in your text editor to write a good message instead of `git commit -am`)
+*   Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR.
+*   Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarised in the next few points:
+    *   In the subject line, use the present tense ("Add feature" not "Added feature").
+    *   In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
+    *   Limit the subject line to 72 characters or less.
+    *   Reference issues and pull requests liberally after the subject line.
+    *   Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in your text editor to write a good message instead of `git commit -am`).

README.md

@@ -10,8 +10,10 @@ This role installs NGINX Open Source, NGINX Plus, the NGINX Amplify agent, or NG
 
 **Deprecation Warnings:**
 
-*   There now is a separate role to manage and create NGINX configurations available [here](https://github.com/nginxinc/ansible-role-nginx-config). Any new issues or PRs related to configuring NGINX should be submitted in the new NGINX Config repository. New issues or PRs related to configuring NGINX submitted in this repository will not be worked on (with the exception of major bugfixes). The NGINX configuration functionalities included in this role will be removed in an upcoming release.
-*   NGINX Unit now has a separate role available [here](https://github.com/nginxinc/ansible-role-nginx-unit). Any new issues or PRs related to NGINX Unit should be submitted in the new NGINX Unit repository. New issues or PRs related to NGINX Unit submitted in this repository will not be worked on (with the exception of major bugfixes). The NGINX Unit functionalities included in this role will be removed in an upcoming release.
+With the advent of Ansible collections and to reduce the overhead of this role, the decision has been made to split this role into three smaller roles:
+*   The NGINX Ansible role will keep working as is and be used to install and setup NGINX.
+*   There now is a separate role to manage and create NGINX configurations available [here](https://github.com/nginxinc/ansible-role-nginx-config). Any new issues or PRs related to configuring NGINX should be submitted in the new NGINX Config repository. New issues or PRs related to configuring NGINX submitted in this repository will not be worked on. The NGINX configuration functionalities included in this role will be removed in an upcoming release.
+*   NGINX Unit now has a separate role available [here](https://github.com/nginxinc/ansible-role-nginx-unit). Any new issues or PRs related to NGINX Unit should be submitted in the new NGINX Unit repository. New issues or PRs related to NGINX Unit submitted in this repository will not be worked on. The NGINX Unit functionalities included in this role will be removed in an upcoming release.
 
 Requirements
 ------------
@@ -42,7 +44,7 @@ Use `git clone https://github.com/nginxinc/ansible-role-nginx.git` to pull the l
 Platforms
 ---------
 
-The NGINX Ansible role supports all platforms supported by [NGINX Open Source](https://nginx.org/en/linux_packages.html#mainline), [NGINX Plus](https://www.nginx.com/products/technical-specs/), the [NGINX Amplify agent](https://github.com/nginxinc/nginx-amplify-doc/blob/master/amplify-faq.md#21-what-operating-systems-are-supported), and [NGINX Unit](https://unit.nginx.org/installation/#official-packages):
+The NGINX Ansible role supports all platforms supported by [NGINX Open Source](https://nginx.org/en/linux_packages.html), [NGINX Plus](https://docs.nginx.com/nginx/technical-specs/), the [NGINX Amplify agent](https://github.com/nginxinc/nginx-amplify-doc/blob/master/amplify-faq.md#21-what-operating-systems-are-supported), and [NGINX Unit](https://unit.nginx.org/installation/#official-packages) (you can also use this role to compile NGINX Open Source from source or install it on BSD systems at your own risk):
 
 **NGINX Open Source**
 
@@ -54,15 +56,12 @@ Alpine:
   - 3.12
 CentOS:
   - 6
-  - 7
+  - 7.4+
   - 8
 Debian:
   - stretch
   - buster
-FreeBSD:
-  - 11.2+
-  - 12
-RedHat:
+Red Hat:
   - 6
   - 7.4+
   - 8
@@ -72,6 +71,7 @@ SUSE/SLES:
 Ubuntu:
   - xenial
   - bionic
+  - eoan
   - focal
 ```
 
@@ -82,7 +82,6 @@ Alpine:
   - 3.9
   - 3.10
   - 3.11
-  - 3.12
 Amazon Linux:
   - 2018.03
 Amazon Linux 2:
@@ -100,7 +99,7 @@ FreeBSD:
 Oracle Linux:
   - 6.5+
   - 7.4+
-RedHat:
+Red Hat:
   - 6.5+
   - 7.4+
   - 8
@@ -110,6 +109,7 @@ SUSE/SLES:
 Ubuntu:
   - xenial
   - bionic
+  - eoan
   - focal
 ```
 
@@ -124,7 +124,7 @@ CentOS:
 Debian:
   - jessie
   - stretch
-RedHat:
+Red Hat:
   - 6
   - 7
 Ubuntu:
@@ -147,7 +147,7 @@ CentOS:
 Debian:
   - stretch
   - buster
-RedHat:
+Red Hat:
   - 6
   - 7
   - 8
@@ -160,7 +160,7 @@ Ubuntu:
 Role Variables
 --------------
 
-This role has multiple variables. The descriptions and defaults for all these variables can be found in the **`defaults/main`** directory in the following files:
+This role has multiple variables. The descriptions and defaults for all these variables can be found in the **`defaults/main/`** directory in the following files:
 
 -   **[defaults/main/main.yml](https://github.com/nginxinc/ansible-role-nginx/blob/main/defaults/main/main.yml):** NGINX installation variables
 -   **[defaults/main/amplify.yml](https://github.com/nginxinc/ansible-role-nginx/blob/main/defaults/main/amplify.yml):** NGINX Amplify agent installation variables
@@ -170,14 +170,14 @@ This role has multiple variables. The descriptions and defaults for all these va
 -   **[defaults/main/bsd.yml](https://github.com/nginxinc/ansible-role-nginx/blob/main/defaults/main/bsd.yml):** BSD installation variables
 -   **[defaults/main/unit.yml](https://github.com/nginxinc/ansible-role-nginx/blob/main/defaults/main/unit.yml):** NGINX Unit installation variables
 
-Similarly, descriptions and defaults for preset variables can be found in the **`vars`** directory:
+Similarly, descriptions and defaults for preset variables can be found in the **`vars/`** directory in the following files:
 
--   **[vars/main.yml](https://github.com/nginxinc/ansible-role-nginx/blob/main/vars/main.yml):** NGINX supported modules
+-   **[vars/main.yml](https://github.com/nginxinc/ansible-role-nginx/blob/main/vars/main.yml):** List of supported NGINX platforms and modules
 
 Example Playbooks
 -----------------
 
-Working functional playbook examples can be found in the **`molecule/common`** directory in the following files:
+Working functional playbook examples can be found in the **`molecule/common/`** directory in the following files:
 
 -   **[molecule/common/playbooks/default_converge.yml](https://github.com/nginxinc/ansible-role-nginx/blob/main/molecule/common/playbooks/default_converge.yml):** Install a specific version of NGINX and set up logrotate
 -   **[molecule/common/playbooks/module_converge.yml](https://github.com/nginxinc/ansible-role-nginx/blob/main/molecule/common/playbooks/module_converge.yml):** Install various NGINX supported modules

defaults/main/bsd.yml

@@ -1,11 +1,4 @@
 ---
-# Supported distributions
-nginx_bsd_systems: ['FreeBSD', 'NetBSD', 'OpenBSD', 'DragonFlyBSD', 'HardenedBSD']
-
-# Supported distributions NGINX Plus
-# https://docs.nginx.com/nginx/technical-specs/
-nginx_plus_bsd_systems: ['FreeBSD']
-
 # Choose to install BSD packages or ports.
 # Options are true for packages or false for ports.
 # Default is true.
@@ -21,6 +14,3 @@ nginx_bsd_update_ports: true
 # Options are true for use packages or false for do not use packages.
 # Default is true.
 nginx_bsd_portinstall_use_packages: true
-
-# FreeBSD extra packages
-nginx_freebsd_extra_packages: ['security/ca_root_nss']