Skip to content

CONSOLE-5475: Replace old Segment CDN variable #1229

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

Open
MikelAlejoBR wants to merge 1 commit into
base: main
Choose a base branch
from
+74 −17
Open

CONSOLE-5475: Replace old Segment CDN variable #1229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion manifests/05-telemetry-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ metadata:
capability.openshift.io/name: Console
data:
SEGMENT_API_HOST: console.redhat.com/connections/api/v1
SEGMENT_JS_HOST: console.redhat.com/connections/cdn
SEGMENT_CDN_URL: https://console.redhat.com/connections/cdn
SEGMENT_PUBLIC_API_KEY: BnuS1RP39EmLQjP21ko67oDjhbl9zpNU
4 changes: 2 additions & 2 deletions pkg/console/operator/sync_v400_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ func newTestConsoleOperator(t *testing.T, telemeterAvailable bool, pullSecretHas
},
Data: map[string]string{
"SEGMENT_API_HOST": "https://segment.example.com",
"SEGMENT_JS_HOST": "https://segment-js.example.com",
"SEGMENT_CDN_URL": "https://segment.example.com/cdn",
"SEGMENT_PUBLIC_API_KEY": "test-key",
},
}
Expand Down Expand Up @@ -547,7 +547,7 @@ func TestGetTelemetryConfiguration_KeySetStableAcrossAvailabilityChange(t *testi
keysAvailable := sortedKeys(configAvailable)

// All keys must be present in both states — no key-set difference allowed.
sharedKeys := []string{"CLUSTER_ID", "ORGANIZATION_ID", "ACCOUNT_MAIL", "TELEMETER_CLIENT_DISABLED", "SEGMENT_API_HOST", "SEGMENT_JS_HOST", "SEGMENT_PUBLIC_API_KEY"}
sharedKeys := []string{"CLUSTER_ID", "ORGANIZATION_ID", "ACCOUNT_MAIL", "TELEMETER_CLIENT_DISABLED", "SEGMENT_API_HOST", "SEGMENT_CDN_URL", "SEGMENT_PUBLIC_API_KEY"}
for _, key := range sharedKeys {
if _, ok := configUnavailable[key]; !ok {
t.Errorf("key %q missing from unavailable config, keys present: %v", key, keysUnavailable)
Expand Down
85 changes: 71 additions & 14 deletions test/e2e/telemetry_config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,24 @@ import (
"time"

operatorsv1 "github.com/openshift/api/operator/v1"
"github.com/openshift/console-operator/pkg/api"
"github.com/openshift/console-operator/pkg/console/subresource/consoleserver"
"github.com/openshift/console-operator/pkg/console/telemetry"
"github.com/openshift/console-operator/test/e2e/framework"
yaml "gopkg.in/yaml.v2"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/wait"

"github.com/openshift/console-operator/pkg/api"
"github.com/openshift/console-operator/pkg/console/telemetry"
"github.com/openshift/console-operator/test/e2e/framework"
)

const (
SEGMENT_API_HOST = "SEGMENT_API_HOST"
SEGMENT_CDN_URL = "SEGMENT_CDN_URL"

defaultSegmentAPIHost = "console.redhat.com/connections/api/v1"
defaultSegmentCDNURL = "https://console.redhat.com/connections/cdn"
patchedSegmentCDNURL = "https://test.example.com/cdn"
)

func setupTelemetryConfigTestCase(t *testing.T) (*framework.ClientSet, *operatorsv1.Console) {
Expand All @@ -30,8 +36,8 @@ func cleanupTelemetryConfigTestCase(t *testing.T, client *framework.ClientSet) {
}

func TestTelemetryConfig(t *testing.T) {
client, _ := setupDownloadsTestCase(t)
defer cleanupDownloadsTestCase(t, client)
client, _ := setupTelemetryConfigTestCase(t)
defer cleanupTelemetryConfigTestCase(t, client)
telemetryConfigMap, err := client.Core.ConfigMaps(api.OpenShiftConsoleOperatorNamespace).Get(context.TODO(), telemetry.TelemetryConfigMapName, v1.GetOptions{})
if err != nil {
t.Fatal(err)
Expand All @@ -42,15 +48,28 @@ func TestTelemetryConfig(t *testing.T) {
}

// check default value for SEGMENT_API_HOST key
value, ok := telemetryConfigMap.Data[SEGMENT_API_HOST]
apiHostValue, ok := telemetryConfigMap.Data[SEGMENT_API_HOST]
if !ok {
t.Fatalf("telemetry-config configmap does not contain SEGMENT_JS_HOST data key. Instead contains: %v", telemetryConfigMap.Data)
t.Fatalf("telemetry-config configmap does not contain SEGMENT_API_HOST data key. Instead contains: %v", telemetryConfigMap.Data)
}
if value != "console.redhat.com/connections/api/v1" {
t.Fatalf("telemetry-config configmap does not contain SEGMENT_API_HOST key with value 'console.redhat.com/connections/api/v1'. Instead contains: %q", value)
if apiHostValue != defaultSegmentAPIHost {
t.Fatalf("telemetry-config configmap does not contain SEGMENT_API_HOST key with value '%s'. Instead contains: %q", defaultSegmentAPIHost, apiHostValue)
}

// update the defaul value for SEGMENT_API_HOST key
// check default value for SEGMENT_CDN_URL key
cdnURLValue, ok := telemetryConfigMap.Data[SEGMENT_CDN_URL]
if !ok {
t.Fatalf("telemetry-config configmap does not contain SEGMENT_CDN_URL data key. Instead contains: %v", telemetryConfigMap.Data)
}
if cdnURLValue != defaultSegmentCDNURL {
t.Fatalf("telemetry-config configmap does not contain SEGMENT_CDN_URL key with value '%s'. Instead contains: %q", defaultSegmentCDNURL, cdnURLValue)
}

if _, ok := telemetryConfigMap.Data["SEGMENT_JS_HOST"]; ok {
t.Fatal("telemetry-config configmap should not contain deprecated SEGMENT_JS_HOST key")
}

// update the default value for SEGMENT_API_HOST key
_, err = client.Core.ConfigMaps(api.OpenShiftConsoleOperatorNamespace).Patch(context.TODO(), telemetry.TelemetryConfigMapName, types.MergePatchType, []byte(`{"data": {"SEGMENT_API_HOST": "test"}}`), metav1.PatchOptions{})
if err != nil {
t.Fatal(err)
Expand All @@ -59,17 +78,55 @@ func TestTelemetryConfig(t *testing.T) {
err = wait.Poll(1*time.Second, framework.AsyncOperationTimeout, func() (stop bool, err error) {
telemetryConfigMap, err := client.Core.ConfigMaps(api.OpenShiftConsoleOperatorNamespace).Get(context.TODO(), telemetry.TelemetryConfigMapName, v1.GetOptions{})
if err != nil {
t.Fatal(err)
return false, err
}
value, ok := telemetryConfigMap.Data[SEGMENT_API_HOST]
if !ok {
return false, fmt.Errorf("updated telemetry-config configmap does not contain SEGMENT_JS_HOST data key. Instead contains: %v", telemetryConfigMap.Data)
return false, fmt.Errorf("updated telemetry-config configmap does not contain SEGMENT_API_HOST data key. Instead contains: %v", telemetryConfigMap.Data)
}
if value != "test" {
return false, fmt.Errorf("update telemetry-config configmap does not contain SEGMENT_API_HOST key with value 'console.redhat.com/connections/api/v1'. Instead contains: %q", value)
return false, fmt.Errorf("updated telemetry-config configmap does not contain SEGMENT_API_HOST key with value 'test'. Instead contains: %q", value)
}

return true, nil
})
if err != nil {
t.Fatal(err)
}

// update the default value for SEGMENT_CDN_URL key
_, err = client.Core.ConfigMaps(api.OpenShiftConsoleOperatorNamespace).Patch(context.TODO(), telemetry.TelemetryConfigMapName, types.MergePatchType, []byte(fmt.Sprintf(`{"data": {"SEGMENT_CDN_URL": "%s"}}`, patchedSegmentCDNURL)), metav1.PatchOptions{})
if err != nil {
t.Fatal(err)
}

err = wait.Poll(1*time.Second, framework.AsyncOperationTimeout, func() (stop bool, err error) {
consoleConfigMap, err := framework.GetConsoleConfigMap(client)
if err != nil {
return false, err
}
configYAML, ok := consoleConfigMap.Data["console-config.yaml"]
if !ok {
return false, fmt.Errorf("console-config configmap does not contain console-config.yaml data key")
}
var consoleConfig consoleserver.Config
if err := yaml.Unmarshal([]byte(configYAML), &consoleConfig); err != nil {
return false, fmt.Errorf("failed to unmarshal console-config.yaml: %w", err)
}
if consoleConfig.Telemetry == nil {
return false, fmt.Errorf("console-config.yaml telemetry section is missing")
}
value, ok := consoleConfig.Telemetry[SEGMENT_CDN_URL]
if !ok {
return false, fmt.Errorf("console-config.yaml telemetry does not contain SEGMENT_CDN_URL key. Instead contains: %v", consoleConfig.Telemetry)
}
if value != patchedSegmentCDNURL {
return false, fmt.Errorf("console-config.yaml telemetry SEGMENT_CDN_URL expected '%s', got %q", patchedSegmentCDNURL, value)
}

return true, nil
})
Comment thread
coderabbitai[bot] marked this conversation as resolved.
if err != nil {
t.Fatal(err)
}
}