fix!: backwards compatibility with nested vars

Identified in `ansible-core < 2.15` nested vars will not be evaluated
within templates that are loaded via `extends` or `includes`. The
solution involves using `lookup('template', ...)` to ensure support
dating back to `2.12`. Unfortunately `lookup` does not have access to
the macro defined in `workflows.yml` nor does it inherit the
`block_*_string` and `variable_*_string` from the
`ansible.builtin.template` module as defined within `tasks/main.yml`.
Also `lookup` does not support setting `block_*_string``

NOTE: this is not ideal due to the duplication and the changing of
block/variable markers. Whilst low priority should be improved/replaced
in the future.

Author: jackhodgkiss

roles/github/templates/generic.yml.j2

@@ -11,8 +11,7 @@
 <%- if github_environment_selector == 'single' -%>
 <%- set _ = github_kayobe_arguments.update({"KAYOBE_ENVIRONMENT": github_kayobe_environments | first}) -%>
 <%- endif -%>
-<% include "header.yml.j2" +%>
-
+%% lookup('template', 'header.yml.j2') %%
 jobs:
   prepare-runner:
     uses: ./.github/workflows/prepare-runner.yml

roles/github/templates/header.yml.j2

@@ -1,20 +1,30 @@
-name: %% format_file_name(workflow.file_name, is_title=true) %%
+{%- macro format_file_name(file_name, is_title=false, is_subtitle=false) -%}
+  {%- set formatted_name = file_name | splitext | first -%}
+  {%- if is_title -%}
+    {%- set formatted_name = formatted_name | replace('-', ' ') | title | regex_replace('Vm','VM') -%}
+  {%- endif -%}
+  {%- if is_subtitle -%}
+    {%- set formatted_name = formatted_name | replace('-', ' ') | capitalize | regex_replace('vm','VM') -%}
+  {%- endif -%}
+  {{ formatted_name }}
+{%- endmacro -%}
+name: {{ format_file_name(workflow.file_name, is_title=true) }}
 
 on:
-<%- if workflow.trigger is defined +%>
-  <%- for trigger_name in workflow.trigger.keys() +%>
-  <%- if trigger_name == 'schedule' +%>
+{%- if workflow.trigger is defined +%}
+  {%- for trigger_name in workflow.trigger.keys() +%}
+  {%- if trigger_name == 'schedule' +%}
   schedule:
-    - cron: '%% workflow.trigger['schedule']['cron'] %%'
-  <%- elif trigger_name == 'workflow_dispatch' +%>
+    - cron: '{{ workflow.trigger['schedule']['cron'] }}'
+  {%- elif trigger_name == 'workflow_dispatch' +%}
   workflow_dispatch:
-    <%- if workflow.trigger['workflow_dispatch'] is not none +%>
+    {%- if workflow.trigger['workflow_dispatch'] is not none +%}
     inputs:
-      %% workflow.trigger['workflow_dispatch'] | flatten | join('') | indent(6) | trim %%
-    <%- if github_environment_selector == 'input' +%>
-      %% github_kayobe_environment_input | flatten | join('') | indent(6) | trim %%
-    <%- endif +%>
-    <%- endif +%>
-  <%- endif +%>
-  <%- endfor +%>
-<%- endif +%>
+      {{ workflow.trigger['workflow_dispatch'] | flatten | join('') | indent(6) | trim }}
+    {%- if github_environment_selector == 'input' +%}
+      {{ github_kayobe_environment_input | flatten | join('') | indent(6) | trim }}
+    {%- endif +%}
+    {%- endif +%}
+  {%- endif +%}
+  {%- endfor +%}
+{%- endif -%}

roles/github/templates/run-tempest.yml.j2

@@ -12,28 +12,7 @@
 <%- if github_environment_selector == 'single' -%>
 <%- set _ = github_kayobe_arguments.update({"KAYOBE_ENVIRONMENT": github_kayobe_environments[0] }) -%>
 <%- endif -%>
-name: %% format_file_name(workflow.file_name, is_title=true) %%
-
-on:
-  workflow_dispatch:
-    inputs:
-      test_suite:
-        description: |
-          The list of tests to run. This should be a name of file under
-          .automation.conf/tempest/load-lists. Defaults to running
-          default test suite.
-        required: false
-        default: 'default'
-        type: choice
-        options:
-          %% workflow.test_suites | flatten | join('') | indent(10) | trim %%
-      tempest_pattern:
-        description: |
-          Limit tests to this regex. Takes precedence over testSuite.
-      <%- if github_environment_selector == 'input' +%>
-      %% github_kayobe_environment_input | flatten | join('') | indent(6) | trim %%
-      <%- endif +%>
-
+%% lookup('template', 'tempest-header.yml.j2') %%
 jobs:
   prepare-runner:
     uses: ./.github/workflows/prepare-runner.yml

roles/github/templates/tempest-header.yml.j2

@@ -0,0 +1,31 @@
+{%- macro format_file_name(file_name, is_title=false, is_subtitle=false) -%}
+  {%- set formatted_name = file_name | splitext | first -%}
+  {%- if is_title -%}
+    {%- set formatted_name = formatted_name | replace('-', ' ') | title | regex_replace('Vm','VM') -%}
+  {%- endif -%}
+  {%- if is_subtitle -%}
+    {%- set formatted_name = formatted_name | replace('-', ' ') | capitalize | regex_replace('vm','VM') -%}
+  {%- endif -%}
+  {{ formatted_name }}
+{%- endmacro -%}
+name: {{ format_file_name(workflow.file_name, is_title=true) }}
+
+on:
+  workflow_dispatch:
+    inputs:
+      test_suite:
+        description: |
+          The list of tests to run. This should be a name of file under
+          .automation.conf/tempest/load-lists. Defaults to running
+          default test suite.
+        required: false
+        default: 'default'
+        type: choice
+        options:
+          {{ workflow.test_suites | flatten | join('') | indent(10) | trim }}
+      tempest_pattern:
+        description: |
+          Limit tests to this regex. Takes precedence over testSuite.
+      {%- if github_environment_selector == 'input' +%}
+      {{ github_kayobe_environment_input | flatten | join('') | indent(6) | trim }}
+      {%- endif +%}