ci: use ci-fairy to generate the template, not a custom script

Signed-off-by: Benjamin Tissoires <benjamin.tissoires@gmail.com>

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 600bd42..5e32be6 100644 (file)
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -1,4 +1,11 @@
 # vim: set expandtab shiftwidth=2 tabstop=8 textwidth=0 filetype=yaml:
+
+########################################
+#                                      #
+# THIS FILE IS GENERATED, DO NOT EDIT  #
+#                                      #
+########################################
+
 #
 # This is a bit complicated for two reasons:
 # - we really want to run dnf/apt/... only once, updating on the test runner for
@@ -132,9 +139,9 @@ check-ci-script:
   stage: prep
   before_script:
     - apk add python3 git
-    - pip3 install --user jinja2
+    - pip3 install git+http://gitlab.freedesktop.org/freedesktop/ci-templates
   script:
-    - python3 ./.gitlab-ci/generate-gitlab-ci.py
+    - ci-fairy generate-template --config .gitlab-ci/config.yml .gitlab-ci/gitlab-ci.tmpl -o .gitlab-ci.yml
     - git diff --exit-code && exit 0 || true
     - echo "Committed gitlab-ci.yml differs from generated gitlab-ci.yml. Please verify"
     - exit 1

diff --git a/.gitlab-ci/config.yml b/.gitlab-ci/config.yml
new file mode 100644 (file)
index 0000000..70d2f8a
--- /dev/null
+++ b/.gitlab-ci/config.yml
@@ -0,0 +1,79 @@
+# This file contains the configuration for the gitlab ci.
+# See the .gitlab-ci/generate-gitlab-ci.py file for more info
+#
+
+# We're happy to rebuild all containers when one changes.
+.default_tag: &default_tag '2020-03-17.0'
+
+distributions:
+  - name: fedora
+    tag: *default_tag
+    versions:
+      - '30'
+      - '31'
+    want_qemu: true
+    ci_templates: true
+  - name: ubuntu
+    tag: *default_tag
+    versions:
+      - '19.10'
+      - '19.04'
+    ci_templates: true
+  - name: arch
+    tag: *default_tag
+    versions:
+      - 'rolling'
+    ci_templates: true
+  - name: alpine
+    tag: *default_tag
+    versions:
+      - 'latest'
+    build:
+      extra_variables:
+        - "MESON_ARGS: '-Ddocumentation=false' # alpine does not have python-recommonmark"
+        # We don't run the tests on alpine. The litest-selftest fails
+        # for any tcase_add_exit_test/tcase_add_test_raise_signal
+        # but someone more invested in musl will have to figure that out.
+        - "MESON_TEST_ARGS: '' # litest-selftest fails on musl"
+    ci_templates: true
+  - name: freebsd
+    tag: *default_tag
+    ci_templates: false
+
+test_suites:
+  - name: touchpad
+    suites: 
+      touchpad
+  - name: tap 
+    suites: 
+      tap
+  - name: tablet 
+    suites: 
+      tablet
+  - name: gestures-device 
+    suites: 
+      gestures 
+      device
+  - name: others
+    suites: 
+      context
+      config
+      misc
+      events
+      totem
+      udev
+      lid
+      log
+      timer
+      tablet-mode
+      quirks
+      trackball
+      pad
+      path
+      keyboard
+      switch
+      touch
+      trackpoint
+  - name: pointer
+    suites: 
+      pointer

