Add logic to generate Renovate postUpgradeTasks

Previously the test matrix was defined in a local variable and only
accessible in the `.github/workflows/test.yaml` template. However, we
now also need access to the test matrix in the `renovate.json` template,
so that we can generate the correct list of `make gen-golden` commands
as Renovate post-upgrade tasks.

To allow this we move the test matrix configuration to global variable
`testMatrix`. During a transitional period, the GitHub actions template
will continue to read the test matrix from the file-level variable
`matrix`, but will fall back to the global variable `testMatrix` if the
file-level variable is missing.

All already onboarded components should migrate their test matrix (if
any) to global parametr `testMatrix`, to take advantage of having their
golden test outputs updated in Renovate PRs.

Author: simu

config_defaults.yml

@@ -3,6 +3,11 @@
   feature_goUnitTests: false
   feature_goldenTests: false
   componentName: ""
+  testMatrix: {}
+  # key: provider
+  # entries:
+  #   - variant1
+  #   - variant2
 
 .github/ISSUE_TEMPLATE/config.yml:
   contact_links:
@@ -13,11 +18,7 @@
 .github/workflows/test.yaml:
   makeTarget: test
   goldenTest_makeTarget: golden-diff # Requires `feature_goldenTests`
-  matrix: {}
-  # key: provider
-  # entries:
-  #   - variant1
-  #   - variant2
+  #matrix: {} # deprecated, use global param `testMatrix`
 
 docs/antora.yml:
   version: master

moduleroot/.github/workflows/test.yaml.erb

@@ -1,3 +1,6 @@
+<%-
+@matrix = @configs.key?('matrix') ? @configs['matrix'] : @configs['testMatrix']
+-%>
 name: Pull Request
 on:
   pull_request:
@@ -30,11 +33,11 @@ jobs:
 <%- if @configs['feature_componentCompile'] -%>
   test:
     runs-on: ubuntu-latest
-  <%- if !@configs['matrix'].empty? -%>
+  <%- if [email protected]? -%>
     strategy:
       matrix:
-        <%= @configs['matrix']['key'] -%>:
-<% @configs['matrix']['entries'].each do |entry| -%>
+        <%= @matrix['key'] -%>:
+<% @matrix['entries'].each do |entry| -%>
           - <%= entry %>
 <% end -%>
   <%- end -%>
@@ -64,11 +67,11 @@ jobs:
 <%- if @configs['feature_goldenTests'] -%>
   golden:
     runs-on: ubuntu-latest
-  <%- if !@configs['matrix'].empty? -%>
+  <%- if !@matrix.empty? -%>
     strategy:
       matrix:
-        <%= @configs['matrix']['key'] -%>:
-<% @configs['matrix']['entries'].each do |entry| -%>
+        <%= @matrix['key'] -%>:
+<% @matrix['entries'].each do |entry| -%>
           - <%= entry %>
 <% end -%>
   <%- end -%>

moduleroot/renovate.json.erb

@@ -4,6 +4,23 @@
     ":gitSignOff",
     ":disableDependencyDashboard"
   ],
+<%- if @configs['feature_goldenTests'] -%>
+  "postUpgradeTasks": {
+    <%- if !@configs['testMatrix'].empty? && !@configs['testMatrix']['entries'].empty? -%>
+    "commands": [
+      <%- @configs['testMatrix']['entries'].each_with_index do |entry, i| -%>
+      "make gen-golden -e instance=<%= entry %>"<%- if i < @configs['testMatrix']['entries'].length-1 -%>,<%- end %>
+      <%- end -%>
+    ]
+    <%- else -%>
+    "commands": [
+      "make gen-golden"
+    ]
+    <%- end -%>
+    "fileFilters": [ "tests/golden/**" ],
+    "executionMode": "update"
+  },
+<%- end -%>
   "labels": [
     "dependency"
   ]