Merge pull request #91 from idealista/develop

Resolved #86 issue

.github/ISSUE_TEMPLATE/config.yml

@@ -1 +1,2 @@
+---
 blank_issues_enabled: false

.github/auto_assign.yml

@@ -1,3 +1,4 @@
+---
 # Set to true to add reviewers to pull requests
 addReviewers: true
 

.github/stale.yml

@@ -1,3 +1,4 @@
+---
 issues:
   # Number of days of inactivity before an issue becomes stale
   daysUntilStale: 90

.travis.yml

@@ -1,16 +1,22 @@
 ---
-dist: xenial
+dist: focal
 language: python
-python: "3.7"
+python: "3.9"
 os: linux
 services:
   - docker
 install:
-  - pip3 install cookiecutter
+  - pip install pipenv
 env:
   jobs:
-    - MOLECULE_DISTRO=debian:stretch-slim
+    - MOLECULE_DISTRO=debian:bullseye-slim
     - MOLECULE_DISTRO=debian:buster-slim
-    
 script:
-  - ./test.sh
+  - ./test.sh
+notifications:
+  email:
+    if: branch = master
+    on_success: change
+    on_failure: always
+    recipients:
+      - desarrollo.benders@idealista.com

CHANGELOG.md

@@ -3,9 +3,41 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a changelog](https://github.com/olivierlacan/keep-a-changelog).
 
 ## Unreleased
+## [2.9.0](https://github.com/idealista/cookiecutter-ansible-role/tree/2.9.0)
+### [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.8.1...2.9.0)
+### Changed
+- *[#86](https://github.com/idealista/cookiecutter-ansible-role/issues/86) Upgrade molecule config to test under debian bullseye* @santi-eidu
+- *[#86](https://github.com/idealista/cookiecutter-ansible-role/issues/86) Upgrade ansible to v5.2.0 and ansible lint to v5.3.2 to avoid lint error* @santi-eidu
+## [2.8.1](https://github.com/idealista/cookiecutter-ansible-role/tree/2.8.1)
+### [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.8.0...2.8.1)
+### Fixed
+- *[#87](https://github.com/idealista/cookiecutter-ansible-role/issues/87) Travis build image and link are broken in the README template* @emepege
+
+## [2.8.0](https://github.com/idealista/cookiecutter-ansible-role/tree/2.8.0)
+### [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.7.0...2.8.0)
 ### Added
+- *[#81](https://github.com/idealista/cookiecutter-ansible-role/issues/81) Add log path variable in defaults* @blalop
+- *[#79](https://github.com/idealista/cookiecutter-ansible-role/issues/79) Add molecule-docker support* @blalop
+- *[#79](https://github.com/idealista/cookiecutter-ansible-role/issues/79) Add default versions for Python packages* @blalop
+- *[#83](https://github.com/idealista/cookiecutter-ansible-role/issues/83) Don't leave empty lines when using jinja* @blalop
+
+## [2.7.0](https://github.com/idealista/cookiecutter-ansible-role/tree/2.7.0)
+### [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.6.1...2.7.0)
+### Added
+- *[#76](https://github.com/idealista/cookiecutter-ansible-role/issues/76) Create shell user variable* @emepege
+
+## [2.6.1](https://github.com/idealista/cookiecutter-ansible-role/tree/2.6.1)
+### [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.6.0...2.6.1)
+### Changed
+- *[#73](https://github.com/idealista/cookiecutter-ansible-role/issues/73) Add document start to .yml files* @blalop
+
+## [2.6.0](https://github.com/idealista/cookiecutter-ansible-role/tree/2.6.0)
+### [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.5.1...2.6.0)
+### Added
+- *[#69](https://github.com/idealista/cookiecutter-ansible-role/issues/69) Email notifications in travis.* @vicsufer
 ### Changed
 ### Fixed
+- *[#67](https://github.com/idealista/cookiecutter-ansible-role/issues/67) fix needed task in check_mode- @vicsufer
 ### Removed
 
 ## [2.5.1](https://github.com/idealista/cookiecutter-ansible-role/tree/2.5.1)

README.md

@@ -1,9 +1,7 @@
 # Cookiecutter Ansible Role
 ![Logo](https://raw.githubusercontent.com/idealista/cookiecutter-ansible-role/master/logo.gif)
 
-[![Build Status](https://travis-ci.com/idealista/cookiecutter-ansible-role.png)](https://travis-ci.com/idealista/cookiecutter-ansible-role)
-
-
+[![Build Status](https://travis-ci.org/idealista/cookiecutter-ansible-role.png)](https://travis-ci.com/idealista/cookiecutter-ansible-role)
 
 This cookiecutter generates an [ansible role](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html).
 
@@ -46,15 +44,15 @@ github_user [idealista]:
 company [Idealista S.A.U.]:
 author []: pablogcaldito
 min_ansible_version []: 2.2
-ansible_version []: 2.8.8
+ansible_version []: 5.2.0
 molecule_version []: 3.0.1
 python_docker_version []: 4.1.0
-ansible_lint_version []: 4.2.0
+ansible_lint_version []: 5.3.2
 license [Apache 2.0]:
 galaxy_tag_1 [example_tag1]: github_cli
 galaxy_tag_2 [example_tag2]: github
 galaxy_tag_3 [example_tag3]: cli
-Select debian_stretch_support:
+Select debian_bullseye_support:
 1 - True
 2 - False
 Choose from 1, 2 [1]:

cookiecutter.json

@@ -7,15 +7,16 @@
   "company": "Idealista S.A.U.",
   "author": "",
   "min_ansible_version": "",
-  "ansible_version": "",
-  "molecule_version": "",
-  "python_docker_version": "",
-  "ansible_lint_version":"",
+  "ansible_version": "5.2.0",
+  "molecule_version": "3.4.0",
+  "python_docker_version": "5.0.0",
+  "molecule_docker_version": "0.2.4",
+  "ansible_lint_version":"5.3.2",
   "license":"Apache 2.0",
   "galaxy_tag_1":"example_tag1",
   "galaxy_tag_2":"example_tag2",
   "galaxy_tag_3":"example_tag3",
-  "debian_stretch_support":["True", "False"],
+  "debian_bullseye_support":["True", "False"],
   "debian_buster_support":["True", "False"],
   "has_service":["True", "False"],
   "has_files":["True", "False"],

test.sh

@@ -3,7 +3,22 @@
 set -e
 
 # Generate role
-printf "cookiecutter==1.7.2\nJinja2==2.11.2" > requirements.txt && pipenv install -r requirements.txt && pipenv run cookiecutter . --no-input app_name="github_cli" exec_name="gh" author="John Doe" min_ansible_version="2.2" ansible_version="2.8.6" molecule_version="3.0.1" python_docker_version="4.1.0" ansible_lint_version="4.2.0" has_service="False" has_files="False" has_handlers="False" has_templates="False" documentation_URL="https://cli.github.com/manual/" && rm Pipfile* requirements.txt
+printf "cookiecutter==1.7.2\nJinja2==2.11.2" > requirements.txt && pipenv install -r requirements.txt && pipenv run cookiecutter . --no-input \
+    app_name="github_cli" \
+    exec_name="gh" \
+    author="John Doe" \
+    min_ansible_version="2.2" \
+    ansible_version="5.2.0" \
+    molecule_version="3.4.0" \
+    python_docker_version="5.0.0" \
+    molecule_docker_version="0.2.4" \
+    ansible_lint_version="5.3.2" \
+    has_service="False" \
+    has_files="False" \
+    has_handlers="False" \
+    has_templates="False" \
+    documentation_URL="https://cli.github.com/manual/" && rm Pipfile* requirements.txt
+
 (
     # Adjust the role to test
     cd github_cli_role
@@ -14,7 +29,7 @@ printf "cookiecutter==1.7.2\nJinja2==2.11.2" > requirements.txt && pipenv instal
     # Launch molecule tests
     pipenv install -r test-requirements.txt --three
     pipenv run molecule test
-    
+
 )
 # Cleanup
 rm -rf github_cli_role

{{cookiecutter.app_name}}_role/.github/ISSUE_TEMPLATE/config.yml

@@ -1 +1,3 @@
+---
+
 blank_issues_enabled: false

{{cookiecutter.app_name}}_role/.github/stale.yml

@@ -1,3 +1,4 @@
+---
 issues:
   # Number of days of inactivity before an issue becomes stale
   daysUntilStale: 90

{{cookiecutter.app_name}}_role/README.md

@@ -1,13 +1,13 @@
 # {{ cookiecutter.app_name | replace('_',' ') | title }} Ansible role
 ![Logo](logo.gif)
 
-[![Build Status](https://travis-ci.com/idealista/{{ cookiecutter.app_name }}_role.png)](https://travis-ci.com/idealista/{{ cookiecutter.app_name }}_role)
+[![Build Status](https://app.travis-ci.com/idealista/{{ cookiecutter.app_name }}_role.svg)](https://app.travis-ci.com/github/idealista/{{ cookiecutter.app_name }}_role)
 [![Ansible Galaxy](https://img.shields.io/badge/galaxy-idealista.{{ cookiecutter.app_name }}_role-B62682.svg)](https://galaxy.ansible.com/idealista/{{ cookiecutter.app_name }}_role)
 
 
 
 This ansible role installs {% if cookiecutter.documentation_URL != "" %}[{% endif %}{{ cookiecutter.app_name | replace('_',' ') | title }}{% if cookiecutter.documentation_URL != "" %}]({{ cookiecutter.documentation_URL }}){% endif %} in a Debian environment. It has been tested for the following Debian versions:
-{% if cookiecutter.debian_stretch_support == 'True' %}* Stretch{% endif %}
+{% if cookiecutter.debian_bullseye_support == 'True' %}* Bulleye{% endif %}
 {% if cookiecutter.debian_buster_support == 'True' %}* Buster{% endif %}
 
 This role has been generated using the [cookiecutter](https://github.com/cookiecutter/cookiecutter) tool, you can generate a similar role that fits your needs using the this [cookiecutter template](https://github.com/idealista/cookiecutter-ansible-role).

{{cookiecutter.app_name}}_role/defaults/main.yml

@@ -21,7 +21,7 @@
 # Installation path
 {{ cookiecutter.app_name }}_root_path: /opt/{{ cookiecutter.app_name }}
 {{ cookiecutter.app_name }}_bin_path: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_root_path {% raw %}}}{% endraw %}/bin"
-{{ cookiecutter.app_name }}_skeleton_paths: 
+{{ cookiecutter.app_name }}_skeleton_paths:
   - "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_bin_path {% raw %}}}{% endraw %}"
 {{ cookiecutter.app_name }}_exec_name: {{ cookiecutter.exec_name }}
 {% if cookiecutter.has_service  == 'True' %}
@@ -32,6 +32,7 @@
 # Owner
 {{ cookiecutter.app_name }}_user: exampleuser
 {{ cookiecutter.app_name }}_group: examplegroup
+{{ cookiecutter.app_name }}_user_shell: /usr/sbin/nologin
 
 # Maximum number of files limit
 {{ cookiecutter.app_name }}_max_files: 32768
@@ -44,7 +45,8 @@
 # Logs
 # If wanted to output the logs to a file define the following variable
 # More information at https://www.freedesktop.org/software/systemd/man/systemd.exec.html#StandardOutput=
-# {{ cookiecutter.app_name }}_log_file: path_of_the_file
+# {{ cookiecutter.app_name }}_log_path: /var/log
+# {{ cookiecutter.app_name }}_log_file: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_log_path {% raw %}}}{% endraw %}/{{ cookiecutter.app_name }}.log"
 {{ cookiecutter.app_name }}_log_output: "{% raw %}{%{% endraw %} if {{ cookiecutter.app_name }}_log_file is defined {% raw %}%}{% endraw %} file:{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_log_file {% raw %}}}{% endraw %} {% raw %}{%{% endraw %} else {% raw %}%}{% endraw %} journal {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %}"
 
 # Flags

{{cookiecutter.app_name}}_role/meta/main.yml

@@ -13,5 +13,5 @@ galaxy_info:
   platforms:
     - name: Debian
       versions:
-        {% if cookiecutter.debian_stretch_support == 'True' %}- stretch{% endif %}
+        {% if cookiecutter.debian_bullseye_support == 'True' %}- bullseye{% endif %}
         {% if cookiecutter.debian_buster_support == 'True' %}- buster{% endif %}

{{cookiecutter.app_name}}_role/molecule/default/Dockerfile.j2

@@ -8,5 +8,5 @@ FROM {{ item.image }}
 
 # install minimal packages for debian slim images
 RUN apt-get update && \
-    apt-get install -y python sudo bash ca-certificates iproute2 systemd systemd-sysv python-pip && \
+    apt-get install -y python3 sudo bash ca-certificates iproute2 systemd systemd-sysv python3-pip && \
     apt-get clean{% endraw %}

{{cookiecutter.app_name}}_role/molecule/default/molecule.yml

@@ -10,7 +10,7 @@ platforms:
   - name: {{ cookiecutter.app_name }}
     groups:
       - {{ cookiecutter.app_name }}_group
-    image: ${MOLECULE_DISTRO:-debian:buster-slim}
+    image: ${MOLECULE_DISTRO:-debian:bullseye-slim}
     privileged: false
     capabilities:
       - SYS_ADMIN

{{cookiecutter.app_name}}_role/molecule/default/tests/test_app.yml

@@ -22,17 +22,17 @@ group:
 {% endif %}
 file:
   /opt/{{ cookiecutter.app_name }}:
-    {% if cookiecutter.has_service == 'True' %}
+    {%- if cookiecutter.has_service == 'True' %}
     owner: exampleuser
     group: examplegroup
-    {% endif %}
+    {%- endif %}
     exists: true
     filetype: directory
   /opt/{{ cookiecutter.app_name }}/bin:
-    {% if cookiecutter.has_service == 'True' %}
+    {%- if cookiecutter.has_service == 'True' %}
     owner: exampleuser
     group: examplegroup
-    {% endif %}
+    {%- endif %}
     exists: true
     filetype: directory
 

{{cookiecutter.app_name}}_role/molecule/default/verify.yml

@@ -24,7 +24,7 @@
       get_url:
         url: "{% raw %}{{{% endraw %} goss_url {% raw %}}}{% endraw %}"
         dest: "{% raw %}{{{% endraw %} goss_dst {% raw %}}}{% endraw %}"
-        sha256sum: "{% raw %}{{{% endraw %} goss_sha256sum {% raw %}}}{% endraw %}"
+        checksum: "sha256{% raw %}:{{{% endraw %} goss_sha256sum {% raw %}}}{% endraw %}"
         mode: 0755
       register: download_goss
       until: download_goss is succeeded

{{cookiecutter.app_name}}_role/tasks/install.yml

@@ -13,7 +13,7 @@
     name: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_user {% raw %}}}{% endraw %}"
     group: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_group {% raw %}}}{% endraw %}"
     system: yes
-    shell: /usr/sbin/nologin
+    shell: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_user_shell {% raw %}}}{% endraw %}"
     createhome: no
   tags:
     - {{ cookiecutter.app_name }}_install
@@ -21,10 +21,11 @@
 - name: {{ cookiecutter.app_name | upper }} | Ensure skeleton paths
   file:
     dest: "{% raw %}{{{% endraw %} item {% raw %}}}{% endraw %}"
-{% if cookiecutter.has_service  == 'True' %}
+{%- if cookiecutter.has_service  == 'True' %}
     owner: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_user {% raw %}}}{% endraw %}"
     group: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_group {% raw %}}}{% endraw %}"
-{% endif %}
+{%- endif %}
+    mode: 0755
     state: directory
   with_items:
     - "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_skeleton_paths {% raw %}}}{% endraw %}"
@@ -34,10 +35,11 @@
 - name: {{ cookiecutter.app_name | upper }} | Ensure skeleton log paths
   file:
     dest: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_log_path {% raw %}}}{% endraw %}"
-{% if cookiecutter.has_service  == 'True' %}
+{%- if cookiecutter.has_service  == 'True' %}
     owner: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_user {% raw %}}}{% endraw %}"
     group: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_group {% raw %}}}{% endraw %}"
-{% endif %}
+{%- endif %}
+    mode: 0755
     state: directory
   when: {{ cookiecutter.app_name }}_log_file is defined
   tags:
@@ -48,6 +50,7 @@
   register: {{ cookiecutter.app_name }}_check
   changed_when: false
   ignore_errors: true
+  check_mode: no
   tags:
     - {{ cookiecutter.app_name }}_install
 
@@ -72,10 +75,10 @@
   copy:
     src: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_src_bin {% raw %}}}{% endraw %}"
     dest: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_bin_path {% raw %}}}{% endraw %}/{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_exec_name {% raw %}}}{% endraw %}"
-{% if cookiecutter.has_service  == 'True' %}
+{%- if cookiecutter.has_service  == 'True' %}
     owner: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_user {% raw %}}}{% endraw %}"
     group: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_group {% raw %}}}{% endraw %}"
