-
Notifications
You must be signed in to change notification settings - Fork 13
/
Copy pathplan_validation.html
297 lines (181 loc) · 10.9 KB
/
plan_validation.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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Plan Validation — bluesky-queueserver 0.post1+g5566af3 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="bluesky_queueserver.validate_plan" href="generated/bluesky_queueserver.validate_plan.html" />
<link rel="prev" title="Using IPython Startup Files" href="ipython.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> bluesky-queueserver
</a>
<div class="version">
0.post1+g5566af3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial (Demo)</a></li>
<li class="toctree-l1"><a class="reference internal" href="release_history.html">Release History</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">User's Guide</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction_for_users.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="features_and_config.html">Features and Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="workflow.html">Submitting and Managing Plans</a></li>
<li class="toctree-l1"><a class="reference internal" href="startup_code.html">Organizing Bluesky Startup Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="ipython.html">Using IPython Startup Files</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Plan Validation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#id1">Plan Validation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#api-for-plan-validation">API for Plan Validation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="generated/bluesky_queueserver.validate_plan.html">bluesky_queueserver.validate_plan</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="plan_annotation.html">Annotating Bluesky Plans</a></li>
<li class="toctree-l1"><a class="reference internal" href="cli_tools.html">Command-Line Tools</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Application Developer's Guide</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="interacting_with_qs.html">Interacting with Queue Server</a></li>
<li class="toctree-l1"><a class="reference internal" href="re_manager_api.html">Run Engine Manager API</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">bluesky-queueserver</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li>Plan Validation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/plan_validation.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="plan-validation">
<h1>Plan Validation<a class="headerlink" href="#plan-validation" title="Permalink to this headline">¶</a></h1>
<div class="section" id="id1">
<span id="id2"></span><h2>Plan Validation<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
<p>All submitted plans are subjected to validation before they can be added to the queue. If plan
validation fails then the plan is rejected. If a batch of plans is submitted to the queue
(e.g. using <a class="reference internal" href="re_manager_api.html#method-queue-item-add-batch"><span class="std std-ref">queue_item_add_batch</span></a> 0MQ API), each plan in
the batch has to be validated before the plans are added to the queue. If validation of
any plan in the batch fails, then the whole batch is rejected.</p>
<p>Validation is using plan name, plan parameters and the name of the user group
to verify if plan parameters are valid and the user is allowed to submit the plan.
Plan validation includes the following steps:</p>
<ul>
<li><p>Verify that the plan name is in the list of allowed plans for the user submitting the plan.
(Each user is assigned to a group. The name of the user group is passed as part of
the API parameters).</p></li>
<li><p>Verify that the set of plan parameters, passed with the API call as a list of args and a dictionary
of kwargs, is successfully accepted by the plan. Validation procedure attempts to bind
the passed arguments to plan parameters and checks the parameter types based on type
annotation.</p></li>
<li><p>Verify that the user is allowed to use plans and devices that are passed as plan parameters.
If parameters of a plan allow to pass plans or devices to the plan, check that the plans and
the devices are in the lists of allowed plans and devices for the user group.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Only names of plans and devices can be passed as parameters in API requests. The names are replaced
by the respective objects from RE Worker namespace before the parameters are passed to the plan.</p>
</div>
</li>
</ul>
<p>Validation of plans is performed without access to the RE Worker namespace and
based exclusively on the data from the list of allowed plans that is generated from the data in
the file <code class="docutils literal notranslate"><span class="pre">existing_plans_and_devices.yaml</span></code>.</p>
<p>Each plan is validated at least twice: at the time it is submitted to the Queue Server and
before execution. Validation is also run each time the plan parameters are modified
(see <a class="reference internal" href="re_manager_api.html#method-queue-item-update"><span class="std std-ref">queue_item_update</span></a> 0MQ API). Third party Python applications
may perform validation before sending the plan to the queue by calling <cite>validate_plan()</cite>
(<a class="reference internal" href="#plan-validation-api"><span class="std std-ref">see below</span></a>).</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If a plan is successfully submitted to the queue, it is expected to pass validation before
execution. If the contents of the list of existing devices (<code class="docutils literal notranslate"><span class="pre">existing_plans_and_devices.yaml</span></code>)
or user group permissions (<code class="docutils literal notranslate"><span class="pre">user_group_permissions.yaml</span></code>) are modified while the plan is
in the queue, validation may still fail.</p>
</div>
</div>
<div class="section" id="api-for-plan-validation">
<span id="plan-validation-api"></span><h2>API for Plan Validation<a class="headerlink" href="#api-for-plan-validation" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/bluesky_queueserver.validate_plan.html#bluesky_queueserver.validate_plan" title="bluesky_queueserver.validate_plan"><code class="xref py py-obj docutils literal notranslate"><span class="pre">validate_plan</span></code></a></p></td>
<td><p>Validate the dictionary of plan parameters.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="generated/bluesky_queueserver.validate_plan.html" class="btn btn-neutral float-right" title="bluesky_queueserver.validate_plan" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="ipython.html" class="btn btn-neutral float-left" title="Using IPython Startup Files" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2019-2021, Brookhaven National Laboratory.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>