-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathDataFilesForTesting.html
369 lines (326 loc) · 22.3 KB
/
DataFilesForTesting.html
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Data Files for Testing</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css?v=fadd4351" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=77160d70" />
<script src="_static/documentation_options.js?v=a8da1a53"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Testing Utilities" href="TestingUtilities.html" />
<link rel="prev" title="System Tests" href="SystemTests.html" />
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-59110517-1', 'auto');
ga('send', 'pageview');
</script>
</head><body>
<div id="navbar" class="navbar navbar-default ">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="http://www.mantidproject.org">
</a>
<span class="navbar-text navbar-version pull-left"><b>main</b></span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li class="divider-vertical"></li>
<li><a href="index.html">Home</a></li>
<li><a href="https://download.mantidproject.org">Download</a></li>
<li><a href="https://docs.mantidproject.org">User Documentation</a></li>
<li><a href="http://www.mantidproject.org/contact">Contact Us</a></li>
</ul>
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<p>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="nav-item nav-item-0"><a href="index.html">Documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Data Files for Testing</a></li>
</ul>
</div> </p>
</div>
<div class="container">
<div class="row">
<div class="body col-md-12 content" role="main">
<section id="data-files-for-testing">
<span id="datafilesfortesting"></span><h1>Data Files for Testing<a class="headerlink" href="#data-files-for-testing" title="Link to this heading">¶</a></h1>
<nav class="contents local" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#summary" id="id2">Summary</a></p></li>
<li><p><a class="reference internal" href="#motivation" id="id3">Motivation</a></p></li>
<li><p><a class="reference internal" href="#cmake-s-external-data" id="id4">CMake’s External Data</a></p></li>
<li><p><a class="reference internal" href="#local-object-store" id="id5">Local Object Store</a></p></li>
<li><p><a class="reference internal" href="#binary-root" id="id6">Binary Root</a></p></li>
<li><p><a class="reference internal" href="#using-existing-data" id="id7">Using Existing Data</a></p></li>
<li><p><a class="reference internal" href="#adding-a-new-file-s" id="id8">Adding A New File(s)</a></p></li>
<li><p><a class="reference internal" href="#updating-file-s" id="id9">Updating File(s)</a></p></li>
<li><p><a class="reference internal" href="#developer-setup" id="id10">Developer Setup</a></p>
<ul>
<li><p><a class="reference internal" href="#example-cmake-command" id="id11">Example cmake command:</a></p></li>
<li><p><a class="reference internal" href="#setting-with-dropbox" id="id12">Setting With Dropbox:</a></p></li>
<li><p><a class="reference internal" href="#proxy-settings" id="id13">Proxy Settings</a></p></li>
<li><p><a class="reference internal" href="#troubleshooting" id="id14">Troubleshooting</a></p></li>
</ul>
</li>
</ul>
</nav>
<section id="summary">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Summary</a><a class="headerlink" href="#summary" title="Link to this heading">¶</a></h2>
<p>This page gives an overview of how data files are managed within Mantid.</p>
</section>
<section id="motivation">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Motivation</a><a class="headerlink" href="#motivation" title="Link to this heading">¶</a></h2>
<p>Some unit tests use a small amount of data that is created by the test
harness and others load data from a file. Take the example of
<code class="docutils literal notranslate"><span class="pre">ApplyCalibrationTest</span></code>. In its first test, testSimple, it creates a
workspace with 10 detectors using
<code class="docutils literal notranslate"><span class="pre">WorkspaceCreationHelper::create2DWorkspaceWithFullInstrument()</span></code>. In
the second test, testComplex, it reads a file
<code class="docutils literal notranslate"><span class="pre">unit_testing/MAPS_Definition_Reduced.xml</span></code>, which contains
the definition of a MAPS instrument with the number of detectors reduced
much to ensure it is read quickly but preserving the other properties of
this instrument. However, new tests should avoid even loading of this
nature unless there is a strong justification for doing so.</p>
<p><strong>Main issues:</strong></p>
<ul class="simple">
<li><p>need to store data, mainly for testing, alongside the code</p></li>
<li><p>some data needs to be versioned</p></li>
<li><p>merging system tests back with main code requires handling large data
files</p></li>
<li><p>git is bad at handling binary files</p></li>
</ul>
<p><strong>Possible solutions:</strong></p>
<ul class="simple">
<li><p>CMake’s <a class="reference external" href="http://www.kitware.com/source/home/post/107">ExternalData</a></p></li>
<li><p>don’t have any reference to data in git and force developers to
manage the data stored on a file server</p></li>
<li><p>extensions to git, e.g.
<a class="reference external" href="https://github.com/jedbrown/git-fat">git-fat</a>,
<a class="reference external" href="https://git-annex.branchable.com/">git-annex</a> to deal with large
files</p></li>
</ul>
<p>We have chosen to use CMake as it is already in use as a build system
and it doesn’t involve introducing extra work with git.</p>
</section>
<section id="cmake-s-external-data">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">CMake’s External Data</a><a class="headerlink" href="#cmake-s-external-data" title="Link to this heading">¶</a></h2>
<figure class="align-center" id="id1">
<img alt="Image originated at http://www.kitware.com/source/home/post/107" src="_images/ExternalDataSchematic.png" />
<figcaption>
<p><span class="caption-text">Image originated at <a class="reference external" href="http://www.kitware.com/source/home/post/107">http://www.kitware.com/source/home/post/107</a></span><a class="headerlink" href="#id1" title="Link to this image">¶</a></p>
</figcaption>
</figure>
<p><strong>Terminology:</strong></p>
<ul class="simple">
<li><p>content - the real data</p></li>
<li><p>content link - text file containing a hash (MD5) of the real content.
The filename is the filename of the real data plus the <code class="docutils literal notranslate"><span class="pre">.md5</span></code>
extension</p></li>
<li><p>object - a file that stores the real data and whose name is the <code class="docutils literal notranslate"><span class="pre">MD5</span></code>
hash of the content</p></li>
</ul>
<p><strong>Overview:</strong></p>
<ul class="simple">
<li><p>git does not store any content, it only stores content links</p></li>
<li><p>content is stored on a remote server that can be accessed via a
<code class="docutils literal notranslate"><span class="pre">http</span></code> link</p></li>
<li><p>running cmake sets up build rules so that the content is downloaded
when dependent projects are built</p></li>
</ul>
</section>
<section id="local-object-store">
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Local Object Store</a><a class="headerlink" href="#local-object-store" title="Link to this heading">¶</a></h2>
<p>CMake does not download content directly but stores the content in a
<em>Local Object Store</em>, whose location is defined by the
<code class="docutils literal notranslate"><span class="pre">ExternalData_OBJECT_STORES</span></code> CMake variable. This allows it to share
content between build trees, especially useful for continuous
integration servers.</p>
</section>
<section id="binary-root">
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Binary Root</a><a class="headerlink" href="#binary-root" title="Link to this heading">¶</a></h2>
<p>The final step is to create the <em>real</em> filename and symbolic link (copy
on windows) it to the object in the local object store. The location of
the <em>real</em> filenames is controlled by the <code class="docutils literal notranslate"><span class="pre">ExternalData_BINARY_ROOT</span></code>
CMake variable and defaults to <code class="docutils literal notranslate"><span class="pre">build/ExternalData</span></code>.</p>
</section>
<section id="using-existing-data">
<h2><a class="toc-backref" href="#id7" role="doc-backlink">Using Existing Data</a><a class="headerlink" href="#using-existing-data" title="Link to this heading">¶</a></h2>
<p>For unit testings, there are two places files may be found:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/mantidproject/mantid/tree/main/Testing/Data">…/Testing/Data/</a>
for <a class="reference internal" href="RunningTheUnitTests.html#runningtheunittests"><span class="std std-ref">unit test</span></a>, <a class="reference internal" href="Standards/DocumentationGuideForDevs.html#documentationguidefordevs"><span class="std std-ref">doc test</span></a>, and <a class="reference internal" href="SystemTests.html#systemtests"><span class="std std-ref">system test</span></a> data</p></li>
<li><p><a class="reference external" href="https://github.com/mantidproject/mantid/tree/main/instrument/unit_testing">…/instrument/unit_testing</a>
for test <a class="reference external" href="https://docs.mantidproject.org/nightly/concepts/InstrumentDefinitionFile.html#instrumentdefinitionfile" title="(in MantidProject v6.11)"><span class="xref std std-ref">IDF</span></a> files</p></li>
</ul>
<p>For system testings, there is one more location developers use to dump reference
data files:</p>
<ul class="simple">
<li><p><cite>…/Testing/SystemTests/tests/framework/reference</cite></p></li>
</ul>
<p>Generally speaking, the testing system will look for the default locations for
corresponding tests:</p>
<ul class="simple">
<li><p><cite>…/Testing/Data/DocTest</cite></p></li>
<li><p><cite>…/Testing/Data/SystemTest</cite></p></li>
<li><p><cite>…/Testing/Data/UnitTest</cite></p></li>
</ul>
<p>However, it is known that some developers like to reuse the same data files for
different type of tests, therefore sometime the DocTest and SystemTest is using
data from UnitTest, which means you should fetch all testing data before trying
to run any test locally.
Furthermore, this location is mostly considered as a centralized location for all
testing data.
But some groups prefer to treat this location for storing <strong>input</strong> testing data
only, therefore the testing system will look for the reference folder mentioned
above if it cannot find the reference data here.
Overall, it is important to talk to the senior developers in your team to learn
the preferred location for storing testing data.</p>
</section>
<section id="adding-a-new-file-s">
<span id="datafilesfortesting-addinganewfile"></span><h2><a class="toc-backref" href="#id8" role="doc-backlink">Adding A New File(s)</a><a class="headerlink" href="#adding-a-new-file-s" title="Link to this heading">¶</a></h2>
<p>A helper git command is defined called <code class="docutils literal notranslate"><span class="pre">add-test-data</span></code>. Before first use, the command must be
aliased using the procedure outlined <a class="reference internal" href="#datafilesfortesting-developersetup"><span class="std std-ref">below</span></a>. Once setup,
it would be called like this:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>add-test-data<span class="w"> </span>Testing/Data/UnitTest/INST12345.nxs
</pre></div>
</div>
<p>This does the following:</p>
<ul class="simple">
<li><p>computes the MD5 hash of the data, e.g.
<code class="docutils literal notranslate"><span class="pre">d6948514d78db7fe251efb6cce4a9b83</span></code></p></li>
<li><p>stores the MD5 hash in a file called
<code class="docutils literal notranslate"><span class="pre">Testing/Data/UnitTest/INST12345.nxs.md5</span></code></p></li>
<li><p>renames the original data file to be its md5 sum
<code class="docutils literal notranslate"><span class="pre">Testing/Data/UnitTest/d6948514d78db7fe251efb6cce4a9b83</span></code></p></li>
<li><p>runs <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">add</span> <span class="pre">Testing/Data/UnitTest/INST12345.nxs.md5</span></code></p></li>
<li><p>tells the user to upload the file(s),
<code class="docutils literal notranslate"><span class="pre">d6948514d78db7fe251efb6cce4a9b83</span></code>, to the <a class="reference external" href="https://testdata.mantidproject.org/ftp/external-data/upload">remote store</a></p></li>
</ul>
<p><strong>Notes:</strong></p>
<ul class="simple">
<li><p>For the change to have effect, re-run <code class="docutils literal notranslate"><span class="pre">cmake</span></code> in the build area</p></li>
<li><p>You need to use a shell to add & modify data files under Windows in
this way. Not every shell works as described, though <a class="reference external" href="https://windows.github.com/">Github for
Windows</a> shell would allow you to do
everything described here step by step without deviations.</p></li>
<li><p>Note, that ILL test data should be placed under <code class="docutils literal notranslate"><span class="pre">ILL/${INSTRUMENT}</span></code>
subdirectories (e.g. <code class="docutils literal notranslate"><span class="pre">ILL/IN16B</span></code>), and should not contain any
instrument prefix in the file name.</p></li>
</ul>
</section>
<section id="updating-file-s">
<h2><a class="toc-backref" href="#id9" role="doc-backlink">Updating File(s)</a><a class="headerlink" href="#updating-file-s" title="Link to this heading">¶</a></h2>
<p>The workflow is the same as <a class="reference internal" href="#datafilesfortesting-addinganewfile"><span class="std std-ref">adding new files</span></a> except that the developer must first put the new version of the file in the right place. For the example above, it would be <code class="docutils literal notranslate"><span class="pre">Testing/Data/UnitTest/INST12345.nxs</span></code>. Then the new <code class="docutils literal notranslate"><span class="pre">.md5</span></code> file and associated renamed file will be created. <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">diff</span></code> will show that change to the contents of <code class="docutils literal notranslate"><span class="pre">Testing/Data/UnitTest/INST12345.nxs.md5</span></code> and that there is an untracked file with the md5 sum for a name.</p>
</section>
<section id="developer-setup">
<span id="datafilesfortesting-developersetup"></span><h2><a class="toc-backref" href="#id10" role="doc-backlink">Developer Setup</a><a class="headerlink" href="#developer-setup" title="Link to this heading">¶</a></h2>
<p>To add the <code class="docutils literal notranslate"><span class="pre">add-test-data</span></code> command alias to git run</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>config<span class="w"> </span>alias.add-test-data<span class="w"> </span><span class="s1">'!bash -c "tools/Development/git/git-add-test-data $*"'</span>
</pre></div>
</div>
<p>in the git bash shell
(<a class="reference external" href="https://github.com/mantidproject/mantid/blob/main/tools/Development/git/git-add-test-data">script source</a>).
The single quotes are important so that bash doesn’t expand the exclamation mark as a variable.</p>
<p>It is advised that CMake is told where to put the “real” data as the
default is <code class="docutils literal notranslate"><span class="pre">$HOME/MantidExternalData</span></code> on Linux/Mac or
<code class="docutils literal notranslate"><span class="pre">C:/MantidExternalData</span></code> on Windows. Over time the store will grow so
it is recommended that it be placed on a disk with a large amount of
space. CMake uses the <code class="docutils literal notranslate"><span class="pre">MANTID_DATA_STORE</span></code> variable to define where the
data is stored.</p>
<section id="example-cmake-command">
<h3><a class="toc-backref" href="#id11" role="doc-backlink">Example cmake command:</a><a class="headerlink" href="#example-cmake-command" title="Link to this heading">¶</a></h3>
<p><strong>Linux/Mac:</strong></p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>mkdir<span class="w"> </span>-p<span class="w"> </span>build
cmake<span class="w"> </span>-DMANTID_DATA_STORE<span class="o">=</span>/home/mgigg/Data/LocalObjectStore<span class="w"> </span>../Code/Mantid
</pre></div>
</div>
<p><strong>Windows:</strong></p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>mkdir<span class="w"> </span>build
cmake<span class="w"> </span>-DMANTID_DATA_STORE<span class="o">=</span>D:/Data/LocalObjectStore<span class="w"> </span>../Code/Mantid
</pre></div>
</div>
</section>
<section id="setting-with-dropbox">
<h3><a class="toc-backref" href="#id12" role="doc-backlink">Setting With Dropbox:</a><a class="headerlink" href="#setting-with-dropbox" title="Link to this heading">¶</a></h3>
<p>This is for people in the ORNL dropbox share and has the effect of
reducing external network traffic. There is a <a class="reference external" href="http://gist.github.com/peterfpeterson/638490530e37c3d8dba5">gist</a> for
getting dropbox running on linux. Instead of defining the
<code class="docutils literal notranslate"><span class="pre">MANTID_DATA_STORE</span></code> in cmake, it is simplest to create a symbolic
link</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>ln<span class="w"> </span>-s<span class="w"> </span>~/Dropbox<span class="se">\ \(</span>ORNL<span class="se">\)</span>/MantidExternalData<span class="w"> </span>~
</pre></div>
</div>
<p>Then everything will happen automatically using CMake’s default behavior.</p>
</section>
<section id="proxy-settings">
<h3><a class="toc-backref" href="#id13" role="doc-backlink">Proxy Settings</a><a class="headerlink" href="#proxy-settings" title="Link to this heading">¶</a></h3>
<p>If you are sitting behind a proxy server then the shell or Visual studio
needs to know about the proxy server. You must set the <code class="docutils literal notranslate"><span class="pre">http_proxy</span></code>
environment variable to <code class="docutils literal notranslate"><span class="pre">http://HOSTNAME:PORT</span></code>.</p>
<p>On Windows you go to <code class="docutils literal notranslate"><span class="pre">Control</span> <span class="pre">Panel->System</span></code> and
<code class="docutils literal notranslate"><span class="pre">Security->System->Advanced</span> <span class="pre">System</span> <span class="pre">settings->Environment</span> <span class="pre">Variables</span></code> and
click <code class="docutils literal notranslate"><span class="pre">New...</span></code> to add a variable.</p>
<p>On Linux/Mac you will need to set the variable in the shell profile or
on Linux you can set it system wide in <code class="docutils literal notranslate"><span class="pre">/etc/environment</span></code>.</p>
</section>
<section id="troubleshooting">
<h3><a class="toc-backref" href="#id14" role="doc-backlink">Troubleshooting</a><a class="headerlink" href="#troubleshooting" title="Link to this heading">¶</a></h3>
<p>If you find that your tests cannot find the data they require check the
following gotchas:</p>
<ul class="simple">
<li><p>Check that you have re-run CMake in the build directory</p></li>
<li><p>Check that you have uploaded the original file renamed as a hash to
the Mantid file repository</p></li>
<li><p>Check that you have removed any user defined data search directories
in <code class="docutils literal notranslate"><span class="pre">~/.mantid</span></code></p></li>
<li><p>Check that you have rebuilt the test executable you’re trying to run</p></li>
<li><p>Check that you have rebuilt the SystemTestData target</p></li>
</ul>
</section>
</section>
</section>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<ul class="nav navbar-nav" style=" float: right;">
<li>
<a href="SystemTests.html" title="Previous Chapter: System Tests"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« System Tests</span>
</a>
</li>
<li>
<a href="TestingUtilities.html" title="Next Chapter: Testing Utilities"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Testing Utilities »</span>
</a>
</li>
<li><a href="#">Back to top</a></li>
</ul>
<p>
</p>
</div>
</footer>
</body>
</html>