@datadog/datadog-ci-plugin-synthetics 5.13.1 → 5.15.0

package/README.md

@@ -390,6 +390,17 @@ The filename for a JUnit report if you want to generate one.
 * ENV variable: `DATADOG_SYNTHETICS_JUNIT_REPORT="e2e-test-junit.xml"`
 * CLI param:`-j "e2e-test-junit.xml"` / `--jUnitReport "e2e-test-junit.xml"`
 
+#### `jsonReport`
+
+The filename for a JSON report of your test results if you want to generate one. The shape of the results is [`synthetics.Result[]`][19].
+
+**Configuration options**
+
+* Default: None
+* Global Config: `"jsonReport": "test-results-report.json"`
+* ENV variable: `DATADOG_SYNTHETICS_JSON_REPORT="test-results-report.json"`
+* CLI param: `--jsonReport "test-results-report.json"`
+
 #### `mobileApplicationVersionFilePath`
 
 Override the mobile application version for [Synthetic mobile application tests][18] with a local or recently built application.
@@ -1031,6 +1042,7 @@ Two reporters are supported out-of-the-box:
 
 1. `stdout`
 2. JUnit
+3. JSON
 
 To enable the JUnit report, specify a filename for your JUnit report with `-j/--jUnitReport`.
 
@@ -1038,6 +1050,12 @@ To enable the JUnit report, specify a filename for your JUnit report with `-j/--
 yarn datadog-ci synthetics run-tests -s 'tag:e2e-tests' --config global-config.json --jUnitReport junit-report.xml
 ```
 
+To enable the JSON report, specify a filename for your JSON report with `--jsonReport`.
+
+```bash
+yarn datadog-ci synthetics run-tests -s 'tag:e2e-tests' --config global-config.json --jsonReport test-results-report.json
+```
+
 Reporters can hook themselves into the `MainReporter` of the command.
 
 ### Available hooks
@@ -1113,6 +1131,7 @@ Additional helpful documentation, links, and articles:
 [16]: https://docs.datadoghq.com/getting_started/site/#access-the-datadog-site
 [17]: https://app.datadoghq.com/synthetics/settings/continuous-testing
 [18]: https://docs.datadoghq.com/synthetics/mobile_app_testing/
+[19]: https://github.com/DataDog/datadog-ci/blob/master/packages/plugin-synthetics/src/interfaces.ts#L223-L254
 
 <!--
   This page is single-sourced:

package/dist/bundle.d.ts

@@ -1284,7 +1284,7 @@ interface ProxyConfiguration {
 }
 //#endregion
 //#region src/interfaces.d.ts
