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 # Note: images are rebuilt weekly with a scheduled pipeline with FDO_FORCE_REBUILD set
187 {# qemu builds are only done for the latest version of any distribution #}
188 {% for distro in distributions if distro.want_qemu %}
189 {% set version = "{}".format(distro.versions|last()) %}
190 {{distro.name}}:{{version}}@qemu-prep:
192 - .fdo.qemu-build@{{distro.name}}
199 FDO_DISTRIBUTION_VERSION: {{version}}
200 FDO_DISTRIBUTION_TAG: $QEMU_TAG
201 FDO_DISTRIBUTION_PACKAGES: ${{distro.name.upper()}}_QEMU_RPMS
205 {% for distro in distributions %}
206 {% for version in distro.versions %}
207 {{distro.name}}:{{version}}@container-prep:
209 - .fdo.container-build@{{distro.name}}
214 FDO_DISTRIBUTION_VERSION: '{{version}}'
215 FDO_DISTRIBUTION_PACKAGES: ${{distro.name.upper()}}_PACKAGES
216 FDO_DISTRIBUTION_TAG: ${{distro.name.upper()}}_TAG
217 {% if version == 'ubuntu'%}
218 FDO_DISTRIBUTION_EXEC: $UBUNTU_EXEC
225 # Note that we want to use the latest buildah image, and for that
226 # we use one of the .fdo.container-build@distribution by replacing the
228 .freebsd@container-prep:
231 - .fdo.container-build@fedora
234 # log in to the registry
235 - podman login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
237 # get the full container image name
238 - export IMAGE=freebsd/$FREEBSD_VERSION:$FREEBSD_TAG
240 - if [[ x"$FDO_FORCE_REBUILD" != x ]] ; then touch .rebuild; fi
242 # pull the latest upstream image if it exists
243 - test -e .rebuild || skopeo copy --dest-creds $CI_REGISTRY_USER:$CI_REGISTRY_PASSWORD
244 docker://$CI_REGISTRY/$FDO_UPSTREAM_REPO/$IMAGE
245 docker://$CI_REGISTRY_IMAGE/$IMAGE && exit 0 || true ;
247 # check if our image is already in the current registry
248 - test -e .rebuild || skopeo inspect docker://$CI_REGISTRY_IMAGE/$IMAGE > /dev/null && exit 0 || true ;
250 - export BUILDAH_RUN="buildah run --isolation chroot"
251 - export BUILDAH_COMMIT="buildah commit --format docker"
252 - buildcntr=$(buildah from --quiet myfreeweb/freebsd-cross:latest)
253 - $BUILDAH_RUN $buildcntr apk add --no-cache $FREEBSD_BUILD_PKGS
254 - $BUILDAH_RUN $buildcntr pkg -r /freebsd update -f
255 - $BUILDAH_RUN $buildcntr pkg -r /freebsd install -y $FREEBSD_PKGS
256 - buildah config --workingdir /app $buildcntr
257 # tag the current container
258 - $BUILDAH_COMMIT $buildcntr $FREEBSD_CONTAINER_IMAGE
259 # clean up the working container
260 - buildah rm $buildcntr
262 # push the container image to the libinput registry
263 - podman push --quiet $FREEBSD_CONTAINER_IMAGE
264 - skopeo copy --dest-creds $CI_REGISTRY_USER:$CI_REGISTRY_PASSWORD
265 docker://$FREEBSD_CONTAINER_IMAGE
266 docker://$CI_REGISTRY_IMAGE/freebsd/$FREEBSD_VERSION:$CI_JOB_ID
268 freebsd:11.2@container-prep:
270 - .freebsd@container-prep
273 FREEBSD_VERSION: "11.2"
276 #################################################################
278 # container clean stage #
279 # run during the clean stage #
281 #################################################################
284 # This stage will look for the container images we currently have in
285 # the registry and will remove any that are not tagged with the provided
286 # $container_image:$tag
289 stage: container_clean
294 - apk add python3 py-pip git
295 - pip3 install git+http://gitlab.freedesktop.org/freedesktop/ci-templates
297 # Go to your Profile, Settings, Access Tokens
298 # Create a personal token with 'api' scope, copy the value.
299 # Go to CI/CD, Schedules, schedule a new monthly job (or edit the existing one)
300 # Define a variable of type File named AUTHFILE. Content is that token
302 - ci-fairy -v --authfile $AUTHFILE delete-image
303 --repository $FDO_DISTRIBUTION_NAME/$FDO_DISTRIBUTION_VERSION
304 --exclude-tag $FDO_DISTRIBUTION_TAG
310 {% for distro in distributions %}
311 {% for version in distro.versions %}
312 {{distro.name}}:{{version}}@container-clean:
317 {{distro.name.upper()}}_VERSION: '{{version}}'
318 CURRENT_CONTAINER_IMAGE: $CI_REGISTRY_IMAGE/{{distro.name}}/$FDO_DISTRIBUTION_VERSION:$FDO_DISTRIBUTION_TAG
319 FDO_DISTRIBUTION_VERSION: '{{version}}'
320 FDO_DISTRIBUTION_TAG: ${{distro.name.upper()}}_TAG
325 freebsd:11.2@container-clean:
330 CURRENT_CONTAINER_IMAGE: $FREEBSD_CONTAINER_IMAGE
332 #################################################################
336 #################################################################
344 - .gitlab-ci/meson-build.sh
351 .check_tainted: &check_tainted |
352 # make sure the kernel is not tainted
353 if [[ "$(ssh localhost -p 5555 cat /proc/sys/kernel/tainted)" -gt 0 ]];
355 echo tainted kernel ;
359 # Run in a test suite. Special variables:
360 # - SUITES: the meson test suites to run, or
361 # - SUITE_NAMES: all elements will be expanded to libinput-test-suite-$value
362 # Set one or the other, not both.
366 - .fdo.distribution-image@fedora
371 MESON_BUILDDIR: build_dir
372 # remove the global --no-suite=hardware
375 - if ! [[ -z $SUITE_NAMES ]]; then SUITES=$(echo $SUITE_NAMES | sed 's/\([^ ]*\)/libinput-test-suite-\1/g'); fi
376 - echo "Testing $SUITES"
378 # start our vm, no args required
379 - /app/start_vm.sh || (echo "Error - Failed to start the VM." && exit 1)
383 - "scp -P 5555 -r $PWD localhost:"
384 - echo "CI_JOB_ID=\"$CI_JOB_ID\"" > sshenv
385 - echo "CI_JOB_NAME=\"$CI_JOB_NAME\"" >> sshenv
386 - echo "MESON_ARGS=\"$MESON_ARGS\"" >> sshenv
387 - echo "MESON_BUILDDIR=\"$MESON_BUILDDIR\"" >> sshenv
388 - echo "MESON_TEST_ARGS=\"$MESON_TEST_ARGS $SUITES\"" >> sshenv
389 - echo "NINJA_ARGS=\"$NINJA_ARGS\"" >> sshenv
390 - "scp -P 5555 sshenv localhost:~/$CI_PROJECT_NAME/.meson_environment"
391 - ssh localhost -p 5555 "cd $CI_PROJECT_NAME ; .gitlab-ci/meson-build.sh" && touch .success || true
392 # no matter the results of the tests, we want to fetch the logs
393 - scp -P 5555 -r localhost:$CI_PROJECT_NAME/$MESON_BUILDDIR .
397 - ssh localhost -p 5555 halt || true
401 - if [[ ! -e .success ]] ;
406 name: "qemu-meson-logs-$CI_JOB_NAME"
410 - $MESON_BUILDDIR/meson-logs
413 junit: $MESON_BUILDDIR/junit-*.xml
421 {# qemu tests are only done for the latest version of any distribution #}
422 {% for distro in distributions if distro.want_qemu %}
423 {% set version = "{}".format(distro.versions|last()) %}
424 .{{distro.name}}:{{version}}@test-suite-vm:
428 FDO_DISTRIBUTION_VERSION: {{version}}
429 FDO_DISTRIBUTION_TAG: $QEMU_TAG
431 - "{{distro.name}}:{{version}}@qemu-prep"
434 {% for suite in test_suites %}
437 - .{{distro.name}}:{{version}}@test-suite-vm
439 SUITE_NAMES: '{{suite.suites}}'
441 vm-{{suite.name}}-no-libwacom:
445 MESON_ARGS: '-Dlibwacom=false'
449 {% for suite in test_suites %}
450 vm-valgrind-{{suite.name}}:
455 MESON_TEST_ARGS: '--setup=valgrind'
458 {% endfor %}{# for if distro.want_qemu #}
460 {% for distro in distributions if distro.use_for_custom_build_tests %}
461 {% set version = "{}".format(distro.versions|last()) %}
462 .{{distro.name}}-build@template:
464 - .fdo.distribution-image@fedora
467 FDO_DISTRIBUTION_VERSION: '{{version}}'
468 FDO_DISTRIBUTION_TAG: ${{distro.name.upper()}}_TAG
470 - "{{distro.name}}:{{version}}@container-prep"
472 default-build-release@{{distro.name}}:{{version}}:
475 - .{{distro.name}}-build@template
477 MESON_ARGS: "-Dbuildtype=release"
480 scan-build@{{distro.name}}:{{version}}:
482 - .{{distro.name}}-build@template
484 NINJA_ARGS: scan-build
487 - dnf install -y clang-analyzer findutils
489 - test ! -d "$MESON_BUILDDIR"/meson-logs/scanbuild && exit 0
490 - test $(find "$MESON_BUILDDIR"/meson-logs/scanbuild -maxdepth 0 ! -empty -exec echo "not empty" \; | wc -l) -eq 0 && exit 0
491 - echo "Check scan-build results"
494 # Below jobs are build option combinations. We only
495 # run them on one image, they shouldn't fail on one distro
496 # when they succeed on another.
498 build-no-libwacom@{{distro.name}}:{{version}}:
500 - .{{distro.name}}-build@template
502 MESON_ARGS: "-Dlibwacom=false"
504 build-no-libwacom-nodeps@{{distro.name}}:{{version}}:
506 - .{{distro.name}}-build@template
508 MESON_ARGS: "-Dlibwacom=false"
510 - dnf remove -y libwacom libwacom-devel
512 build-no-docs@{{distro.name}}:{{version}}:
514 - .{{distro.name}}-build@template
516 MESON_ARGS: "-Ddocumentation=false"
518 build-no-docs-nodeps@{{distro.name}}:{{version}}:
520 - .{{distro.name}}-build@template
522 MESON_ARGS: "-Ddocumentation=false"
524 - dnf remove -y doxygen graphviz
526 build-no-debuggui@{{distro.name}}:{{version}}:
528 - .{{distro.name}}-build@template
530 MESON_ARGS: "-Ddebug-gui=false"
532 build-no-debuggui-nodeps@{{distro.name}}:{{version}}:
534 - .{{distro.name}}-build@template
536 MESON_ARGS: "-Ddebug-gui=false"
538 - dnf remove -y gtk3-devel
540 build-no-tests@{{distro.name}}:{{version}}:
542 - .{{distro.name}}-build@template
544 MESON_ARGS: "-Dtests=false"
546 build-no-tests-nodeps@{{distro.name}}:{{version}}:
548 - .{{distro.name}}-build@template
550 MESON_ARGS: "-Dtests=false"
552 - dnf remove -y check-devel
554 valgrind@{{distro.name}}:{{version}}:
556 - .{{distro.name}}-build@template
558 MESON_TEST_ARGS: '--suite=valgrind --no-suite=hardware --setup=valgrind'
560 - dnf install -y valgrind
562 # Python checks, only run on Fedora
564 usr-bin-env-python@{{distro.name}}:{{version}}:
566 - .{{distro.name}}-build@template
569 if git grep -l '^#!/usr/bin/python'; then
570 echo "Use '/usr/bin/env python3' in the above files";
574 flake8@{{distro.name}}:{{version}}:
576 - .{{distro.name}}-build@template
578 - dnf install -y python3-flake8
580 - flake8-3 --ignore=W501,E501,W504 $(git grep -l '^#!/usr/bin/env python3')
587 # This requires the COVERITY_SCAN_TOKEN. Log into scan.coverity.com and get
588 # the token from the respective project settings page.
589 # Schedule a pipeline and set a variable COVERITY_SCAN_TOKEN with the token value.
590 # https://gitlab.freedesktop.org/$CI_PROJECT_PATH/-/pipeline_schedules
591 # Email from coverity will be sent to the GITLAB_USER_EMAIL that scheduled the
594 # Coverity ratelimits submissions and the coverity tools download is about
595 # 700M, do not run this too often.
599 - .fdo.distribution-image@fedora
603 # coverity doesn't work on Fedora 32
604 FDO_DISTRIBUTION_VERSION: '31'
605 FDO_DISTRIBUTION_TAG: $FEDORA_TAG
606 # so git-describe works, or should work
610 - $COVERITY_SCAN_TOKEN
612 - curl https://scan.coverity.com/download/linux64
613 -o /tmp/cov-analysis-linux64.tgz
614 --form project=$CI_PROJECT_NAME
615 --form token=$COVERITY_SCAN_TOKEN
616 - tar xfz /tmp/cov-analysis-linux64.tgz
617 # coverity has special build options in meson, make sure we enable those
618 - meson coverity-build -Ddocumentation=false -Dcoverity=true
619 - cov-analysis-linux64-*/bin/cov-build --dir cov-int ninja -C coverity-build
620 - tar cfz cov-int.tar.gz cov-int
621 - curl https://scan.coverity.com/builds?project=$CI_PROJECT_NAME
622 --form token=$COVERITY_SCAN_TOKEN --form email=$GITLAB_USER_EMAIL
623 --form file=@cov-int.tar.gz --form version="$(git describe --tags)"
624 --form description="$(git describe --tags) / $CI_COMMIT_TITLE / $CI_COMMIT_REF_NAME:$CI_PIPELINE_ID"
626 name: "coverity-submit-data"
632 - "fedora:31@container-prep"
634 #################################################################
638 #################################################################
640 {% for distro in distributions %}
641 {% for version in distro.versions %}
642 {{distro.name}}:{{version}}@default-build:
646 - .fdo.distribution-image@{{distro.name}}
648 FDO_DISTRIBUTION_VERSION: '{{version}}'
649 FDO_DISTRIBUTION_TAG: ${{distro.name.upper()}}_TAG
650 {# Where we have extra_variables defined, add them to the list #}
651 {% if distro.build is defined and distro.build.extra_variables is defined %}
652 {% for var in distro.build.extra_variables %}
657 - "{{distro.name}}:{{version}}@container-prep"
670 image: $FREEBSD_CONTAINER_IMAGE
672 MESON_ARGS: '--cross-file freebsd -Ddocumentation=false -Dtests=false -Depoll-dir=/freebsd/usr/local/'
673 # Can't run FreeBSD tests on Linux machine, so MESON_TEST_ARGS shouldn't be "test"
676 freebsd:11.2@default-build:
680 - "freebsd:11.2@container-prep"
688 - .fdo.distribution-image@fedora
692 FDO_DISTRIBUTION_VERSION: '32'
693 FDO_DISTRIBUTION_TAG: $FEDORA_TAG
695 - "fedora:32@container-prep"
697 - dnf install -y rpmdevtools jq
698 - meson "$MESON_BUILDDIR"
699 - VERSION=$(meson introspect "$MESON_BUILDDIR" --projectinfo | jq -r .version)
700 - sed -e "s/@PIPELINEID@/${CI_PIPELINE_ID}/"
701 -e "s/@GITVERSION@/${CI_COMMIT_SHA}/"
702 -e "s/@VERSION@/${VERSION}/" .gitlab-ci/libinput.spec.in > libinput.spec
703 - git config --local user.name 'gitlab CI'
704 - git config --local user.email 'noreply@nowhere'
705 - git add libinput.spec && git commit -m 'Add libinput.spec for build testing' libinput.spec
706 - cd "$MESON_BUILDDIR"
707 - meson dist --no-test
708 - rpmbuild -ta meson-dist/libinput*.tar.xz
716 # - variable WAYLAND_WEB_TOKEN defined as type File in libinput's CI/CD settings
717 # - content of that file is the token value, as generated by the Pipeline Triggers
718 # of the wayland.freedesktop.org project.
719 - curl --request POST
720 --form "token=<$WAYLAND_WEB_TOKEN"
722 https://gitlab.freedesktop.org/api/v4/projects/wayland${SLASH}wayland${DOT}freedesktop${DOT}org/trigger/pipeline
730 - $CI_PROJECT_PATH == "libinput/libinput"