diff --git a/.gitlab-ci/generate-gitlab-ci.py b/.gitlab-ci/generate-gitlab-ci.py
deleted file mode 100755 (executable)
index 053cfb1..0000000
--- a/.gitlab-ci/generate-gitlab-ci.py
+++ /dev/null
@@ -1,55 +0,0 @@
-#!/usr/bin/env python3
-# vim: set expandtab shiftwidth=4:
-
-# This file generates the .gitlab-ci.yml file that defines the pipeline.
-
-import jinja2
-
-distributions = [
-    {'name': 'fedora', 'version': '30'},
-    {'name': 'fedora', 'version': '31'},
-    {'name': 'ubuntu', 'version': '19.10'},
-    {'name': 'ubuntu', 'version': '19.04'},
-    {'name': 'arch', 'version': 'rolling'},
-    {
-        'name': 'alpine', 'version': 'latest',
-        'build': {
-            'extra_variables': [
-                'MESON_ARGS: \'-Ddocumentation=false\' # alpine does not have python-recommonmark',
-                # We don't run the tests on alpine. The litest-selftest fails
-                # for any tcase_add_exit_test/tcase_add_test_raise_signal
-                # but someone more invested in musl will have to figure that out.
-                'MESON_TEST_ARGS: \'\' # litest-selftest fails on musl',
-            ]
-        },
-    }
-]
-
-templates = sorted(set([x['name'] for x in distributions]))
-
-# in reverse order of duration to get the slowest ones started first
-test_suites = [
-    {'name': 'touchpad', 'suites': 'touchpad'},
-    {'name': 'tap', 'suites': 'tap'},
-    {'name': 'tablet', 'suites': 'tablet'},
-    {'name': 'gestures-device', 'suites': 'gestures device'},
-    {'name': 'others',
-     'suites': 'context config misc events totem udev lid log timer tablet-mode quirks trackball pad path keyboard switch touch trackpoint'},
-    {'name': 'pointer', 'suites': 'pointer'}
-]
-
-
-def generate_template():
-    env = jinja2.Environment(loader=jinja2.FileSystemLoader('./.gitlab-ci'),
-                             trim_blocks=True, lstrip_blocks=True)
-
-    template = env.get_template('gitlab-ci.tmpl')
-    config = {'distributions': distributions,
-              'test_suites': test_suites,
-              'templates': templates}
-    with open('.gitlab-ci.yml', 'w') as fd:
-        template.stream(config).dump(fd)
-
-
-if __name__ == '__main__':
-    generate_template()

diff --git a/.gitlab-ci/gitlab-ci.tmpl b/.gitlab-ci/gitlab-ci.tmpl
index 904874c..568c64c 100644 (file)
--- a/.gitlab-ci/gitlab-ci.tmpl
+++ b/.gitlab-ci/gitlab-ci.tmpl
@@ -1,4 +1,13 @@
 # vim: set expandtab shiftwidth=2 tabstop=8 textwidth=0 filetype=yaml:
