fix: refactor module structure

.github/workflows/test.yml

@@ -11,17 +11,26 @@ env:
   DOMAIN_NAME: "pr-${{ github.run_id }}-caddy"
   DOMAIN_SUFFIX: "test.stackhead.io"
 
+# You should not need to change anything below.
+
 jobs:
   smoke:
     name: Smoketest test-tf-generation
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - name: Install Ansible v2.10 alpha (GH actions currently uses 2.9)
-        run: ANSIBLE_SKIP_CONFLICT_CHECK=1 pip install --user ansible==2.10.0a9 && ansible --version
+      - name: Remove Python 2 and old Ansible 2.9 version
+        run: sudo apt purge python ansible -y
+      - name: Set up Python 3
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+      - name: Install Ansible v2.10.3 (GH actions currently uses 2.9)
+        run: pip install ansible==2.10.3
+      - name: Print Ansible and Python version
+        run: ansible --version && python --version
       - name: Get latest StackHead version
         run: ansible-galaxy collection install git+https://github.com/getstackhead/stackhead.git,next -f
-      - run: pip install -r ./requirements/pip.txt
       - run: ansible-playbook ./__tests__/test-tf-generation.yml
 
   checkLabel:
@@ -36,82 +45,81 @@ jobs:
     needs: checkLabel
     runs-on: ubuntu-latest
     if: github.event.pull_request.draft == false