-{% endif %}
+{%- endif %}
     remote_src: True
     mode: 0755
   when: {{ cookiecutter.app_name }}_force_reinstall or {{ cookiecutter.app_name }}_check is failed or {{ cookiecutter.app_name }}_version not in {{ cookiecutter.app_name }}_check.stderr

{{cookiecutter.app_name}}_role/tasks/main.yml

@@ -1,17 +1,17 @@
 ---
 
 - name: {{ cookiecutter.app_name | upper }} | Install
-  include: install.yml
+  import_tasks: install.yml
   tags:
     - {{ cookiecutter.app_name }}_install
 
 - name: {{ cookiecutter.app_name | upper }} | Configure
-  include: config.yml
+  import_tasks: config.yml
   tags:
     - {{ cookiecutter.app_name }}_configure
 {% if cookiecutter.has_service  == 'True' %}
 - name: {{ cookiecutter.app_name | upper }} | Service
-  include: service.yml
+  import_tasks: service.yml
   tags:
     - {{ cookiecutter.app_name }}_service
 {% endif %}

{{cookiecutter.app_name}}_role/test-requirements.txt

@@ -1,4 +1,5 @@
 ansible=={{ cookiecutter.ansible_version }}
 molecule=={{ cookiecutter.molecule_version }}
 docker=={{ cookiecutter.python_docker_version }}
+molecule-docker=={{ cookiecutter.molecule_docker_version }}
 ansible-lint=={{ cookiecutter.ansible_lint_version }}

{{cookiecutter.app_name}}_role/{% raw %}.travis.yml{% endraw %}

@@ -10,10 +10,16 @@ install:
   - pipenv sync
 env:
   jobs:
-    {% if cookiecutter.debian_stretch_support == 'True' %}- MOLECULE_DISTRO=debian:stretch-slim{% endif %}
     {% if cookiecutter.debian_buster_support == 'True' %}- MOLECULE_DISTRO=debian:buster-slim{% endif %}
+    {% if cookiecutter.debian_bullseye_support == 'True' %}- MOLECULE_DISTRO=debian:bullseye-slim{% endif %}
 script:
   - pipenv run molecule test --all
 
 notifications:
   webhooks: https://galaxy.ansible.com/api/v1/notifications/
+  email:
+    if: branch = main
+    on_success: change
+    on_failure: always
+    recipients:
+      - desarrollo.benders@idealista.com