-type SupportedReporter = 'junit' | 'default';
+type SupportedReporter = 'junit' | 'json' | 'default';
 interface MainReporter {
   log(log: string): void;
   error(error: string): void;
@@ -1939,6 +1939,7 @@ interface RunTestsCommandConfig extends SyntheticsCIConfig {
   failOnTimeout: boolean;
   files: string[];
   jUnitReport?: string;
+  jsonReport?: string;
   mobileApplicationVersionFilePath?: string;
   publicIds: string[];
   /** Whether to only run the tests which failed in the previous test batches. By default, the organization default setting is used. */
@@ -2060,6 +2061,41 @@ declare class DefaultReporter implements MainReporter {
   private removeSpinner;
 }
 //#endregion
+//#region src/reporters/file.d.ts
+type Args$2 = {
+  context: ReporterContext;
+  defaultExtension: string;
+  destination: string;
+  reportName: string;
+};
+declare abstract class FileReporter {
+  protected destination: string;
+  protected write: Writable['write'];
+  private reportName;
+  constructor({
+    context,
+    defaultExtension,
+    destination,
+    reportName
+  }: Args$2);
+  protected writeReportToFile(contents: string): void;
+}
+//#endregion
+//#region src/reporters/json.d.ts
+interface Args$1 {
+  context: ReporterContext;
+  jsonReport?: string;
+}
+declare class JSONReporter extends FileReporter implements Reporter {
+  private readonly results;
+  constructor({
+    context,
+    jsonReport
+  }: Args$1);
+  resultEnd(result: Result): void;
+  runEnd(): void;
+}
+//#endregion
 //#region src/reporters/junit.d.ts
 interface SuiteStats {
   errors: number;
@@ -2136,11 +2172,9 @@ interface Args {
   jUnitReport?: string;
   runName?: string;
 }
-declare class JUnitReporter implements Reporter {
+declare class JUnitReporter extends FileReporter implements Reporter {
   private builder;
-  private destination;
   private json;
-  private write;
   constructor({
     context,
     jUnitReport,
@@ -2165,6 +2199,7 @@ declare class JUnitReporter implements Reporter {
 type ExecuteOptions = {
   initialSummary?: InitialSummary;
   jUnitReport?: string;
+  jsonReport?: string;
   reporters?: (SupportedReporter | Reporter)[];
   runId?: string;
   suites?: Suite[];
@@ -2178,14 +2213,7 @@ declare const planDryRun: (reporter: MainReporter, runConfig: WrapperConfig, sui
   testPlan: TestPlan;
   initialSummary: InitialSummary;
 }>;
-declare const executeWithDetails: (runConfig: WrapperConfig, {
-  initialSummary,
-  jUnitReport,
-  reporters,
-  runId,
-  suites,
-  testPlan
-}: ExecuteOptions) => Promise<{
+declare const executeWithDetails: (runConfig: WrapperConfig, executeOptions: ExecuteOptions) => Promise<{
   results: Result[];
   summary: Summary;
   exitCode: 0 | 1;
@@ -2296,6 +2324,7 @@ declare class SyntheticsRunTestsCommand extends BaseCommand {
   static paths: string[][];
   static usage: Usage;
   jUnitReport: string | undefined;
+  jsonReport: string | undefined;
   runName: string | undefined;
   protected apiKey: string | undefined;
   protected appKey: string | undefined;
@@ -2388,5 +2417,5 @@ declare const commands: {
   };
 };
 //#endregion
-export { APIConfiguration, APIHelperConfig, ApiServerResult, AppUploadDetails, Assertion, BaseConfigOverride, BaseResult, BaseResultInBatch, BaseServerResult, BasicAuthCredentials, Batch, BatchOptions, BrowserError, BrowserServerResult, CiError, CookiesObject, CriticalError, DEFAULT_COMMAND_CONFIG, DatadogCIConfig, DefaultReporter, DeployTestsCommandConfig, Device, ExecutionRule, ImportTestsCommandConfig, JUnitReporter, LocalTestDefinition, LocalTestPayload, LocalTriggerConfig, Location, LocationsMapping, MainReporter, MobileAppExtractedMetadata, MobileAppUploadResult, MobileApplication, MobileApplicationNewVersionParams, MobileApplicationUploadPart, MobileApplicationUploadPartResponse, MobileApplicationVersion, MobileTestWithOverride, MultiLocator, MultiStep, MultiStepsServerResult, MultipartPresignedUrlsResponse, Operator, OptionsWithUnsupportedFields, Payload, PollResult, RawPollResult, RawPollResultTest, RemoteTestPayload, RemoteTriggerConfig, Reporter, ReporterContext, Result, ResultDisplayInfo, ResultInBatch, ResultInBatchSkippedBySelectiveRerun, ResultSkippedBySelectiveRerun, RetryConfig, RunTestsCommandConfig, SelectiveRerunDecision, ServerBatch, ServerConfigOverride, ServerResult, ServerTest, ServerTrigger, Step, Suite, Summary, SupportedReporter, SyntheticsCIConfig, SyntheticsOrgSettings, Test, TestConfig, TestMissing, TestPayload, TestPlan, TestPlanItem, TestRequest, TestSearchResult, TestSkipped, TestStepWithUnsupportedFields, TestWithOverride, TriggerConfig, TriggerInfo, UploadApplicationCommandConfig, UserConfigOverride, Vitals, WrapperConfig, type XMLJSON, commands, execute, executeTests, executeWithDetails, planDryRun, public_d_exports as utils };
+export { APIConfiguration, APIHelperConfig, ApiServerResult, AppUploadDetails, Assertion, BaseConfigOverride, BaseResult, BaseResultInBatch, BaseServerResult, BasicAuthCredentials, Batch, BatchOptions, BrowserError, BrowserServerResult, CiError, CookiesObject, CriticalError, DEFAULT_COMMAND_CONFIG, DatadogCIConfig, DefaultReporter, DeployTestsCommandConfig, Device, ExecutionRule, ImportTestsCommandConfig, JSONReporter, JUnitReporter, LocalTestDefinition, LocalTestPayload, LocalTriggerConfig, Location, LocationsMapping, MainReporter, MobileAppExtractedMetadata, MobileAppUploadResult, MobileApplication, MobileApplicationNewVersionParams, MobileApplicationUploadPart, MobileApplicationUploadPartResponse, MobileApplicationVersion, MobileTestWithOverride, MultiLocator, MultiStep, MultiStepsServerResult, MultipartPresignedUrlsResponse, Operator, OptionsWithUnsupportedFields, Payload, PollResult, RawPollResult, RawPollResultTest, RemoteTestPayload, RemoteTriggerConfig, Reporter, ReporterContext, Result, ResultDisplayInfo, ResultInBatch, ResultInBatchSkippedBySelectiveRerun, ResultSkippedBySelectiveRerun, RetryConfig, RunTestsCommandConfig, SelectiveRerunDecision, ServerBatch, ServerConfigOverride, ServerResult, ServerTest, ServerTrigger, Step, Suite, Summary, SupportedReporter, SyntheticsCIConfig, SyntheticsOrgSettings, Test, TestConfig, TestMissing, TestPayload, TestPlan, TestPlanItem, TestRequest, TestSearchResult, TestSkipped, TestStepWithUnsupportedFields, TestWithOverride, TriggerConfig, TriggerInfo, UploadApplicationCommandConfig, UserConfigOverride, Vitals, WrapperConfig, type XMLJSON, commands, execute, executeTests, executeWithDetails, planDryRun, public_d_exports as utils };
 //# sourceMappingURL=bundle.d.ts.map