Skip to content

Commit

Permalink
loadStackParametersを使う場合にaws-cdkに依存しないように変更
Browse files Browse the repository at this point in the history
  • Loading branch information
@KDxCBdP7
KDxCBdP7 committed May 26, 2020
1 parent 92bff0c commit b40388f
Show file tree
Hide file tree
Showing 10 changed files with 254 additions and 256 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ SSM に書き出された設定値を、webpack で読み込んでビルドす
```typescript
// webpack.config.ts
import webpack from 'webpack'
import { loadStackParameters } from 'cdk-env-manager'
import { loadStackParameters } from 'cdk-env-manager/util'

const configFunction: () => Promise<webpack.Configuration> = async () => {
// load stack parameters from ssm
Expand Down
2 changes: 1 addition & 1 deletion example/webpack.config.ts
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import webpack from 'webpack'
import { loadStackParameters } from '../lib'
import { loadStackParameters } from '../lib/util'

const configFunction: () => Promise<webpack.Configuration> = async () => {
// load stack parameters from ssm by cdkEnvKey
Expand Down
2 changes: 1 addition & 1 deletion lib/CdkAppBase.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import {
ENVIRONMENT_VARIABLE_NAME_CDK_APP_KEY,
ENVIRONMENT_VARIABLE_NAME_CDK_ENV_KEY,
loadCdkDeployParametersFromLocal,
} from './CdkUtils'
} from './util'

export abstract class CdkAppBase<
T extends CdkDeployParameters = CdkDeployParameters
Expand Down
3 changes: 2 additions & 1 deletion lib/CdkSingletonStackBase.ts
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import * as cdk from '@aws-cdk/core'
import { CdkAppBase } from './CdkAppBase'
import { createCdkSsmStringParameter, getTagNameCdkEnvKey, SINGLETON_PREFIX } from './CdkUtils'
import { createCdkSsmStringParameter } from './CdkUtils'
import { getTagNameCdkEnvKey, SINGLETON_PREFIX } from './util'

export abstract class CdkSingletonStackBase<
Props extends {} = {},
Expand Down
3 changes: 2 additions & 1 deletion lib/CdkStackBase.ts
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import * as cdk from '@aws-cdk/core'
import { CdkAppBase } from './CdkAppBase'
import { createCdkSsmStringParameter, getTagNameCdkEnvKey } from './CdkUtils'
import { createCdkSsmStringParameter } from './CdkUtils'
import { getTagNameCdkEnvKey } from './util'

export abstract class CdkStackBase<
Props extends {} = {},
Expand Down
198 changes: 1 addition & 197 deletions lib/CdkUtils.ts
View file
Original file line number Diff line number Diff line change
@@ -1,29 +1,6 @@
import ResourceGroupsTaggingAPI from 'aws-sdk/clients/resourcegroupstaggingapi'
import AwsSdkSsm from 'aws-sdk/clients/ssm'
import dotenv from 'dotenv'
import fs from 'fs'
import stringify from 'json-stringify-pretty-compact'
import { pascalCase } from 'pascal-case'
import path from 'path'
import * as AwsCdkSsm from '@aws-cdk/aws-ssm'
import { Construct } from '@aws-cdk/core'

export type CdkDeployParameters = { [name: string]: string }

export const ENVIRONMENT_VARIABLE_NAME_CDK_ENV_KEY = 'CDK_ENV_KEY'
export const ENVIRONMENT_VARIABLE_NAME_CDK_APP_KEY = 'CDK_APP_KEY'
export const SINGLETON_PREFIX = 'SINGLETON__'
export const CDK_DEPLOY_PARAMETERS_KEY = 'CdkDeployParametersString'
export const CDK_DEPLOY_DEFAULT_PARAMETERS_FILE_PATH = 'cdk.parameters.default.env'

const makeStackParameterPath = (cdkAppKey: string, cdkEnvKey: string, ...paths: string[]) =>
'/' + ['CDK', pascalCase(cdkAppKey), pascalCase(cdkEnvKey), ...paths].filter((s) => !!s).join('/')

const makeCdkDeployParametersFilePath = (cdkAppKey: string, cdkEnvKey: string) => {
const cwd = process.cwd()
const cdkJson = require(path.resolve(cwd, 'cdk.json'))
return path.resolve(cwd, cdkJson.output || 'cdk.out', `${cdkAppKey}${cdkEnvKey}.parameters.json`)
}
import { makeStackParameterPath } from './util'

export const createCdkSsmStringParameter = (
scope: Construct,
Expand All @@ -39,176 +16,3 @@ export const createCdkSsmStringParameter = (
stringValue: value,
})
}

export const getStackParameters = async <T extends { [key: string]: string }>(
cdkAppKey: string,
cdkEnvKey: string,
option?: AwsSdkSsm.Types.ClientConfiguration
) => {
const parameterPath = makeStackParameterPath(cdkAppKey, cdkEnvKey) + '/'

// ssmからAWSリソースの設定情報を取得
const ssm = new AwsSdkSsm(option)
const getParametersByPath: (nextToken?: string) => Promise<AwsSdkSsm.Parameter[]> = async (
nextToken
) => {
const ssmResult = await ssm
.getParametersByPath({ Path: parameterPath, Recursive: true, NextToken: nextToken })
.promise()
if (ssmResult.NextToken) {
return [...(ssmResult.Parameters || []), ...(await getParametersByPath(ssmResult.NextToken))]
}
return ssmResult.Parameters || []
}
const parameters = await getParametersByPath()

// 取得したパラメータを整形
const params = parameters.reduce<T>(
(payload, p) => ({
...payload,
[p.Name!.substring(parameterPath.length)]: p.Value,
}),
{} as any
)
return params
}

const getStackTagMappingList = async (
cdkAppKey: string,
options?: ResourceGroupsTaggingAPI.Types.ClientConfiguration
) => {
const client = new ResourceGroupsTaggingAPI(options)
const getStackTagMappingListPerPage: (
paginationToken?: string
) => Promise<ResourceGroupsTaggingAPI.ResourceTagMappingList> = async (paginationToken) => {
const result = await client
.getResources({
PaginationToken: paginationToken,
TagFilters: [{ Key: getTagNameCdkEnvKey(cdkAppKey) }],
ResourceTypeFilters: ['cloudformation:stack'],
})
.promise()
if (result.PaginationToken) {
return [
...(result.ResourceTagMappingList || []),
...(await getStackTagMappingListPerPage(result.PaginationToken)),
]
}
return result.ResourceTagMappingList || []
}
return getStackTagMappingListPerPage()
}

export const getTagNameCdkEnvKey = (cdkAppKey: string) => cdkAppKey || 'CdkEnvKey'

export const getStackNamesPerCdkEnvKey = async (
cdkAppKey: string,
options?: ResourceGroupsTaggingAPI.Types.ClientConfiguration
) => {
const stackTagMappingList = await getStackTagMappingList(cdkAppKey, options)
const stackNamesPerCdkEnvKey = stackTagMappingList.reduce<{ [cdkEnvKey: string]: string[] }>(
(payload, stackTagMapping) => {
const cdkEnvKey = stackTagMapping.Tags![0].Value
if (!payload[cdkEnvKey]) {
payload[cdkEnvKey] = []
}
// ResourceARN: 'arn:aws:cloudformation:ap-northeast-1:9999999999:stack/StackName/e53ede20-ff06-11e9-bc7e-999999999999'
payload[cdkEnvKey].push(stackTagMapping.ResourceARN!.split('/')[1])
return payload
},
{} as { [cdkEnvKey: string]: string[] }
)
return stackNamesPerCdkEnvKey
}

export const loadCdkDeployParametersDefault = () => {
let defaultParameters = null
if (!defaultParameters) {
// 事前チェック：既定のパラメータファイルを取得
const defaultParametersFilePath = path.resolve(
process.cwd(),
CDK_DEPLOY_DEFAULT_PARAMETERS_FILE_PATH
)
if (!fs.existsSync(defaultParametersFilePath)) {
fs.writeFileSync(defaultParametersFilePath, '#REMOVAL_POLICY=retain', { encoding: 'utf8' })
console.log(`file not found: ${defaultParametersFilePath}, created default parameter file.`)
}
defaultParameters = dotenv.config({ path: defaultParametersFilePath }).parsed || {}
}
return defaultParameters as CdkDeployParameters
}

export const loadCdkDeployParametersFromSsm: (
cdkAppKey: string,
cdkEnvKey: string,
option?: AwsSdkSsm.Types.ClientConfiguration
) => Promise<CdkDeployParameters> = async (cdkAppKey, cdkEnvKey, option) => {
const response = await new AwsSdkSsm(option)
.getParameter({ Name: makeStackParameterPath(cdkAppKey, cdkEnvKey, CDK_DEPLOY_PARAMETERS_KEY) })
.promise()
return response.Parameter && response.Parameter.Value ? JSON.parse(response.Parameter.Value) : {}
}

export const loadCdkDeployParametersFromLocal = <
T extends CdkDeployParameters = CdkDeployParameters
>(
cdkAppKey: string,
cdkEnvKey: string
) => require(makeCdkDeployParametersFilePath(cdkAppKey, cdkEnvKey)) as T

export const writeCdkDeployParametersToSsm = async (
cdkAppKey: string,
cdkEnvKey: string,
deployParameters: CdkDeployParameters,
overwrite: boolean,
option?: AwsSdkSsm.Types.ClientConfiguration
) => {
new AwsSdkSsm(option)
.putParameter({
Type: 'String',
Overwrite: overwrite,
Name: makeStackParameterPath(cdkAppKey, cdkEnvKey, CDK_DEPLOY_PARAMETERS_KEY),
Value: JSON.stringify(deployParameters),
Tags: overwrite ? undefined : [{ Key: getTagNameCdkEnvKey(cdkAppKey), Value: cdkEnvKey }],
})
.promise()
.catch((e) => {
if (e.code === 'ParameterAlreadyExists') {
return writeCdkDeployParametersToSsm(cdkAppKey, cdkEnvKey, deployParameters, true, option)
}
return Promise.reject(e)
})
}

export const writeCdkDeployParametersToLocal = (
cdkAppKey: string,
cdkEnvKey: string,
deployParameters: CdkDeployParameters
) => {
const filePath = makeCdkDeployParametersFilePath(cdkAppKey, cdkEnvKey)
if (!fs.existsSync(path.dirname(filePath))) {
fs.mkdirSync(path.dirname(filePath), { recursive: true })
}
fs.writeFileSync(filePath, stringify(deployParameters, { maxLength: 4 }), { encoding: 'utf8' })
}

export const mergeCdkDeployParameters = (
defaultParameters: CdkDeployParameters,
parameters: CdkDeployParameters
) => {
const mergedParameters = Object.keys(defaultParameters).reduce<CdkDeployParameters>(
(payload, key) => ({ ...payload, [key]: parameters[key] || defaultParameters[key] }),
{}
)
return mergedParameters
}

export const diffCdkDeployParametersKeys = (a: CdkDeployParameters, b: CdkDeployParameters) => {
const aKeys = Object.keys(a)
const bKeys = Object.keys(b)

return !!(
aKeys.filter((aKey) => !bKeys.includes(aKey)).length ||
bKeys.filter((bKey) => !aKeys.includes(bKey)).length
)
}
17 changes: 0 additions & 17 deletions lib/index.ts
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,3 @@
import {
ENVIRONMENT_VARIABLE_NAME_CDK_APP_KEY,
ENVIRONMENT_VARIABLE_NAME_CDK_ENV_KEY,
getStackParameters,
} from './CdkUtils'

export * from './CdkAppBase'
export * from './CdkStackBase'
export * from './CdkSingletonStackBase'

export const loadStackParameters = () => {
const cdkAppKey = process.env[ENVIRONMENT_VARIABLE_NAME_CDK_APP_KEY] || ''
const cdkEnvKey = process.env[ENVIRONMENT_VARIABLE_NAME_CDK_ENV_KEY]
if (!cdkEnvKey) {
throw Error(`Environment Variable not found: ${ENVIRONMENT_VARIABLE_NAME_CDK_ENV_KEY}`)
}

// load stack parameters from ssm
return getStackParameters(cdkAppKey, cdkEnvKey)
}
Loading

0 comments on commit b40388f

Please sign in to comment.