Merge pull request #624 from weichou1229/issue-623

feat: Add secret route path and HTTP client

Author: cloudxxx8

v2/clients/http/common.go

@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2020 IOTech Ltd
+// Copyright (C) 2020-2021 IOTech Ltd
 //
 // SPDX-License-Identifier: Apache-2.0
 
@@ -61,3 +61,11 @@ func (cc *commonClient) Version(ctx context.Context) (common.VersionResponse, er
 	}
 	return vr, nil
 }
+
+func (cc *commonClient) AddSecret(ctx context.Context, request common.SecretRequest) (res common.BaseResponse, err errors.EdgeX) {
+	err = utils.PostRequestWithRawData(ctx, &res, cc.baseUrl+v2.ApiSecretRoute, request)
+	if err != nil {
+		return res, errors.NewCommonEdgeXWrapper(err)
+	}
+	return res, nil
+}

v2/clients/http/common_test.go

@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2020 IOTech Ltd
+// Copyright (C) 2020-2021 IOTech Ltd
 //
 // SPDX-License-Identifier: Apache-2.0
 
@@ -65,6 +65,24 @@ func TestVersion(t *testing.T) {
 	require.Equal(t, expected, response)
 }
 
+func TestAddSecret(t *testing.T) {
+	expected := common.BaseResponse{}
+	req := common.NewSecretRequest(
+		"testPath",
+		[]common.SecretDataKeyValue{
+			{Key: "username", Value: "tester"},
+			{Key: "password", Value: "123"},
+		},
+	)
+	ts := newTestServer(http.MethodPost, v2.ApiSecretRoute, expected)
+	defer ts.Close()
+
+	client := NewCommonClient(ts.URL)
+	res, err := client.AddSecret(context.Background(), req)
+	require.NoError(t, err)
+	require.IsType(t, expected, res)
+}
+
 func newTestServer(httpMethod string, apiRoute string, expectedResponse interface{}) *httptest.Server {
 	return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		if r.Method != httpMethod {

v2/clients/interfaces/common.go

@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2020 IOTech Ltd
+// Copyright (C) 2020-2021 IOTech Ltd
 //
 // SPDX-License-Identifier: Apache-2.0
 
@@ -21,4 +21,6 @@ type CommonClient interface {
 	Ping(ctx context.Context) (common.PingResponse, errors.EdgeX)
 	// Version obtains version information from the target service.
 	Version(ctx context.Context) (common.VersionResponse, errors.EdgeX)
+	// AddSecret adds EdgeX Service exclusive secret to the Secret Store
+	AddSecret(ctx context.Context, request common.SecretRequest) (common.BaseResponse, errors.EdgeX)
 }

v2/clients/interfaces/mocks/CommonClient.go

@@ -94,6 +94,7 @@ const (
 	ApiMetricsRoute = ApiBase + "/metrics"
 	ApiPingRoute    = ApiBase + "/ping"
 	ApiVersionRoute = ApiBase + "/version"
+	ApiSecretRoute  = ApiBase + "/secret"
 
 	ApiDeviceCallbackRoute      = ApiBase + "/callback/device"
 	ApiDeviceCallbackNameRoute  = ApiBase + "/callback/device/name/{name}"

v2/constants.go

@@ -64,3 +64,11 @@ func (sr *SecretRequest) UnmarshalJSON(b []byte) error {
 	}
 	return nil
 }
+
+func NewSecretRequest(path string, secretData []SecretDataKeyValue) SecretRequest {
+	return SecretRequest{
+		BaseRequest: NewBaseRequest(),
+		Path:        path,
+		SecretData:  secretData,
+	}
+}