-
Notifications
You must be signed in to change notification settings - Fork 3.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(codebuild): introduce BuildSpec object (#2820)
Minimal representation of BuildSpec, formalizing some logic that was already in `Project` but not really well-placed there. It has very minimal support for merging buildspecs (only commands, not artifacts or anything else). Internal representation is hidden though, and can be improved and extended later. BREAKING CHANGE: * **codebuild**: buildSpec argument is now a `BuildSpec` object.
- Loading branch information
Showing
14 changed files
with
188 additions
and
82 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| import { IResolveContext, Lazy, Stack } from '@aws-cdk/cdk'; | ||
|
|
||
| /** | ||
| * BuildSpec for CodeBuild projects | ||
| */ | ||
| export abstract class BuildSpec { | ||
| public static fromObject(value: {[key: string]: any}): BuildSpec { | ||
| return new ObjectBuildSpec(value); | ||
| } | ||
|
|
||
| /** | ||
| * Use a file from the source as buildspec | ||
| * | ||
| * Use this if you want to use a file different from 'buildspec.yml'` | ||
| */ | ||
| public static fromSourceFilename(filename: string): BuildSpec { | ||
| return new FilenameBuildSpec(filename); | ||
| } | ||
|
|
||
| /** | ||
| * Whether the buildspec is directly available or deferred until build-time | ||
| */ | ||
| public abstract readonly isImmediate: boolean; | ||
|
|
||
| protected constructor() { | ||
| } | ||
|
|
||
| /** | ||
| * Render the represented BuildSpec | ||
| */ | ||
| public abstract toBuildSpec(): string; | ||
| } | ||
|
|
||
| /** | ||
| * BuildSpec that just returns the input unchanged | ||
| */ | ||
| class FilenameBuildSpec extends BuildSpec { | ||
| public readonly isImmediate: boolean = false; | ||
|
|
||
| constructor(private readonly filename: string) { | ||
| super(); | ||
| } | ||
|
|
||
| public toBuildSpec(): string { | ||
| return this.filename; | ||
| } | ||
|
|
||
| public toString() { | ||
| return `<buildspec file: ${this.filename}>`; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * BuildSpec that understands about structure | ||
| */ | ||
| class ObjectBuildSpec extends BuildSpec { | ||
| public readonly isImmediate: boolean = true; | ||
|
|
||
| constructor(public readonly spec: {[key: string]: any}) { | ||
| super(); | ||
| } | ||
|
|
||
| public toBuildSpec(): string { | ||
| // We have to pretty-print the buildspec, otherwise | ||
| // CodeBuild will not recognize it as an inline buildspec. | ||
| return Lazy.stringValue({ produce: (ctx: IResolveContext) => | ||
| Stack.of(ctx.scope).toJsonString(this.spec, 2) | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Merge two buildspecs into a new BuildSpec | ||
| * | ||
| * NOTE: will currently only merge commands, not artifact | ||
| * declarations, environment variables, secrets, or any | ||
| * other configuration elements. | ||
| * | ||
| * Internal for now because it's not complete/good enough | ||
| * to expose on the objects directly, but we need to it to | ||
| * keep feature-parity for Project. | ||
| * | ||
| * @internal | ||
| */ | ||
| export function mergeBuildSpecs(lhs: BuildSpec, rhs: BuildSpec): BuildSpec { | ||
| if (!(lhs instanceof ObjectBuildSpec) || !(rhs instanceof ObjectBuildSpec)) { | ||
| throw new Error('Can only merge buildspecs created using BuildSpec.fromObject()'); | ||
| } | ||
|
|
||
| return new ObjectBuildSpec(copyCommands(lhs.spec, rhs.spec)); | ||
| } | ||
|
|
||
| /** | ||
| * Extend buildSpec phases with the contents of another one | ||
| */ | ||
| function copyCommands(buildSpec: any, extend: any): any { | ||
| if (buildSpec.version === '0.1') { | ||
| throw new Error('Cannot extend buildspec at version "0.1". Set the version to "0.2" or higher instead.'); | ||
| } | ||
|
|
||
| const ret = Object.assign({}, buildSpec); // Return a copy | ||
| ret.phases = Object.assign({}, ret.phases); | ||
|
|
||
| for (const phaseName of Object.keys(extend.phases)) { | ||
| const phase = ret.phases[phaseName] = Object.assign({}, ret.phases[phaseName]); | ||
| phase.commands = [...phase.commands || [], ...extend.phases[phaseName].commands]; | ||
| } | ||
|
|
||
| return ret; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.