Skip to content

Commit

Permalink
validate duplicated variables and triggers with duplicate source action
Browse files Browse the repository at this point in the history
validate triggers with duplicate source action

variableName doc

sourceAction doc
  • Loading branch information
go-to-k committed Feb 10, 2024
1 parent 2b3c633 commit 5369755
Show file tree
Hide file tree
Showing 5 changed files with 70 additions and 4 deletions.
24 changes: 21 additions & 3 deletions packages/aws-cdk-lib/aws-codepipeline/lib/pipeline.ts
Original file line number Diff line number Diff line change
Expand Up @@ -494,8 +494,6 @@ export class Pipeline extends PipelineBase {
Annotations.of(this).addWarningV2('@aws-cdk/aws-codepipeline:unspecifiedPipelineType', 'V1 pipeline type is implicitly selected when `pipelineType` is not set. If you want to use V2 type, set `PipelineType.V2`.');
}
this.pipelineType = props.pipelineType ?? PipelineType.V1;
this.variables = props.variables ?? [];
this.triggers = props.triggers?.map(trigger => this.addTrigger(trigger)) ?? [];

this.codePipeline = new CfnPipeline(this, 'Resource', {
artifactStore: Lazy.any({ produce: () => this.renderArtifactStoreProperty() }),
Expand Down Expand Up @@ -534,6 +532,12 @@ export class Pipeline extends PipelineBase {
for (const stage of props.stages || []) {
this.addStage(stage);
}
for (const variable of props.variables || []) {
this.addVariable(variable);
}
for (const trigger of props.triggers || []) {
this.addTrigger(trigger);
}

this.node.addValidation({ validate: () => this.validatePipeline() });
}
Expand Down Expand Up @@ -572,9 +576,16 @@ export class Pipeline extends PipelineBase {
* Adds a new Variable to this Pipeline.
*
* @param variable Variable instance to add to this Pipeline
* @returns the newly created variable
*/
public addVariable(variable: Variable) {
public addVariable(variable: Variable): Variable {
// check for duplicate variables and names
if (this.variables.find(v => v.variableName === variable.variableName)) {
throw new Error(`Variable with duplicate name '${variable.variableName}' added to the Pipeline`);
}

this.variables.push(variable);
return variable;
}

/**
Expand All @@ -585,6 +596,13 @@ export class Pipeline extends PipelineBase {
*/
public addTrigger(props: TriggerProps): Trigger {
const trigger = new Trigger(props);
const actionName = props.gitConfiguration?.sourceAction.actionProperties.actionName;

// check for duplicate source actions for triggers
if (actionName !== undefined && this.triggers.find(t => t.sourceAction?.actionProperties.actionName === actionName)) {
throw new Error(`Trigger with duplicate source action '${actionName}' added to the Pipeline`);
}

this.triggers.push(trigger);
return trigger;
}
Expand Down
6 changes: 6 additions & 0 deletions packages/aws-cdk-lib/aws-codepipeline/lib/trigger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,13 @@ export interface TriggerProps {
* Trigger.
*/
export class Trigger {
/**
* The pipeline source action where the trigger configuration.
*/
public readonly sourceAction: IAction | undefined;

constructor(private readonly props: TriggerProps) {
this.sourceAction = props.gitConfiguration?.sourceAction;
this.validate();
}

Expand Down
6 changes: 5 additions & 1 deletion packages/aws-cdk-lib/aws-codepipeline/lib/variable.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,11 @@ export interface VariableProps {
* Pipeline-Level variable.
*/
export class Variable {
private readonly variableName: string;
/**
* The name of a pipeline-level variable.
*/
public readonly variableName: string;

private readonly description?: string;
private readonly defaultValue?: string;

Expand Down
24 changes: 24 additions & 0 deletions packages/aws-cdk-lib/aws-codepipeline/test/triggers.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,30 @@ describe('triggers', () => {
}).toThrow(/provider for actionProperties in sourceAction with name 'FakeSource' must be 'CodeStarSourceConnection', got 'Fake'/);
});

test('throw if source action with duplicate action name added to the Pipeline', () => {
const pipeline = new codepipeline.Pipeline(stack, 'Pipeline', {
pipelineType: codepipeline.PipelineType.V2,
triggers: [{
providerType: codepipeline.ProviderType.CODE_STAR_SOURCE_CONNECTION,
gitConfiguration: {
sourceAction,
pushFilter: [{
excludedTags: ['exclude1', 'exclude2'],
includedTags: ['include1', 'include2'],
}],
},
}],
});
expect(() => {
pipeline.addTrigger({
providerType: codepipeline.ProviderType.CODE_STAR_SOURCE_CONNECTION,
gitConfiguration: {
sourceAction,
},
});
}).toThrow(/Trigger with duplicate source action 'CodeStarConnectionsSourceAction' added to the Pipeline/);
});

test('throw if triggers are specified when pipelineType is not set to V2', () => {
const pipeline = new codepipeline.Pipeline(stack, 'Pipeline', {
pipelineType: codepipeline.PipelineType.V1,
Expand Down
14 changes: 14 additions & 0 deletions packages/aws-cdk-lib/aws-codepipeline/test/variables.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,20 @@ describe('variables', () => {
});
}).toThrow(/Description for variable 'var-name-1' must not be greater than 200 characters long, got 201/);
});

test('throw if variable with duplicate name added to the Pipeline', () => {
const pipeline = new codepipeline.Pipeline(stack, 'Pipeline', {
variables: [variable1],
});
const duplicated = new codepipeline.Variable({
variableName: 'var-name-1',
description: 'description-dummy',
defaultValue: 'default-dummy',
});
expect(() => {
pipeline.addVariable(duplicated);
}).toThrow(/Variable with duplicate name 'var-name-1' added to the Pipeline/);
});
});
});

Expand Down

0 comments on commit 5369755

Please sign in to comment.