Firebase Rules API . projects

Instance Methods

releases()

Returns the releases Resource.

rulesets()

Returns the rulesets Resource.

test(name=None, body, x__xgafv=None)

Test `Source` for syntactic and semantic correctness. Issues present, if

Method Details

test(name=None, body, x__xgafv=None)
Test `Source` for syntactic and semantic correctness. Issues present, if
any, will be returned to the caller with a description, severity, and
source location.

The test method may be executed with `Source` or a `Ruleset` name.
Passing `Source` is useful for unit testing new rules. Passing a `Ruleset`
name is useful for regression testing an existing rule.

The following is an example of `Source` that permits users to upload images
to a bucket bearing their user id and matching the correct metadata:

_*Example*_

    // Users are allowed to subscribe and unsubscribe to the blog.
    service firebase.storage {
      match /users/{userId}/images/{imageName} {
          allow write: if userId == request.auth.uid
              && (imageName.matches('*.png$')
              || imageName.matches('*.jpg$'))
              && resource.mimeType.matches('^image/')
      }
    }

Args:
  name: string, Tests may either provide `source` or a `Ruleset` resource name.

For tests against `source`, the resource name must refer to the project:
Format: `projects/{project_id}`

For tests against a `Ruleset`, this must be the `Ruleset` resource name:
Format: `projects/{project_id}/rulesets/{ruleset_id}` (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request for FirebaseRulesService.TestRuleset.
    "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # Optional `Source` to be checked for correctness.
        # 
        # This field must not be set when the resource name refers to a `Ruleset`.
      "files": [ # `File` set constituting the `Source` bundle.
        { # `File` containing source content.
          "content": "A String", # Textual Content.
          "name": "A String", # File name.
          "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
        },
      ],
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for FirebaseRulesService.TestRuleset.
    "testResults": [ # The set of test results given the test cases in the `TestSuite`.
        # The results will appear in the same order as the test cases appear in the
        # `TestSuite`.
      { # Test result message containing the state of the test as well as a
          # description and source position for test failures.
        "debugMessages": [ # Debug messages related to test execution issues encountered during
            # evaluation.
            #
            # Debug messages may be related to too many or too few invocations of
            # function mocks or to runtime errors that occur during evaluation.
            #
            # For example: ```Unable to read variable [name: "resource"]```
          "A String",
        ],
        "state": "A String", # State of the test.
        "errorPosition": { # Position in the `Source` content including its line, column number, and an # Position in the `Source` or `Ruleset` where the principle runtime error
            # occurs.
            #
            # Evaluation of an expression may result in an error. Rules are deny by
            # default, so a `DENY` expectation when an error is generated is valid.
            # When there is a `DENY` with an error, the `SourcePosition` is returned.
            #
            # E.g. `error_position { line: 19 column: 37 }`
            # index of the `File` in the `Source` message. Used for debug purposes.
          "column": 42, # First column on the source line associated with the source fragment.
          "line": 42, # Line number of the source fragment. 1-based.
          "fileName": "A String", # Name of the `File`.
        },
        "functionCalls": [ # The set of function calls made to service-defined methods.
            #
            # Function calls are included in the order in which they are encountered
            # during evaluation, are provided for both mocked and unmocked functions,
            # and included on the response regardless of the test `state`.
          { # Represents a service-defined function call that was invoked during test
              # execution.
            "function": "A String", # Name of the function invoked.
            "args": [ # The arguments that were provided to the function.
              "",
            ],
          },
        ],
      },
    ],
    "issues": [ # Syntactic and semantic `Source` issues of varying severity. Issues of
        # `ERROR` severity will prevent tests from executing.
      { # Issues include warnings, errors, and deprecation notices.
        "sourcePosition": { # Position in the `Source` content including its line, column number, and an # Position of the issue in the `Source`.
            # index of the `File` in the `Source` message. Used for debug purposes.
          "column": 42, # First column on the source line associated with the source fragment.
          "line": 42, # Line number of the source fragment. 1-based.
          "fileName": "A String", # Name of the `File`.
        },
        "severity": "A String", # The severity of the issue.
        "description": "A String", # Short error description.
      },
    ],
  }