-    env:
-      INVENTORY_PATH: __tests__/inventory.yml
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python 3
-      uses: actions/setup-python@v2
-      with:
-        python-version: '3.x'
-    - name: Uninstall old Ansible
-      run: ansible --version && sudo apt purge ansible -y
-    - name: Install Ansible v2.10 alpha (GH actions currently uses 2.9)
-      run: sudo python -m pip install ansible==2.10.0a9 && ansible --version
-    - run: pip install -r ./requirements/pip.txt
-    - name: Print Ansible version
-      run: ansible --version
-    - uses: webfactory/[email protected]
-      with:
-        ssh-private-key: "${{ secrets.SSH_PRIVATE_KEY }}"
-    - name: Setup Hetzner server
-      id: setup_server
-      uses: saitho/[email protected]
-      with:
-        action: create
-        server_name: "${{ env.DOMAIN_NAME }}"
-        server_image: ubuntu-18.04
-        server_location: fsn1
-        server_ssh_key_name: gh-actions
-        wait_for_ssh: 1
-      env:
-        API_TOKEN: ${{ secrets.HETZNER_TOKEN }}
-    - name: Add DNS record
-      uses: saitho/create-dns-record@patch-1
-      with:
-        type: "A"
-        name: "${{ env.DOMAIN_NAME }}.${{ env.DOMAIN_SUFFIX }}"
-        content: "${{ steps.setup_server.outputs.hcloud_server_created_ipv4 }}"
-        ttl: 1
-        proxied: 0
-        token: "${{ secrets.CLOUDFLARE_TOKEN }}"
-        zone: "${{ secrets.CLOUDFLARE_ZONE }}"
-    - name: Add DNS record for subdomain
-      uses: saitho/create-dns-record@patch-1
-      with:
-        type: "A"
-        name: "sub.${{ env.DOMAIN_NAME }}.${{ env.DOMAIN_SUFFIX }}"
-        content: "${{ steps.setup_server.outputs.hcloud_server_created_ipv4 }}"
-        ttl: 1
-        proxied: 0
-        token: "${{ secrets.CLOUDFLARE_TOKEN }}"
-        zone: "${{ secrets.CLOUDFLARE_ZONE }}"
-    - uses: getstackhead/stackhead/actions/integration-test@next
-      with:
-        ipaddress: ${{ steps.setup_server.outputs.hcloud_server_created_ipv4 }}
-        domain: '${{ env.DOMAIN_NAME }}.${{ env.DOMAIN_SUFFIX }}'
-        domain2: 'sub.${{ env.DOMAIN_NAME }}.${{ env.DOMAIN_SUFFIX }}'
-        webserver: '${{ env.WEBSERVER }}'
-        rolename: '${{ env.ROLE_NAME }}'
-    - name: Remove DNS record
-      uses: saitho/delete-dns-record@saitho-patch-1
-      if: always()
-      with:
-        name: "${{ env.DOMAIN_NAME }}.${{ env.DOMAIN_SUFFIX }}"
-        token: "${{ secrets.CLOUDFLARE_TOKEN }}"
-        zone: "${{ secrets.CLOUDFLARE_ZONE }}"
-    - name: Remove DNS record for subdomain
-      uses: saitho/delete-dns-record@saitho-patch-1
-      if: always()
-      with:
-        name: "sub.${{ env.DOMAIN_NAME }}.${{ env.DOMAIN_SUFFIX }}"
-        token: "${{ secrets.CLOUDFLARE_TOKEN }}"
-        zone: "${{ secrets.CLOUDFLARE_ZONE }}"
-    - name: Remove Hetzner server
-      uses: saitho/[email protected]
-      if: always()
-      with:
-        action: remove
-        server_id: "${{ steps.setup_server.outputs.hcloud_server_id }}"
-      env:
-        API_TOKEN: ${{ secrets.HETZNER_TOKEN }}
+      - uses: actions/checkout@v2
+      - name: Remove Python 2 and old Ansible 2.9 version
+        run: sudo apt purge python ansible -y
+      - name: Set up Python 3
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+      - name: Install Ansible v2.10.3 (GH actions currently uses 2.9)
+        run: pip install ansible==2.10.3
+      - name: Print Ansible and Python version
+        run: ansible --version && python --version
+      - uses: webfactory/[email protected]
+        with:
+          ssh-private-key: "${{ secrets.SSH_PRIVATE_KEY }}"
+      - name: Setup Hetzner server
+        id: setup_server
+        uses: saitho/[email protected]
+        with:
+          action: create
+          server_name: "${{ env.DOMAIN_NAME }}"
+          server_image: ubuntu-18.04
+          server_location: fsn1
+          server_ssh_key_name: gh-actions
+          wait_for_ssh: 1
+        env:
+          API_TOKEN: ${{ secrets.HETZNER_TOKEN }}
+      - name: Add DNS record
+        uses: saitho/create-dns-record@patch-1
+        with:
+          type: "A"
+          name: "${{ env.DOMAIN_NAME }}.${{ env.DOMAIN_SUFFIX }}"
+          content: "${{ steps.setup_server.outputs.hcloud_server_created_ipv4 }}"
+          ttl: 1
+          proxied: 0
+          token: "${{ secrets.CLOUDFLARE_TOKEN }}"
+          zone: "${{ secrets.CLOUDFLARE_ZONE }}"
+      - name: Add DNS record for subdomain
+        uses: saitho/create-dns-record@patch-1
+        with:
+          type: "A"
+          name: "sub.${{ env.DOMAIN_NAME }}.${{ env.DOMAIN_SUFFIX }}"
+          content: "${{ steps.setup_server.outputs.hcloud_server_created_ipv4 }}"
+          ttl: 1
+          proxied: 0
+          token: "${{ secrets.CLOUDFLARE_TOKEN }}"
+          zone: "${{ secrets.CLOUDFLARE_ZONE }}"
+      - name: Install samdoran.caddy dependency
+        run: ansible-galaxy install samdoran.caddy,2.1.0
+      - uses: getstackhead/stackhead/actions/integration-test@next
+        with:
+          ipaddress: ${{ steps.setup_server.outputs.hcloud_server_created_ipv4 }}
+          domain: '${{ env.DOMAIN_NAME }}.${{ env.DOMAIN_SUFFIX }}'
+          domain2: 'sub.${{ env.DOMAIN_NAME }}.${{ env.DOMAIN_SUFFIX }}'
+          webserver: '${{ env.WEBSERVER }}'
+          rolename: '${{ env.ROLE_NAME }}'
+      - name: Remove DNS record
+        uses: saitho/delete-dns-record@saitho-patch-1
+        if: always() && !contains( github.event.pull_request.labels.*.name, 'action/keep-integration-stage')
+        with:
+          name: "${{ env.DOMAIN_NAME }}.${{ env.DOMAIN_SUFFIX }}"
+          token: "${{ secrets.CLOUDFLARE_TOKEN }}"
+          zone: "${{ secrets.CLOUDFLARE_ZONE }}"
+      - name: Remove DNS record for subdomain
+        uses: saitho/delete-dns-record@saitho-patch-1
+        if: always() && !contains( github.event.pull_request.labels.*.name, 'action/keep-integration-stage')
+        with:
+          name: "sub.${{ env.DOMAIN_NAME }}.${{ env.DOMAIN_SUFFIX }}"
+          token: "${{ secrets.CLOUDFLARE_TOKEN }}"
+          zone: "${{ secrets.CLOUDFLARE_ZONE }}"
+      - name: Remove Hetzner server
+        uses: saitho/[email protected]
+        if: always() && !contains( github.event.pull_request.labels.*.name, 'action/keep-integration-stage')
+        with:
+          action: remove
+          server_id: "${{ steps.setup_server.outputs.hcloud_server_id }}"
+        env:
+          API_TOKEN: ${{ secrets.HETZNER_TOKEN }}

__tests__/test-tf-generation.yml

