Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / firebaserules_v1.projects.html
blob: c5320ad785496fe8453f1b303d314364bac3b6f8 [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="firebaserules_v1.html">Firebase Rules API</a> . <a href="firebaserules_v1.projects.html">projects</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="firebaserules_v1.projects.releases.html">releases()</a></code>
79</p>
80<p class="firstline">Returns the releases Resource.</p>
81
82<p class="toc_element">
83 <code><a href="firebaserules_v1.projects.rulesets.html">rulesets()</a></code>
84</p>
85<p class="firstline">Returns the rulesets Resource.</p>
86
87<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]88 <code><a href="#test">test(name, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]89<p class="firstline">Test `Source` for syntactic and semantic correctness. Issues present, if</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]90<h3>Method Details</h3>
91<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]92 <code class="details" id="test">test(name, body=None, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]93 <pre>Test `Source` for syntactic and semantic correctness. Issues present, if
94any, will be returned to the caller with a description, severity, and
95source location.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]96
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]97The test method may be executed with `Source` or a `Ruleset` name.
98Passing `Source` is useful for unit testing new rules. Passing a `Ruleset`
99name is useful for regression testing an existing rule.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]100
101The following is an example of `Source` that permits users to upload images
102to a bucket bearing their user id and matching the correct metadata:
103
104_*Example*_
105
106 // Users are allowed to subscribe and unsubscribe to the blog.
107 service firebase.storage {
108 match /users/{userId}/images/{imageName} {
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]109 allow write: if userId == request.auth.uid
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]110 &amp;&amp; (imageName.matches('*.png$')
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]111 || imageName.matches('*.jpg$'))
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]112 &amp;&amp; resource.mimeType.matches('^image/')
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]113 }
114 }
115
116Args:
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]117 name: string, Tests may either provide `source` or a `Ruleset` resource name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]118
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]119For tests against `source`, the resource name must refer to the project:
120Format: `projects/{project_id}`
121
122For tests against a `Ruleset`, this must be the `Ruleset` resource name:
123Format: `projects/{project_id}/rulesets/{ruleset_id}` (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]124 body: object, The request body.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]125 The object takes the form of:
126
127{ # The request for FirebaseRulesService.TestRuleset.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]128 "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # Optional `Source` to be checked for correctness.
129 #
130 # This field must not be set when the resource name refers to a `Ruleset`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]131 "files": [ # `File` set constituting the `Source` bundle.
132 { # `File` containing source content.
133 "content": "A String", # Textual Content.
134 "name": "A String", # File name.
135 "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
136 },
137 ],
138 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]139 "testSuite": { # `TestSuite` is a collection of `TestCase` instances that validate the logical # Inline `TestSuite` to run.
140 # correctness of a `Ruleset`. The `TestSuite` may be referenced in-line within
141 # a `TestRuleset` invocation or as part of a `Release` object as a pre-release
142 # check.
143 "testCases": [ # Collection of test cases associated with the `TestSuite`.
144 { # `TestCase` messages provide the request context and an expectation as to
145 # whether the given context will be allowed or denied. Test cases may specify
146 # the `request`, `resource`, and `function_mocks` to mock a function call to
147 # a service-provided function.
148 #
149 # The `request` object represents context present at request-time.
150 #
151 # The `resource` is the value of the target resource as it appears in
152 # persistent storage before the request is executed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]153 "resource": "", # Optional resource value as it appears in persistent storage before the
154 # request is fulfilled.
155 #
156 # The resource type depends on the `request.path` value.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]157 "functionMocks": [ # Optional function mocks for service-defined functions. If not set, any
158 # service defined function is expected to return an error, which may or may
159 # not influence the test outcome.
160 { # Mock function definition.
161 #
162 # Mocks must refer to a function declared by the target service. The type of
163 # the function args and result will be inferred at test time. If either the
164 # arg or result values are not compatible with function type declaration, the
165 # request will be considered invalid.
166 #
167 # More than one `FunctionMock` may be provided for a given function name so
168 # long as the `Arg` matchers are distinct. There may be only one function
169 # for a given overload where all `Arg` values are `Arg.any_value`.
170 "function": "A String", # The name of the function.
171 #
172 # The function name must match one provided by a service declaration.
173 "args": [ # The list of `Arg` values to match. The order in which the arguments are
174 # provided is the order in which they must appear in the function
175 # invocation.
176 { # Arg matchers for the mock function.
177 "anyValue": { # A generic empty message that you can re-use to avoid defining duplicated # Argument matches any value provided.
178 # empty messages in your APIs. A typical example is to use it as the request
179 # or the response type of an API method. For instance:
180 #
181 # service Foo {
182 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
183 # }
184 #
185 # The JSON representation for `Empty` is empty JSON object `{}`.
186 },
187 "exactValue": "", # Argument exactly matches value provided.
188 },
189 ],
190 "result": { # Possible result values from the function mock invocation. # The mock result of the function call.
191 "undefined": { # A generic empty message that you can re-use to avoid defining duplicated # The result is undefined, meaning the result could not be computed.
192 # empty messages in your APIs. A typical example is to use it as the request
193 # or the response type of an API method. For instance:
194 #
195 # service Foo {
196 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
197 # }
198 #
199 # The JSON representation for `Empty` is empty JSON object `{}`.
200 },
201 "value": "", # The result is an actual value. The type of the value must match that
202 # of the type declared by the service.
203 },
204 },
205 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]206 "request": "", # Request context.
207 #
208 # The exact format of the request context is service-dependent. See the
209 # appropriate service documentation for information about the supported
210 # fields and types on the request. Minimally, all services support the
211 # following fields and types:
212 #
213 # Request field | Type
214 # ---------------|-----------------
215 # auth.uid | `string`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]216 # auth.token | `map&lt;string, string&gt;`
217 # headers | `map&lt;string, string&gt;`
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]218 # method | `string`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]219 # params | `map&lt;string, string&gt;`
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]220 # path | `string`
221 # time | `google.protobuf.Timestamp`
222 #
223 # If the request value is not well-formed for the service, the request will
224 # be rejected as an invalid argument.
225 "expectation": "A String", # Test expectation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]226 "expressionReportLevel": "A String", # Specifies what should be included in the response.
227 "pathEncoding": "A String", # Specifies whether paths (such as request.path) are encoded and how.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]228 },
229 ],
230 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]231 }
232
233 x__xgafv: string, V1 error format.
234 Allowed values
235 1 - v1 error format
236 2 - v2 error format
237
238Returns:
239 An object of the form:
240
241 { # The response for FirebaseRulesService.TestRuleset.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]242 "testResults": [ # The set of test results given the test cases in the `TestSuite`.
243 # The results will appear in the same order as the test cases appear in the
244 # `TestSuite`.
245 { # Test result message containing the state of the test as well as a
246 # description and source position for test failures.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]247 "errorPosition": { # Position in the `Source` content including its line, column number, and an # Position in the `Source` or `Ruleset` where the principle runtime error
248 # occurs.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]249 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]250 # Evaluation of an expression may result in an error. Rules are deny by
251 # default, so a `DENY` expectation when an error is generated is valid.
252 # When there is a `DENY` with an error, the `SourcePosition` is returned.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]253 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]254 # E.g. `error_position { line: 19 column: 37 }`
255 # index of the `File` in the `Source` message. Used for debug purposes.
256 "column": 42, # First column on the source line associated with the source fragment.
257 "line": 42, # Line number of the source fragment. 1-based.
258 "currentOffset": 42, # Start position relative to the beginning of the file.
259 "endOffset": 42, # End position relative to the beginning of the file.
260 "fileName": "A String", # Name of the `File`.
261 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]262 "visitedExpressions": [ # The set of visited permission expressions for a given test. This returns
263 # the positions and evaluation results of all visited permission
264 # expressions which were relevant to the test case, e.g.
265 # ```
266 # match /path {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]267 # allow read if: &lt;expr&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]268 # }
269 # ```
270 # For a detailed report of the intermediate evaluation states, see the
271 # `expression_reports` field
272 { # Store the position and access outcome for an expression visited in rules.
273 "sourcePosition": { # Position in the `Source` content including its line, column number, and an # Position in the `Source` or `Ruleset` where an expression was visited.
274 # index of the `File` in the `Source` message. Used for debug purposes.
275 "column": 42, # First column on the source line associated with the source fragment.
276 "line": 42, # Line number of the source fragment. 1-based.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]277 "currentOffset": 42, # Start position relative to the beginning of the file.
278 "endOffset": 42, # End position relative to the beginning of the file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]279 "fileName": "A String", # Name of the `File`.
280 },
281 "value": "", # The evaluated value for the visited expression, e.g. true/false
282 },
283 ],
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]284 "state": "A String", # State of the test.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]285 "functionCalls": [ # The set of function calls made to service-defined methods.
286 #
287 # Function calls are included in the order in which they are encountered
288 # during evaluation, are provided for both mocked and unmocked functions,
289 # and included on the response regardless of the test `state`.
290 { # Represents a service-defined function call that was invoked during test
291 # execution.
292 "function": "A String", # Name of the function invoked.
293 "args": [ # The arguments that were provided to the function.
294 "",
295 ],
296 },
297 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]298 "debugMessages": [ # Debug messages related to test execution issues encountered during
299 # evaluation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]300 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]301 # Debug messages may be related to too many or too few invocations of
302 # function mocks or to runtime errors that occur during evaluation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]303 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]304 # For example: ```Unable to read variable [name: "resource"]```
305 "A String",
306 ],
307 "expressionReports": [ # The mapping from expression in the ruleset AST to the values they were
308 # evaluated to. Partially-nested to mirror AST structure. Note that this
309 # field is actually tracking expressions and not permission statements in
310 # contrast to the "visited_expressions" field above. Literal expressions
311 # are omitted.
312 { # Describes where in a file an expression is found and what it was
313 # evaluated to over the course of its use.
314 "sourcePosition": { # Position in the `Source` content including its line, column number, and an # Position of expression in original rules source.
315 # index of the `File` in the `Source` message. Used for debug purposes.
316 "column": 42, # First column on the source line associated with the source fragment.
317 "line": 42, # Line number of the source fragment. 1-based.
318 "currentOffset": 42, # Start position relative to the beginning of the file.
319 "endOffset": 42, # End position relative to the beginning of the file.
320 "fileName": "A String", # Name of the `File`.
321 },
322 "values": [ # Values that this expression evaluated to when encountered.
323 { # Tuple for how many times an Expression was evaluated to a particular
324 # ExpressionValue.
325 "count": 42, # The amount of times that expression returned.
326 "value": "", # The return value of the expression
327 },
328 ],
329 "children": [ # Subexpressions
330 # Object with schema name: ExpressionReport
331 ],
332 },
333 ],
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]334 },
335 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]336 "issues": [ # Syntactic and semantic `Source` issues of varying severity. Issues of
337 # `ERROR` severity will prevent tests from executing.
338 { # Issues include warnings, errors, and deprecation notices.
339 "sourcePosition": { # Position in the `Source` content including its line, column number, and an # Position of the issue in the `Source`.
340 # index of the `File` in the `Source` message. Used for debug purposes.
341 "column": 42, # First column on the source line associated with the source fragment.
342 "line": 42, # Line number of the source fragment. 1-based.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]343 "currentOffset": 42, # Start position relative to the beginning of the file.
344 "endOffset": 42, # End position relative to the beginning of the file.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]345 "fileName": "A String", # Name of the `File`.
346 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]347 "severity": "A String", # The severity of the issue.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]348 "description": "A String", # Short error description.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]349 },
350 ],
351 }</pre>
352</div>
353
354</body></html>