exporttypeOutcomeSummary=/** The default value. This value is used if the state is omitted. */"OUTCOME_SUMMARY_UNSPECIFIED"/** * The test matrix run was successful, for instance: * - All test cases passed. * - No crash of the application under test was detected. */|"SUCCESS"/** * A run failed, for instance: * - One or more test case failed. * - A test timed out. * - The application under test crashed. */|"FAILURE"/** * Something unexpected happened. The test run should still be considered * unsuccessful but this is likely a transient problem and re-running the * test might be successful. */|"INCONCLUSIVE"/** All tests were skipped. */|"SKIPPED";
testLab.TestState
Possible test states for a test matrix.
Signature:
exporttypeTestState=/** The default value. This value is used if the state is omitted. */"TEST_STATE_UNSPECIFIED"/** The test matrix is being validated. */|"VALIDATING"/** The test matrix is waiting for resources to become available. */|"PENDING"/** The test matrix has completed normally. */|"FINISHED"/** The test matrix has completed because of an infrastructure failure. */|"ERROR"/** The test matrix was not run because the provided inputs are not valid. */|"INVALID";
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-14 UTC."],[],[],null,["# testLab namespace\n\nFunctions\n---------\n\n| Function | Description |\n|------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|\n| [onTestMatrixCompleted(handler)](./firebase-functions.testlab.md#testlabontestmatrixcompleted) | Event handler which triggers when a Firebase test matrix completes. |\n| [onTestMatrixCompleted(opts, handler)](./firebase-functions.testlab.md#testlabontestmatrixcompleted) | Event handler which triggers when a Firebase test matrix completes. |\n\nInterfaces\n----------\n\n| Interface | Description |\n|-----------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|\n| [ClientInfo](./firebase-functions.testlab.clientinfo.md#testlabclientinfo_interface) | Information about the client which invoked the test. |\n| [ResultStorage](./firebase-functions.testlab.resultstorage.md#testlabresultstorage_interface) | Locations where test results are stored. |\n| [TestMatrixCompletedData](./firebase-functions.testlab.testmatrixcompleteddata.md#testlabtestmatrixcompleteddata_interface) | The data within all Firebase test matrix completed events. |\n\nType Aliases\n------------\n\n| Type Alias | Description |\n|-------------------------------------------------------------------------|---------------------------------------------|\n| [OutcomeSummary](./firebase-functions.testlab.md#testlaboutcomesummary) | Outcome summary for a finished test matrix. |\n| [TestState](./firebase-functions.testlab.md#testlabteststate) | Possible test states for a test matrix. |\n\ntestLab.onTestMatrixCompleted()\n-------------------------------\n\nEvent handler which triggers when a Firebase test matrix completes.\n\n**Signature:** \n\n export declare function onTestMatrixCompleted(handler: (event: CloudEvent\u003cTestMatrixCompletedData\u003e) =\u003e any | Promise\u003cany\u003e): CloudFunction\u003cCloudEvent\u003cTestMatrixCompletedData\u003e\u003e;\n\n### Parameters\n\n| Parameter | Type | Description |\n|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|\n| handler | (event: [CloudEvent](./firebase-functions.cloudevent.md#cloudevent_interface)\\\u003c[TestMatrixCompletedData](./firebase-functions.testlab.testmatrixcompleteddata.md#testlabtestmatrixcompleteddata_interface)\\\u003e) =\\\u003e any \\| Promise\\\u003cany\\\u003e | Event handler which is run every time a Firebase test matrix completes. |\n\n**Returns:**\n\n[CloudFunction](./firebase-functions.cloudfunction.md#cloudfunction_interface)\\\u003c[CloudEvent](./firebase-functions.cloudevent.md#cloudevent_interface)\\\u003c[TestMatrixCompletedData](./firebase-functions.testlab.testmatrixcompleteddata.md#testlabtestmatrixcompleteddata_interface)\\\u003e\\\u003e\n\nA Cloud Function that you can export and deploy.\n\ntestLab.onTestMatrixCompleted()\n-------------------------------\n\nEvent handler which triggers when a Firebase test matrix completes.\n\n**Signature:** \n\n export declare function onTestMatrixCompleted(opts: EventHandlerOptions, handler: (event: CloudEvent\u003cTestMatrixCompletedData\u003e) =\u003e any | Promise\u003cany\u003e): CloudFunction\u003cCloudEvent\u003cTestMatrixCompletedData\u003e\u003e;\n\n### Parameters\n\n| Parameter | Type | Description |\n|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|\n| opts | [EventHandlerOptions](./firebase-functions.eventhandleroptions.md#eventhandleroptions_interface) | Options that can be set on an individual event-handling function. |\n| handler | (event: [CloudEvent](./firebase-functions.cloudevent.md#cloudevent_interface)\\\u003c[TestMatrixCompletedData](./firebase-functions.testlab.testmatrixcompleteddata.md#testlabtestmatrixcompleteddata_interface)\\\u003e) =\\\u003e any \\| Promise\\\u003cany\\\u003e | Event handler which is run every time a Firebase test matrix completes. |\n\n**Returns:**\n\n[CloudFunction](./firebase-functions.cloudfunction.md#cloudfunction_interface)\\\u003c[CloudEvent](./firebase-functions.cloudevent.md#cloudevent_interface)\\\u003c[TestMatrixCompletedData](./firebase-functions.testlab.testmatrixcompleteddata.md#testlabtestmatrixcompleteddata_interface)\\\u003e\\\u003e\n\nA Cloud Function that you can export and deploy.\n\ntestLab.OutcomeSummary\n----------------------\n\nOutcome summary for a finished test matrix.\n\n**Signature:** \n\n export type OutcomeSummary = \n /** The default value. This value is used if the state is omitted. */\n \"OUTCOME_SUMMARY_UNSPECIFIED\"\n /**\n * The test matrix run was successful, for instance:\n * - All test cases passed.\n * - No crash of the application under test was detected.\n */\n | \"SUCCESS\"\n /**\n * A run failed, for instance:\n * - One or more test case failed.\n * - A test timed out.\n * - The application under test crashed.\n */\n | \"FAILURE\"\n /**\n * Something unexpected happened. The test run should still be considered\n * unsuccessful but this is likely a transient problem and re-running the\n * test might be successful.\n */\n | \"INCONCLUSIVE\"\n /** All tests were skipped. */\n | \"SKIPPED\";\n\ntestLab.TestState\n-----------------\n\nPossible test states for a test matrix.\n\n**Signature:** \n\n export type TestState = \n /** The default value. This value is used if the state is omitted. */\n \"TEST_STATE_UNSPECIFIED\"\n /** The test matrix is being validated. */\n | \"VALIDATING\"\n /** The test matrix is waiting for resources to become available. */\n | \"PENDING\"\n /** The test matrix has completed normally. */\n | \"FINISHED\"\n /** The test matrix has completed because of an infrastructure failure. */\n | \"ERROR\"\n /** The test matrix was not run because the provided inputs are not valid. */\n | \"INVALID\";"]]
