1 # vim: set expandtab shiftwidth=2 tabstop=8 textwidth=0 filetype=yaml:
3 {# You're looking at the template here, so you can ignore the below
4 warning. This is the right file to edit #}
5 ########################################
7 # THIS FILE IS GENERATED, DO NOT EDIT #
9 ########################################
12 # This is a bit complicated for two reasons:
13 # - we really want to run dnf/apt/... only once, updating on the test runner for
14 # each job takes forever. So we create a container image for each distribution
15 # tested, then run the tests on this container image.
17 # Creating a container image is time-consuming, so we only do so for pushes to
18 # libinput directly (not merge requests) and if the current image is 'old'.
20 # - GitLab only allows one script: set per job but we have a bunch of commands
21 # we need to re-run for each build (meson && ninja && etc). YAML cannot merge
22 # arrays templates so we're screwed.
24 # So instead we use a default_build template and override everything with
25 # variables. The only two variables that matter:
26 # MESON_ARGS=-Denable-something=true
27 # NINJA_ARGS=dist ... to run 'ninja -C builddir dist'
28 # Note that you cannot use scripts: in any target if you expect default_build
32 # All jobs must follow the naming scheme of
33 # <distribution>:<version>@activity:
34 # e.g. fedora:31@build-default
36 .templates_sha: &template_sha 395535ce90eb48e260c0dff12c35d9237e22c539 # see https://docs.gitlab.com/ee/ci/yaml/#includefile
39 {% for distro in distributions|sort(attribute="name") %}
40 {% if not distro.does_not_have_ci_templates %}
41 # {{ distro.name.capitalize() }} container builder template
42 - project: 'freedesktop/ci-templates'
44 file: '/templates/{{distro.name}}.yml'
49 - prep # prep work like rebuilding the container images if there is a change
50 - build # for actually building and testing things in a container
51 - VM # for running the test suite in a VM
52 - valgrind # for running the test suite under valgrind in a VM
53 - distro # distribs test
54 - deploy # trigger wayland's website generation
55 - container_clean # clean up unused container images
58 ###############################################################################
59 # This is the list of packages required to build libinput with the default #
62 # Run dnf install/apt-get install/.. with the list of packages for your #
65 # See the documentation here: #
66 # https://wayland.freedesktop.org/libinput/doc/latest/building_libinput.html #
67 ###############################################################################
68 FEDORA_PACKAGES: 'git gcc gcc-c++ pkgconf-pkg-config meson check-devel libudev-devel libevdev-devel doxygen graphviz python3-sphinx python3-recommonmark python3-sphinx_rtd_theme python3-pytest-xdist libwacom-devel cairo-devel gtk3-devel glib2-devel mtdev-devel diffutils'
69 FEDORA_QEMU_RPMS: 'git gcc gcc-c++ pkgconf-pkg-config meson check-devel libudev-devel libevdev-devel doxygen graphviz python3-sphinx python3-recommonmark python3-sphinx_rtd_theme python3-pytest-xdist libwacom-devel cairo-devel gtk3-devel glib2-devel mtdev-devel diffutils valgrind'
70 UBUNTU_PACKAGES: 'git gcc g++ pkg-config meson check libudev-dev libevdev-dev doxygen graphviz python3-sphinx python3-recommonmark python3-sphinx-rtd-theme python3-pytest-xdist libwacom-dev libcairo2-dev libgtk-3-dev libglib2.0-dev libmtdev-dev'
71 ARCH_PACKAGES: 'git gcc pkgconfig meson check libsystemd libevdev doxygen graphviz python-sphinx python-recommonmark python-sphinx_rtd_theme python-pytest-xdist libwacom gtk3 mtdev diffutils'
72 FREEBSD_BUILD_PKGS: 'meson'
73 FREEBSD_PKGS: 'libepoll-shim libudev-devd libevdev libwacom gtk3 libmtdev '
74 ALPINE_PACKAGES: 'git gcc build-base pkgconfig meson check-dev eudev-dev libevdev-dev libwacom-dev cairo-dev gtk+3.0-dev mtdev-dev bash'
75 ############################ end of package lists #############################
77 # these tags should be updated each time the list of packages is updated
78 # changing these will force rebuilding the associated image
79 # Note: these tags have no meaning and are not tied to a particular
81 {% for distro in distributions %}
82 {{"%-13s"| format(distro.name.upper() + '_TAG:')}}'{{distro.tag}}'
84 {% for distro in distributions %}
85 {% if distro.want_qemu %}
86 QEMU_TAG: 'qemu-vm-{{distro.tag}}'
90 UBUNTU_EXEC: "bash .gitlab-ci/ubuntu_install.sh $UBUNTU_CUSTOM_DEBS"
92 FREEBSD_CONTAINER_IMAGE: $CI_REGISTRY_IMAGE/freebsd/11.2:$FREEBSD_TAG
93 FDO_UPSTREAM_REPO: libinput/libinput
95 MESON_BUILDDIR: "build dir"
98 MESON_TEST_ARGS: '--no-suite=hardware'
100 # udev isn't available/working properly in the containers
101 UDEV_NOT_AVAILABLE: 1
108 - runner_system_failure
109 - stuck_or_timeout_failure
110 # cancel run when a newer version is pushed to the branch
115 name: "meson-logs-$CI_JOB_NAME"
119 - $MESON_BUILDDIR/meson-logs
121 junit: $MESON_BUILDDIR/junit-*.xml
123 #################################################################
127 #################################################################
129 # Re-generate the CI script and make sure it's the one currently checked in
130 # If this job fails, re-generate the gitlab-ci.yml script, see
131 # $SRCDIR/.gitlab-ci/generate-gitlab-ci.py
137 - apk add python3 py-pip git
138 - pip3 install git+http://gitlab.freedesktop.org/freedesktop/ci-templates
140 - ci-fairy generate-template
141 - git diff --exit-code && exit 0 || true
142 - echo "Committed gitlab-ci.yml differs from generated gitlab-ci.yml. Please verify"
146 # Verify that commit messages are as expected, signed-off, etc.
153 - apk add python3 py-pip git
154 - pip3 install git+http://gitlab.freedesktop.org/freedesktop/ci-templates
156 - ci-fairy check-commits --signed-off-by --junit-xml=results.xml
158 - master@libinput/libinput
166 # Verify that the merge request has the allow-collaboration checkbox ticked
173 - apk add python3 py-pip git
174 - pip3 install git+http://gitlab.freedesktop.org/freedesktop/ci-templates
176 - ci-fairy check-merge-request --require-allow-collaboration --junit-xml=results.xml
184 # This stage will recreate the container images only if the image
185 # is too old or if it is missing some dependencies.
188 .rebuild_for_schedule:
190 # force rebuild if schedule, reuse otherwise
191 - if [[ $CI_PIPELINE_SOURCE == "schedule" ]] ; then export FDO_FORCE_REBUILD=1; fi
193 {# qemu builds are only done for the latest version of any distribution #}
194 {% for distro in distributions if distro.want_qemu %}
195 {% set version = "{}".format(distro.versions|last()) %}
196 {{distro.name}}:{{version}}@qemu-prep:
198 - .fdo.qemu-build@{{distro.name}}
200 - .rebuild_for_schedule
206 FDO_DISTRIBUTION_VERSION: {{version}}
207 FDO_DISTRIBUTION_TAG: $QEMU_TAG
208 FDO_DISTRIBUTION_PACKAGES: ${{distro.name.upper()}}_QEMU_RPMS
212 {% for distro in distributions %}
213 {% for version in distro.versions %}
214 {{distro.name}}:{{version}}@container-prep:
216 - .fdo.container-build@{{distro.name}}
218 - .rebuild_for_schedule
222 FDO_DISTRIBUTION_VERSION: '{{version}}'
223 FDO_DISTRIBUTION_PACKAGES: ${{distro.name.upper()}}_PACKAGES
224 FDO_DISTRIBUTION_TAG: ${{distro.name.upper()}}_TAG
225 {% if version == 'ubuntu'%}
226 FDO_DISTRIBUTION_EXEC: $UBUNTU_EXEC
233 # Note that we want to use the latest buildah image, and for that
234 # we use one of the .fdo.container-build@distribution by replacing the
236 .freebsd@container-prep:
239 - .fdo.container-build@fedora
242 # log in to the registry
243 - podman login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
245 # get the full container image name
246 - export IMAGE=freebsd/$FREEBSD_VERSION:$FREEBSD_TAG
248 # force rebuild if schedule, reuse otherwise
249 - if [[ $CI_PIPELINE_SOURCE == "schedule" ]] ; then touch .scheduled; fi
251 # pull the latest upstream image if it exists
252 - test -e .scheduled || skopeo copy --dest-creds $CI_REGISTRY_USER:$CI_REGISTRY_PASSWORD
253 docker://$CI_REGISTRY/$FDO_UPSTREAM_REPO/$IMAGE
254 docker://$CI_REGISTRY_IMAGE/$IMAGE && exit 0 || true ;
256 # check if our image is already in the current registry
257 - test -e .scheduled || skopeo inspect docker://$CI_REGISTRY_IMAGE/$IMAGE > /dev/null && exit 0 || true ;
259 - export BUILDAH_RUN="buildah run --isolation chroot"
260 - export BUILDAH_COMMIT="buildah commit --format docker"
261 - buildcntr=$(buildah from --quiet myfreeweb/freebsd-cross:latest)
262 - $BUILDAH_RUN $buildcntr apk add --no-cache $FREEBSD_BUILD_PKGS
263 - $BUILDAH_RUN $buildcntr pkg -r /freebsd update -f
264 - $BUILDAH_RUN $buildcntr pkg -r /freebsd install -y $FREEBSD_PKGS
265 - buildah config --workingdir /app $buildcntr
266 # tag the current container
267 - $BUILDAH_COMMIT $buildcntr $FREEBSD_CONTAINER_IMAGE
268 # clean up the working container
269 - buildah rm $buildcntr
271 # push the container image to the libinput registry
272 - podman push --quiet $FREEBSD_CONTAINER_IMAGE
273 - skopeo copy --dest-creds $CI_REGISTRY_USER:$CI_REGISTRY_PASSWORD
274 docker://$FREEBSD_CONTAINER_IMAGE
275 docker://$CI_REGISTRY_IMAGE/freebsd/$FREEBSD_VERSION:$CI_JOB_ID
277 freebsd:11.2@container-prep:
279 - .freebsd@container-prep
282 FREEBSD_VERSION: "11.2"
285 #################################################################
287 # container clean stage #
288 # run during the clean stage #
290 #################################################################
293 # This stage will look for the container images we currently have in
294 # the registry and will remove any that are not tagged with the provided
295 # $container_image:$tag
298 stage: container_clean
303 - apk add python3 py-pip git
304 - pip3 install git+http://gitlab.freedesktop.org/freedesktop/ci-templates
306 # Go to your Profile, Settings, Access Tokens
307 # Create a personal token with 'api' scope, copy the value.
308 # Go to CI/CD, Schedules, schedule a new monthly job (or edit the existing one)
309 # Define a variable of type File named AUTHFILE. Content is that token
311 - ci-fairy -v --authfile $AUTHFILE delete-image
312 --repository $FDO_DISTRIBUTION_NAME/$FDO_DISTRIBUTION_VERSION
313 --exclude-tag $FDO_DISTRIBUTION_TAG
319 {% for distro in distributions %}
320 {% for version in distro.versions %}
321 {{distro.name}}:{{version}}@container-clean:
326 {{distro.name.upper()}}_VERSION: '{{version}}'
327 CURRENT_CONTAINER_IMAGE: $CI_REGISTRY_IMAGE/{{distro.name}}/$FDO_DISTRIBUTION_VERSION:$FDO_DISTRIBUTION_TAG
328 FDO_DISTRIBUTION_VERSION: '{{version}}'
329 FDO_DISTRIBUTION_TAG: ${{distro.name.upper()}}_TAG
334 freebsd:11.2@container-clean:
339 CURRENT_CONTAINER_IMAGE: $FREEBSD_CONTAINER_IMAGE
341 #################################################################
345 #################################################################
353 - .gitlab-ci/meson-build.sh
360 .check_tainted: &check_tainted |
361 # make sure the kernel is not tainted
362 if [[ "$(ssh localhost -p 5555 cat /proc/sys/kernel/tainted)" -gt 0 ]];
364 echo tainted kernel ;
368 # Run in a test suite. Special variables:
369 # - SUITES: the meson test suites to run, or
370 # - SUITE_NAMES: all elements will be expanded to libinput-test-suite-$value
371 # Set one or the other, not both.
375 - .fdo.distribution-image@fedora
380 MESON_BUILDDIR: build_dir
381 # remove the global --no-suite=hardware
384 - if ! [[ -z $SUITE_NAMES ]]; then SUITES=$(echo $SUITE_NAMES | sed 's/\([^ ]*\)/libinput-test-suite-\1/g'); fi
385 - echo "Testing $SUITES"
387 # start our vm, no args required
388 - /app/start_vm.sh || (echo "Error - Failed to start the VM." && exit 1)
392 - "scp -P 5555 -r $PWD localhost:"
393 - echo "CI_JOB_ID=\"$CI_JOB_ID\"" > sshenv
394 - echo "CI_JOB_NAME=\"$CI_JOB_NAME\"" >> sshenv
395 - echo "MESON_ARGS=\"$MESON_ARGS\"" >> sshenv
396 - echo "MESON_BUILDDIR=\"$MESON_BUILDDIR\"" >> sshenv
397 - echo "MESON_TEST_ARGS=\"$MESON_TEST_ARGS $SUITES\"" >> sshenv
398 - echo "NINJA_ARGS=\"$NINJA_ARGS\"" >> sshenv
399 - "scp -P 5555 sshenv localhost:~/$CI_PROJECT_NAME/.meson_environment"
400 - ssh localhost -p 5555 "cd $CI_PROJECT_NAME ; .gitlab-ci/meson-build.sh" && touch .success || true
401 # no matter the results of the tests, we want to fetch the logs
402 - scp -P 5555 -r localhost:$CI_PROJECT_NAME/$MESON_BUILDDIR .
406 - ssh localhost -p 5555 halt || true
410 - if [[ ! -e .success ]] ;
415 name: "qemu-meson-logs-$CI_JOB_NAME"
419 - $MESON_BUILDDIR/meson-logs
422 junit: $MESON_BUILDDIR/junit-*.xml
430 {# qemu tests are only done for the latest version of any distribution #}
431 {% for distro in distributions if distro.want_qemu %}
432 {% set version = "{}".format(distro.versions|last()) %}
433 .{{distro.name}}:{{version}}@test-suite-vm:
437 FDO_DISTRIBUTION_VERSION: {{version}}
438 FDO_DISTRIBUTION_TAG: $QEMU_TAG
440 - "{{distro.name}}:{{version}}@qemu-prep"
443 {% for suite in test_suites %}
446 - .{{distro.name}}:{{version}}@test-suite-vm
448 SUITE_NAMES: '{{suite.suites}}'
450 vm-{{suite.name}}-no-libwacom:
454 MESON_ARGS: '-Dlibwacom=false'
458 {% for suite in test_suites %}
459 vm-valgrind-{{suite.name}}:
464 MESON_TEST_ARGS: '--setup=valgrind'
467 {% endfor %}{# for if distro.want_qemu #}
469 {% for distro in distributions if distro.use_for_custom_build_tests %}
470 {% set version = "{}".format(distro.versions|last()) %}
471 .{{distro.name}}-build@template:
473 - .fdo.distribution-image@fedora
476 FDO_DISTRIBUTION_VERSION: '{{version}}'
477 FDO_DISTRIBUTION_TAG: ${{distro.name.upper()}}_TAG
479 - "{{distro.name}}:{{version}}@container-prep"
481 default-build-release@{{distro.name}}:{{version}}:
484 - .{{distro.name}}-build@template
486 MESON_ARGS: "-Dbuildtype=release"
489 scan-build@{{distro.name}}:{{version}}:
491 - .{{distro.name}}-build@template
493 NINJA_ARGS: scan-build
496 - dnf install -y clang-analyzer findutils
498 - test ! -d "$MESON_BUILDDIR"/meson-logs/scanbuild && exit 0
499 - test $(find "$MESON_BUILDDIR"/meson-logs/scanbuild -maxdepth 0 ! -empty -exec echo "not empty" \; | wc -l) -eq 0 && exit 0
500 - echo "Check scan-build results"
503 # Below jobs are build option combinations. We only
504 # run them on one image, they shouldn't fail on one distro
505 # when they succeed on another.
507 build-no-libwacom@{{distro.name}}:{{version}}:
509 - .{{distro.name}}-build@template
511 MESON_ARGS: "-Dlibwacom=false"
513 build-no-libwacom-nodeps@{{distro.name}}:{{version}}:
515 - .{{distro.name}}-build@template
517 MESON_ARGS: "-Dlibwacom=false"
519 - dnf remove -y libwacom libwacom-devel
521 build-no-docs@{{distro.name}}:{{version}}:
523 - .{{distro.name}}-build@template
525 MESON_ARGS: "-Ddocumentation=false"
527 build-no-docs-nodeps@{{distro.name}}:{{version}}:
529 - .{{distro.name}}-build@template
531 MESON_ARGS: "-Ddocumentation=false"
533 - dnf remove -y doxygen graphviz
535 build-no-debuggui@{{distro.name}}:{{version}}:
537 - .{{distro.name}}-build@template
539 MESON_ARGS: "-Ddebug-gui=false"
541 build-no-debuggui-nodeps@{{distro.name}}:{{version}}:
543 - .{{distro.name}}-build@template
545 MESON_ARGS: "-Ddebug-gui=false"
547 - dnf remove -y gtk3-devel
549 build-no-tests@{{distro.name}}:{{version}}:
551 - .{{distro.name}}-build@template
553 MESON_ARGS: "-Dtests=false"
555 build-no-tests-nodeps@{{distro.name}}:{{version}}:
557 - .{{distro.name}}-build@template
559 MESON_ARGS: "-Dtests=false"
561 - dnf remove -y check-devel
563 valgrind@{{distro.name}}:{{version}}:
565 - .{{distro.name}}-build@template
567 MESON_TEST_ARGS: '--suite=valgrind --no-suite=hardware --setup=valgrind'
569 - dnf install -y valgrind
571 # Python checks, only run on Fedora
573 usr-bin-env-python@{{distro.name}}:{{version}}:
575 - .{{distro.name}}-build@template
578 if git grep -l '^#!/usr/bin/python'; then
579 echo "Use '/usr/bin/env python3' in the above files";
583 flake8@{{distro.name}}:{{version}}:
585 - .{{distro.name}}-build@template
587 - dnf install -y python3-flake8
589 - flake8-3 --ignore=W501,E501,W504 $(git grep -l '^#!/usr/bin/env python3')
592 #################################################################
596 #################################################################
598 {% for distro in distributions %}
599 {% for version in distro.versions %}
600 {{distro.name}}:{{version}}@default-build:
604 - .fdo.distribution-image@{{distro.name}}
606 FDO_DISTRIBUTION_VERSION: '{{version}}'
607 FDO_DISTRIBUTION_TAG: ${{distro.name.upper()}}_TAG
608 {# Where we have extra_variables defined, add them to the list #}
609 {% if distro.build is defined and distro.build.extra_variables is defined %}
610 {% for var in distro.build.extra_variables %}
615 - "{{distro.name}}:{{version}}@container-prep"
628 image: $FREEBSD_CONTAINER_IMAGE
630 MESON_ARGS: '--cross-file freebsd -Ddocumentation=false -Dtests=false -Depoll-dir=/freebsd/usr/local/'
631 # Can't run FreeBSD tests on Linux machine, so MESON_TEST_ARGS shouldn't be "test"
634 freebsd:11.2@default-build:
638 - "freebsd:11.2@container-prep"
650 # - variable WAYLAND_WEB_TOKEN defined as type File in libinput's CI/CD settings
651 # - content of that file is the token value, as generated by the Pipeline Triggers
652 # of the wayland.freedesktop.org project.
653 - curl --request POST
654 --form "token=<$WAYLAND_WEB_TOKEN"
656 https://gitlab.freedesktop.org/api/v4/projects/wayland${SLASH}wayland${DOT}freedesktop${DOT}org/trigger/pipeline
664 - $CI_PROJECT_PATH == "libinput/libinput"