refactor: move ClientOptions to environment/types (#255)

* Preparation for Converged Client:

 - Go and toolchain versions bump up
 - Linter version bump up
 - ClientOptions and related structure moved to types
 - Fix linter errors

* Fix lint errors

* Add more unit-test to pass coverage requirements

* More tests

* Fix lint errors

* Fix hash is equal comment

* Fix review comments

Author: adiantum

.gitignore

@@ -2,6 +2,7 @@
 /.work
 /_output
 cover.out
+coverage.out
 /vendor
 /.vendor-new
 .DS_Store

.golangci.yaml

@@ -1,9 +1,8 @@
+version: 2
+
 linters:
   enable:
     - errcheck
-    - gofmt
-    - gofumpt
-    - gosimple
     - govet
     - ineffassign
     - nolintlint

devbox.lock

@@ -438,50 +438,50 @@
       }
     },
     "golangci-lint@latest": {
-      "last_modified": "2024-07-31T08:48:38Z",
-      "resolved": "github:NixOS/nixpkgs/c3392ad349a5227f4a3464dce87bcc5046692fce#golangci-lint",
+      "last_modified": "2025-08-03T19:18:05Z",
+      "resolved": "github:NixOS/nixpkgs/bf9fa86a9b1005d932f842edf2c38eeecc98eef3#golangci-lint",
       "source": "devbox-search",
-      "version": "1.59.1",
+      "version": "2.3.1",
       "systems": {
         "aarch64-darwin": {
           "outputs": [
             {
               "name": "out",
-              "path": "/nix/store/k3rnfx753gnx5v8l3i4sx1g1al2ds0di-golangci-lint-1.59.1",
+              "path": "/nix/store/ahn380skfkdg3ynimjpqakc1wp26mpsi-golangci-lint-2.3.1",
               "default": true
             }
           ],
-          "store_path": "/nix/store/k3rnfx753gnx5v8l3i4sx1g1al2ds0di-golangci-lint-1.59.1"
+          "store_path": "/nix/store/ahn380skfkdg3ynimjpqakc1wp26mpsi-golangci-lint-2.3.1"
         },
         "aarch64-linux": {
           "outputs": [
             {
               "name": "out",
-              "path": "/nix/store/29908ar68rrr9jzdhzcrlkbfk30gnihf-golangci-lint-1.59.1",
+              "path": "/nix/store/5wf61l5pnqlna9mwllllq334rkh1i2a6-golangci-lint-2.3.1",
               "default": true
             }
           ],
-          "store_path": "/nix/store/29908ar68rrr9jzdhzcrlkbfk30gnihf-golangci-lint-1.59.1"
+          "store_path": "/nix/store/5wf61l5pnqlna9mwllllq334rkh1i2a6-golangci-lint-2.3.1"
         },
         "x86_64-darwin": {
           "outputs": [
             {
               "name": "out",
-              "path": "/nix/store/v7882fqgdy46a7l432q11f3xmbln80rc-golangci-lint-1.59.1",
+              "path": "/nix/store/sbqfd50kb6g4gka3w1vixjrnacspdwq5-golangci-lint-2.3.1",
               "default": true
             }
           ],
-          "store_path": "/nix/store/v7882fqgdy46a7l432q11f3xmbln80rc-golangci-lint-1.59.1"
+          "store_path": "/nix/store/sbqfd50kb6g4gka3w1vixjrnacspdwq5-golangci-lint-2.3.1"
         },
         "x86_64-linux": {
           "outputs": [
             {
               "name": "out",
-              "path": "/nix/store/1m1i9zhrgdw2192803n6wf2k7g86y6d5-golangci-lint-1.59.1",
+              "path": "/nix/store/kxbsvkixvkn0ss81rbc1g814sizd1jwj-golangci-lint-2.3.1",
               "default": true
             }
           ],
-          "store_path": "/nix/store/1m1i9zhrgdw2192803n6wf2k7g86y6d5-golangci-lint-1.59.1"
+          "store_path": "/nix/store/kxbsvkixvkn0ss81rbc1g814sizd1jwj-golangci-lint-2.3.1"
         }
       }
     },

