[med-svn] [Git][med-team/policy][master] Update policy about embedding test data
Nilesh Patra
gitlab at salsa.debian.org
Mon Nov 2 11:05:06 GMT 2020
Nilesh Patra pushed to branch master at Debian Med / policy
Commits:
22154aec by Nilesh Patra at 2020-11-02T16:34:21+05:30
Update policy about embedding test data
- - - - -
2 changed files:
- policy.html
- policy.rst
Changes:
=====================================
policy.html
=====================================
@@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
+<meta name="generator" content="Docutils 0.16: http://docutils.sourceforge.net/" />
<title>policy.rst</title>
<style type="text/css">
@@ -365,7 +365,7 @@ ul.auto-toc {
<p><img alt="debian-med-logo" src="https://people.debian.org/~tille/debian-med/logos/med-06.jpg" /></p>
<div class="contents topic" id="table-of-contents">
-<p class="topic-title first">Table of Contents</p>
+<p class="topic-title">Table of Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#introduction" id="id10">Introduction</a></li>
<li><a class="reference internal" href="#how-to-contribute" id="id11">How to Contribute</a><ul>
@@ -447,8 +447,9 @@ ul.auto-toc {
</li>
</ul>
</li>
-<li><a class="reference internal" href="#faq" id="id72">FAQ</a><ul>
-<li><a class="reference internal" href="#what-to-do-if-a-large-package-does-not-build-on-a-specific-autobuilder-architecture" id="id73">What to do if a large package does not build on a specific autobuilder architecture?</a></li>
+<li><a class="reference internal" href="#embedding-large-test-data" id="id72">Embedding Large Test Data</a></li>
+<li><a class="reference internal" href="#faq" id="id73">FAQ</a><ul>
+<li><a class="reference internal" href="#what-to-do-if-a-large-package-does-not-build-on-a-specific-autobuilder-architecture" id="id74">What to do if a large package does not build on a specific autobuilder architecture?</a></li>
</ul>
</li>
</ul>
@@ -1299,10 +1300,37 @@ the Debian Wiki.</p>
</div>
</div>
</div>
+<div class="section" id="embedding-large-test-data">
+<h1><a class="toc-backref" href="#id72">Embedding Large Test Data</a></h1>
+<p>Often a lot of times, there's a need to fetch external data for adding autopkgtests.
+We choose to make a separate orig tarball for data if the size of data far exceeds the size of package.</p>
+<p><tt class="docutils literal">Step - 1:</tt></p>
+<p>Update <tt class="docutils literal">gbp.conf</tt> with the following:</p>
+<pre class="literal-block">
+[DEFAULT]
+pristine-tar=True
+filter=[ '.gitignore', '.travis.yml', '.git*' ]
+component=['debian-tests-data']
+</pre>
+<p><tt class="docutils literal">Step - 2:</tt></p>
+<p>Usually the orig tarball of existing package is: <tt class="docutils literal">pkgname_version.orig.tar.xz</tt> or <tt class="docutils literal">pkgname_version.orig.tar.gz</tt>
+The data tar should be named: <tt class="docutils literal"><span class="pre">pkgname_version.orig-debian-tests-data.tar.xz</span></tt> or <tt class="docutils literal"><span class="pre">pkgname_version.orig-debian-tests-data.tar.gz</span></tt> respectively.</p>
+<p>Migrate outside the source directory,
+Simply fetch the data(from external source) and make the tarball: <tt class="docutils literal">tar cJf <span class="pre">pkgname_version.orig-debian-tests-data.tar.xz</span> data</tt></p>
+<p><tt class="docutils literal">Step - 3:</tt></p>
+<p>Delete the corresponding upstream tag pertaining to the current version (if already present): <tt class="docutils literal">git tag <span class="pre">-d</span> upstream/version</tt>
+Import the orig tarball with: <tt class="docutils literal">gbp <span class="pre">import-orig</span> <span class="pre">--pristine-tar</span> <span class="pre">../pkgname_version.orig.tar.xz</span></tt></p>
+<p><tt class="docutils literal">NB:</tt> Make sure that <tt class="docutils literal">pkgname_version.orig.tar.xz</tt> and <tt class="docutils literal"><span class="pre">pkgname_version.orig-debian-tests-data.tar.xz</span></tt></p>
+<p>After this, you should see a <tt class="docutils literal"><span class="pre">debian-tests-data</span></tt> in the source tree and running <tt class="docutils literal">origtargz</tt> should also generate a data tarball.
+Simply use the <tt class="docutils literal"><span class="pre">debian-tests-data</span></tt> to seek data for running autopkgtests:</p>
+<p>Either move files from this directory to <tt class="docutils literal">AUTOPKGTEST_TMP</tt> or install it in a separate binary.</p>
+<p>Packages: <a class="reference external" href="https://salsa.debian.org/med-team/stringtie">stringtie</a> and <a class="reference external" href="https://salsa.debian.org/med-team/radiant">radiant</a> can serve as examples here.
+For further reading, check <a class="reference external" href="https://wiki.debian.org/Javascript/GroupSourcesTutorial#Manual_way">Javascript Team Embedding wiki</a></p>
+</div>
<div class="section" id="faq">
-<h1><a class="toc-backref" href="#id72">FAQ</a></h1>
+<h1><a class="toc-backref" href="#id73">FAQ</a></h1>
<div class="section" id="what-to-do-if-a-large-package-does-not-build-on-a-specific-autobuilder-architecture">
-<span id="autobuilder"></span><h2><a class="toc-backref" href="#id73">What to do if a large package does not build on a specific autobuilder architecture?</a></h2>
+<span id="autobuilder"></span><h2><a class="toc-backref" href="#id74">What to do if a large package does not build on a specific autobuilder architecture?</a></h2>
<p>Some of our target packages are large regarding memory consumption or
requiring more computing power to build on not so powerful
architectures. Since the Debian autobuilder infrastructure consists of
=====================================
policy.rst
=====================================
@@ -1104,6 +1104,47 @@ Please see ``man 1 quilt`` to have a comprehensive list of commands
and the `UsingQuilt <https://wiki.debian.org/UsingQuilt>`__ page on
the Debian Wiki.
+Embedding Large Test Data
+=========================
+
+Often a lot of times, there's a need to fetch external data for adding autopkgtests.
+We choose to make a separate orig tarball for data if the size of data far exceeds the size of package.
+
+``Step - 1:``
+
+Update ``gbp.conf`` with the following:
+::
+
+ [DEFAULT]
+ pristine-tar=True
+ filter=[ '.gitignore', '.travis.yml', '.git*' ]
+ component=['debian-tests-data']
+
+
+``Step - 2:``
+
+Usually the orig tarball of existing package is: ``pkgname_version.orig.tar.xz`` or ``pkgname_version.orig.tar.gz``
+The data tar should be named: ``pkgname_version.orig-debian-tests-data.tar.xz`` or ``pkgname_version.orig-debian-tests-data.tar.gz`` respectively.
+
+Migrate outside the source directory,
+Simply fetch the data(from external source) and make the tarball: ``tar cJf pkgname_version.orig-debian-tests-data.tar.xz data``
+
+``Step - 3:``
+
+Delete the corresponding upstream tag pertaining to the current version (if already present): ``git tag -d upstream/version``
+Import the orig tarball with: ``gbp import-orig --pristine-tar ../pkgname_version.orig.tar.xz``
+
+``NB:`` Make sure that ``pkgname_version.orig.tar.xz`` and ``pkgname_version.orig-debian-tests-data.tar.xz``
+
+After this, you should see a ``debian-tests-data`` in the source tree and running ``origtargz`` should also generate a data tarball.
+Simply use the ``debian-tests-data`` to seek data for running autopkgtests:
+
+Either move files from this directory to ``AUTOPKGTEST_TMP`` or install it in a separate binary.
+
+Packages: `stringtie <https://salsa.debian.org/med-team/stringtie>`_ and `radiant <https://salsa.debian.org/med-team/radiant>`_ can serve as examples here.
+For further reading, check `Javascript Team Embedding wiki <https://wiki.debian.org/Javascript/GroupSourcesTutorial#Manual_way>`_
+
+
FAQ
===
View it on GitLab: https://salsa.debian.org/med-team/policy/-/commit/22154aec4780317a3546fa21951536874cade9a5
--
View it on GitLab: https://salsa.debian.org/med-team/policy/-/commit/22154aec4780317a3546fa21951536874cade9a5
You're receiving this email because of your account on salsa.debian.org.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://alioth-lists.debian.net/pipermail/debian-med-commit/attachments/20201102/91dbfa38/attachment-0001.html>
More information about the debian-med-commit
mailing list