Skip to content

Commit

Permalink
[release-1.3] Add OneAgent version validator (#3967)
Browse files Browse the repository at this point in the history
Co-authored-by: Christoph Muellner <[email protected]>
albertogdd and chrismuellner authored Oct 23, 2024

Verified

This commit was signed with the committer’s verified signature.
andyquinterom Andrés Felipe Quintero Moreano
1 parent 255dc3f commit 04ea135
Showing 6 changed files with 129 additions and 36 deletions.
21 changes: 15 additions & 6 deletions pkg/api/v1beta1/dynakube/validation/oneagent.go
Original file line number Diff line number Diff line change
@@ -3,11 +3,11 @@ package validation
import (
"context"
"fmt"
"strings"
"regexp"

"github.com/Dynatrace/dynatrace-operator/pkg/api/v1beta1/dynakube" //nolint:staticcheck
"github.com/Dynatrace/dynatrace-operator/pkg/util/dtversion"
"github.com/Dynatrace/dynatrace-operator/pkg/util/kubeobjects/env"
"golang.org/x/mod/semver"
"k8s.io/apimachinery/pkg/labels"
"sigs.k8s.io/controller-runtime/pkg/client"
)
@@ -25,6 +25,10 @@ The conflicting Dynakube: %s
warningOneAgentInstallerEnvVars = `Environment variables ONEAGENT_INSTALLER_SCRIPT_URL and ONEAGENT_INSTALLER_TOKEN are only relevant for an unsupported image type. Please make sure you are using a supported image.`

warningHostGroupConflict = `DynaKube's specification sets the host group using --set-host-group parameter. Instead, specify the new spec.oneagent.hostGroup field. If you use both settings, the new field precedes the parameter.`

versionRegex = `^\d+.\d+.\d+.\d{8}-\d{6}$`

versionInvalidMessage = "The OneAgent's version is only valid in the format 'major.minor.patch.timestamp', e.g. 1.0.0.20240101-000000"
)

