Merge pull request #981 from lindseysimple/issue-980

feat: Add the SecretStoreTokenClient http client

Author: cloudxxx8

clients/http/secretstoretoken.go

@@ -0,0 +1,54 @@
+//
+// Copyright (C) 2025 IOTech Ltd
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package http
+
+import (
+	"context"
+
+	"github.com/edgexfoundry/go-mod-core-contracts/v4/clients"
+	"github.com/edgexfoundry/go-mod-core-contracts/v4/clients/http/utils"
+	"github.com/edgexfoundry/go-mod-core-contracts/v4/clients/interfaces"
+	"github.com/edgexfoundry/go-mod-core-contracts/v4/common"
+	dtoCommon "github.com/edgexfoundry/go-mod-core-contracts/v4/dtos/common"
+	"github.com/edgexfoundry/go-mod-core-contracts/v4/errors"
+)
+
+type SecretStoreTokenClient struct {
+	baseUrlFunc  clients.ClientBaseUrlFunc
+	authInjector interfaces.AuthenticationInjector
+}
+
+// NewSecretStoreTokenClient creates an instance of SecretStoreTokenClient
+func NewSecretStoreTokenClient(baseUrl string, authInjector interfaces.AuthenticationInjector) interfaces.SecretStoreTokenClient {
+	return &SecretStoreTokenClient{
+		baseUrlFunc:  clients.GetDefaultClientBaseUrlFunc(baseUrl),
+		authInjector: authInjector,
+	}
+}
+
+// NewSecretStoreTokenClientWithUrlCallback creates an instance of SecretStoreTokenClient with ClientBaseUrlFunc.
+func NewSecretStoreTokenClientWithUrlCallback(baseUrlFunc clients.ClientBaseUrlFunc, authInjector interfaces.AuthenticationInjector) interfaces.AuthClient {
+	return &AuthClient{
+		baseUrlFunc:  baseUrlFunc,
+		authInjector: authInjector,
+	}
+}
+
+// RegenToken regenerates the secret store client token based on the specified entity id
+func (ac *SecretStoreTokenClient) RegenToken(ctx context.Context, entityId string) (dtoCommon.BaseResponse, errors.EdgeX) {
+	var response dtoCommon.BaseResponse
+	baseUrl, err := clients.GetBaseUrl(ac.baseUrlFunc)
+	if err != nil {
+		return response, errors.NewCommonEdgeXWrapper(err)
+	}
+
+	path := common.NewPathBuilder().SetPath(common.ApiTokenRoute).SetPath(common.EntityId).SetPath(entityId).BuildPath()
+	err = utils.PutRequest(ctx, &response, baseUrl, path, nil, nil, ac.authInjector)
+	if err != nil {
+		return response, errors.NewCommonEdgeXWrapper(err)
+	}
+	return response, nil
+}

clients/http/secretstoretoken_test.go

@@ -0,0 +1,31 @@
+//
+// Copyright (C) 2025 IOTech Ltd
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package http
+
+import (
+	"context"
+	"net/http"
+	"testing"
+
+	"github.com/edgexfoundry/go-mod-core-contracts/v4/common"
+	dtoCommon "github.com/edgexfoundry/go-mod-core-contracts/v4/dtos/common"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestRegenToken(t *testing.T) {
+	mockId := "mockId"
+
+	path := common.NewPathBuilder().EnableNameFieldEscape(false).
+		SetPath(common.ApiTokenRoute).SetPath(common.EntityId).SetPath(mockId).BuildPath()
+	ts := newTestServer(http.MethodPut, path, dtoCommon.BaseResponse{})
+	defer ts.Close()
+
+	client := NewSecretStoreTokenClient(ts.URL, NewNullAuthenticationInjector())
+	res, err := client.RegenToken(context.Background(), mockId)
+	require.NoError(t, err)
+	require.IsType(t, dtoCommon.BaseResponse{}, res)
+}

clients/interfaces/mocks/SecretStoreTokenClient.go

@@ -0,0 +1,19 @@
+//
+// Copyright (C) 2025 IOTech Ltd
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package interfaces
+
+import (
+	"context"
+
+	dtoCommon "github.com/edgexfoundry/go-mod-core-contracts/v4/dtos/common"
+	"github.com/edgexfoundry/go-mod-core-contracts/v4/errors"
+)
+
+// SecretStoreTokenClient defines the interface for interactions with the API endpoint on the security-secretstore-setup service.
+type SecretStoreTokenClient interface {
+	// RegenToken regenerates the secret store client token based on the specified entity id
+	RegenToken(ctx context.Context, entityId string) (dtoCommon.BaseResponse, errors.EdgeX)
+}

clients/interfaces/secretstoretoken.go

@@ -136,6 +136,9 @@ const (
 
 	ApiKeyRoute                     = ApiBase + "/key"
 	ApiVerificationKeyByIssuerRoute = ApiKeyRoute + "/" + VerificationKeyType + "/" + Issuer + "/:" + Issuer
+
+	ApiTokenRoute      = ApiBase + "/" + Token
+	ApiRegenTokenRoute = ApiTokenRoute + "/" + EntityId + "/:" + EntityId
 )
 
 // Constants related to defined url path names and parameters in the v3 service APIs
@@ -405,3 +408,9 @@ const (
 	SigningKeyType      = "signing"
 	Issuer              = "issuer"
 )
+
+// Constants related to the security-secretstore-setup service
+const (
+	EntityId = "entityId"
+	Token    = "token"
+)