feat(debug) support response tracing

* add support for `DEBUG=3` to trace raw HTTP responses
* fix scenario, when `HTML5_CACHE=1` is used for the first time and configuration file not yet exists
* fix pagination issue, convert absolute URLs of the next page to relative, when calling `cf curl` internally
* update README.md with SSL configuration documentation
* update CHANGELOG.md
* bump version to 1.4.9

Author: micellius

CHANGELOG.md

@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [1.4.8] - 2024-02-19
+### Added
+- Support `DEBUG=3` to print raw responses in the trace logs
+
+### Fixed
+- Wait until the CF job of service key or service instrance deletion is completed
+- Create new configuration file on first call of CLI with `HTML5_CACHE=1` flag
+- Handle CloudFoundry `v3` API pagination with absolute next URL
+
 ## [1.4.8] - 2024-01-18
 ### Added
 - Respect `cf` CLI TLS settings, including `--skip-ssl-validation` login option as well as `SSL_CERT_FILE` and `SSL_CERT_DIR` environment variables ([#65](https://github.com/SAP/cf-html5-apps-repo-cli-plugin/issues/65))

Makefile

@@ -1,5 +1,5 @@
 NAME=cf-html5-apps-repo-cli-plugin
-VERSION=1.4.8
+VERSION=1.4.9
 
 # Build the project
 all: clean build install

README.md

@@ -281,6 +281,7 @@ The configuration of the CF HTML5 Applications Repository CLI Plugin is done by
 The following are supported:
   * `DEBUG=1` - enables trace logs with detailed information about currently running steps. If you want to
      see also the sensitive information in the trace logs (e.g. access tokens), use `DEBUG=2` instead.
+     To see the raw HTTP responses in trace logs, use `DEBUG=3`.
   * `HTML5_CACHE=1` - enables persisted cache. Disabled by default. Should be enabled only for sequential
      execution of the CF HTML5 Applications Repository CLI Plugin commands in the same context 
      (org/space/user) during short period of time (less than 12 hours)
@@ -297,6 +298,7 @@ In addition CF HTML5 Applications Repository CLI Plugin supports the following c
   * `--skip-ssl-validation` - command line argument option of `cf login`
   * `SSL_CERT_FILE` - environment variable pointing to file with additional signing certificate
   * `SSL_CERT_DIR` - environment variable pointing to directory with `server.crt` file containing additional signing certificate
+As an alternative, you can (install)[https://docs.cloudfoundry.org/cf-cli/self-signed.html] custom or self-signed certificate on machine, where CLI is running.
 
 ## Troubleshooting
 
@@ -310,6 +312,15 @@ these service instances. If one of the flows invoked by the CF HTML5 Application
 Repository CLI Plugin fails in the middle, these artifacts may remain
 in the current space. 
 
+#### Self-signed Certificates
+
+Note, that on macOS Cloud Foundry CLI itself (does not support)[https://github.com/cloudfoundry/cli/issues/1263] the `SSL_CERT_FILE` and `SSL_CERT_DIR`.
+Therefore, running the CLI commands is only possible if at least one of two conditions is met:
+  * The login was done with `cf login --skip-ssl-validation`, and all subsequent CLI commands ignore certificate issues
+  * The certificate of Cloud Foundry deployment was installed on machine, where CLI is running
+
+Trying to use both `--skip-ssl-validation` and `SSL_CERT_FILE` will result in commands, targeting Cloud Foundry Cloud Controller, executed without certificate validation, and commands targeting services (e.g. HTML5 Applications Repository) will check server certificate using `SSL_CERT_FILE`. 
+
 ## Limitations
 
 Currently, you can't use the CF HTML5 Applications Repository CLI Plugin with 

clients/create_service_instance.go

@@ -6,7 +6,7 @@ import (
 	"cf-html5-apps-repo-cli-plugin/log"
 	"encoding/json"
 	"fmt"
-	"io/ioutil"
+	"io"
 	"net/http"
 	"strconv"
 	"time"
@@ -73,12 +73,14 @@ func CreateServiceInstance(cliConnection plugin.CliConnection, spaceGUID string,
 	}
 	defer response.Body.Close()
 
+	body, err = io.ReadAll(response.Body)
+	log.Trace(log.Response{Head: response, Body: body})
+	if err != nil {
+		return nil, err
+	}
+
 	if response.StatusCode != 202 {
-		body, err = ioutil.ReadAll(response.Body)
-		if err != nil {
-			return nil, err
-		}
-		return nil, fmt.Errorf("Could not create service instance: [%d] %s", response.StatusCode, string(body))
+		return nil, fmt.Errorf("Could not create service instance: [%d] %s", response.StatusCode, string(body[:]))
 	}
 
 	// Pool job

clients/create_service_instance_destination.go

@@ -44,11 +44,14 @@ func CreateServiceInstanceDestination(serviceURL string, accessToken string, des
 	}
 	defer response.Body.Close()
 
+	body, err = io.ReadAll(response.Body)
+	log.Trace(log.Response{Head: response, Body: body})
+	if err != nil {
+		return err
+	}
+
 	if response.StatusCode > 201 {
-		body, err = io.ReadAll(response.Body)
-		if err != nil {
-			return fmt.Errorf("Could not create destination: [%s] %+v", response.Status, body)
-		}
+		return fmt.Errorf("Could not create destination: [%s] %+v", response.Status, body)
 	}
 
 	return nil

clients/create_service_key.go

@@ -6,7 +6,7 @@ import (
 	"cf-html5-apps-repo-cli-plugin/log"
 	"encoding/json"
 	"fmt"
-	"io/ioutil"
+	"io"
 	"net/http"
 	"strconv"
 	"time"
@@ -69,11 +69,13 @@ func CreateServiceKey(cliConnection plugin.CliConnection, serviceInstanceGUID st
 	}
 	defer response.Body.Close()
 
+	body, err = io.ReadAll(response.Body)
+	log.Trace(log.Response{Head: response, Body: body})
+	if err != nil {
+		return nil, err
+	}
+
 	if response.StatusCode != 202 {
-		body, err = ioutil.ReadAll(response.Body)
-		if err != nil {
-			return nil, err
-		}
 		return nil, fmt.Errorf("Could not create service key: [%d] %s", response.StatusCode, string(body))
 	}
 

clients/create_subaccount_destination.go

@@ -5,7 +5,7 @@ import (
 	models "cf-html5-apps-repo-cli-plugin/clients/models"
 	"cf-html5-apps-repo-cli-plugin/log"
 	"fmt"
-	"io/ioutil"
+	"io"
 	"net/http"
 )
 
@@ -44,8 +44,14 @@ func CreateSubaccountDestination(serviceURL string, accessToken string, destinat
 	}
 	defer response.Body.Close()
 
+	body, err = io.ReadAll(response.Body)
+	log.Trace(log.Response{Head: response, Body: body})
+	if err != nil {
+		return err
+	}
+
 	if response.StatusCode > 201 {
-		body, err = ioutil.ReadAll(response.Body)
+		body, err = io.ReadAll(response.Body)
 		if err != nil {
 			return fmt.Errorf("Could not create destination: [%s] %+v", response.Status, body)
 		}

clients/delete_service_content.go

@@ -3,6 +3,7 @@ package clients
 import (
 	"cf-html5-apps-repo-cli-plugin/log"
 	"errors"
+	"io"
 	"net/http"
 )
 
@@ -28,6 +29,9 @@ func DeleteServiceContent(serviceURL string, accessToken string) error {
 	if response, err = client.Do(request); err != nil {
 		return err
 	}
+	defer response.Body.Close()
+	body, err := io.ReadAll(response.Body)
+	log.Trace(log.Response{Head: response, Body: body})
 	if response.StatusCode != 200 {
 		return errors.New(response.Status)
 	}

clients/delete_service_instance.go

@@ -1,11 +1,11 @@
 package clients
 
 import (
-	models "cf-html5-apps-repo-cli-plugin/clients/models"
+	"bytes"
 	"cf-html5-apps-repo-cli-plugin/log"
-	"encoding/json"
-	"errors"
-	"strings"
+	"fmt"
+	"io"
+	"net/http"
 
 	"github.com/cloudfoundry/cli/plugin"
 )
@@ -14,43 +14,59 @@ import (
 func DeleteServiceInstance(cliConnection plugin.CliConnection, serviceInstanceGUID string, maxRetryCount int) error {
 	var err error
 	var url string
-	var responseStrings []string
-	var responseBytes []byte
-	var errorResponse models.CFErrorResponse
 	var currentTry = 1
+	var request *http.Request
+	var response *http.Response
+	var body []byte
+	var apiEndpoint string
+	var accessToken string
 
-	url = "/v3/service_instances/" + serviceInstanceGUID
+	apiEndpoint, err = cliConnection.ApiEndpoint()
+	if err != nil {
+		return err
+	}
+
+	accessToken, err = cliConnection.AccessToken()
+	if err != nil {
+		return err
+	}
+
+	url = apiEndpoint + "/v3/service_instances/" + serviceInstanceGUID
 
 	for currentTry <= maxRetryCount {
-		log.Tracef("Making request to (try %d/%d): %s\n", currentTry, maxRetryCount, url)
-		responseStrings, err = cliConnection.CliCommandWithoutTerminalOutput("curl", url, "-X", "DELETE")
+		log.Tracef("Making request to: %s (try %d/%d)\n", url, currentTry, maxRetryCount)
+		request, err = http.NewRequest("DELETE", url, bytes.NewBuffer([]byte{}))
 		if err != nil {
 			return err
 		}
+		request.Header.Set("Content-Type", "application/json")
+		request.Header.Set("Authorization", accessToken)
 
-		responseBytes = []byte(strings.Join(responseStrings, ""))
-		if len(responseBytes) > 0 {
-			log.Tracef("Response is not empty, maybe error: %+v\n", responseStrings)
-			errorResponse = models.CFErrorResponse{}
-			err = json.Unmarshal(responseBytes, &errorResponse)
-			if err != nil {
-				return err
-			}
-			if len(errorResponse) == 0 {
-				return errors.New(strings.Join(responseStrings, "\n"))
-			}
-			if errorResponse[0].Code > 0 {
-				if currentTry == maxRetryCount {
-					if errorResponse[0].Title != "" || errorResponse[0].Detail != "" {
-						return errors.New(errorResponse[0].Title + " " + errorResponse[0].Detail)
-					}
-					return errors.New(strings.Join(responseStrings, "\n"))
-				}
-				currentTry++
+		client, err := GetDefaultClient()
+		if err != nil {
+			return err
+		}
+		response, err = client.Do(request)
+		if err != nil {
+			return err
+		}
+		defer response.Body.Close()
+
+		body, err = io.ReadAll(response.Body)
+		log.Trace(log.Response{Head: response, Body: body})
+		if err != nil {
+			return err
+		}
+
+		if response.StatusCode != 202 {
+			if currentTry != maxRetryCount {
 				continue
 			}
+			return fmt.Errorf("Could not delete service instance: [%d] %s", response.StatusCode, string(body[:]))
 		} else {
-			return nil
+			// Pool job
+			_, err = PollJob(cliConnection, response.Header.Get("Location"))
+			return err
 		}
 	}
 

clients/delete_service_instance_destination.go

@@ -35,7 +35,7 @@ func DeleteServiceInstanceDestination(serviceURL string, accessToken string, des
 		return err
 	}
 	defer response.Body.Close()
-
+	log.Trace(log.Response{Head: response})
 	if response.StatusCode > 201 {
 		body, err = io.ReadAll(response.Body)
 		if err != nil {