Skip to content

fix(manifest): preserve default network config on empty env overrides #2442

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

Merged
mergify merged 3 commits into from
Jun 14, 2021
Merged

fix(manifest): preserve default network config on empty env overrides #2442

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
53b4310
fix(manifest): preserve default network config on empty env overrides
efekarakus Jun 10, 2021
6233e83
chore: fix typo in the comment
efekarakus Jun 11, 2021
5c9d757
Merge branch 'mainline' into issues/fix-2420
mergify[bot] Jun 14, 2021
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
8 changes: 7 additions & 1 deletion internal/pkg/deploy/cloudformation/stack/transformers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -533,7 +533,13 @@ func convertEFSConfiguration(in manifest.EFSVolumeConfiguration) *template.EFSVo
}
}

func convertNetworkConfig(network manifest.NetworkConfig) *template.NetworkOpts {
func convertNetworkConfig(network *manifest.NetworkConfig) *template.NetworkOpts {
if network == nil || network.VPC == nil {
return &template.NetworkOpts{
AssignPublicIP: template.EnablePublicIP,
SubnetsType: template.PublicSubnetsPlacement,
}
}
opts := &template.NetworkOpts{
AssignPublicIP: template.EnablePublicIP,
SubnetsType: template.PublicSubnetsPlacement,
Comment on lines +537 to 545
Copy link
Copy Markdown
Contributor

@iamhopaul123 iamhopaul123 Jun 11, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if network == nil || network.VPC == nil {
return &template.NetworkOpts{
AssignPublicIP: template.EnablePublicIP,
SubnetsType: template.PublicSubnetsPlacement,
}
}
opts := &template.NetworkOpts{
AssignPublicIP: template.EnablePublicIP,
SubnetsType: template.PublicSubnetsPlacement,
opts := &template.NetworkOpts{
AssignPublicIP: template.EnablePublicIP,
SubnetsType: template.PublicSubnetsPlacement
}
if network == nil || network.VPC == nil {
return opts
}
opts.SecurityGroups = network.VPC.SecurityGroups

Expand Down
6 changes: 3 additions & 3 deletions internal/pkg/manifest/backend_svc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ type BackendServiceConfig struct {
TaskConfig `yaml:",inline"`
*Logging `yaml:"logging,flow"`
Sidecars map[string]*SidecarConfig `yaml:"sidecars"`
Network NetworkConfig `yaml:"network"`
Network *NetworkConfig `yaml:"network"`
}

type imageWithPortAndHealthcheck struct {
Expand Down Expand Up @@ -149,8 +149,8 @@ func newDefaultBackendService() *BackendService {
Enable: aws.Bool(false),
},
},
Network: NetworkConfig{
VPC: vpcConfig{
Network: &NetworkConfig{
VPC: &vpcConfig{
Placement: stringP(PublicSubnetPlacement),
},
},
Expand Down
8 changes: 4 additions & 4 deletions internal/pkg/manifest/backend_svc_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ func TestNewBackendSvc(t *testing.T) {
Enable: aws.Bool(false),
},
},
Network: NetworkConfig{
VPC: vpcConfig{
Network: &NetworkConfig{
VPC: &vpcConfig{
Placement: stringP("public"),
},
},
Expand Down Expand Up @@ -104,8 +104,8 @@ func TestNewBackendSvc(t *testing.T) {
Enable: aws.Bool(false),
},
},
Network: NetworkConfig{
VPC: vpcConfig{
Network: &NetworkConfig{
VPC: &vpcConfig{
Placement: stringP("public"),
},
},
Expand Down
6 changes: 3 additions & 3 deletions internal/pkg/manifest/job.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ type ScheduledJobConfig struct {
Sidecars map[string]*SidecarConfig `yaml:"sidecars"`
On JobTriggerConfig `yaml:"on,flow"`
JobFailureHandlerConfig `yaml:",inline"`
Network NetworkConfig `yaml:"network"`
Network *NetworkConfig `yaml:"network"`
}

// JobTriggerConfig represents the configuration for the event that triggers the job.
Expand Down Expand Up @@ -80,8 +80,8 @@ func newDefaultScheduledJob() *ScheduledJob {
Value: aws.Int(1),
},
},
Network: NetworkConfig{
VPC: vpcConfig{
Network: &NetworkConfig{
VPC: &vpcConfig{
Placement: stringP(PublicSubnetPlacement),
},
},
Expand Down
8 changes: 4 additions & 4 deletions internal/pkg/manifest/job_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,8 @@ func TestScheduledJob_ApplyEnv(t *testing.T) {
Value: aws.Int(1),
},
},
Network: NetworkConfig{
VPC: vpcConfig{
Network: &NetworkConfig{
VPC: &vpcConfig{
Placement: stringP(PublicSubnetPlacement),
},
},
Expand Down Expand Up @@ -166,8 +166,8 @@ func TestScheduledJob_ApplyEnv(t *testing.T) {
"LOG_LEVEL": "prod",
},
},
Network: NetworkConfig{
VPC: vpcConfig{
Network: &NetworkConfig{
VPC: &vpcConfig{
Placement: stringP(PublicSubnetPlacement),
},
},
Expand Down
6 changes: 3 additions & 3 deletions internal/pkg/manifest/lb_web_svc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ type LoadBalancedWebServiceConfig struct {
TaskConfig `yaml:",inline"`
*Logging `yaml:"logging,flow"`
Sidecars map[string]*SidecarConfig `yaml:"sidecars"`
Network NetworkConfig `yaml:"network"`
Network *NetworkConfig `yaml:"network"`

// Fields that are used while marshaling the template for additional clarifications,
// but don't correspond to a field in the manifests.
Expand Down Expand Up @@ -116,8 +116,8 @@ func newDefaultLoadBalancedWebService() *LoadBalancedWebService {
Enable: aws.Bool(false),
},
},
Network: NetworkConfig{
VPC: vpcConfig{
Network: &NetworkConfig{
VPC: &vpcConfig{
Placement: stringP(PublicSubnetPlacement),
},
},
Expand Down
30 changes: 21 additions & 9 deletions internal/pkg/manifest/lb_web_svc_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ func TestNewLoadBalancedWebService(t *testing.T) {
Enable: aws.Bool(false),
},
},
Network: NetworkConfig{
VPC: vpcConfig{
Network: &NetworkConfig{
VPC: &vpcConfig{
Placement: stringP("public"),
},
},
Expand Down Expand Up @@ -352,8 +352,8 @@ func TestLoadBalancedWebService_ApplyEnv(t *testing.T) {
Logging: &Logging{
ConfigFile: aws.String("mockConfigFile"),
},
Network: NetworkConfig{
VPC: vpcConfig{
Network: &NetworkConfig{
VPC: &vpcConfig{
Placement: stringP("public"),
SecurityGroups: []string{"sg-123"},
},
Expand Down Expand Up @@ -416,8 +416,8 @@ func TestLoadBalancedWebService_ApplyEnv(t *testing.T) {
"FOO": "BAR",
},
},
Network: NetworkConfig{
VPC: vpcConfig{
Network: &NetworkConfig{
VPC: &vpcConfig{
SecurityGroups: []string{"sg-456", "sg-789"},
},
},
Expand Down Expand Up @@ -505,8 +505,8 @@ func TestLoadBalancedWebService_ApplyEnv(t *testing.T) {
"FOO": "BAR",
},
},
Network: NetworkConfig{
VPC: vpcConfig{
Network: &NetworkConfig{
VPC: &vpcConfig{
Placement: stringP("public"),
SecurityGroups: []string{"sg-456", "sg-789"},
},
Expand Down Expand Up @@ -549,7 +549,7 @@ func TestLoadBalancedWebService_ApplyEnv(t *testing.T) {
},
},
},
"with range override": {
"with range override and preserving network config": {
in: &LoadBalancedWebService{
LoadBalancedWebServiceConfig: LoadBalancedWebServiceConfig{
TaskConfig: TaskConfig{
Expand All @@ -560,6 +560,12 @@ func TestLoadBalancedWebService_ApplyEnv(t *testing.T) {
},
},
},
Network: &NetworkConfig{
VPC: &vpcConfig{
Placement: stringP("public"),
SecurityGroups: []string{"sg-456", "sg-789"},
},
},
},
Environments: map[string]*LoadBalancedWebServiceConfig{
"prod-iad": {},
Expand All @@ -578,6 +584,12 @@ func TestLoadBalancedWebService_ApplyEnv(t *testing.T) {
},
},
},
Network: &NetworkConfig{
VPC: &vpcConfig{
Placement: stringP("public"),
SecurityGroups: []string{"sg-456", "sg-789"},
},
},
},
},
},
Expand Down
8 changes: 4 additions & 4 deletions internal/pkg/manifest/svc_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,8 @@ environments:
"LOG_TOKEN": "LOG_TOKEN",
},
},
Network: NetworkConfig{
VPC: vpcConfig{
Network: &NetworkConfig{
VPC: &vpcConfig{
Placement: stringP("public"),
},
},
Expand Down Expand Up @@ -229,8 +229,8 @@ secrets:
"API_TOKEN": "SUBS_API_TOKEN",
},
},
Network: NetworkConfig{
VPC: vpcConfig{
Network: &NetworkConfig{
VPC: &vpcConfig{
Placement: stringP("public"),
},
},
Expand Down
14 changes: 9 additions & 5 deletions internal/pkg/manifest/workload.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,21 +438,25 @@ type TaskConfig struct {

// NetworkConfig represents options for network connection to AWS resources within a VPC.
type NetworkConfig struct {
VPC vpcConfig `yaml:"vpc"`
VPC *vpcConfig `yaml:"vpc"`
}

// UnmarshalYAML ensures that a NetworkConfig always defaults to public subnets.
// If the user specified a placement that's not valid then throw an error.
func (c *NetworkConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
type networkWithDefaults NetworkConfig
defaultVPCConf := &vpcConfig{
Placement: stringP(PublicSubnetPlacement),
}
conf := networkWithDefaults{
VPC: vpcConfig{
Placement: stringP(PublicSubnetPlacement),
},
VPC: defaultVPCConf,
}
if err := unmarshal(&conf); err != nil {
return err
}
if conf.VPC == nil { // If after unmarshaling the user did not specify VPC configuration then reset it to public.
conf.VPC = defaultVPCConf
}
if !conf.VPC.isValidPlacement() {
return fmt.Errorf("field '%s' is '%v' must be one of %#v", "network.vpc.placement", aws.StringValue(conf.VPC.Placement), subnetPlacements)
}
Expand All @@ -466,7 +470,7 @@ type vpcConfig struct {
SecurityGroups []string `yaml:"security_groups"`
}

func (c vpcConfig) isValidPlacement() bool {
func (c *vpcConfig) isValidPlacement() bool {
if c.Placement == nil {
return false
}
Expand Down
12 changes: 6 additions & 6 deletions internal/pkg/manifest/workload_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -518,16 +518,16 @@ func TestNetworkConfig_UnmarshalYAML(t *testing.T) {
testCases := map[string]struct {
data string

wantedConfig NetworkConfig
wantedConfig *NetworkConfig
wantedErr error
}{
"defaults to public placement if vpc is empty": {
data: `
network:
vpc:
`,
wantedConfig: NetworkConfig{
VPC: vpcConfig{
wantedConfig: &NetworkConfig{
VPC: &vpcConfig{
Placement: stringP(PublicSubnetPlacement),
},
},
Expand All @@ -549,8 +549,8 @@ network:
- 'sg-1234'
- 'sg-4567'
`,
wantedConfig: NetworkConfig{
VPC: vpcConfig{
wantedConfig: &NetworkConfig{
VPC: &vpcConfig{
Placement: stringP(PublicSubnetPlacement),
SecurityGroups: []string{"sg-1234", "sg-4567"},
},
Expand All @@ -562,7 +562,7 @@ network:
t.Run(name, func(t *testing.T) {
// GIVEN
type manifest struct {
Network NetworkConfig `yaml:"network"`
Network *NetworkConfig `yaml:"network"`
}
var m manifest

Expand Down