fix(metrics-operator): provide more information for dynatrace api error

metrics-operator/controllers/common/providers/dynatrace/client/client.go

@@ -57,8 +57,8 @@ func NewAPIClient(config apiConfig, options ...APIClientOption) *apiClient {
 
 // Do sends and API request to the Dynatrace API and returns its result as a string containing the raw response payload
 func (client *apiClient) Do(ctx context.Context, path, method string, payload []byte) ([]byte, int, error) {
-	if err := client.auth(ctx); err != nil {
-		return nil, http.StatusUnauthorized, err
+	if statusCode, err := client.auth(ctx); err != nil {
+		return nil, statusCode, err
 	}
 	api := fmt.Sprintf("%s%s", client.config.serverURL, path)
 	req, err := http.NewRequestWithContext(ctx, method, api, bytes.NewBuffer(payload))
@@ -89,10 +89,10 @@ func (client *apiClient) Do(ctx context.Context, path, method string, payload []
 	return b, res.StatusCode, nil
 }
 
-func (client *apiClient) auth(ctx context.Context) error {
+func (client *apiClient) auth(ctx context.Context) (int, error) {
 	// return if we already have a token
 	if client.config.oAuthCredentials.accessToken != "" {
-		return nil
+		return http.StatusOK, nil
 	}
 	client.Log.V(10).Info("OAuth login")
 	ctx, cancel := context.WithTimeout(ctx, 30*time.Second)
@@ -103,12 +103,12 @@ func (client *apiClient) auth(ctx context.Context) error {
 
 	req, err := http.NewRequestWithContext(ctx, "POST", client.config.authURL, bytes.NewBuffer(body))
 	if err != nil {
-		return err
+		return http.StatusInternalServerError, err
 	}
 	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
 	res, err := client.httpClient.Do(req)
 	if err != nil {
-		return err
+		return http.StatusInternalServerError, err
 	}
 	defer func() {
 		err := res.Body.Close()
@@ -117,20 +117,20 @@ func (client *apiClient) auth(ctx context.Context) error {
 		}
 	}()
 	if isErrorStatus(res.StatusCode) {
-		return ErrRequestFailed
+		return res.StatusCode, ErrRequestFailed
 	}
 	// we ignore the error here because we fail later while unmarshalling
 	oauthResponse := OAuthResponse{}
 	b, _ := io.ReadAll(res.Body)
 	err = json.Unmarshal(b, &oauthResponse)
 	if err != nil {
-		return err
+		return http.StatusInternalServerError, err
 	}
 
 	if oauthResponse.AccessToken == "" {
-		return ErrAuthenticationFailed
+		return http.StatusUnauthorized, ErrAuthenticationFailed
 	}
 
 	client.config.oAuthCredentials.accessToken = oauthResponse.AccessToken
-	return nil
+	return http.StatusOK, nil
 }

metrics-operator/controllers/common/providers/dynatrace/client/client_test.go

@@ -79,7 +79,7 @@ func TestAPIClientAuthError(t *testing.T) {
 
 	require.ErrorIs(t, err, ErrRequestFailed)
 	require.Empty(t, resp)
-	require.Equal(t, http.StatusUnauthorized, code)
+	require.Equal(t, http.StatusInternalServerError, code)
 }
 
 func TestAPIClientAuthNoToken(t *testing.T) {
@@ -154,3 +154,39 @@ func TestAPIClientRequestError(t *testing.T) {
 	require.Empty(t, resp)
 	require.Equal(t, http.StatusInternalServerError, code)
 }
+
+func TestAPIClientAuthResponse(t *testing.T) {
+	server := httptest.NewServer(http.HandlerFunc(func(writer http.ResponseWriter, request *http.Request) {
+		if request.URL.Path == "/auth" {
+			_, _ = writer.Write([]byte(`{"access_token": "my-token"}`))
+			return
+		}
+		writer.WriteHeader(http.StatusInternalServerError)
+	}))
+
+	defer server.Close()
+
+	config, err := NewAPIConfig(
+		server.URL,
+		mockSecret,
+		WithAuthURL(server.URL+"/auth"),
+	)
+
+	require.Nil(t, err)
+	require.NotNil(t, config)
+
+	apiClient := NewAPIClient(
+		*config,
+		WithHTTPClient(http.Client{}),
+		WithLogger(logr.New(klog.NewKlogr().GetSink())),
+	)
+
+	require.NotNil(t, apiClient)
+
+	int, err := apiClient.auth(context.TODO())
+
+	require.Equal(t, int, http.StatusOK)
+	require.Equal(t, err, nil)
+
+	require.Equal(t, "my-token", apiClient.config.oAuthCredentials.accessToken)
+}

test/chainsaw/testmetrics/dynatrace-provider/00-assert.yaml

@@ -0,0 +1,8 @@
+apiVersion: metrics.keptn.sh/v1beta1
+kind: KeptnMetric
+metadata:
+  name: podtatometric
+  labels:
+    app: podtato-head
+status:
+  errMsg: ""

test/chainsaw/testmetrics/dynatrace-provider/00-install.yaml

@@ -0,0 +1,30 @@
+apiVersion: metrics.keptn.sh/v1beta1
+kind: KeptnMetric
+metadata:
+  name: podtatometric
+spec:
+  provider:
+    name: "dynatrace"
+  query: "query"
+  fetchIntervalSeconds: 5
+
+---
+apiVersion: metrics.keptn.sh/v1beta1
+kind: KeptnMetricsProvider
+metadata:
+  name: dynatrace
+spec:
+  secretKeyRef:
+    key: DT_TOKEN
+    name: dynatrace
+  type: dynatrace
+  targetServer: (join('.', ['http://mockserver', $namespace, 'svc.cluster.local:1080']))
+
+---
+apiVersion: v1
+kind: Secret
+metadata:
+  name: dynatrace
+type: Opaque
+data:
+  DT_TOKEN: dG9rZW46IG15dG9rZW4=

test/chainsaw/testmetrics/dynatrace-provider/chainsaw-test.yaml

@@ -0,0 +1,19 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/kyverno/chainsaw/main/.schemas/json/test-chainsaw-v1alpha1.json
+apiVersion: chainsaw.kyverno.io/v1alpha1
+kind: Test
+metadata:
+  name: dynatrace-provider-auth
+spec:
+  namespaceTemplate:
+    metadata:
+      annotations:
+        keptn.sh/lifecycle-toolkit: enabled
+  steps:
+    - name: step-00
+      try:
+        - apply:
+            file: mock-server.yaml
+        - apply:
+            file: 00-install.yaml
+        - assert:
+            file: 00-assert.yaml

test/chainsaw/testmetrics/dynatrace-provider/mock-server.yaml

@@ -0,0 +1,142 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: mockserver
+spec:
+  ports:
+    - name: serviceport
+      port: 1080
+      protocol: TCP
+      targetPort: serviceport
+  selector:
+    app: mockserver
+  sessionAffinity: None
+  type: ClusterIP
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  labels:
+    app: mockserver
+  name: mockserver
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: mockserver
+  template:
+    metadata:
+      labels:
+        app: mockserver
+      name: mockserver
+    spec:
+      automountServiceAccountToken: false
+      containers:
+        - env:
+            - name: MOCKSERVER_LOG_LEVEL
+              value: INFO
+            - name: SERVER_PORT
+              value: "1080"
+          image: mockserver/mockserver:mockserver-5.13.0
+          imagePullPolicy: IfNotPresent
+          resources:
+            limits:
+              cpu: 500m
+              memory: 128Mi
+            requests:
+              cpu: 10m
+              memory: 64Mi
+          livenessProbe:
+            failureThreshold: 10
+            initialDelaySeconds: 10
+            periodSeconds: 5
+            successThreshold: 1
+            tcpSocket:
+              port: serviceport
+            timeoutSeconds: 1
+          name: mockserver
+          ports:
+            - containerPort: 1080
+              name: serviceport
+              protocol: TCP
+          readinessProbe:
+            failureThreshold: 10
+            initialDelaySeconds: 2
+            periodSeconds: 2
+            successThreshold: 1
+            tcpSocket:
+              port: serviceport
+            timeoutSeconds: 1
+          volumeMounts:
+            - mountPath: /config
+              name: config-volume
+            - mountPath: /libs
+              name: libs-volume
+      terminationGracePeriodSeconds: 30
+      volumes:
+        - configMap:
+            defaultMode: 420
+            name: mockserver-config
+            optional: true
+          name: config-volume
+        - configMap:
+            defaultMode: 420
+            name: mockserver-config
+            optional: true
+          name: libs-volume
+---
+kind: ConfigMap
+apiVersion: v1
+metadata:
+  name: mockserver-config
+data:
+  initializerJson.json: |-
+    [
+      {
+        "httpRequest": {
+          "method" : "GET",
+          "path" : "/api/v2/metrics/query",
+          "queryStringParameters" : {
+            "metricSelector" : [ "query" ]
+          }
+        },
+        "httpResponse": {
+          "body": {
+            "status": "error",
+            "data": {
+              "resultType": "matrix",
+              "result": []
+            }
+          },
+          "statusCode": 401
+        }
+      }
+    ]
+  mockserver.properties: |-
+    ###############################
+    # MockServer & Proxy Settings #
+    ###############################
+    # Socket & Port Settings
+    # socket timeout in milliseconds (default 120000)
+    mockserver.maxSocketTimeout=120000
+    # Certificate Generation
+    # dynamically generated CA key pair (if they don't already exist in
+    specified directory)
+    mockserver.dynamicallyCreateCertificateAuthorityCertificate=true
+    # save dynamically generated CA key pair in working directory
+    mockserver.directoryToSaveDynamicSSLCertificate=.
+    # certificate domain name (default "localhost")
+    mockserver.sslCertificateDomainName=localhost
+    # comma separated list of ip addresses for Subject Alternative Name domain
+    names (default empty list)
+    mockserver.sslSubjectAlternativeNameDomains=www.example.com,www.another.com
+    # comma separated list of ip addresses for Subject Alternative Name ips
+    (default empty list)
+    mockserver.sslSubjectAlternativeNameIps=127.0.0.1
+    # CORS
+    # enable CORS for MockServer REST API
+    mockserver.enableCORSForAPI=true
+    # enable CORS for all responses
+    mockserver.enableCORSForAllResponses=true
+    # Json Initialization
+    mockserver.initializationJsonPath=/config/initializerJson.json