-
Notifications
You must be signed in to change notification settings - Fork 189
/
Copy pathfireworks.tests.html
477 lines (425 loc) · 46.4 KB
/
fireworks.tests.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
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
<!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>fireworks.tests package — FireWorks 2.0.4 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/nature.css?v=b0beeceb" />
<script src="_static/documentation_options.js?v=adc66a14"></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 href='https://fonts.googleapis.com/css?family=Lato:400,700' rel='stylesheet' type='text/css'>
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">FireWorks 2.0.4 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">fireworks.tests package</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="fireworks-tests-package">
<h1>fireworks.tests package<a class="headerlink" href="#fireworks-tests-package" title="Link to this heading">¶</a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">¶</a></h2>
</section>
<section id="fireworks-tests-master-tests-module">
<h2>fireworks.tests.master_tests module<a class="headerlink" href="#fireworks-tests-master-tests-module" title="Link to this heading">¶</a></h2>
</section>
<section id="fireworks-tests-mongo-tests-module">
<h2>fireworks.tests.mongo_tests module<a class="headerlink" href="#fireworks-tests-mongo-tests-module" title="Link to this heading">¶</a></h2>
</section>
<section id="module-fireworks.tests.multiprocessing_tests">
<span id="fireworks-tests-multiprocessing-tests-module"></span><h2>fireworks.tests.multiprocessing_tests module<a class="headerlink" href="#module-fireworks.tests.multiprocessing_tests" title="Link to this heading">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="fireworks.tests.multiprocessing_tests.TestCheckoutFW">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">fireworks.tests.multiprocessing_tests.</span></span><span class="sig-name descname"><span class="pre">TestCheckoutFW</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">methodName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'runTest'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fireworks.tests.multiprocessing_tests.TestCheckoutFW" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">TestCase</span></code></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="fireworks.tests.multiprocessing_tests.TestCheckoutFW.lp">
<span class="sig-name descname"><span class="pre">lp</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#fireworks.tests.multiprocessing_tests.TestCheckoutFW.lp" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.multiprocessing_tests.TestCheckoutFW.setUp">
<span class="sig-name descname"><span class="pre">setUp</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.multiprocessing_tests.TestCheckoutFW.setUp" title="Link to this definition">¶</a></dt>
<dd><p>Hook method for setting up the test fixture before exercising it.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.multiprocessing_tests.TestCheckoutFW.setUpClass">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setUpClass</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.multiprocessing_tests.TestCheckoutFW.setUpClass" title="Link to this definition">¶</a></dt>
<dd><p>Hook method for setting up class fixture before running tests in the class.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.multiprocessing_tests.TestCheckoutFW.tearDown">
<span class="sig-name descname"><span class="pre">tearDown</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.multiprocessing_tests.TestCheckoutFW.tearDown" title="Link to this definition">¶</a></dt>
<dd><p>Hook method for deconstructing the test fixture after testing it.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.multiprocessing_tests.TestCheckoutFW.tearDownClass">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tearDownClass</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.multiprocessing_tests.TestCheckoutFW.tearDownClass" title="Link to this definition">¶</a></dt>
<dd><p>Hook method for deconstructing the class fixture after running all tests in the class.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.multiprocessing_tests.TestCheckoutFW.test_checkout_fw">
<span class="sig-name descname"><span class="pre">test_checkout_fw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.multiprocessing_tests.TestCheckoutFW.test_checkout_fw" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="fireworks.tests.multiprocessing_tests.TestEarlyExit">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">fireworks.tests.multiprocessing_tests.</span></span><span class="sig-name descname"><span class="pre">TestEarlyExit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">methodName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'runTest'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fireworks.tests.multiprocessing_tests.TestEarlyExit" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">TestCase</span></code></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="fireworks.tests.multiprocessing_tests.TestEarlyExit.lp">
<span class="sig-name descname"><span class="pre">lp</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#fireworks.tests.multiprocessing_tests.TestEarlyExit.lp" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.multiprocessing_tests.TestEarlyExit.setUp">
<span class="sig-name descname"><span class="pre">setUp</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.multiprocessing_tests.TestEarlyExit.setUp" title="Link to this definition">¶</a></dt>
<dd><p>Hook method for setting up the test fixture before exercising it.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.multiprocessing_tests.TestEarlyExit.setUpClass">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setUpClass</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.multiprocessing_tests.TestEarlyExit.setUpClass" title="Link to this definition">¶</a></dt>
<dd><p>Hook method for setting up class fixture before running tests in the class.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.multiprocessing_tests.TestEarlyExit.tearDown">
<span class="sig-name descname"><span class="pre">tearDown</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.multiprocessing_tests.TestEarlyExit.tearDown" title="Link to this definition">¶</a></dt>
<dd><p>Hook method for deconstructing the test fixture after testing it.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.multiprocessing_tests.TestEarlyExit.tearDownClass">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tearDownClass</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.multiprocessing_tests.TestEarlyExit.tearDownClass" title="Link to this definition">¶</a></dt>
<dd><p>Hook method for deconstructing the class fixture after running all tests in the class.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.multiprocessing_tests.TestEarlyExit.test_early_exit">
<span class="sig-name descname"><span class="pre">test_early_exit</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.multiprocessing_tests.TestEarlyExit.test_early_exit" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="fireworks.tests.multiprocessing_tests.TestLinks">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">fireworks.tests.multiprocessing_tests.</span></span><span class="sig-name descname"><span class="pre">TestLinks</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">methodName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'runTest'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fireworks.tests.multiprocessing_tests.TestLinks" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">TestCase</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.multiprocessing_tests.TestLinks.test_pickle">
<span class="sig-name descname"><span class="pre">test_pickle</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.multiprocessing_tests.TestLinks.test_pickle" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-fireworks.tests.tasks">
<span id="fireworks-tests-tasks-module"></span><h2>fireworks.tests.tasks module<a class="headerlink" href="#module-fireworks.tests.tasks" title="Link to this heading">¶</a></h2>
<p>TODO: Modify module doc.</p>
<dl class="py class">
<dt class="sig sig-object py" id="fireworks.tests.tasks.DummyFWEnvTask">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">fireworks.tests.tasks.</span></span><span class="sig-name descname"><span class="pre">DummyFWEnvTask</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fireworks.tests.tasks.DummyFWEnvTask" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="fireworks.core.html#fireworks.core.firework.FiretaskBase" title="fireworks.core.firework.FiretaskBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">FiretaskBase</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.tasks.DummyFWEnvTask.run_task">
<span class="sig-name descname"><span class="pre">run_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fw_spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fireworks.tests.tasks.DummyFWEnvTask.run_task" title="Link to this definition">¶</a></dt>
<dd><p>This method gets called when the Firetask is run. It can take in a
Firework spec, perform some task using that data, and then return an
output in the form of a FWAction.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>fw_spec</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><em>dict</em></a>) – A Firework spec. This comes from the master spec.
In addition, this spec contains a special “_fw_env” key that
contains the env settings of the FWorker calling this method.
This provides for abstracting out certain commands or
settings. For example, “foo” may be named “foo1” in resource
1 and “foo2” in resource 2. The FWorker env can specify {
“foo”: “foo1”}, which maps an abstract variable “foo” to the
relevant “foo1” or “foo2”. You can then write a task that
uses fw_spec[“_fw_env”][“foo”] that will work across all
these multiple resources.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>(FWAction)</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="fireworks.tests.tasks.DummyJobPassTask">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">fireworks.tests.tasks.</span></span><span class="sig-name descname"><span class="pre">DummyJobPassTask</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fireworks.tests.tasks.DummyJobPassTask" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="fireworks.core.html#fireworks.core.firework.FiretaskBase" title="fireworks.core.firework.FiretaskBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">FiretaskBase</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.tasks.DummyJobPassTask.run_task">
<span class="sig-name descname"><span class="pre">run_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fw_spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fireworks.tests.tasks.DummyJobPassTask.run_task" title="Link to this definition">¶</a></dt>
<dd><p>This method gets called when the Firetask is run. It can take in a
Firework spec, perform some task using that data, and then return an
output in the form of a FWAction.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>fw_spec</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><em>dict</em></a>) – A Firework spec. This comes from the master spec.
In addition, this spec contains a special “_fw_env” key that
contains the env settings of the FWorker calling this method.
This provides for abstracting out certain commands or
settings. For example, “foo” may be named “foo1” in resource
1 and “foo2” in resource 2. The FWorker env can specify {
“foo”: “foo1”}, which maps an abstract variable “foo” to the
relevant “foo1” or “foo2”. You can then write a task that
uses fw_spec[“_fw_env”][“foo”] that will work across all
these multiple resources.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>(FWAction)</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="fireworks.tests.tasks.DummyLPTask">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">fireworks.tests.tasks.</span></span><span class="sig-name descname"><span class="pre">DummyLPTask</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fireworks.tests.tasks.DummyLPTask" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="fireworks.core.html#fireworks.core.firework.FiretaskBase" title="fireworks.core.firework.FiretaskBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">FiretaskBase</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.tasks.DummyLPTask.run_task">
<span class="sig-name descname"><span class="pre">run_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fw_spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fireworks.tests.tasks.DummyLPTask.run_task" title="Link to this definition">¶</a></dt>
<dd><p>This method gets called when the Firetask is run. It can take in a
Firework spec, perform some task using that data, and then return an
output in the form of a FWAction.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>fw_spec</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><em>dict</em></a>) – A Firework spec. This comes from the master spec.
In addition, this spec contains a special “_fw_env” key that
contains the env settings of the FWorker calling this method.
This provides for abstracting out certain commands or
settings. For example, “foo” may be named “foo1” in resource
1 and “foo2” in resource 2. The FWorker env can specify {
“foo”: “foo1”}, which maps an abstract variable “foo” to the
relevant “foo1” or “foo2”. You can then write a task that
uses fw_spec[“_fw_env”][“foo”] that will work across all
these multiple resources.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>(FWAction)</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="module-fireworks.tests.test_fw_config">
<span id="fireworks-tests-test-fw-config-module"></span><h2>fireworks.tests.test_fw_config module<a class="headerlink" href="#module-fireworks.tests.test_fw_config" title="Link to this heading">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="fireworks.tests.test_fw_config.ConfigTest">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">fireworks.tests.test_fw_config.</span></span><span class="sig-name descname"><span class="pre">ConfigTest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">methodName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'runTest'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fireworks.tests.test_fw_config.ConfigTest" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">TestCase</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.test_fw_config.ConfigTest.test_config">
<span class="sig-name descname"><span class="pre">test_config</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.test_fw_config.ConfigTest.test_config" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-fireworks.tests.test_workflow">
<span id="fireworks-tests-test-workflow-module"></span><h2>fireworks.tests.test_workflow module<a class="headerlink" href="#module-fireworks.tests.test_workflow" title="Link to this heading">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="fireworks.tests.test_workflow.TestWorkflowState">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">fireworks.tests.test_workflow.</span></span><span class="sig-name descname"><span class="pre">TestWorkflowState</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">methodName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'runTest'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fireworks.tests.test_workflow.TestWorkflowState" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">TestCase</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.test_workflow.TestWorkflowState.test_archived">
<span class="sig-name descname"><span class="pre">test_archived</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.test_workflow.TestWorkflowState.test_archived" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.test_workflow.TestWorkflowState.test_completed">
<span class="sig-name descname"><span class="pre">test_completed</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.test_workflow.TestWorkflowState.test_completed" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.test_workflow.TestWorkflowState.test_defused">
<span class="sig-name descname"><span class="pre">test_defused</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.test_workflow.TestWorkflowState.test_defused" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.test_workflow.TestWorkflowState.test_fizzled_1">
<span class="sig-name descname"><span class="pre">test_fizzled_1</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.test_workflow.TestWorkflowState.test_fizzled_1" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.test_workflow.TestWorkflowState.test_fizzled_2">
<span class="sig-name descname"><span class="pre">test_fizzled_2</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.test_workflow.TestWorkflowState.test_fizzled_2" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.test_workflow.TestWorkflowState.test_fizzled_3">
<span class="sig-name descname"><span class="pre">test_fizzled_3</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.test_workflow.TestWorkflowState.test_fizzled_3" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.test_workflow.TestWorkflowState.test_fizzled_4">
<span class="sig-name descname"><span class="pre">test_fizzled_4</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.test_workflow.TestWorkflowState.test_fizzled_4" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.test_workflow.TestWorkflowState.test_fizzled_5">
<span class="sig-name descname"><span class="pre">test_fizzled_5</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.test_workflow.TestWorkflowState.test_fizzled_5" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.test_workflow.TestWorkflowState.test_fizzled_6">
<span class="sig-name descname"><span class="pre">test_fizzled_6</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.test_workflow.TestWorkflowState.test_fizzled_6" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.test_workflow.TestWorkflowState.test_paused">
<span class="sig-name descname"><span class="pre">test_paused</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.test_workflow.TestWorkflowState.test_paused" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.test_workflow.TestWorkflowState.test_ready">
<span class="sig-name descname"><span class="pre">test_ready</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.test_workflow.TestWorkflowState.test_ready" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.test_workflow.TestWorkflowState.test_reserved">
<span class="sig-name descname"><span class="pre">test_reserved</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.test_workflow.TestWorkflowState.test_reserved" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.test_workflow.TestWorkflowState.test_running_1">
<span class="sig-name descname"><span class="pre">test_running_1</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.test_workflow.TestWorkflowState.test_running_1" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="fireworks.tests.test_workflow.TestWorkflowState.test_running_2">
<span class="sig-name descname"><span class="pre">test_running_2</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.tests.test_workflow.TestWorkflowState.test_running_2" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-fireworks.tests">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-fireworks.tests" title="Link to this heading">¶</a></h2>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">fireworks.tests package</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#fireworks-tests-master-tests-module">fireworks.tests.master_tests module</a></li>
<li><a class="reference internal" href="#fireworks-tests-mongo-tests-module">fireworks.tests.mongo_tests module</a></li>
<li><a class="reference internal" href="#module-fireworks.tests.multiprocessing_tests">fireworks.tests.multiprocessing_tests module</a><ul>
<li><a class="reference internal" href="#fireworks.tests.multiprocessing_tests.TestCheckoutFW"><code class="docutils literal notranslate"><span class="pre">TestCheckoutFW</span></code></a><ul>
<li><a class="reference internal" href="#fireworks.tests.multiprocessing_tests.TestCheckoutFW.lp"><code class="docutils literal notranslate"><span class="pre">TestCheckoutFW.lp</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.multiprocessing_tests.TestCheckoutFW.setUp"><code class="docutils literal notranslate"><span class="pre">TestCheckoutFW.setUp()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.multiprocessing_tests.TestCheckoutFW.setUpClass"><code class="docutils literal notranslate"><span class="pre">TestCheckoutFW.setUpClass()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.multiprocessing_tests.TestCheckoutFW.tearDown"><code class="docutils literal notranslate"><span class="pre">TestCheckoutFW.tearDown()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.multiprocessing_tests.TestCheckoutFW.tearDownClass"><code class="docutils literal notranslate"><span class="pre">TestCheckoutFW.tearDownClass()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.multiprocessing_tests.TestCheckoutFW.test_checkout_fw"><code class="docutils literal notranslate"><span class="pre">TestCheckoutFW.test_checkout_fw()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#fireworks.tests.multiprocessing_tests.TestEarlyExit"><code class="docutils literal notranslate"><span class="pre">TestEarlyExit</span></code></a><ul>
<li><a class="reference internal" href="#fireworks.tests.multiprocessing_tests.TestEarlyExit.lp"><code class="docutils literal notranslate"><span class="pre">TestEarlyExit.lp</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.multiprocessing_tests.TestEarlyExit.setUp"><code class="docutils literal notranslate"><span class="pre">TestEarlyExit.setUp()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.multiprocessing_tests.TestEarlyExit.setUpClass"><code class="docutils literal notranslate"><span class="pre">TestEarlyExit.setUpClass()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.multiprocessing_tests.TestEarlyExit.tearDown"><code class="docutils literal notranslate"><span class="pre">TestEarlyExit.tearDown()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.multiprocessing_tests.TestEarlyExit.tearDownClass"><code class="docutils literal notranslate"><span class="pre">TestEarlyExit.tearDownClass()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.multiprocessing_tests.TestEarlyExit.test_early_exit"><code class="docutils literal notranslate"><span class="pre">TestEarlyExit.test_early_exit()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#fireworks.tests.multiprocessing_tests.TestLinks"><code class="docutils literal notranslate"><span class="pre">TestLinks</span></code></a><ul>
<li><a class="reference internal" href="#fireworks.tests.multiprocessing_tests.TestLinks.test_pickle"><code class="docutils literal notranslate"><span class="pre">TestLinks.test_pickle()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#module-fireworks.tests.tasks">fireworks.tests.tasks module</a><ul>
<li><a class="reference internal" href="#fireworks.tests.tasks.DummyFWEnvTask"><code class="docutils literal notranslate"><span class="pre">DummyFWEnvTask</span></code></a><ul>
<li><a class="reference internal" href="#fireworks.tests.tasks.DummyFWEnvTask.run_task"><code class="docutils literal notranslate"><span class="pre">DummyFWEnvTask.run_task()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#fireworks.tests.tasks.DummyJobPassTask"><code class="docutils literal notranslate"><span class="pre">DummyJobPassTask</span></code></a><ul>
<li><a class="reference internal" href="#fireworks.tests.tasks.DummyJobPassTask.run_task"><code class="docutils literal notranslate"><span class="pre">DummyJobPassTask.run_task()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#fireworks.tests.tasks.DummyLPTask"><code class="docutils literal notranslate"><span class="pre">DummyLPTask</span></code></a><ul>
<li><a class="reference internal" href="#fireworks.tests.tasks.DummyLPTask.run_task"><code class="docutils literal notranslate"><span class="pre">DummyLPTask.run_task()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#module-fireworks.tests.test_fw_config">fireworks.tests.test_fw_config module</a><ul>
<li><a class="reference internal" href="#fireworks.tests.test_fw_config.ConfigTest"><code class="docutils literal notranslate"><span class="pre">ConfigTest</span></code></a><ul>
<li><a class="reference internal" href="#fireworks.tests.test_fw_config.ConfigTest.test_config"><code class="docutils literal notranslate"><span class="pre">ConfigTest.test_config()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#module-fireworks.tests.test_workflow">fireworks.tests.test_workflow module</a><ul>
<li><a class="reference internal" href="#fireworks.tests.test_workflow.TestWorkflowState"><code class="docutils literal notranslate"><span class="pre">TestWorkflowState</span></code></a><ul>
<li><a class="reference internal" href="#fireworks.tests.test_workflow.TestWorkflowState.test_archived"><code class="docutils literal notranslate"><span class="pre">TestWorkflowState.test_archived()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.test_workflow.TestWorkflowState.test_completed"><code class="docutils literal notranslate"><span class="pre">TestWorkflowState.test_completed()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.test_workflow.TestWorkflowState.test_defused"><code class="docutils literal notranslate"><span class="pre">TestWorkflowState.test_defused()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.test_workflow.TestWorkflowState.test_fizzled_1"><code class="docutils literal notranslate"><span class="pre">TestWorkflowState.test_fizzled_1()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.test_workflow.TestWorkflowState.test_fizzled_2"><code class="docutils literal notranslate"><span class="pre">TestWorkflowState.test_fizzled_2()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.test_workflow.TestWorkflowState.test_fizzled_3"><code class="docutils literal notranslate"><span class="pre">TestWorkflowState.test_fizzled_3()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.test_workflow.TestWorkflowState.test_fizzled_4"><code class="docutils literal notranslate"><span class="pre">TestWorkflowState.test_fizzled_4()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.test_workflow.TestWorkflowState.test_fizzled_5"><code class="docutils literal notranslate"><span class="pre">TestWorkflowState.test_fizzled_5()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.test_workflow.TestWorkflowState.test_fizzled_6"><code class="docutils literal notranslate"><span class="pre">TestWorkflowState.test_fizzled_6()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.test_workflow.TestWorkflowState.test_paused"><code class="docutils literal notranslate"><span class="pre">TestWorkflowState.test_paused()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.test_workflow.TestWorkflowState.test_ready"><code class="docutils literal notranslate"><span class="pre">TestWorkflowState.test_ready()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.test_workflow.TestWorkflowState.test_reserved"><code class="docutils literal notranslate"><span class="pre">TestWorkflowState.test_reserved()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.test_workflow.TestWorkflowState.test_running_1"><code class="docutils literal notranslate"><span class="pre">TestWorkflowState.test_running_1()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.tests.test_workflow.TestWorkflowState.test_running_2"><code class="docutils literal notranslate"><span class="pre">TestWorkflowState.test_running_2()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#module-fireworks.tests">Module contents</a></li>
</ul>
</li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/fireworks.tests.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">FireWorks 2.0.4 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">fireworks.tests package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2013, Anubhav Jain.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
</div>
<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-53488807-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>