Skip to content

Commit

Permalink
chore(deps): upgrade dependencies (#4)
Browse files Browse the repository at this point in the history
Upgrades project dependencies. See details in [workflow run].

[Workflow Run]: https://github.com/flochaz/synthetics-canaries-e2e-tests-runner/actions/runs/1231811908

------

*Automatically created by projen via the "upgrade" workflow*

Co-authored-by: flochaz <[email protected]>
  • Loading branch information
github-actions[bot] and flochaz authored Sep 14, 2021
1 parent e26e977 commit aafbe08
Show file tree
Hide file tree
Showing 4 changed files with 665 additions and 664 deletions.
32 changes: 30 additions & 2 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Run and Evaluate AWS Cloudwatch Canaries parallel with AWS Step Functions.

State machine's execution will fail if any of the canaries fail but it will wait for all to run before failing.

#### Initializer <a name="synthetics-canaries-e2e-tests-runner.StepFunctionOrchestrator.Initializer"></a>
#### Initializers <a name="synthetics-canaries-e2e-tests-runner.StepFunctionOrchestrator.Initializer"></a>

```typescript
import { StepFunctionOrchestrator } from 'synthetics-canaries-e2e-tests-runner'
Expand Down Expand Up @@ -40,6 +40,10 @@ new StepFunctionOrchestrator(scope: Construct, id: string, props: StepFunctionOr

##### `stateMachine`<sup>Required</sup> <a name="synthetics-canaries-e2e-tests-runner.StepFunctionOrchestrator.property.stateMachine"></a>

```typescript
public readonly stateMachine: StateMachine;
```

- *Type:* [`@aws-cdk/aws-stepfunctions.StateMachine`](#@aws-cdk/aws-stepfunctions.StateMachine)

---
Expand All @@ -61,6 +65,10 @@ const e2ETestsStepProps: E2ETestsStepProps = { ... }

##### `canaries`<sup>Required</sup> <a name="synthetics-canaries-e2e-tests-runner.E2ETestsStepProps.property.canaries"></a>

```typescript
public readonly canaries: Canary[];
```

- *Type:* [`@aws-cdk/aws-synthetics.Canary`](#@aws-cdk/aws-synthetics.Canary)[]

Array of AWS Cloudwatch canary to execute in this step.
Expand All @@ -69,6 +77,10 @@ Array of AWS Cloudwatch canary to execute in this step.

##### `inputsFromDeployedStack`<sup>Required</sup> <a name="synthetics-canaries-e2e-tests-runner.E2ETestsStepProps.property.inputsFromDeployedStack"></a>

```typescript
public readonly inputsFromDeployedStack: CfnOutput[];
```

- *Type:* [`@aws-cdk/core.CfnOutput`](#@aws-cdk/core.CfnOutput)[]

The potential list of CloudFormation outputs exposed by the App under test deployed in the previous step of the code pipeline workflow and that are needed by canaries to run properly.
Expand All @@ -80,6 +92,10 @@ Those will be pushed to AWS SSM Parameter store to be accessed by the canary at

##### `scope`<sup>Required</sup> <a name="synthetics-canaries-e2e-tests-runner.E2ETestsStepProps.property.scope"></a>

```typescript
public readonly scope: Construct;
```

- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)

Scope in wich to instantiate the state machine (usually your pipeline stack).
Expand All @@ -100,6 +116,10 @@ const stepFunctionOrchestratorProps: StepFunctionOrchestratorProps = { ... }

##### `canaries`<sup>Required</sup> <a name="synthetics-canaries-e2e-tests-runner.StepFunctionOrchestratorProps.property.canaries"></a>

```typescript
public readonly canaries: Canary[];
```

- *Type:* [`@aws-cdk/aws-synthetics.Canary`](#@aws-cdk/aws-synthetics.Canary)[]

Array of AWS Cloudwatch canary to execute.
Expand All @@ -114,7 +134,7 @@ Array of AWS Cloudwatch canary to execute.

Run AWS Cloudwatch Canaries end to end tests in parallel in the pipeline.

#### Initializer <a name="synthetics-canaries-e2e-tests-runner.E2ETestsStep.Initializer"></a>
#### Initializers <a name="synthetics-canaries-e2e-tests-runner.E2ETestsStep.Initializer"></a>

```typescript
import { E2ETestsStep } from 'synthetics-canaries-e2e-tests-runner'
Expand Down Expand Up @@ -159,12 +179,20 @@ public produceAction(stage: IStage, options: ProduceActionOptions)

##### `inputsFromDeployedStack`<sup>Required</sup> <a name="synthetics-canaries-e2e-tests-runner.E2ETestsStep.property.inputsFromDeployedStack"></a>

```typescript
public readonly inputsFromDeployedStack: any[];
```

- *Type:* `any`[]

---

##### `stateMachine`<sup>Required</sup> <a name="synthetics-canaries-e2e-tests-runner.E2ETestsStep.property.stateMachine"></a>

```typescript
public readonly stateMachine: StateMachine;
```

- *Type:* [`@aws-cdk/aws-stepfunctions.StateMachine`](#@aws-cdk/aws-stepfunctions.StateMachine)

---
Expand Down
14 changes: 7 additions & 7 deletions package.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

54 changes: 27 additions & 27 deletions test/unit/__snapshots__/orchestrator.test.ts.snap

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit aafbe08

Please sign in to comment.