func conflictingOneAgentConfiguration(_ context.Context, _ *Validator, dk *dynakube.DynaKube) string {
@@ -143,15 +147,20 @@ func conflictingHostGroupSettings(_ context.Context, _ *Validator, dk *dynakube.
return ""
}

func validateOneAgentVersionIsSemVerCompliant(_ context.Context, _ *Validator, dk *dynakube.DynaKube) string {
func isOneAgentVersionValid(_ context.Context, _ *Validator, dk *dynakube.DynaKube) string {
agentVersion := dk.CustomOneAgentVersion()
if agentVersion == "" {
return ""
}

version := "v" + agentVersion
if !(semver.IsValid(version) && semver.Prerelease(version) == "" && semver.Build(version) == "" && len(strings.Split(version, ".")) == 3) {
return "Only semantic versions in the form of major.minor.patch (e.g. 1.0.0) are allowed!"
_, err := dtversion.ToSemver(agentVersion)
if err != nil {
return versionInvalidMessage
}

match, err := regexp.MatchString(versionRegex, agentVersion)
if err != nil || !match {
return versionInvalidMessage
}

return ""
68 changes: 39 additions & 29 deletions pkg/api/v1beta1/dynakube/validation/oneagent_test.go
Original file line number Diff line number Diff line change
@@ -425,40 +425,50 @@ func createDynakubeWithHostGroup(args []string, hostGroup string) *dynakube.Dyna
}
}

func TestValidateOneAgentVersionIsSemVer(t *testing.T) {
testCasesAcceptedVersions := []string{"", "1.0.0", "1.200.1"}
func TestIsOneAgentVersionValid(t *testing.T) {
dk := dynakube.DynaKube{
ObjectMeta: defaultDynakubeObjectMeta,
Spec: dynakube.DynaKubeSpec{
APIURL: testApiUrl,
OneAgent: dynakube.OneAgentSpec{
ClassicFullStack: &dynakube.HostInjectSpec{},
},
},
}

testCasesNotAcceptedVersions := []string{"latest", "raw", "1.200.1-raw", "v1.200.1-raw", "1.200.1+build", "v1.200.1+build", "1.200.1-raw+build", "v1.200.1-raw+build", "1.200", "v1.200", "1", "v1", "1.0", "v1.0", "v1.200.0"}
validVersions := []string{"", "1.0.0.20240101-000000"}
invalidVersions := []string{
"latest",
"raw",
"1.200.1-raw",
"v1.200.1-raw",
"1.200.1+build",
"v1.200.1+build",
"1.200.1-raw+build",
"v1.200.1-raw+build",
"1.200",
"1.200.0",
"1.200.0.0",
"1.200.0.0-0",
"v1.200",
"1",
"v1",
"1.0",
"v1.0",
"v1.200.0",
}

for _, tc := range testCasesAcceptedVersions {
t.Run("should accept version "+tc, func(t *testing.T) {
assertAllowed(t, &dynakube.DynaKube{
ObjectMeta: defaultDynakubeObjectMeta,
Spec: dynakube.DynaKubeSpec{
APIURL: testApiUrl,
OneAgent: dynakube.OneAgentSpec{
ClassicFullStack: &dynakube.HostInjectSpec{
Version: tc,
},
},
},
})
for _, validVersion := range validVersions {
dk.Spec.OneAgent.ClassicFullStack.Version = validVersion
t.Run(fmt.Sprintf("OneAgent custom version %s is allowed", validVersion), func(t *testing.T) {
assertAllowed(t, &dk)
})
}

for _, tc := range testCasesNotAcceptedVersions {
t.Run("should accept version "+tc, func(t *testing.T) {
assertDenied(t, []string{"Only semantic versions in the form of major.minor.patch (e.g. 1.0.0) are allowed!"}, &dynakube.DynaKube{
ObjectMeta: defaultDynakubeObjectMeta,
Spec: dynakube.DynaKubeSpec{
APIURL: testApiUrl,
OneAgent: dynakube.OneAgentSpec{
ClassicFullStack: &dynakube.HostInjectSpec{
Version: tc,
},
},
},
})
for _, invalidVersion := range invalidVersions {
dk.Spec.OneAgent.ClassicFullStack.Version = invalidVersion
t.Run(fmt.Sprintf("OneAgent custom version %s is not allowed", invalidVersion), func(t *testing.T) {
assertDenied(t, []string{versionInvalidMessage}, &dk)
})
}
}
2 changes: 1 addition & 1 deletion pkg/api/v1beta1/dynakube/validation/validation.go
Original file line number Diff line number Diff line change
@@ -22,6 +22,7 @@ var (
NoApiUrl,
IsInvalidApiUrl,
IsThirdGenAPIUrl,
isOneAgentVersionValid,
missingCSIDaemonSet,
disabledCSIForReadonlyCSIVolume,
invalidActiveGateCapabilities,
@@ -37,7 +38,6 @@ var (
nameTooLong,
namespaceSelectorViolateLabelSpec,
imageFieldHasTenantImage,
validateOneAgentVersionIsSemVerCompliant,
}
validatorWarningFuncs = []validatorFunc{
missingActiveGateMemoryLimit,
25 changes: 25 additions & 0 deletions pkg/api/v1beta2/dynakube/validation/oneagent.go
Original file line number Diff line number Diff line change
@@ -3,8 +3,10 @@ package validation
import (
"context"
"fmt"
"regexp"

"github.com/Dynatrace/dynatrace-operator/pkg/api/v1beta2/dynakube"
"github.com/Dynatrace/dynatrace-operator/pkg/util/dtversion"
"github.com/Dynatrace/dynatrace-operator/pkg/util/kubeobjects/env"
"k8s.io/apimachinery/pkg/labels"
"sigs.k8s.io/controller-runtime/pkg/client"
@@ -23,6 +25,10 @@ The conflicting Dynakube: %s
warningOneAgentInstallerEnvVars = `Environment variables ONEAGENT_INSTALLER_SCRIPT_URL and ONEAGENT_INSTALLER_TOKEN are only relevant for an unsupported image type. Please make sure you are using a supported image.`

warningHostGroupConflict = `DynaKube's specification sets the host group using --set-host-group parameter. Instead, specify the new spec.oneagent.hostGroup field. If you use both settings, the new field precedes the parameter.`

versionRegex = `^\d+.\d+.\d+.\d{8}-\d{6}$`

versionInvalidMessage = "The OneAgent's version is only valid in the format 'major.minor.patch.timestamp', e.g. 1.0.0.20240101-000000"
)

func conflictingOneAgentConfiguration(_ context.Context, _ *Validator, dk *dynakube.DynaKube) string {
@@ -140,3 +146,22 @@ func conflictingHostGroupSettings(_ context.Context, _ *Validator, dk *dynakube.

return ""
}

func isOneAgentVersionValid(_ context.Context, _ *Validator, dk *dynakube.DynaKube) string {
agentVersion := dk.CustomOneAgentVersion()
if agentVersion == "" {
return ""
}

_, err := dtversion.ToSemver(agentVersion)
if err != nil {
return versionInvalidMessage
}

match, err := regexp.MatchString(versionRegex, agentVersion)
if err != nil || !match {
return versionInvalidMessage
}

return ""
}
48 changes: 48 additions & 0 deletions pkg/api/v1beta2/dynakube/validation/oneagent_test.go
Original file line number Diff line number Diff line change
@@ -424,3 +424,51 @@ func createDynakubeWithHostGroup(args []string, hostGroup string) *dynakube.Dyna
},
}
}

func TestIsOneAgentVersionValid(t *testing.T) {
dk := dynakube.DynaKube{
ObjectMeta: defaultDynakubeObjectMeta,
Spec: dynakube.DynaKubeSpec{
APIURL: testApiUrl,
OneAgent: dynakube.OneAgentSpec{
ClassicFullStack: &dynakube.HostInjectSpec{},
},
},
}

validVersions := []string{"", "1.0.0.20240101-000000"}
invalidVersions := []string{
"latest",
"raw",
"1.200.1-raw",
"v1.200.1-raw",
"1.200.1+build",
"v1.200.1+build",
"1.200.1-raw+build",
"v1.200.1-raw+build",
"1.200",
"1.200.0",
"1.200.0.0",
"1.200.0.0-0",
"v1.200",
"1",
"v1",
"1.0",
"v1.0",
"v1.200.0",
}

for _, validVersion := range validVersions {
dk.Spec.OneAgent.ClassicFullStack.Version = validVersion
t.Run(fmt.Sprintf("OneAgent custom version %s is allowed", validVersion), func(t *testing.T) {
assertAllowed(t, &dk)
})
}

for _, invalidVersion := range invalidVersions {
dk.Spec.OneAgent.ClassicFullStack.Version = invalidVersion
t.Run(fmt.Sprintf("OneAgent custom version %s is not allowed", invalidVersion), func(t *testing.T) {
assertDenied(t, []string{versionInvalidMessage}, &dk)
})
}
}
1 change: 1 addition & 0 deletions pkg/api/v1beta2/dynakube/validation/validation.go
Original file line number Diff line number Diff line change
@@ -19,6 +19,7 @@ type Validator struct {

var (
validatorErrorFuncs = []validatorFunc{
isOneAgentVersionValid,
NoApiUrl,
IsInvalidApiUrl,
IsThirdGenAPIUrl,

0 comments on commit 04ea135

Please sign in to comment.