1 .. SPDX-License-Identifier: GPL-2.0+
2
3 =========================================
4 Automated testing of the DRM subsystem
5 =========================================
6
7 Introduction
8 ============
9
10 Making sure that changes to the core or driver
11 be very time-consuming when lots of different
12 be tested. Moreover, it isn't practical for ea
13 testing to have to acquire and maintain what c
14 hardware.
15
16 Also, it is desirable for developers to check
17 themselves, instead of relying on the maintain
18 reporting back.
19
20 There are facilities in gitlab.freedesktop.org
21 can be used as well for testing the DRM subsys
22 people interested in testing it can use this s
23 quite some time and effort.
24
25
26 Relevant files
27 ==============
28
29 drivers/gpu/drm/ci/gitlab-ci.yml
30 --------------------------------
31
32 This is the root configuration file for GitLab
33 bits, it specifies the specific version of the
34 some variables that can be modified to change
35
36 DRM_CI_PROJECT_PATH
37 Repository that contains the Mesa software
38
39 DRM_CI_COMMIT_SHA
40 A particular revision to use from that rep
41
42 UPSTREAM_REPO
43 URL to git repository containing the targe
44
45 TARGET_BRANCH
46 Branch to which this branch is to be merge
47
48 IGT_VERSION
49 Revision of igt-gpu-tools being used, from
50 https://gitlab.freedesktop.org/drm/igt-gpu
51
52 drivers/gpu/drm/ci/testlist.txt
53 -------------------------------
54
55 IGT tests to be run on all drivers (unless men
56 file, see below).
57
58 drivers/gpu/drm/ci/${DRIVER_NAME}-${HW_REVISIO
59 ----------------------------------------------
60
61 Lists the known failures for a given driver on
62
63 drivers/gpu/drm/ci/${DRIVER_NAME}-${HW_REVISIO
64 ----------------------------------------------
65
66 Lists the tests that for a given driver on a s
67 known to behave unreliably. These tests won't
68 the result. They will still be run.
69
70 Each new flake entry must be associated with a
71 bug to the author of the affected driver, the
72 the board, the first kernel version affected,
73 and an approximation of the failure rate.
74
75 They should be provided under the following fo
76
77 # Bug Report: $LORE_OR_PATCHWORK_URL
78 # Board Name: broken-board.dtb
79 # Linux Version: 6.6-rc1
80 # IGT Version: 1.28-gd2af13d9f
81 # Failure Rate: 100
82 flaky-test
83
84 drivers/gpu/drm/ci/${DRIVER_NAME}-${HW_REVISIO
85 ----------------------------------------------
86
87 Lists the tests that won't be run for a given
88 revision. These are usually tests that interfe
89 list due to hanging the machine, causing OOM,
90
91
92 How to enable automated testing on your tree
93 ============================================
94
95 1. Create a Linux tree in https://gitlab.freed
96 yet
97
98 2. In your kernel repo's configuration (eg.
99 https://gitlab.freedesktop.org/janedoe/linux/-
100 CI/CD configuration file from .gitlab-ci.yml t
101 drivers/gpu/drm/ci/gitlab-ci.yml.
102
103 3. Request to be added to the drm/ci-ok group
104 necessary privileges to run the CI on https://
105
106 4. Next time you push to this repository, you
107 created (eg. https://gitlab.freedesktop.org/ja
108
109 5. The various jobs will be run and when the p
110 should be green unless a regression has been f
111
112
113 How to update test expectations
114 ===============================
115
116 If your changes to the code fix any tests, you
117 lines from one or more of the files in
118 drivers/gpu/drm/ci/${DRIVER_NAME}_*_fails.txt,
119 affected by the change.
120
121
122 How to expand coverage
123 ======================
124
125 If your code changes make it possible to run m
126 issues, for example), you can remove tests fro
127 and then the expected results if there are any
128
129 If there is a need for updating the version of
130 added more tests to it), update the IGT_VERSIO
131 gitlab-ci.yml file.
132
133
134 How to test your changes to the scripts
135 =======================================
136
137 For testing changes to the scripts in the drm-
138 DRM_CI_PROJECT_PATH and DRM_CI_COMMIT_SHA vari
139 drivers/gpu/drm/ci/gitlab-ci.yml to match your
140 janedoe/drm-ci). This fork needs to be in http
141
142
143 How to incorporate external fixes in your test
144 ==============================================
145
146 Often, regressions in other trees will prevent
147 tree under test. These fixes will be automatic
148 jobs from a branch in the target tree that is
149 ${TARGET_BRANCH}-external-fixes.
150
151 If the pipeline is not in a merge request and
152 exists in the local tree, commits from that br
153
154
155 How to deal with automated testing labs that m
156 ==============================================
157
158 If a hardware farm is down and thus causing pi
159 otherwise pass, one can disable all jobs that
160 by editing the file at
161 https://gitlab.freedesktop.org/gfx-ci/lab-stat
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.