/usr/share/debci/public/doc/file.MAINTAINERS.html is in debci 1.5.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 | <!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
File: MAINTAINERS
— Documentation by YARD 0.9.7
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
pathId = "MAINTAINERS";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="file_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index</a> »
<span class="title">File: MAINTAINERS</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><div id='filecontents'>
<h1 id="label-FAQ+for+package+maintainers">FAQ for package maintainers</h1>
<h2 id="label-How+can+I+reproduce+the+test+run+locally-3F">How can I reproduce the test run locally?</h2>
<p><strong>NOTE:</strong> if you intend to run tests frequently, you should
consider installing <code>apt-cacher-ng</code> before anything else.
<code>debci</code> will notice the running proxy and will setup the testbed
to use it, so you won't have to wait for the download of each package
more than once.</p>
<h3 id="label-Using+no+virtualization+backend">Using no virtualization backend</h3>
<p>This is the fastest way to run tests, but does not reproduce the continuous
integration environment faithfully and your local environment may make the
results unreliable. It's useful nevertheless when initially writing the
tests, or for quick runs against your main host system.</p>
<p>To run the test suite from <strong>the root of a source package</strong>
against the currently installed packages, run:</p>
<pre class="code ruby"><code class="ruby">$ adt-run --output-dir /tmp/output-dir ./ --- null</code></pre>
<p>For more details, see the documentation for the <code>autopkgtest</code>
package.</p>
<h3 id="label-Using+the+lxc+backend+-28default+as+of+debci+-3E-3D+1.0-29">Using the lxc backend (default as of debci >= 1.0)</h3>
<p>First step is to configure networking for the lxc containers. The easiest
way to to that is by using the libvirt networking support. First, install
the necessary packages and activate the default libvirt network:</p>
<pre class="code ruby"><code class="ruby"><span class='comment'># apt install lxc libvirt-clients libvirt-daemon-system
</span><span class='comment'># virsh net-start default
</span><span class='comment'># virsh net-autostart default
</span></code></pre>
<p><strong>Note:</strong> the default libvirt network will use the
<code>192.168.122.0/24</code> network. If that conflicts with your local
network, you will need to configure it to use a different IP range.</p>
<p>Now configure lxc to use the default libvirt network, by putting the
following content in <code>/etc/lxc/default.conf</code>:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_lxc'>lxc</span><span class='period'>.</span><span class='id identifier rubyid_network'>network</span><span class='period'>.</span><span class='id identifier rubyid_type'>type</span> <span class='op'>=</span> <span class='id identifier rubyid_veth'>veth</span>
<span class='id identifier rubyid_lxc'>lxc</span><span class='period'>.</span><span class='id identifier rubyid_network'>network</span><span class='period'>.</span><span class='id identifier rubyid_link'>link</span> <span class='op'>=</span> <span class='id identifier rubyid_virbr0'>virbr0</span>
<span class='id identifier rubyid_lxc'>lxc</span><span class='period'>.</span><span class='id identifier rubyid_network'>network</span><span class='period'>.</span><span class='id identifier rubyid_flags'>flags</span> <span class='op'>=</span> <span class='id identifier rubyid_up'>up</span>
</code></pre>
<p>Now install and configure <code>debci</code>:</p>
<pre class="code ruby"><code class="ruby">$ sudo apt install debci autopkgtest</code></pre>
<p>You will also need permissions to run the <code>lxc-*</code> commands as
root, preserving your environment. An easy way to do that is to add
yourself to the debci group.</p>
<pre class="code ruby"><code class="ruby">$ sudo addgroup YOUR_USERNAME debci</code></pre>
<p>You're now ready to create the lxc container:</p>
<pre class="code ruby"><code class="ruby">$ sudo debci setup</code></pre>
<p>This might take a few minutes since it will create a fresh container from
scratch.</p>
<p>Now to actually run tests, we'll use the adt-run tool from
<code>autopkgtest</code> directly. The following examples assume your
architecture is amd64, replace it by your actual architecture if that is
not the case.</p>
<p>To run the test suite <strong>from a source package in the
archive</strong>, just pass the <em>source package name</em> to adt-run:</p>
<pre class="code ruby"><code class="ruby">$ adt-run --user debci --output-dir /tmp/output-dir SOURCEPACKAGE --- lxc --sudo adt-sid-amd64</code></pre>
<p>To run the test suite against <strong>a locally-built source
package</strong>, using the test suite from that source package and the
binary packages you just built, you can pass the <code>.changes</code> file
to adt-run:</p>
<pre class="code ruby"><code class="ruby">$ adt-run --user debci --output-dir /tmp/output-dir \
/path/to/PACKAGE_x.y-z_amd64.changes \
--- lxc --sudo adt-sid-amd64</code></pre>
<p>For more details, see the documentation for the <code>autopkgtest</code>
package.</p>
<h3 id="label-Using+the+schroot+backend">Using the schroot backend</h3>
<p>Install a configure <code>debci</code> and <code>schroot</code>:</p>
<pre class="code ruby"><code class="ruby">$ sudo apt install debci autopkgtest schroot
$ sudo debci setup --backend schroot</code></pre>
<p>Edit <code>/etc/schroot/chroot.d/debci-SUITE-ARCH</code> (by default
<code>SUITE</code> is <code>unstable</code> and <code>ARCH</code> is your
native architecture), and add your username to the <code>users</code>,
<code>root-users</code> and <code>source-root-users</code> configuration
keys:</p>
<pre class="code ruby"><code class="ruby">[...]
users=debci,$YOUR_USERNAME
[...]
root-users=debci,$YOUR_USERNAME
source-root=users=debci,$YOUR_USERNAME
[...]</code></pre>
<p>To speed up test suite execution, you can also add the following line at
the end:</p>
<pre class="code ruby"><code class="ruby">union-overlay-directory=/dev/shm</code></pre>
<p>This will mount the chroot overlay on <code>tmpfs</code> which will make
installing test dependencies a lot faster. If your hard disk is already a
SSD, you probably don't need that. If you don't have a good amount
of RAM, you may have problems using this.</p>
<p>The following examples assume:</p>
<ul><li>
<p>suite = <code>unstable</code> (the default)</p>
</li><li>
<p>architecture = <code>amd64</code></p>
</li></ul>
<p>To run the test suite <strong>from a source package in the
archive</strong>, you pass the <em>package name</em> to adt-run:</p>
<pre class="code ruby"><code class="ruby">$ adt-run --user debci --output-dir /tmp/output-dir SOURCEPACKAGE --- schroot debci-unstable-amd64</code></pre>
<p>To run the test suite against <strong>a locally-built source
package</strong>, using the test suite from that source package and the
binary packages you just built, you can pass the <code>.changes</code> file
to adt-run:</p>
<pre class="code ruby"><code class="ruby">$ adt-run --user debci --output-dir /tmp/output-dir \
/path/to/PACKAGE_x.y-z_amd64.changes \
--- schroot debci-unstable-amd64</code></pre>
<p>For more details, see the documentation for the <code>autopkgtest</code>
package.</p>
<h2 id="label-How+do+I+get+my+package+to+have+its+test+suite+executed-3F">How do I get my package to have its test suite executed?</h2>
<p>Test suites must be included in source packages as defined in the <a
href="http://dep.debian.net/deps/dep8/">DEP-8 specification</a>. In short.</p>
<ul><li>
<p>The fact that the package has a test suite must be declared by adding a
<code>Testsuite: autopkgtest</code> entry to the source stanza in
<code>debian/control</code>.</p>
</li><li>
<p>if the package is built with dpkg earlier than 1.17.6, you need to use
<code>XS-Testsuite: autopkgtest</code> instead.</p>
</li><li>
<p>tests are declared in <code>debian/tests/control</code>.</p>
</li></ul>
<p>Please refer to the DEP-8 spec for details on how to declare your tests.</p>
<h2 id="label-How+exactly+is+the+test+suite+executed-3F">How exactly is the test suite executed?</h2>
<p>Test suites are executed by <a
href="http://packages.debian.org/autopkgtest">autopkgtest</a>. The version
of autopkgtest used to execute the tests is shown in the log file for each
test run.</p>
<h2 id="label-How+often+are+test+suites+executed-3F">How often are test suites executed?</h2>
<p>The test suite for a source package will be executed:</p>
<ul><li>
<p>when any package in the dependency chain of its binary packages changes;</p>
</li><li>
<p>when the package itself changes;</p>
</li><li>
<p>when 1 month is passed since the test suite was run for the last time.</p>
</li></ul>
</div></div>
<div id="footer">
Generated by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.7 (ruby-2.3.3).
</div>
</div>
</body>
</html>
|