Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: CDKTF Component improvements #336

Merged
merged 1 commit into from
Sep 11, 2024
Merged

feat: CDKTF Component improvements #336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 55 additions & 9 deletions templates/templates/component/cdktf/src/helpers/fogg-stack.ts.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
TerraformStack,
S3Backend,
S3BackendConfig,
DataTerraformRemoteState,
DataTerraformRemoteStateS3,
DataTerraformRemoteStateS3Config,
TerraformHclModule,
Expand Down Expand Up @@ -44,6 +45,8 @@ export class FoggStack extends TerraformStack {
public readonly foggComp: Component;
public readonly modules: Record<string, TerraformHclModule> = {};
public readonly locals: Record<string, TerraformLocal> = {};
private readonly _providers: Record<string, awsProvider.AwsProvider> = {};
private readonly _remoteStates: Record<string, DataTerraformRemoteState> = {};

constructor(scope: Construct, id: string, props: FoggStackProps) {
super(scope, id);
Expand Down Expand Up @@ -78,6 +81,32 @@ export class FoggStack extends TerraformStack {
this.setModuleVariables(id, variables);
}

/**
* Return a remote state defined in the fogg component configuration.
* @param name - The name of the remote state to get
* @returns the DataTerraformRemoteState object
* @throws if the remote state is not found
*/
public remoteState(name: string): DataTerraformRemoteState {
if (!this._remoteStates[name]) {
throw new Error(`Remote state ${name} not found`);
}
return this._remoteStates[name];
}

/**
* Return a provider defined in the fogg component configuration.
* @param alias - The alias of the provider to get
* @returns the AwsProvider object
* @throws if the provider is not found
*/
public awsProvider(alias: string): awsProvider.AwsProvider {
if (!this._providers[alias]) {
throw new Error(`Provider ${alias} not found`);
}
return this._providers[alias];
}

/**
* Set variables for a module included in the fogg component modules[] configuration.
*
Expand Down Expand Up @@ -154,14 +183,11 @@ export class FoggStack extends TerraformStack {
roleArn: s3Config.role_arn,
};
}
// console.log(
// `Setting ${id} Remote backend Config ${JSON.stringify(
// remoteStateConfig,
// null,
// 2
// )}`
// );
new DataTerraformRemoteStateS3(this, id, remoteStateConfig);
this._remoteStates[id] = new DataTerraformRemoteStateS3(
this,
id,
remoteStateConfig,
);
} else {
throw new Error(`Unsupported backend configuration ${remoteConfig.kind}`);
}
Expand Down Expand Up @@ -244,6 +270,22 @@ export class FoggStack extends TerraformStack {
region: config.region,
alias: config.alias,
};
if (config.default_tags && config.default_tags.enabled) {
c.defaultTags = [
{
tags: {
env: this.foggComp.env,
owner: this.foggComp.owner,
project: this.foggComp.project,
managedBy: "terraform",
service: this.foggComp.name,
...(this.foggComp.backend.s3?.key_path && {
tfstateKey: this.foggComp.backend.s3?.key_path,
}),
},
},
];
}
if (config.profile) {
c.profile = config.profile;
} else if (config.role_arn) {
Expand All @@ -253,7 +295,11 @@ export class FoggStack extends TerraformStack {
},
];
}
new awsProvider.AwsProvider(this, id, c);
this._providers[c.alias ?? "Default"] = new awsProvider.AwsProvider(
this,
id,
c,
);
}

private parseDataDogProviderConfig(_config: DatadogProvider): void {
Expand Down
64 changes: 55 additions & 9 deletions testdata/v2_cdktf_components/terraform/envs/test/lambda/src/helpers/fogg-stack.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
TerraformStack,
S3Backend,
S3BackendConfig,
DataTerraformRemoteState,
DataTerraformRemoteStateS3,
DataTerraformRemoteStateS3Config,
TerraformHclModule,
Expand Down Expand Up @@ -46,6 +47,8 @@ export class FoggStack extends TerraformStack {
public readonly foggComp: Component;
public readonly modules: Record<string, TerraformHclModule> = {};
public readonly locals: Record<string, TerraformLocal> = {};
private readonly _providers: Record<string, awsProvider.AwsProvider> = {};
private readonly _remoteStates: Record<string, DataTerraformRemoteState> = {};

constructor(scope: Construct, id: string, props: FoggStackProps) {
super(scope, id);
Expand Down Expand Up @@ -80,6 +83,32 @@ export class FoggStack extends TerraformStack {
this.setModuleVariables(id, variables);
}

/**
* Return a remote state defined in the fogg component configuration.
* @param name - The name of the remote state to get
* @returns the DataTerraformRemoteState object
* @throws if the remote state is not found
*/
public remoteState(name: string): DataTerraformRemoteState {
if (!this._remoteStates[name]) {
throw new Error(`Remote state ${name} not found`);
}
return this._remoteStates[name];
}

/**
* Return a provider defined in the fogg component configuration.
* @param alias - The alias of the provider to get
* @returns the AwsProvider object
* @throws if the provider is not found
*/
public awsProvider(alias: string): awsProvider.AwsProvider {
if (!this._providers[alias]) {
throw new Error(`Provider ${alias} not found`);
}
return this._providers[alias];
}

/**
* Set variables for a module included in the fogg component modules[] configuration.
*
Expand Down Expand Up @@ -156,14 +185,11 @@ export class FoggStack extends TerraformStack {
roleArn: s3Config.role_arn,
};
}
// console.log(
// `Setting ${id} Remote backend Config ${JSON.stringify(
// remoteStateConfig,
// null,
// 2
// )}`
// );
new DataTerraformRemoteStateS3(this, id, remoteStateConfig);
this._remoteStates[id] = new DataTerraformRemoteStateS3(
this,
id,
remoteStateConfig,
);
} else {
throw new Error(`Unsupported backend configuration ${remoteConfig.kind}`);
}
Expand Down Expand Up @@ -246,6 +272,22 @@ export class FoggStack extends TerraformStack {
region: config.region,
alias: config.alias,
};
if (config.default_tags && config.default_tags.enabled) {
c.defaultTags = [
{
tags: {
env: this.foggComp.env,
owner: this.foggComp.owner,
project: this.foggComp.project,
managedBy: "terraform",
service: this.foggComp.name,
...(this.foggComp.backend.s3?.key_path && {
tfstateKey: this.foggComp.backend.s3?.key_path,
}),
},
},
];
}
if (config.profile) {
c.profile = config.profile;
} else if (config.role_arn) {
Expand All @@ -255,7 +297,11 @@ export class FoggStack extends TerraformStack {
},
];
}
new awsProvider.AwsProvider(this, id, c);
this._providers[c.alias ?? "Default"] = new awsProvider.AwsProvider(
this,
id,
c,
);
}

private parseDataDogProviderConfig(_config: DatadogProvider): void {
Expand Down
64 changes: 55 additions & 9 deletions testdata/v2_cdktf_components/terraform/envs/test/network/src/helpers/fogg-stack.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
TerraformStack,
S3Backend,
S3BackendConfig,
DataTerraformRemoteState,
DataTerraformRemoteStateS3,
DataTerraformRemoteStateS3Config,
TerraformHclModule,
Expand Down Expand Up @@ -46,6 +47,8 @@ export class FoggStack extends TerraformStack {
public readonly foggComp: Component;
public readonly modules: Record<string, TerraformHclModule> = {};
public readonly locals: Record<string, TerraformLocal> = {};
private readonly _providers: Record<string, awsProvider.AwsProvider> = {};
private readonly _remoteStates: Record<string, DataTerraformRemoteState> = {};

constructor(scope: Construct, id: string, props: FoggStackProps) {
super(scope, id);
Expand Down Expand Up @@ -80,6 +83,32 @@ export class FoggStack extends TerraformStack {
this.setModuleVariables(id, variables);
}

/**
* Return a remote state defined in the fogg component configuration.
* @param name - The name of the remote state to get
* @returns the DataTerraformRemoteState object
* @throws if the remote state is not found
*/
public remoteState(name: string): DataTerraformRemoteState {
if (!this._remoteStates[name]) {
throw new Error(`Remote state ${name} not found`);
}
return this._remoteStates[name];
}

/**
* Return a provider defined in the fogg component configuration.
* @param alias - The alias of the provider to get
* @returns the AwsProvider object
* @throws if the provider is not found
*/
public awsProvider(alias: string): awsProvider.AwsProvider {
if (!this._providers[alias]) {
throw new Error(`Provider ${alias} not found`);
}
return this._providers[alias];
}

/**
* Set variables for a module included in the fogg component modules[] configuration.
*
Expand Down Expand Up @@ -156,14 +185,11 @@ export class FoggStack extends TerraformStack {
roleArn: s3Config.role_arn,
};
}
// console.log(
// `Setting ${id} Remote backend Config ${JSON.stringify(
// remoteStateConfig,
// null,
// 2
// )}`
// );
new DataTerraformRemoteStateS3(this, id, remoteStateConfig);
this._remoteStates[id] = new DataTerraformRemoteStateS3(
this,
id,
remoteStateConfig,
);
} else {
throw new Error(`Unsupported backend configuration ${remoteConfig.kind}`);
}
Expand Down Expand Up @@ -246,6 +272,22 @@ export class FoggStack extends TerraformStack {
region: config.region,
alias: config.alias,
};
if (config.default_tags && config.default_tags.enabled) {
c.defaultTags = [
{
tags: {
env: this.foggComp.env,
owner: this.foggComp.owner,
project: this.foggComp.project,
managedBy: "terraform",
service: this.foggComp.name,
...(this.foggComp.backend.s3?.key_path && {
tfstateKey: this.foggComp.backend.s3?.key_path,
}),
},
},
];
}
if (config.profile) {
c.profile = config.profile;
} else if (config.role_arn) {
Expand All @@ -255,7 +297,11 @@ export class FoggStack extends TerraformStack {
},
];
}
new awsProvider.AwsProvider(this, id, c);
this._providers[c.alias ?? "Default"] = new awsProvider.AwsProvider(
this,
id,
c,
);
}

private parseDataDogProviderConfig(_config: DatadogProvider): void {
Expand Down