+
+{# You're looking at the template here, so you can ignore the below
+   warning. This is the right file to edit #}
+########################################
+#                                      #
+# THIS FILE IS GENERATED, DO NOT EDIT  #
+#                                      #
+########################################
+
 #
 # This is a bit complicated for two reasons:
 # - we really want to run dnf/apt/... only once, updating on the test runner for
@@ -27,11 +36,13 @@
 .templates_sha: &template_sha 395535ce90eb48e260c0dff12c35d9237e22c539 # see https://docs.gitlab.com/ee/ci/yaml/#includefile
 
 include:
-  {% for template in templates %}
-  # {{ template.capitalize() }} container builder template
+  {% for distro in distributions|sort(attribute="name") %}
+  {% if distro.ci_templates %}
+  # {{ distro.name.capitalize() }} container builder template
   - project: 'freedesktop/ci-templates'
     ref: *template_sha
-    file: '/templates/{{template}}.yml'
+    file: '/templates/{{distro.name}}.yml'
+  {% endif %}
   {% endfor %}
 
 stages:
@@ -67,12 +78,14 @@ variables:
   # changing these will force rebuilding the associated image
   # Note: these tags have no meaning and are not tied to a particular
   # libinput version
-  FEDORA_TAG:  '2020-03-17.0'
-  UBUNTU_TAG:  '2020-03-17.0'
-  ARCH_TAG:    '2020-03-17.0'
-  ALPINE_TAG:  '2020-03-17.0'
-  FREEBSD_TAG: '2020-03-17.0'
-  QEMU_TAG:    'qemu-vm-2020-03-17.0'
+{% for distro in distributions %}
+  {{"%-13s"| format(distro.name.upper() + '_TAG:')}}'{{distro.tag}}'
+{% endfor %}
+{% for distro in distributions %}
+{% if distro.want_qemu %}
+  QEMU_TAG:    'qemu-vm-{{distro.tag}}'
+{% endif %}
+{% endfor %}
 
   UBUNTU_EXEC: "bash .gitlab-ci/ubuntu_install.sh $UBUNTU_CUSTOM_DEBS"
 
@@ -122,9 +135,9 @@ check-ci-script:
   stage: prep
   before_script:
     - apk add python3 git
-    - pip3 install --user jinja2
+    - pip3 install git+http://gitlab.freedesktop.org/freedesktop/ci-templates
   script:
-    - python3 ./.gitlab-ci/generate-gitlab-ci.py
+    - ci-fairy generate-template --config .gitlab-ci/config.yml .gitlab-ci/gitlab-ci.tmpl -o .gitlab-ci.yml
     - git diff --exit-code && exit 0 || true
     - echo "Committed gitlab-ci.yml differs from generated gitlab-ci.yml. Please verify"
     - exit 1
@@ -180,7 +193,8 @@ fedora:30@qemu-prep:
   allow_failure: true
 
 {% for distro in distributions %}
-{{distro.name}}:{{distro.version}}@container-prep:
+{% for version in distro.versions %}
+{{distro.name}}:{{version}}@container-prep:
   extends:
     - .fdo.container-build@{{distro.name}}
     - .policy
@@ -188,7 +202,7 @@ fedora:30@qemu-prep:
   stage: prep
   variables:
     GIT_STRATEGY: none
-    FDO_DISTRIBUTION_VERSION: '{{distro.version}}'
+    FDO_DISTRIBUTION_VERSION: '{{version}}'
     FDO_DISTRIBUTION_PACKAGES: ${{distro.name.upper()}}_PACKAGES
     FDO_DISTRIBUTION_TAG: ${{distro.name.upper()}}_TAG
  {% if version == 'ubuntu'%}
@@ -196,6 +210,7 @@ fedora:30@qemu-prep:
  {% endif %}
 
 {% endfor %}
+{% endfor %}
 
 
 # Note that we want to use the latest buildah image, and for that
@@ -285,17 +300,19 @@ freebsd:11.2@container-prep:
     - schedules
 
 {% for distro in distributions %}
-{{distro.name}}:{{distro.version}}@container-clean:
+{% for version in distro.versions %}
+{{distro.name}}:{{version}}@container-clean:
   extends:
     - .container-clean
   variables:
     GIT_STRATEGY: none
-    {{distro.name.upper()}}_VERSION: '{{distro.version}}'
+    {{distro.name.upper()}}_VERSION: '{{version}}'
     CURRENT_CONTAINER_IMAGE: $CI_REGISTRY_IMAGE/{{distro.name}}/$FDO_DISTRIBUTION_VERSION:$FDO_DISTRIBUTION_TAG
-    FDO_DISTRIBUTION_VERSION: '{{distro.version}}'
+    FDO_DISTRIBUTION_VERSION: '{{version}}'
     FDO_DISTRIBUTION_TAG: ${{distro.name.upper()}}_TAG
 
 {% endfor %}
+{% endfor %}
 
 freebsd:11.2@container-clean:
   extends:
@@ -554,13 +571,14 @@ flake8@fedora:30:
 #################################################################
 
 {% for distro in distributions %}
-{{distro.name}}:{{distro.version}}@default-build:
+{% for version in distro.versions %}
+{{distro.name}}:{{version}}@default-build:
   stage: distro
   extends:
     - .build@template
     - .fdo.distribution-image@{{distro.name}}
   variables:
-    FDO_DISTRIBUTION_VERSION: '{{distro.version}}'
+    FDO_DISTRIBUTION_VERSION: '{{version}}'
     FDO_DISTRIBUTION_TAG: ${{distro.name.upper()}}_TAG
     {# Where we have extra_variables defined, add them to the list #}
     {% if distro.build is defined and distro.build.extra_variables is defined %}
@@ -568,10 +586,11 @@ flake8@fedora:30:
     {{var}}
     {% endfor %}
     {% endif %}
-  needs: ['{{distro.name}}:{{distro.version}}@container-prep']
+  needs: ['{{distro.name}}:{{version}}@container-prep']
 
 
 {% endfor %}
+{% endfor %}
 
 #
 # FreeBSD