Skip to content
This repository has been archived by the owner on Oct 24, 2023. It is now read-only.

Commit

Permalink
chore: add distro + imageRef validation
Browse files Browse the repository at this point in the history
  • Loading branch information
@jackfrancis
jackfrancis committed Oct 8, 2019
1 parent 94703b3 commit ff10ec1
Show file tree
Hide file tree
Showing 2 changed files with 318 additions and 0 deletions.
6 changes: 6 additions & 0 deletions pkg/api/vlabs/validate.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,9 @@ func (a *Properties) validateMasterProfile(isUpdate bool) error {
}

if m.ImageRef != nil {
if m.Distro != "" {
return errors.New("masterProfile includes a custom image configuration (imageRef) and an explicit distro configuration, you may use one of these but not both simultaneously.")
}
if err := m.ImageRef.validateImageNameAndGroup(); err != nil {
return err
}
Expand Down Expand Up @@ -500,6 +503,9 @@ func (a *Properties) validateAgentPoolProfiles(isUpdate bool) error {
}

if agentPoolProfile.ImageRef != nil {
if agentPoolProfile.Distro != "" {
return errors.Errorf("agentPoolProfile %s includes a custom image configuration (imageRef) and an explicit distro configuration, you may use one of these but not both simultaneously.", agentPoolProfile.Name)
}
return agentPoolProfile.ImageRef.validateImageNameAndGroup()
}

Expand Down
312 changes: 312 additions & 0 deletions pkg/api/vlabs/validate_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3357,3 +3357,315 @@ func TestValidateFeatureFlags(t *testing.T) {
})
}
}

func TestValidateMasterProfileImageRef(t *testing.T) {
tests := map[string]struct {
properties *Properties
isUpdate bool
expectedError error
}{
"should error when masterProfile includes both an ImageRef and a Distro configuration": {
properties: &Properties{
OrchestratorProfile: &OrchestratorProfile{
OrchestratorType: Kubernetes,
},
MasterProfile: &MasterProfile{
Distro: AKSUbuntu1604,
ImageRef: &ImageReference{
Name: "name",
ResourceGroup: "rg",
SubscriptionID: "sub-id",
Gallery: "gallery",
Version: "version",
},
DNSPrefix: "foo",
},
},
isUpdate: false,
expectedError: errors.New("masterProfile includes a custom image configuration (imageRef) and an explicit distro configuration, you may use one of these but not both simultaneously."),
},
"should error when masterProfile includes both an ImageRef and a Distro configuration in update context": {
properties: &Properties{
OrchestratorProfile: &OrchestratorProfile{
OrchestratorType: Kubernetes,
},
MasterProfile: &MasterProfile{
Distro: AKSUbuntu1604,
ImageRef: &ImageReference{
Name: "name",
ResourceGroup: "rg",
SubscriptionID: "sub-id",
Gallery: "gallery",
Version: "version",
},
DNSPrefix: "foo",
},
},
isUpdate: true,
expectedError: errors.New("masterProfile includes a custom image configuration (imageRef) and an explicit distro configuration, you may use one of these but not both simultaneously."),
},
"should not error when masterProfile includes an ImageRef configuration only": {
properties: &Properties{
OrchestratorProfile: &OrchestratorProfile{
OrchestratorType: Kubernetes,
},
MasterProfile: &MasterProfile{
ImageRef: &ImageReference{
Name: "name",
ResourceGroup: "rg",
SubscriptionID: "sub-id",
Gallery: "gallery",
Version: "version",
},
DNSPrefix: "foo",
},
},
isUpdate: false,
expectedError: nil,
},
"should not error when masterProfile includes an ImageRef configuration only in an upgrade context": {
properties: &Properties{
OrchestratorProfile: &OrchestratorProfile{
OrchestratorType: Kubernetes,
},
MasterProfile: &MasterProfile{
ImageRef: &ImageReference{
Name: "name",
ResourceGroup: "rg",
SubscriptionID: "sub-id",
Gallery: "gallery",
Version: "version",
},
DNSPrefix: "foo",
},
},
isUpdate: true,
expectedError: nil,
},
"should not error when masterProfile includes a Distro configuration only": {
properties: &Properties{
OrchestratorProfile: &OrchestratorProfile{
OrchestratorType: Kubernetes,
},
MasterProfile: &MasterProfile{
Distro: AKSUbuntu1604,
DNSPrefix: "foo",
},
},
isUpdate: false,
expectedError: nil,
},
"should not error when masterProfile includes a Distro configuration only in an upgrade context": {
properties: &Properties{
OrchestratorProfile: &OrchestratorProfile{
OrchestratorType: Kubernetes,
},
MasterProfile: &MasterProfile{
Distro: AKSUbuntu1604,
DNSPrefix: "foo",
},
},
isUpdate: true,
expectedError: nil,
},
"should not error when masterProfile includes neither an explicit Distro nor ImageRef configuration": {
properties: &Properties{
OrchestratorProfile: &OrchestratorProfile{
OrchestratorType: Kubernetes,
},
MasterProfile: &MasterProfile{
DNSPrefix: "foo",
},
},
isUpdate: false,
expectedError: nil,
},
"should not error when masterProfile includes neither an explicit Distro nor ImageRef configuration in an upgrade context": {
properties: &Properties{
OrchestratorProfile: &OrchestratorProfile{
OrchestratorType: Kubernetes,
},
MasterProfile: &MasterProfile{
DNSPrefix: "foo",
},
},
isUpdate: true,
expectedError: nil,
},
}

for testName, test := range tests {
test := test
t.Run(testName, func(t *testing.T) {
t.Parallel()
err := test.properties.validateMasterProfile(test.isUpdate)
if !helpers.EqualError(err, test.expectedError) {
t.Errorf("expected error: %v, got: %v", test.expectedError, err)
}
})
}
}

