Merge pull request #8 from cloudfoundry-community/devel

upgrade go and dependencies

Author: romain-dartigues

.github/workflows/golangci-lint.yml

@@ -0,0 +1,26 @@
+name: golangci-lint
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request:
+
+permissions:
+  contents: read
+  # Optional: allow read access to pull request. Use with `only-new-issues` option.
+  # pull-requests: read
+
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: '>=1.22'
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v6
+        with:
+          version: v1.58

.github/workflows/unit-tests.yml

@@ -0,0 +1,31 @@
+name: unit-tests
+
+on:
+  pull_request: ~
+  push: ~
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: set up go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.22"
+
+      - name: cache go modules
+        uses: actions/cache@v4
+        with:
+          path: ~/go/pkg/mod
+          key: "${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}"
+          restore-keys: |
+            ${{ runner.os }}-go-
+
+      - name: tests
+        run: |
+          go test -v ./...

config.go

@@ -1,6 +1,6 @@
 package clients
 
-// config -
+// Config -
 type Config struct {
 	// Cloud foundry api endoint
 	Endpoint string

go.mod

@@ -1,8 +1,6 @@
 module github.com/cloudfoundry-community/go-cf-clients-helper/v2
 
-go 1.21
-
-toolchain go1.21.5
+go 1.22.3
 
 exclude (
 	github.com/imdario/mergo v0.3.16

rawclient.go

@@ -31,7 +31,7 @@ type RawClientConfig struct {
 	ApiEndpoint       string
 }
 
-// Raw http client has uaa client authentication to make raw request with golang native api.
+// RawClient Raw http client has uaa client authentication to make raw request with golang native api.
 type RawClient struct {
 	connection  cloudcontroller.Connection
 	apiEndpoint string

requestlogger.go

@@ -98,23 +98,23 @@ func NewRequestLogger() *RequestLogger {
 }
 
 func (display *RequestLogger) DisplayBody([]byte) error {
-	log.Print(fmt.Sprintf("%s\n", RedactedValue))
+	log.Printf("%s\n", RedactedValue)
 	return nil
 }
 
 func (display *RequestLogger) DisplayDump(dump string) error {
 	sanitized := display.dumpSanitizer.ReplaceAllString(dump, RedactedValue)
-	log.Print(fmt.Sprintf("%s\n", sanitized))
+	log.Printf("%s\n", sanitized)
 	return nil
 }
 
 func (display *RequestLogger) DisplayHeader(name string, value string) error {
-	log.Print(fmt.Sprintf("%s: %s\n", name, value))
+	log.Printf("%s: %s\n", name, value)
 	return nil
 }
 
 func (display *RequestLogger) DisplayHost(name string) error {
-	log.Print(fmt.Sprintf("host: %s\n", name))
+	log.Printf("host: %s\n", name)
 	return nil
 }
 
@@ -125,27 +125,27 @@ func (display *RequestLogger) DisplayJSONBody(body []byte) error {
 
 	sanitized, err := SanitizeJSON(body)
 	if err != nil {
-		log.Print(fmt.Sprintf("%s\n", string(body)))
+		log.Printf("%s\n", string(body))
 		return nil
 	}
 
-	log.Print(fmt.Sprintf("%s\n", string(sanitized)))
+	log.Printf("%s\n", string(sanitized))
 
 	return nil
 }
 
 func (display *RequestLogger) DisplayMessage(msg string) error {
-	log.Print(fmt.Sprintf("%s\n", msg))
+	log.Printf("%s\n", msg)
 	return nil
 }
 
 func (display *RequestLogger) DisplayRequestHeader(method string, uri string, httpProtocol string) error {
-	log.Print(fmt.Sprintf("%s %s %s\n", method, uri, httpProtocol))
+	log.Printf("%s %s %s\n", method, uri, httpProtocol)
 	return nil
 }
 
 func (display *RequestLogger) DisplayResponseHeader(httpProtocol string, status string) error {
-	log.Print(fmt.Sprintf("%s %s\n", httpProtocol, status))
+	log.Printf("%s %s\n", httpProtocol, status)
 	return nil
 }
 

retrywrapper.go

@@ -5,8 +5,8 @@ import (
 	"code.cloudfoundry.org/cli/api/cloudcontroller"
 	"code.cloudfoundry.org/cli/api/cloudcontroller/ccerror"
 	"code.cloudfoundry.org/cli/api/router"
+	"errors"
 	"io"
-	"io/ioutil"
 	"net/http"
 	"reflect"
 )
@@ -46,7 +46,7 @@ func (retry *RetryRequest) Make(request *cloudcontroller.Request, passedResponse
 
 		// detect if body is ioutil.NopCloser(&bytes.Buffer)
 		// if so we reset the content the buffer to be able to redo request with same body
-		if reflect.TypeOf(request.Body) == reflect.TypeOf(ioutil.NopCloser) {
+		if reflect.TypeOf(request.Body) == reflect.TypeOf(io.NopCloser) {
 			reader := reflect.ValueOf(request.Body).FieldByName("Reader")
 			if buf, ok := reader.Interface().(*bytes.Buffer); ok {
 				data := buf.Bytes()
@@ -60,7 +60,8 @@ func (retry *RetryRequest) Make(request *cloudcontroller.Request, passedResponse
 		if reader, ok := request.Body.(io.ReadSeeker); ok {
 			_, resetErr := reader.Seek(0, 0)
 			if resetErr != nil {
-				if _, ok := resetErr.(ccerror.PipeSeekError); ok {
+				var pipeSeekError ccerror.PipeSeekError
+				if errors.As(resetErr, &pipeSeekError) {
 					return ccerror.PipeSeekError{Err: err}
 				}
 				return resetErr
@@ -117,7 +118,7 @@ func (retry *retryRequestRouter) Make(request *router.Request, passedResponse *r
 		}
 		// detect if body is ioutil.NopCloser(&bytes.Buffer)
 		// if so we reset the content the buffer to be able to redo request with same body
-		if reflect.TypeOf(request.Body) == reflect.TypeOf(ioutil.NopCloser) {
+		if reflect.TypeOf(request.Body) == reflect.TypeOf(io.NopCloser) {
 			reader := reflect.ValueOf(request.Body).FieldByName("Reader")
 			if buf, ok := reader.Interface().(*bytes.Buffer); ok {
 				data := buf.Bytes()
@@ -131,7 +132,8 @@ func (retry *retryRequestRouter) Make(request *router.Request, passedResponse *r
 		if reader, ok := request.Body.(io.ReadSeeker); ok {
 			_, resetErr := reader.Seek(0, 0)
 			if resetErr != nil {
-				if _, ok := resetErr.(ccerror.PipeSeekError); ok {
+				var pipeSeekError ccerror.PipeSeekError
+				if errors.As(resetErr, &pipeSeekError) {
 					return ccerror.PipeSeekError{Err: err}
 				}
 				return resetErr

session.go

@@ -85,32 +85,32 @@ func NewSession(c Config) (s *Session, err error) {
 	return s, nil
 }
 
-// Give access to api cf v3 (complete and always up to date, thanks to cli v7 team)
+// V3 Give access to api cf v3 (complete and always up to date, thanks to cli v7 team)
 func (s *Session) V3() *ccv3.Client {
 	return s.clientV3
 }
 
-// Give access to api uaa (incomplete)
+// UAA Give access to api uaa (incomplete)
 func (s *Session) UAA() *uaa.Client {
 	return s.clientUAA
 }
 
-// Give access to TCP Routing api
+// TCPRouter Give access to TCP Routing api
 func (s *Session) TCPRouter() *router.Client {
 	return s.routerClient
 }
 
-// Give access to networking policy api
+// Networking Give access to networking policy api
 func (s *Session) Networking() *cfnetv1.Client {
 	return s.netClient
 }
 
-// Give an http client which pass authorization header to call api(s) directly
+// Raw Give an http client which pass authorization header to call api(s) directly
 func (s *Session) Raw() *RawClient {
 	return s.rawClient
 }
 
-// Give config store for client which need access token
+// ConfigStore Give config store for client which need access token
 func (s *Session) ConfigStore() *configv3.Config {
 	return s.configStore
 }
@@ -146,7 +146,9 @@ func (s *Session) init(config *configv3.Config, configUaa *configv3.Config, conf
 	// create an uaa client with cf_username/cf_password or client_id/client secret
 	// to use it for authenticate requests
 	uaaClient := uaa.NewClient(config)
-	uaaClient.GetAPIVersion()
+	if _, err := uaaClient.GetAPIVersion(); err != nil {
+		return fmt.Errorf("unable to get API version: %s", err)
+	}
 
 	uaaAuthWrapper := uaaWrapper.NewUAAAuthentication(nil, configUaa)
 	uaaClient.WrapConnection(uaaAuthWrapper)