@@ -11,9 +11,9 @@
       with_items: "{{ app_config.domains }}"
     - block:
         - name: Generate Caddy Terraform file
-          import_tasks: "../tasks/steps/generate-serverconfig-tf.yml"
+          import_tasks: "{{ module_role_path | default(role_path) }}/tasks/caddy_steps/generate-serverconfig-tf.yml"
         - name: Generate Caddyfile
-          import_tasks: "../tasks/steps/generate-caddyfile-tf.yml"
+          import_tasks: "{{ module_role_path | default(role_path) }}/tasks/caddy_steps/generate-caddyfile-tf.yml"
       vars:
         module_role_path: ".."
         caddy_root: "."

meta/main.yml

@@ -14,8 +14,5 @@ galaxy_info:
     - caddyserver
 
 dependencies:
-  #- name: samdoran.caddy
-  #  version: v1.0.0
-  - src: git+https://github.com/saitho/ansible-role-caddy.git
-    version: caddy-v2
-    name: samdoran.caddy
+  - name: samdoran.caddy
+    version: 2.1.0

stackhead-module.yml

@@ -5,5 +5,3 @@ terraform:
     vendor: getstackhead
     name: caddy
     version: 1.0.1
-    # deprecated: remove url with Terraform 0.13 in main project
-    url: https://github.com/getstackhead/terraform-caddy/releases/download/v1.0.0/terraform-provider-caddy

tasks/steps/generate-serverconfig-tf.yml → tasks/caddy_steps/generate-serverconfig-tf.yml

@@ -1,5 +1,11 @@
 ---
 - block:
+    - debug:
+        msg: "{{ module_role_path }}"
+    - debug:
+        msg: "{{ role_path|d() }}"
+    - debug:
+        msg: "{{ module_role_path|default(role_path) }}/templates/terraform/caddy_server.tf.j2"
     - template:
         src: "{{ module_role_path|default(role_path) }}/templates/terraform/caddy_server.tf.j2"
         dest: "{{ dest_file }}"

tasks/deploy.yml → tasks/steps/deploy.yml

@@ -1,15 +1,11 @@
 # This task list generates the Caddy configuration for a project
 ---
-- name: Include OS-specific variables.
-  include_vars: "{{ ansible_os_family }}.yml"
-  ignore_errors: yes
-
 - name: Check if authentications are defined
   set_fact:
     auths_basic: "{{ auths_basic|default([]) + item.security.authentication }}"
   when: item.security is defined and item.security.authentication is defined
   with_items: "{{ app_config.domains }}"
 
 - name: Generate Caddy Terraform file
-  include_tasks: "{{ module_role_path|default(role_path) }}/tasks/steps/generate-serverconfig-tf.yml"
+  include_tasks: "{{ module_role_path|default(role_path) }}/tasks/caddy_steps/generate-serverconfig-tf.yml"
 

tasks/setup.yml → tasks/steps/setup.yml

@@ -1,18 +1,10 @@
 # This task list sets up Caddy during server setup
 ---
-- debug:
-    msg: "{{ caddy_install_source }}"
-- debug:
-    msg: "{{ caddy_install_source }}"
-  vars:
-    caddy_install_source: package
 - name: Setup Caddy
   include_role:
     name: samdoran.caddy
-  vars:
-    caddy_install_source: package
 - name: Overwrite Caddyfile
-  include_tasks: "{{ module_role_path|default(role_path) }}/tasks/steps/generate-caddyfile-tf.yml"
+  include_tasks: "{{ module_role_path|default(role_path) }}/tasks/caddy_steps/generate-caddyfile-tf.yml"
 - name: Restart Caddy
   command: /bin/true
   notify:
@@ -22,6 +14,6 @@
     url: "http://{{ ansible_default_ipv4.address|default(ansible_all_ipv4_addresses[0]) }}"
     return_content: yes
   register: uri_result
-  until: '"Caddy web server" in uri_result.content'
+  until: '"Caddy" in uri_result.content'
   retries: 5
-  delay: 1
+  delay: 5

templates/caddy/Caddyfile.j2

@@ -1,7 +1,7 @@
 #jinja2: trim_blocks:False
 {
 {% if lookup('env','TEST') == '1' %}    acme_ca https://acme-staging-v02.api.letsencrypt.org/directory{% endif %}
-    email [email protected]
+    email {{ certificates_email_address }}
 }
 
 *:80 {
@@ -10,4 +10,4 @@
     file_server
 }
 
-import conf.d/*.conf
+import conf.d/*.conf

vars/main.yml

@@ -1,5 +1,3 @@
 ---
 caddy_user: "stackhead"
 caddy_group: "stackhead"
-caddy_version: "2.1.1"
-caddy_install_source: "package"