func TestValidateAgentPoolProfilesImageRef(t *testing.T) {
tests := map[string]struct {
properties *Properties
isUpdate bool
expectedError error
}{
"should error when AgentPoolProfile includes both an ImageRef and a Distro configuration": {
properties: &Properties{
OrchestratorProfile: &OrchestratorProfile{
OrchestratorType: Kubernetes,
},
AgentPoolProfiles: []*AgentPoolProfile{
&AgentPoolProfile{
Name: "foo",
Distro: AKSUbuntu1604,
ImageRef: &ImageReference{
Name: "name",
ResourceGroup: "rg",
SubscriptionID: "sub-id",
Gallery: "gallery",
Version: "version",
},
},
},
},
isUpdate: false,
expectedError: errors.Errorf("agentPoolProfile %s includes a custom image configuration (imageRef) and an explicit distro configuration, you may use one of these but not both simultaneously.", "foo"),
},
"should error when AgentPoolProfile includes both an ImageRef and a Distro configuration in update context": {
properties: &Properties{
OrchestratorProfile: &OrchestratorProfile{
OrchestratorType: Kubernetes,
},
AgentPoolProfiles: []*AgentPoolProfile{
&AgentPoolProfile{
Name: "foo",
Distro: AKSUbuntu1604,
ImageRef: &ImageReference{
Name: "name",
ResourceGroup: "rg",
SubscriptionID: "sub-id",
Gallery: "gallery",
Version: "version",
},
},
},
},
isUpdate: true,
expectedError: errors.Errorf("agentPoolProfile %s includes a custom image configuration (imageRef) and an explicit distro configuration, you may use one of these but not both simultaneously.", "foo"),
},
"should not error when AgentPoolProfile includes an ImageRef configuration only": {
properties: &Properties{
OrchestratorProfile: &OrchestratorProfile{
OrchestratorType: Kubernetes,
},
AgentPoolProfiles: []*AgentPoolProfile{
&AgentPoolProfile{
Name: "foo",
ImageRef: &ImageReference{
Name: "name",
ResourceGroup: "rg",
SubscriptionID: "sub-id",
Gallery: "gallery",
Version: "version",
},
},
},
},
isUpdate: false,
expectedError: nil,
},
"should not error when AgentPoolProfile includes an ImageRef configuration only in an upgrade context": {
properties: &Properties{
OrchestratorProfile: &OrchestratorProfile{
OrchestratorType: Kubernetes,
},
AgentPoolProfiles: []*AgentPoolProfile{
&AgentPoolProfile{
Name: "foo",
ImageRef: &ImageReference{
Name: "name",
ResourceGroup: "rg",
SubscriptionID: "sub-id",
Gallery: "gallery",
Version: "version",
},
},
},
},
isUpdate: true,
expectedError: nil,
},
"should not error when AgentPoolProfile includes a Distro configuration only": {
properties: &Properties{
OrchestratorProfile: &OrchestratorProfile{
OrchestratorType: Kubernetes,
},
AgentPoolProfiles: []*AgentPoolProfile{
&AgentPoolProfile{
Name: "foo",
Distro: AKSUbuntu1604,
},
},
},
isUpdate: false,
expectedError: nil,
},
"should not error when AgentPoolProfile includes a Distro configuration only in an upgrade context": {
properties: &Properties{
OrchestratorProfile: &OrchestratorProfile{
OrchestratorType: Kubernetes,
},
AgentPoolProfiles: []*AgentPoolProfile{
&AgentPoolProfile{
Name: "foo",
Distro: AKSUbuntu1604,
},
},
},
isUpdate: true,
expectedError: nil,
},
"should not error when AgentPoolProfile includes neither an explicit Distro nor ImageRef configuration": {
properties: &Properties{
OrchestratorProfile: &OrchestratorProfile{
OrchestratorType: Kubernetes,
},
AgentPoolProfiles: []*AgentPoolProfile{
&AgentPoolProfile{
Name: "foo",
},
},
},
isUpdate: false,
expectedError: nil,
},
"should not error when AgentPoolProfile includes neither an explicit Distro nor ImageRef configuration in an upgrade context": {
properties: &Properties{
OrchestratorProfile: &OrchestratorProfile{
OrchestratorType: Kubernetes,
},
AgentPoolProfiles: []*AgentPoolProfile{
&AgentPoolProfile{
Name: "foo",
},
},
},
isUpdate: true,
expectedError: nil,
},
}

for testName, test := range tests {
test := test
t.Run(testName, func(t *testing.T) {
t.Parallel()
err := test.properties.validateAgentPoolProfiles(test.isUpdate)
if !helpers.EqualError(err, test.expectedError) {
t.Errorf("expected error: %v, got: %v", test.expectedError, err)
}
})
}
}

0 comments on commit ff10ec1

Please sign in to comment.