forked from aws/aws-cdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(vpc): allow Vpc.fromLookup() to discover asymmetric subnets
Previously, Vpc.fromLookup() required every subnet group to be in the same Availability Zones, and for all subnets in all groups to cover all of those Availability Zones. This loosens this requirement, so that now Vpc.fromLookup() works for VPCs of all shapes. This also add a way to customize which tag of the subnet is considered when grouping subnets into groups when calling fromLookup(). Fixes aws#3407
- Loading branch information
Showing
10 changed files
with
934 additions
and
46 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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| import { Construct, ContextProvider, GetContextValueOptions, GetContextValueResult, Lazy, Stack } from "@aws-cdk/core"; | ||
| import cxapi = require('@aws-cdk/cx-api'); | ||
| import { Test } from 'nodeunit'; | ||
| import { Vpc } from "../lib"; | ||
|
|
||
| export = { | ||
| 'Vpc.fromLookup()': { | ||
| 'requires concrete values'(test: Test) { | ||
| // GIVEN | ||
| const stack = new Stack(); | ||
|
|
||
| test.throws(() => { | ||
| Vpc.fromLookup(stack, 'Vpc', { | ||
| vpcId: Lazy.stringValue({ produce: () => 'some-id' }) | ||
| }); | ||
|
|
||
| }, 'All arguments to Vpc.fromLookup() must be concrete'); | ||
|
|
||
| test.done(); | ||
| }, | ||
|
|
||
| 'selecting subnets by name from a looked-up VPC does not throw'(test: Test) { | ||
| // GIVEN | ||
| const stack = new Stack(undefined, undefined, { env: { region: 'us-east-1', account: '123456789012' }}); | ||
| const vpc = Vpc.fromLookup(stack, 'VPC', { | ||
| vpcId: 'vpc-1234' | ||
| }); | ||
|
|
||
| // WHEN | ||
| vpc.selectSubnets({ subnetName: 'Bleep' }); | ||
|
|
||
| // THEN: no exception | ||
|
|
||
| test.done(); | ||
| }, | ||
|
|
||
| 'accepts asymmetric subnets'(test: Test) { | ||
| const previous = mockVpcContextProviderWith({ | ||
| vpcId: 'vpc-1234', | ||
| subnetGroups: [ | ||
| { | ||
| name: 'Public', | ||
| type: cxapi.VpcSubnetGroupType.PUBLIC, | ||
| subnets: [ | ||
| { | ||
| subnetId: 'pub-sub-in-us-east-1a', | ||
| availabilityZone: 'us-east-1a', | ||
| routeTableId: 'rt-123', | ||
| }, | ||
| { | ||
| subnetId: 'pub-sub-in-us-east-1b', | ||
| availabilityZone: 'us-east-1b', | ||
| routeTableId: 'rt-123', | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| name: 'Private', | ||
| type: cxapi.VpcSubnetGroupType.PRIVATE, | ||
| subnets: [ | ||
| { | ||
| subnetId: 'pri-sub-1-in-us-east-1c', | ||
| availabilityZone: 'us-east-1c', | ||
| routeTableId: 'rt-123', | ||
| }, | ||
| { | ||
| subnetId: 'pri-sub-2-in-us-east-1c', | ||
| availabilityZone: 'us-east-1c', | ||
| routeTableId: 'rt-123', | ||
| }, | ||
| { | ||
| subnetId: 'pri-sub-1-in-us-east-1d', | ||
| availabilityZone: 'us-east-1d', | ||
| routeTableId: 'rt-123', | ||
| }, | ||
| { | ||
| subnetId: 'pri-sub-2-in-us-east-1d', | ||
| availabilityZone: 'us-east-1d', | ||
| routeTableId: 'rt-123', | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| }, options => { | ||
| test.deepEqual(options.filter, { | ||
| isDefault: 'true', | ||
| }); | ||
|
|
||
| test.equal(options.subnetGroupNameTag, undefined); | ||
| }); | ||
|
|
||
| const stack = new Stack(); | ||
| const vpc = Vpc.fromLookup(stack, 'Vpc', { | ||
| isDefault: true, | ||
| }); | ||
|
|
||
| test.deepEqual(vpc.availabilityZones, ['us-east-1a', 'us-east-1b', 'us-east-1c', 'us-east-1d']); | ||
| test.equal(vpc.publicSubnets.length, 2); | ||
| test.equal(vpc.privateSubnets.length, 4); | ||
| test.equal(vpc.isolatedSubnets.length, 0); | ||
|
|
||
| restoreContextProvider(previous); | ||
| test.done(); | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| function mockVpcContextProviderWith(response: cxapi.AsymmetricVpcContextResponse, | ||
| paramValidator?: (options: cxapi.AsymmetricVpcContextQuery) => void) { | ||
| const previous = ContextProvider.getValue; | ||
| ContextProvider.getValue = (_scope: Construct, options: GetContextValueOptions) => { | ||
| // do some basic sanity checks | ||
| if (options.provider !== cxapi.ASYMMETRIC_VPC_PROVIDER) { | ||
| throw new Error(`Expected: '${cxapi.ASYMMETRIC_VPC_PROVIDER}', got: '${options.provider}'`); | ||
| } | ||
|
|
||
| if (paramValidator) { | ||
| paramValidator(options.props as any); | ||
| } | ||
| return { | ||
| value: response, | ||
| }; | ||
| }; | ||
| return previous; | ||
| } | ||
|
|
||
| function restoreContextProvider(previous: (scope: Construct, options: GetContextValueOptions) => GetContextValueResult): void { | ||
| ContextProvider.getValue = previous; | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| import { VpcContextQuery } from './vpc'; | ||
|
|
||
| export const ASYMMETRIC_VPC_PROVIDER = 'asymmetric-vpc-provider'; | ||
|
|
||
| /** | ||
| * Query input for looking up a VPC that allows asymmetric subnets. | ||
| */ | ||
| export interface AsymmetricVpcContextQuery extends VpcContextQuery { | ||
| /** | ||
| * Optional tag whose value is used as the name of the subnet group | ||
| * the subnet with the tag belongs to. | ||
| * If not provided, we'll look at the aws-cdk:subnet-name tag. | ||
| * If the subnet does not have the tag, | ||
| * we'll use its type as the name. | ||
| */ | ||
| readonly subnetGroupNameTag?: string; | ||
| } | ||
|
|
||
| export enum VpcSubnetGroupType { | ||
| PUBLIC = 'Public', | ||
| PRIVATE = 'Private', | ||
| ISOLATED = 'Isolated', | ||
| } | ||
|
|
||
| export interface VpcSubnet { | ||
| readonly subnetId: string; | ||
| readonly availabilityZone: string; | ||
| readonly routeTableId: string; | ||
| } | ||
|
|
||
| export interface VpcSubnetGroup { | ||
| readonly name: string; | ||
| readonly type: VpcSubnetGroupType; | ||
| readonly subnets: VpcSubnet[]; | ||
| } | ||
|
|
||
| /** | ||
| * Properties of a discovered VPC | ||
| */ | ||
| export interface AsymmetricVpcContextResponse { | ||
| /** | ||
| * VPC id | ||
| */ | ||
| readonly vpcId: string; | ||
|
|
||
| readonly subnetGroups: VpcSubnetGroup[]; | ||
|
|
||
| /** | ||
| * The VPN gateway ID | ||
| */ | ||
| readonly vpnGatewayId?: string; | ||
| } |
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.