Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://googleapis.deno.dev/v1/toolresults:v1beta3.ts";

§Classes

GoogleAuth
ToolResults

API to publish and access results from developer tools.

§Variables

auth

§Interfaces

AndroidAppInfo

Android app information.

AndroidInstrumentationTest

A test of an Android application that can control an Android component independently of its normal lifecycle. See for more information on types of Android tests.

AndroidRoboTest

A test of an android application that explores the application on a virtual or physical Android device, finding culprits and crashes as it goes.

AndroidTest

An Android mobile test specification.

AndroidTestLoop

Test Loops are tests that can be launched by the app itself, determining when to run by listening for an intent.

ANR

Additional details for an ANR crash.

Any

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := ptypes.MarshalAny(foo) ... foo := &pb.Foo{} if err := ptypes.UnmarshalAny(any, foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". # JSON The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message google.protobuf.Duration): { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

AppStartTime
AssetIssue

There was an issue with the assets in this test.

AvailableDeepLinks

A suggestion to use deep links for a Robo run.

BasicPerfSampleSeries

Encapsulates the metadata for basic sample series represented by a line chart

BatchCreatePerfSamplesRequest

The request must provide up to a maximum of 5000 samples to be created; a larger sample size will cause an INVALID_ARGUMENT error

BatchCreatePerfSamplesResponse
BlankScreen

A warning that Robo encountered a screen that was mostly blank; this may indicate a problem with the app.

CPUInfo
CrashDialogError

Crash dialog was detected during the test execution

CredentialsClient

Defines the root interface for all clients that generate credentials for calling Google APIs. All clients should implement this interface.

DetectedAppSplashScreen

A notification that Robo detected a splash screen provided by app (vs. Android OS splash screen).

DeviceOutOfMemory

A warning that device ran out of memory

Duration

A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years.

EncounteredLoginScreen

Additional details about encountered login screens.

EncounteredNonAndroidUiWidgetScreen

Additional details about encountered screens with elements that are not Android UI widgets.

Environment

An Environment represents the set of test runs (Steps) from the parent Execution that are configured with the same set of dimensions (Model, Version, Locale, and Orientation). Multiple such runs occur particularly because of features like sharding (splitting up a test suite to run in parallel across devices) and reruns (running a test multiple times to check for different outcomes).

EnvironmentDimensionValueEntry
Execution

An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step The maximum size of an execution message is 1 MiB. An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable.

FailedToInstall

Failed to install the App.

FailureDetail

Details for an outcome with a FAILURE outcome summary.

FatalException

Additional details for a fatal exception.

FileReference

A reference to a file.

GraphicsStats

Graphics statistics for the App. The information is collected from 'adb shell dumpsys graphicsstats'. For more info see: https://developer.android.com/training/testing/performance.html Statistics will only be present for API 23+.

GraphicsStatsBucket
History

A History represents a sorted list of Executions ordered by the start_timestamp_millis field (descending). It can be used to group all the Executions of a continuous build. Note that the ordering only operates on one-dimension. If a repository has multiple branches, it means that multiple histories will need to be used in order to order Executions per branch.

Image

An image, with a link to the main image and a thumbnail.

InAppPurchasesFound

Additional details of in-app purchases encountered during the crawl.

InconclusiveDetail

Details for an outcome with an INCONCLUSIVE outcome summary.

IndividualOutcome

Step Id and outcome of each individual step that was run as a group with other steps with the same configuration.

InsufficientCoverage

A warning that Robo did not crawl potentially important parts of the app.

IosAppCrashed

Additional details for an iOS app crash.

IosAppInfo

iOS app information

IosRoboTest

A Robo test for an iOS application.

IosTest

A iOS mobile test specification

IosTestLoop

A game loop test of an iOS application.

IosXcTest

A test of an iOS application that uses the XCTest framework.

LauncherActivityNotFound

Failed to find the launcher activity of an app.

ListEnvironmentsResponse

Response message for EnvironmentService.ListEnvironments.

ListExecutionsResponse
ListHistoriesResponse

Response message for HistoryService.List

ListPerfSampleSeriesResponse
ListPerfSamplesResponse
ListScreenshotClustersResponse
ListStepAccessibilityClustersResponse

Response message for AccessibilityService.ListStepAccessibilityClusters.

ListStepsResponse

Response message for StepService.List.

ListStepThumbnailsResponse

A response containing the thumbnails in a step.

ListTestCasesResponse

Response message for StepService.ListTestCases.

LogcatCollectionError

A warning that there were issues in logcat collection.

MatrixDimensionDefinition

One dimension of the matrix of different runs of a step.

MemoryInfo
MergedResult

Merged test result for environment. If the environment has only one step (no reruns or shards), then the merged result is the same as the step result. If the environment has multiple shards and/or reruns, then the results of shards and reruns that belong to the same environment are merged into one environment result.

MultiStep

Details when multiple steps are run with the same configuration as a group.

NativeCrash

Additional details for a native crash.

NonSdkApi

A non-sdk API and examples of it being called along with other metadata See https://developer.android.com/distribute/best-practices/develop/restrictions-non-sdk-interfaces

NonSdkApiInsight

Non-SDK API insights (to address debugging solutions).

NonSdkApiUsageViolation

Additional details for a non-sdk API usage violation.

NonSdkApiUsageViolationReport

Contains a summary and examples of non-sdk API usage violations.

Outcome

Interprets a result so that humans and machines can act on it.

OverlappingUIElements

A warning that Robo encountered a screen that has overlapping clickable elements; this may indicate a potential UI issue.

PendingGoogleUpdateInsight

This insight indicates that the hidden API usage originates from a Google-provided library. Users need not take any action.

PerfEnvironment

Encapsulates performance environment info

PerfMetricsSummary

A summary of perf metrics collected and performance environment info

PerformedGoogleLogin

A notification that Robo signed in with Google.

PerformedMonkeyActions

A notification that Robo performed some monkey actions.

PerfSample

Resource representing a single performance measure or data point

PerfSampleSeries

Resource representing a collection of performance samples (or data points)

PrimaryStep

Stores rollup test status of multiple steps that were run as a group and outcome of each individual step.

ProjectSettings

Per-project settings for the Tool Results service.

ProjectsHistoriesCreateOptions

Additional options for ToolResults#projectsHistoriesCreate.

ProjectsHistoriesExecutionsCreateOptions

Additional options for ToolResults#projectsHistoriesExecutionsCreate.

ProjectsHistoriesExecutionsEnvironmentsListOptions

Additional options for ToolResults#projectsHistoriesExecutionsEnvironmentsList.

ProjectsHistoriesExecutionsListOptions

Additional options for ToolResults#projectsHistoriesExecutionsList.

ProjectsHistoriesExecutionsPatchOptions

Additional options for ToolResults#projectsHistoriesExecutionsPatch.

ProjectsHistoriesExecutionsStepsAccessibilityClustersOptions

Additional options for ToolResults#projectsHistoriesExecutionsStepsAccessibilityClusters.

ProjectsHistoriesExecutionsStepsCreateOptions

Additional options for ToolResults#projectsHistoriesExecutionsStepsCreate.

ProjectsHistoriesExecutionsStepsListOptions

Additional options for ToolResults#projectsHistoriesExecutionsStepsList.

ProjectsHistoriesExecutionsStepsPatchOptions

Additional options for ToolResults#projectsHistoriesExecutionsStepsPatch.

ProjectsHistoriesExecutionsStepsPerfSampleSeriesListOptions

Additional options for ToolResults#projectsHistoriesExecutionsStepsPerfSampleSeriesList.

ProjectsHistoriesExecutionsStepsPerfSampleSeriesSamplesListOptions

Additional options for ToolResults#projectsHistoriesExecutionsStepsPerfSampleSeriesSamplesList.

ProjectsHistoriesExecutionsStepsTestCasesListOptions

Additional options for ToolResults#projectsHistoriesExecutionsStepsTestCasesList.

ProjectsHistoriesExecutionsStepsThumbnailsListOptions

Additional options for ToolResults#projectsHistoriesExecutionsStepsThumbnailsList.

ProjectsHistoriesListOptions

Additional options for ToolResults#projectsHistoriesList.

PublishXunitXmlFilesRequest

Request message for StepService.PublishXunitXmlFiles.

RegionProto

A rectangular region.

ResultsStorage

The storage for test results.

RoboScriptExecution

Execution stats for a user-provided Robo script.

SafeHtmlProto

IMPORTANT: It is unsafe to accept this message from an untrusted source, since it's trivial for an attacker to forge serialized messages that don't fulfill the type's safety contract -- for example, it could contain attacker controlled script. A system which receives a SafeHtmlProto implicitly trusts the producer of the SafeHtmlProto. So, it's generally safe to return this message in RPC responses, but generally unsafe to accept it in RPC requests.

Screen
ScreenshotCluster
ShardSummary

Result summary for a shard in an environment.

SkippedDetail

Details for an outcome with a SKIPPED outcome summary.

Specification

The details about how to run the execution.

StackTrace

A stacktrace.

StartActivityNotFound

User provided intent failed to resolve to an activity.

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

Step

A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like:

  • user creates a Execution with id 1 - user creates a TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable.
StepDimensionValueEntry
StepLabelsEntry
StepSummary

Lightweight summary of a step within this execution.

SuccessDetail

Details for an outcome with a SUCCESS outcome summary. LINT.IfChange

SuggestionClusterProto

A set of similar suggestions that we suspect are closely related. This proto and most of the nested protos are branched from foxandcrown.prelaunchreport.service.SuggestionClusterProto, replacing PLR's dependencies with FTL's.

SuggestionProto
TestCase
TestCaseReference

A reference to a test case. Test case references are canonically ordered lexicographically by these three factors: * First, by test_suite_name. * Second, by class_name. * Third, by name.

TestExecutionStep

A step that represents running tests. It accepts ant-junit xml files which will be parsed into structured test results by the service. Xml file paths are updated in order to append more files, however they can't be deleted. Users can also add test results manually by using the test_result field.

TestIssue

An issue detected occurring during a test execution.

TestSuiteOverview

A summary of a test suite result either parsed from XML or uploaded directly by a user. Note: the API related comments are for StepService only. This message is also being used in ExecutionService in a read only mode for the corresponding step.

TestTiming

Testing timing break down to know phases.

Thumbnail

A single thumbnail, with its size and format.

Timestamp

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a 24-hour linear smear. The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

ToolExecution

An execution of an arbitrary tool. It could be a test runner or a tool copying artifacts or deploying code.

ToolExecutionStep

Generic tool step to be used for binaries we do not explicitly support. For example: running cp to copy artifacts from one location to another.

ToolExitCode

Exit code from a tool execution.

ToolOutputReference

A reference to a ToolExecution output file.

UIElementTooDeep

A warning that the screen hierarchy is deeper than the recommended threshold.

UnspecifiedWarning

Default unspecified warning.

UnusedRoboDirective

Additional details of an unused robodirective.

UpgradeInsight

This insight is a recommendation to upgrade a given library to the specified version, in order to avoid dependencies on non-SDK APIs.

UsedRoboDirective

Additional details of a used Robo directive.

UsedRoboIgnoreDirective

Additional details of a used Robo directive with an ignore action. Note: This is a different scenario than unused directive.