feat: #35 Adding support for OAuth2 context transmission

Signed-off-by: Laurent Broudoux <[email protected]>

Author: lbroudoux

README.md

@@ -75,7 +75,8 @@ The `test` command provides additional flags for advanced usages and options:
 * `--caCerts=<path1,path2>` allows to specify additional certificates CRT files to add to trusted roots ones,
 * `--secretName='<Secret Name>'` is an optional flag specifying the name of a Secret to use for connecting endpoint,
 * `--filteredOperations=<JSON>` allows to filter a list of operations to launch a test for,
-* `--operationsHeaders=<JSON>` allows to override some operations headers for the tests to launch.
+* `--operationsHeaders=<JSON>` allows to override some operations headers for the tests to launch,
+* `--oAuth2Context=<JSON>` allows specification of an OAuth2 grant flow to execute before launching the test (starts with Microcks version `1.8.0`).
 
 Overriden test operations headers is a JSON strings where 1st level keys are operation name (eg. `GET /beer`) or `globals` for header applying to all the operations of the API. Headers are specified as an array of objects defining `key` and `values` properties.
 
@@ -88,7 +89,8 @@ $ ./microcks-cli test 'Beer Catalog API:0.9' http://localhost:9090/api/ OPEN_API
         --keycloakClientSecret=7deb71e8-8c80-4376-95ad-00a399ee3ca1 \
         --insecure --verbose  --waitFor=3sec \
         --filteredOperations='["GET /beer", "GET /beer/{name}"]' \
-        --operationsHeaders='{"globals": [{"name": "x-api-key", "values": "my-values"}], "GET /beer": [{"name": "x-trace-id", "values": "xcvbnsdfghjklm"}]}'
+        --operationsHeaders='{"globals": [{"name": "x-api-key", "values": "my-values"}], "GET /beer": [{"name": "x-trace-id", "values": "xcvbnsdfghjklm"}]}' \
+        --oAuth2Context='{"clientId": "microcks-test", "clientSecret": "ab54d329-e435-41ae-a900-ec6b3fe15c54", "tokenUri": "https://idp.acme.org/realms/my-app/protocol/openid-connect/token", "grantType": "CLIENT_CREDENTIALS"}'
 
 MicrocksClient got status for test "64c25f7ddec62569f9a0ed95" - success: true, inProgress: false 
 Full TestResult details are available here: http://localhost:8080/#/tests/64c25f7ddec62569f9a0ed95 

cmd/test.go