environment/providers/secretdir/secretdir_test.go

@@ -34,11 +34,11 @@ func TestBasicAuth(t *testing.T) {
 	g.Expect(err).To(Succeed())
 	defer func() {
 		if !t.Failed() {
-			os.RemoveAll(path)
+			_ = os.RemoveAll(path)
 		}
 	}()
 	t.Logf("Temporary directory %s", path)
-	os.Setenv(envSecretDir, path)
+	_ = os.Setenv(envSecretDir, path)
 	ip := rand.String(10)
 	user := rand.String(10)
 	passwd := rand.String(10)
@@ -61,13 +61,13 @@ func TestTLSAuth(t *testing.T) {
 	g.Expect(err).To(Succeed())
 	defer func() {
 		if !t.Failed() {
-			os.RemoveAll(path)
+			_ = os.RemoveAll(path)
 		}
 	}()
 	ip := rand.String(10)
 	cert := rand.String(512)
 	t.Logf("Temporary directory %s", path)
-	os.Setenv(envSecretDir, path)
+	_ = os.Setenv(envSecretDir, path)
 	g.Expect(writeParam(t, path, secretKeyCertName, cert)).To(Succeed())
 	g.Expect(writeParam(t, path, secretKeyEndpoint,
 		fmt.Sprintf("%s:9440", ip))).To(Succeed())
@@ -87,7 +87,7 @@ func TestNutanixAuth(t *testing.T) {
 	g.Expect(err).To(Succeed())
 	defer func() {
 		if !t.Failed() {
-			os.RemoveAll(path)
+			_ = os.RemoveAll(path)
 		}
 	}()
 	ip := rand.String(10)
@@ -109,7 +109,7 @@ func TestNutanixAuth(t *testing.T) {
 	`, user, passwd)
 	endpoint := fmt.Sprintf("%s:9440", ip)
 	t.Logf("Temporary directory %s", path)
-	os.Setenv(envSecretDir, path)
+	_ = os.Setenv(envSecretDir, path)
 
 	// Write three keys
 	g.Expect(writeParam(t, path, secretKeyCredentials, creds)).To(Succeed())

environment/types/types.go

@@ -1,6 +1,9 @@
 package types
 
 import (
+	"crypto/sha256"
+	"encoding/hex"
+	"encoding/json"
 	"fmt"
 	"net/url"
 )
@@ -62,3 +65,34 @@ type Environment interface {
 type Provider interface {
 	Environment
 }
+
+// CachedClientParams define the interface that needs to be implemented by an object that will be used to create
+// a cached client.
+type CachedClientParams interface {
+	// ManagementEndpoint returns the struct containing all information needed to construct a new client
+	// and is used to calculate the validation hash for the client for the purpose of cache invalidation.
+	// The validation hash is calculated based on the serialized version of the ManagementEndpoint.
+	ManagementEndpoint() ManagementEndpoint
+	// Key returns a unique key for the client that is used to store the client in the cache
+	Key() string
+}
+
+type CacheOpts[T any] func(*T)
+type ClientOption[T any] func(*T) error
+
+func (ep *ManagementEndpoint) GetHash() (string, error) {
+	// Note: this will only work reliably as long as types.ManagementEndpoint is predictably serializable i.e. does
+	// not contain a map. Due to randomized ordering of map keys in Go, we would constantly invalidate caches
+	// if the ManagementEndpoint has a map.
+	serializedEndpoint, err := json.Marshal(*ep)
+	if err != nil {
+		return "", err
+	}
+
+	hasher := sha256.New()
+	hasher.Write(serializedEndpoint)
+	hashedBytes := hasher.Sum(nil)
+	currentValidationHash := hex.EncodeToString(hashedBytes)
+
+	return currentValidationHash, nil
+}