feat: Add v2.KeptnInterface that adds context.Context support to …

…`api.KeptnInterface` (#449) * Add `context.Context` to request methods Signed-off-by: Arthur Pitman <[email protected]> * Add get method Signed-off-by: Arthur Pitman <[email protected]> * Use get methods Signed-off-by: Arthur Pitman <[email protected]> * Add context to `APIV1Interface` Signed-off-by: Arthur Pitman <[email protected]> * Add context to `AuthV1Interface` Signed-off-by: Arthur Pitman <[email protected]> * Add context to `EventsV1Interface` Signed-off-by: Arthur Pitman <[email protected]> * Add context to `LogsV1Interface` Signed-off-by: Arthur Pitman <[email protected]> * Add context to `ProjectsV1Interface` Signed-off-by: Arthur Pitman <[email protected]> * Add initial context support to `ResourcesV1Interface` Signed-off-by: Arthur Pitman <[email protected]> * Add context to `ResourcesV1Interface` Signed-off-by: Arthur Pitman <[email protected]> * Add context to `SecretsV1Interface` Signed-off-by: Arthur Pitman <[email protected]> * Add context to `SequencesV1Interface` Signed-off-by: Arthur Pitman <[email protected]> * Add context to `ServicesV1Interface` Signed-off-by: Arthur Pitman <[email protected]> * Add context to `ShipyardControlV1Interface` Signed-off-by: Arthur Pitman <[email protected]> * Add context to `StagesV1Interface` Signed-off-by: Arthur Pitman <[email protected]> * Add context to `UniformV1Interface` Signed-off-by: Arthur Pitman <[email protected]> * Add context to `Keptn` and `KeptnBase` Signed-off-by: Arthur Pitman <[email protected]> * Fix comments Signed-off-by: Arthur Pitman <[email protected]> * Introduce APIV2Interface Signed-off-by: Arthur Pitman <[email protected]> * Second option: APIV2Interface with `...WithContext` methods Signed-off-by: Arthur Pitman <[email protected]> * Create `v2` as duplicate of `api` package Signed-off-by: Arthur Pitman <[email protected]> * Fix `v2.AuthInterface` Signed-off-by: Arthur Pitman <[email protected]> * Fix `v2.EventsInterface` Signed-off-by: Arthur Pitman <[email protected]> * Fix `v2.LogsInterface` Signed-off-by: Arthur Pitman <[email protected]> * Fix `v2.ProjectsInterface` Signed-off-by: Arthur Pitman <[email protected]> * Fix `v2.ResourcesInterface` Signed-off-by: Arthur Pitman <[email protected]> * Fix `v2.SecretsInterface` Signed-off-by: Arthur Pitman <[email protected]> * Fix `v2.SequencesInterface` Signed-off-by: Arthur Pitman <[email protected]> * Fix `v2.ServicesInterface` Signed-off-by: Arthur Pitman <[email protected]> * Fix `v2.ShipyardControlInterface` Signed-off-by: Arthur Pitman <[email protected]> * Fix `v2.StagesInterface` Signed-off-by: Arthur Pitman <[email protected]> * Fix `v2.UniformInterface` Signed-off-by: Arthur Pitman <[email protected]> * Fix `v2.Client` Signed-off-by: Arthur Pitman <[email protected]> * APIHandler: v1 embeds v2 Signed-off-by: Arthur Pitman <[email protected]> * AuthHandler: v1 embeds v2 Signed-off-by: Arthur Pitman <[email protected]> * EventHandler: v1 embeds v2 Signed-off-by: Arthur Pitman <[email protected]> * LogHandler: v1 embeds v2 Signed-off-by: Arthur Pitman <[email protected]> * ProjectHandler: v1 embeds v2 Signed-off-by: Arthur Pitman <[email protected]> * SecretHandler: v1 embeds v2 Signed-off-by: Arthur Pitman <[email protected]> * SequenceControlHandler: v1 embeds v2 Signed-off-by: Arthur Pitman <[email protected]> * ServiceHandler: v1 embeds v2 Signed-off-by: Arthur Pitman <[email protected]> * ShipyardControllerHandler: v1 embeds v2 Signed-off-by: Arthur Pitman <[email protected]> * StageHandler: v1 embeds v2 Signed-off-by: Arthur Pitman <[email protected]> * UniformHandler: v1 embeds v2 Signed-off-by: Arthur Pitman <[email protected]> * Revert "Add context to `Keptn` and `KeptnBase`" Signed-off-by: Arthur Pitman <[email protected]> * Remove redundant test Signed-off-by: Arthur Pitman <[email protected]> * Revert `ResourcesV1Interface` Signed-off-by: Arthur Pitman <[email protected]> * Rename and export implementation methods Signed-off-by: Arthur Pitman <[email protected]> * Fix options for `v2.ResourceHandler` methods Signed-off-by: Arthur Pitman <[email protected]> * ResourceHandler: v1 embeds v2 Signed-off-by: Arthur Pitman <[email protected]> * Remove redundant test Signed-off-by: Arthur Pitman <[email protected]> * Add construction functions Signed-off-by: Arthur Pitman <[email protected]> * Harmonize construction functions Signed-off-by: Arthur Pitman <[email protected]> * Remove deprecated functions from v2 Signed-off-by: Arthur Pitman <[email protected]> * Add v2 construction functions Signed-off-by: Arthur Pitman <[email protected]> * Polish v2 handlers Signed-off-by: Arthur Pitman <[email protected]> * Add missing functions for APIHandler Signed-off-by: Arthur Pitman <[email protected]> * added missing api handler in GetMetadata() Signed-off-by: Florian Bacher <[email protected]> * added alias for v2.ResourceNotFoundError to stay backwards compatible Signed-off-by: Florian Bacher <[email protected]> * fix: Make sure all api handlers are set when using v2 api handlers in v1 (#479) * debug output Signed-off-by: Florian Bacher <[email protected]> * debug output Signed-off-by: Florian Bacher <[email protected]> * ensure that uniform handler is set Signed-off-by: Florian Bacher <[email protected]> * ensure that uniform handler is set Signed-off-by: Florian Bacher <[email protected]> * ensure that all api handlers are set Signed-off-by: Florian Bacher <[email protected]> Co-authored-by: Florian Bacher <[email protected]>
keptn · Jun 23, 2022 · 0874051 · 0874051
1 parent 647fbac
commit 0874051
Show file tree

Hide file tree

Showing 43 changed files with 4,738 additions and 1,405 deletions.
diff --git a/pkg/api/utils/apiServiceUtils.go b/pkg/api/utils/apiServiceUtils.go
@@ -2,6 +2,7 @@ package api
 
 import (
 	"bytes"
+	"context"
 	"crypto/tls"
 	"fmt"
 	"io/ioutil"
@@ -61,11 +62,66 @@ func getClientTransport(rt http.RoundTripper) http.RoundTripper {
 		return tr
 	}
 	return rt
+}
+
+func getAndExpectOK(ctx context.Context, uri string, api APIService) ([]byte, *models.Error) {
+	body, statusCode, status, err := get(ctx, uri, api)
+	if err != nil {
+		return nil, err
+	}
 
+	if statusCode == 200 {
+		return body, nil
+	}
+
+	if len(body) > 0 {
+		return nil, handleErrStatusCode(statusCode, body)
+	}
+
+	return nil, buildErrorResponse(fmt.Sprintf("Received unexpected response: %d %s", statusCode, status))
 }
 
-func putWithEventContext(uri string, data []byte, api APIService) (*models.EventContext, *models.Error) {
-	req, err := http.NewRequest("PUT", uri, bytes.NewBuffer(data))
+func getAndExpectSuccess(ctx context.Context, uri string, api APIService) ([]byte, *models.Error) {
+	body, statusCode, status, err := get(ctx, uri, api)
+	if err != nil {
+		return nil, err
+	}
+
+	if statusCode >= 200 && statusCode < 300 {
+		return body, nil
+	}
+
+	if len(body) > 0 {
+		return nil, handleErrStatusCode(statusCode, body)
+	}
+
+	return nil, buildErrorResponse(fmt.Sprintf("Received unexpected response: %d %s", statusCode, status))
+}
+
+func get(ctx context.Context, uri string, api APIService) ([]byte, int, string, *models.Error) {
+	req, err := http.NewRequestWithContext(ctx, "GET", uri, nil)
+	if err != nil {
+		return nil, 0, "", buildErrorResponse(err.Error())
+	}
+	req.Header.Set("Content-Type", "application/json")
+	addAuthHeader(req, api)
+
+	resp, err := api.getHTTPClient().Do(req)
+	if err != nil {
+		return nil, 0, "", buildErrorResponse(err.Error())
+	}
+	defer resp.Body.Close()
+
+	body, err := ioutil.ReadAll(resp.Body)
+	if err != nil {
+		return nil, 0, "", buildErrorResponse(err.Error())
+	}
+
+	return body, resp.StatusCode, resp.Status, nil
+}
+
+func putWithEventContext(ctx context.Context, uri string, data []byte, api APIService) (*models.EventContext, *models.Error) {
+	req, err := http.NewRequestWithContext(ctx, "PUT", uri, bytes.NewBuffer(data))
 	if err != nil {
 		return nil, buildErrorResponse(err.Error())
 	}
@@ -84,20 +140,21 @@ func putWithEventContext(uri string, data []byte, api APIService) (*models.Event
 	}
 
 	if resp.StatusCode >= 200 && resp.StatusCode <= 204 {
-		if len(body) > 0 {
-			eventContext := &models.EventContext{}
-			if err = eventContext.FromJSON(body); err != nil {
-				// failed to parse json
-				return nil, buildErrorResponse(err.Error() + "\n" + "-----DETAILS-----" + string(body))
-			}
-
-			if eventContext.KeptnContext != nil {
-				fmt.Println("ID of Keptn context: " + *eventContext.KeptnContext)
-			}
-			return eventContext, nil
+		if len(body) == 0 {
+			return nil, nil
+		}
+
+		eventContext := &models.EventContext{}
+
+		if err = eventContext.FromJSON(body); err != nil {
+			// failed to parse json
+			return nil, buildErrorResponse(err.Error() + "\n" + "-----DETAILS-----" + string(body))
 		}
 
-		return nil, nil
+		if eventContext.KeptnContext != nil {
+			fmt.Println("ID of Keptn context: " + *eventContext.KeptnContext)
+		}
+		return eventContext, nil
 	}
 
 	if len(body) > 0 {
@@ -107,8 +164,8 @@ func putWithEventContext(uri string, data []byte, api APIService) (*models.Event
 	return nil, buildErrorResponse(fmt.Sprintf("Received unexpected response: %d %s", resp.StatusCode, resp.Status))
 }
 
-func put(uri string, data []byte, api APIService) (string, *models.Error) {
-	req, err := http.NewRequest("PUT", uri, bytes.NewBuffer(data))
+func put(ctx context.Context, uri string, data []byte, api APIService) (string, *models.Error) {
+	req, err := http.NewRequestWithContext(ctx, "PUT", uri, bytes.NewBuffer(data))
 	if err != nil {
 		return "", buildErrorResponse(err.Error())
 	}
@@ -127,11 +184,7 @@ func put(uri string, data []byte, api APIService) (string, *models.Error) {
 	}
 
 	if resp.StatusCode >= 200 && resp.StatusCode <= 204 {
-		if len(body) > 0 {
-			return string(body), nil
-		}
-
-		return "", nil
+		return string(body), nil
 	}
 
 	if len(body) > 0 {
@@ -141,8 +194,8 @@ func put(uri string, data []byte, api APIService) (string, *models.Error) {
 	return "", buildErrorResponse(fmt.Sprintf("Received unexpected response: %d %s", resp.StatusCode, resp.Status))
 }
 
-func postWithEventContext(uri string, data []byte, api APIService) (*models.EventContext, *models.Error) {
-	req, err := http.NewRequest("POST", uri, bytes.NewBuffer(data))
+func postWithEventContext(ctx context.Context, uri string, data []byte, api APIService) (*models.EventContext, *models.Error) {
+	req, err := http.NewRequestWithContext(ctx, "POST", uri, bytes.NewBuffer(data))
 	if err != nil {
 		return nil, buildErrorResponse(err.Error())
 	}
@@ -161,20 +214,20 @@ func postWithEventContext(uri string, data []byte, api APIService) (*models.Even
 	}
 
 	if resp.StatusCode >= 200 && resp.StatusCode <= 204 {
-		if len(body) > 0 {
-			eventContext := &models.EventContext{}
-			if err = eventContext.FromJSON(body); err != nil {
-				// failed to parse json
-				return nil, buildErrorResponse(err.Error() + "\n" + "-----DETAILS-----" + string(body))
-			}
-
-			if eventContext.KeptnContext != nil {
-				fmt.Println("ID of Keptn context: " + *eventContext.KeptnContext)
-			}
-			return eventContext, nil
+		if len(body) == 0 {
+			return nil, nil
+		}
+
+		eventContext := &models.EventContext{}
+		if err = eventContext.FromJSON(body); err != nil {
+			// failed to parse json
+			return nil, buildErrorResponse(err.Error() + "\n" + "-----DETAILS-----" + string(body))
 		}
 
-		return nil, nil
+		if eventContext.KeptnContext != nil {
+			fmt.Println("ID of Keptn context: " + *eventContext.KeptnContext)
+		}
+		return eventContext, nil
 	}
 
 	if len(body) > 0 {
@@ -184,8 +237,8 @@ func postWithEventContext(uri string, data []byte, api APIService) (*models.Even
 	return nil, buildErrorResponse(fmt.Sprintf("Received unexpected response: %d %s", resp.StatusCode, resp.Status))
 }
 
-func post(uri string, data []byte, api APIService) (string, *models.Error) {
-	req, err := http.NewRequest("POST", uri, bytes.NewBuffer(data))
+func post(ctx context.Context, uri string, data []byte, api APIService) (string, *models.Error) {
+	req, err := http.NewRequestWithContext(ctx, "POST", uri, bytes.NewBuffer(data))
 	if err != nil {
 		return "", buildErrorResponse(err.Error())
 	}
@@ -204,11 +257,7 @@ func post(uri string, data []byte, api APIService) (string, *models.Error) {
 	}
 
 	if resp.StatusCode >= 200 && resp.StatusCode <= 204 {
-		if len(body) > 0 {
-			return string(body), nil
-		}
-
-		return "", nil
+		return string(body), nil
 	}
 
 	if len(body) > 0 {
@@ -218,8 +267,8 @@ func post(uri string, data []byte, api APIService) (string, *models.Error) {
 	return "", buildErrorResponse(fmt.Sprintf("Received unexpected response: %d %s", resp.StatusCode, resp.Status))
 }
 
-func deleteWithEventContext(uri string, api APIService) (*models.EventContext, *models.Error) {
-	req, err := http.NewRequest("DELETE", uri, nil)
+func deleteWithEventContext(ctx context.Context, uri string, api APIService) (*models.EventContext, *models.Error) {
+	req, err := http.NewRequestWithContext(ctx, "DELETE", uri, nil)
 	if err != nil {
 		return nil, buildErrorResponse(err.Error())
 	}
@@ -238,23 +287,23 @@ func deleteWithEventContext(uri string, api APIService) (*models.EventContext, *
 	}
 
 	if resp.StatusCode >= 200 && resp.StatusCode < 300 {
-		if len(body) > 0 {
-			eventContext := &models.EventContext{}
-			if err = eventContext.FromJSON(body); err != nil {
-				// failed to parse json
-				return nil, buildErrorResponse(err.Error() + "\n" + "-----DETAILS-----" + string(body))
-			}
-			return eventContext, nil
+		if len(body) == 0 {
+			return nil, nil
 		}
 
-		return nil, nil
+		eventContext := &models.EventContext{}
+		if err = eventContext.FromJSON(body); err != nil {
+			// failed to parse json
+			return nil, buildErrorResponse(err.Error() + "\n" + "-----DETAILS-----" + string(body))
+		}
+		return eventContext, nil
 	}
 
 	return nil, handleErrStatusCode(resp.StatusCode, body)
 }
 
-func delete(uri string, api APIService) (string, *models.Error) {
-	req, err := http.NewRequest("DELETE", uri, nil)
+func delete(ctx context.Context, uri string, api APIService) (string, *models.Error) {
+	req, err := http.NewRequestWithContext(ctx, "DELETE", uri, nil)
 	if err != nil {
 		return "", buildErrorResponse(err.Error())
 	}
@@ -273,11 +322,7 @@ func delete(uri string, api APIService) (string, *models.Error) {
 	}
 
 	if resp.StatusCode >= 200 && resp.StatusCode < 300 {
-		if len(body) > 0 {
-			return string(body), nil
-		}
-
-		return "", nil
+		return string(body), nil
 	}
 
 	return "", handleErrStatusCode(resp.StatusCode, body)