@@ -82,6 +82,7 @@ func (c *testComamnd) Execute() {
 	var secretName string
 	var filteredOperations string
 	var operationsHeaders string
+	var oAuth2Context string
 	var insecureTLS bool
 	var caCertPaths string
 	var verbose bool
@@ -93,6 +94,7 @@ func (c *testComamnd) Execute() {
 	testCmd.StringVar(&secretName, "secretName", "", "Secret to use for connecting test endpoint")
 	testCmd.StringVar(&filteredOperations, "filteredOperations", "", "List of operations to launch a test for")
 	testCmd.StringVar(&operationsHeaders, "operationsHeaders", "", "Override of operations headers as JSON string")
+	testCmd.StringVar(&oAuth2Context, "oAuth2Context", "", "Spec of an OAuth2 client context as JSON string")
 	testCmd.BoolVar(&insecureTLS, "insecure", false, "Whether to accept insecure HTTPS connection")
 	testCmd.StringVar(&caCertPaths, "caCerts", "", "Comma separated paths of CRT files to add to Root CAs")
 	testCmd.BoolVar(&verbose, "verbose", false, "Produce dumps of HTTP exchanges")
@@ -165,7 +167,7 @@ func (c *testComamnd) Execute() {
 	mc.SetOAuthToken(oauthToken)
 
 	var testResultID string
-	testResultID, err = mc.CreateTestResult(serviceRef, testEndpoint, runnerType, secretName, waitForMilliseconds, filteredOperations, operationsHeaders)
+	testResultID, err = mc.CreateTestResult(serviceRef, testEndpoint, runnerType, secretName, waitForMilliseconds, filteredOperations, operationsHeaders, oAuth2Context)
 	if err != nil {
 		fmt.Printf("Got error when invoking Microcks client creating Test: %s", err)
 		os.Exit(1)

pkg/connectors/microcks_client.go

@@ -32,11 +32,15 @@ import (
 	"github.com/microcks/microcks-cli/pkg/config"
 )
 
+var (
+	grantTypeChoices = map[string]bool{"PASSWORD": true, "CLIENT_CREDENTIALS": true, "REFRESH_TOKEN": true}
+)
+
 // MicrocksClient allows interacting with Microcks APIs
 type MicrocksClient interface {
 	GetKeycloakURL() (string, error)
 	SetOAuthToken(oauthToken string)
-	CreateTestResult(serviceID string, testEndpoint string, runnerType string, secretName string, timeout int64, filteredOperations string, operationsHeaders string) (string, error)
+	CreateTestResult(serviceID string, testEndpoint string, runnerType string, secretName string, timeout int64, filteredOperations string, operationsHeaders string, oAuth2Context string) (string, error)
 	GetTestResult(testResultID string) (*TestResultSummary, error)
 	UploadArtifact(specificationFilePath string, mainArtifact bool) (string, error)
 }
@@ -60,6 +64,18 @@ type HeaderDTO struct {
 	Values string `json:"values"`
 }
 
+// OAuth2ClientContext represents a test request OAuth2 client context
+type OAuth2ClientContext struct {
+	ClientId     string `json:"clientId"`
+	ClientSecret string `json:"clientSecret"`
+	TokenURI     string `json:"tokenUri"`
+	Username     string `json:"username"`
+	Password     string `json:"password"`
+	RefreshToken string `json:"refreshToken"`
+	GrantType    string `json:"grantType"`
+	Scopes       string `json:"scopes"`
+}
+
 type microcksClient struct {
 	APIURL     *url.URL
 	OAuthToken string
@@ -105,12 +121,18 @@ func (c *microcksClient) GetKeycloakURL() (string, error) {
 
 	req.Header.Set("Accept", "application/json")
 
+	// Dump request if verbose required.
+	config.DumpRequestIfRequired("Microcks for getting Keycloak config", req, true)
+
 	resp, err := c.httpClient.Do(req)
 	if err != nil {
 		return "", err
 	}
 	defer resp.Body.Close()
 
+	// Dump request if verbose required.
+	config.DumpResponseIfRequired("Microcks for getting Keycloak config", resp, true)
+
 	body, err := ioutil.ReadAll(resp.Body)
 	if err != nil {
 		panic(err.Error())
@@ -137,7 +159,7 @@ func (c *microcksClient) SetOAuthToken(oauthToken string) {
 	c.OAuthToken = oauthToken
 }
 
-func (c *microcksClient) CreateTestResult(serviceID string, testEndpoint string, runnerType string, secretName string, timeout int64, filteredOperations string, operationsHeaders string) (string, error) {
+func (c *microcksClient) CreateTestResult(serviceID string, testEndpoint string, runnerType string, secretName string, timeout int64, filteredOperations string, operationsHeaders string, oAuth2Context string) (string, error) {
 	// Ensure we have a correct URL.
 	rel := &url.URL{Path: "tests"}
 	u := c.APIURL.ResolveReference(rel)
@@ -157,6 +179,9 @@ func (c *microcksClient) CreateTestResult(serviceID string, testEndpoint string,
 	if len(operationsHeaders) > 0 && ensureValidOperationsHeaders(operationsHeaders) {
 		input += (", \"operationsHeaders\": " + operationsHeaders)
 	}
+	if len(oAuth2Context) > 0 && ensureValieOAuth2Context(oAuth2Context) {
+		input += (", \"oAuth2Context\": " + oAuth2Context)
+	}
 
 	input += "}"
 
@@ -311,3 +336,17 @@ func ensureValidOperationsHeaders(operationsHeaders string) bool {
 	}
 	return true
 }
+
+func ensureValieOAuth2Context(oAuth2Context string) bool {
+	var oContext = OAuth2ClientContext{}
+	err := json.Unmarshal([]byte(oAuth2Context), &oContext)
+	if err != nil {
+		fmt.Println("Error parsing JSON in oAuth2Context: ", err)
+		return false
+	}
+	if !grantTypeChoices[oContext.GrantType] {
+		fmt.Println("grantType in oAuth2Context is not supported. OAuth2 is turned off.")
+		return false
+	}
+	return true
+}