fixup! Refactor and add unit tests (#422)

bridge/onboardDevice_test.go

@@ -0,0 +1,100 @@
+/****************************************************************************
+ *
+ * Copyright (c) 2024 plgd.dev s.r.o.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"),
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
+ *
+ ****************************************************************************/
+
+package bridge_test
+
+import (
+	"context"
+	"testing"
+	"time"
+
+	"github.com/google/uuid"
+	bridgeTest "github.com/plgd-dev/device/v2/bridge/test"
+	"github.com/plgd-dev/device/v2/test"
+	testClient "github.com/plgd-dev/device/v2/test/client"
+	"github.com/stretchr/testify/require"
+)
+
+func TestOnboardDevice(t *testing.T) {
+	s := bridgeTest.NewBridgeService(t)
+	deviceID := uuid.New().String()
+	d := bridgeTest.NewBridgedDevice(t, s, true, deviceID)
+	defer func() {
+		s.DeleteAndCloseDevice(d.GetID())
+	}()
+	cleanup := bridgeTest.RunBridgeService(s)
+	defer cleanup()
+
+	type args struct {
+		deviceID              string
+		authorizationProvider string
+		authorizationCode     string
+		cloudURL              string
+		cloudID               string
+	}
+	tests := []struct {
+		name    string
+		args    args
+		wantErr bool
+	}{
+		{
+			name: "notFound",
+			args: args{
+				deviceID:              "notFound",
+				authorizationProvider: "authorizationProvider",
+				authorizationCode:     "authorizationCode",
+				cloudURL:              "coaps+tcp://test:5684",
+				cloudID:               "cloudID",
+			},
+			wantErr: true,
+		},
+		{
+			name: "valid",
+			args: args{
+				deviceID:              deviceID,
+				authorizationProvider: "authorizationProvider",
+				authorizationCode:     "authorizationCode",
+				cloudURL:              "coaps+tcp://test:5684",
+				cloudID:               "cloudID",
+			},
+		},
+	}
+
+	c, err := testClient.NewTestSecureClient()
+	require.NoError(t, err)
+	defer func() {
+		errC := c.Close(context.Background())
+		require.NoError(t, errC)
+	}()
+	ctx, cancel := context.WithTimeout(context.Background(), test.TestTimeout)
+	defer cancel()
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			ttCtx, ttCancel := context.WithTimeout(ctx, time.Second)
+			defer ttCancel()
+			err = c.OnboardDevice(ttCtx, tt.args.deviceID, tt.args.authorizationProvider, tt.args.cloudURL, tt.args.authorizationCode, tt.args.cloudID, withDeviceID(d.GetID().String()))
+			if tt.wantErr {
+				require.Error(t, err)
+				return
+			}
+			require.NoError(t, err)
+			err = c.OffboardDevice(ttCtx, tt.args.deviceID, withDeviceID(d.GetID().String()))
+			require.NoError(t, err)
+		})
+	}
+}

client/client_test.go

@@ -36,8 +36,6 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-const TestTimeout = time.Second * 8
-
 var (
 	ETagSupported                   = false
 	ETagBatchSupported              = false
@@ -91,7 +89,7 @@ func init() {
 		panicIfErr(errC)
 	}()
 
-	ctx, cancel := context.WithTimeout(context.Background(), TestTimeout)
+	ctx, cancel := context.WithTimeout(context.Background(), test.TestTimeout)
 	defer cancel()
 
 	deviceID, err = c.OwnDevice(ctx, deviceID)

client/createResource_test.go

@@ -85,7 +85,7 @@ func TestClientCreateResource(t *testing.T) {
 		errC := c.Close(context.Background())
 		require.NoError(t, errC)
 	}()
-	ctx, cancel := context.WithTimeout(context.Background(), TestTimeout)
+	ctx, cancel := context.WithTimeout(context.Background(), test.TestTimeout)
 	defer cancel()
 	deviceID, err = c.OwnDevice(ctx, deviceID, client.WithOTMs([]client.OTMType{client.OTMType_JustWorks}))
 	require.NoError(t, err)

client/deleteResource_test.go

@@ -95,7 +95,7 @@ func TestClientDeleteResource(t *testing.T) {
 		errC := c.Close(context.Background())
 		require.NoError(t, errC)
 	}()
-	ctx, cancel := context.WithTimeout(context.Background(), TestTimeout)
+	ctx, cancel := context.WithTimeout(context.Background(), test.TestTimeout)
 	defer cancel()
 	deviceID, err = c.OwnDevice(ctx, deviceID, client.WithOTMs([]client.OTMType{client.OTMType_JustWorks}))
 	require.NoError(t, err)
@@ -124,7 +124,7 @@ func TestClientBatchDeleteResources(t *testing.T) {
 		errC := c.Close(context.Background())
 		require.NoError(t, errC)
 	}()
-	ctx, cancel := context.WithTimeout(context.Background(), TestTimeout*50)
+	ctx, cancel := context.WithTimeout(context.Background(), test.TestTimeout)
 	defer cancel()
 	deviceID, err = c.OwnDevice(ctx, deviceID, client.WithOTMs([]client.OTMType{client.OTMType_JustWorks}))
 	require.NoError(t, err)

client/getDevice_test.go

@@ -121,7 +121,7 @@ func TestClientGetDevice(t *testing.T) {
 		},
 	}
 
-	ctx, cancel := context.WithTimeout(context.Background(), TestTimeout)
+	ctx, cancel := context.WithTimeout(context.Background(), test.TestTimeout)
 	defer cancel()
 
 	c, err := testClient.NewTestSecureClient()
@@ -189,7 +189,7 @@ func TestClientGetDeviceByIP(t *testing.T) {
 		},
 	}
 
-	ctx, cancel := context.WithTimeout(context.Background(), TestTimeout)
+	ctx, cancel := context.WithTimeout(context.Background(), test.TestTimeout)
 	defer cancel()
 
 	c, err := testClient.NewTestSecureClient()
@@ -297,7 +297,7 @@ func TestClientGetDeviceByIPOwnedByOther(t *testing.T) {
 	deviceID := test.MustFindDeviceByName(test.DevsimName)
 	ip4 := test.MustFindDeviceIP(test.DevsimName, test.IP4)
 
-	ctx, cancel := context.WithTimeout(context.Background(), TestTimeout)
+	ctx, cancel := context.WithTimeout(context.Background(), test.TestTimeout)
 	defer cancel()
 
 	c, err := testClient.NewTestSecureClient()

client/getResource_test.go

@@ -110,7 +110,7 @@ func TestClientGetResource(t *testing.T) {
 		errC := c.Close(context.Background())
 		require.NoError(t, errC)
 	}()
-	ctx, cancel := context.WithTimeout(context.Background(), TestTimeout)
+	ctx, cancel := context.WithTimeout(context.Background(), test.TestTimeout)
 	defer cancel()
 	deviceID, err = c.OwnDevice(ctx, deviceID)
 	require.NoError(t, err)
@@ -138,7 +138,7 @@ func TestClientGetDiscoveryResourceWithResourceTypeFilter(t *testing.T) {
 		errC := c.Close(context.Background())
 		require.NoError(t, errC)
 	}()
-	ctx, cancel := context.WithTimeout(context.Background(), TestTimeout*8)
+	ctx, cancel := context.WithTimeout(context.Background(), test.TestTimeout*8)
 	defer cancel()
 	deviceID, err = c.OwnDevice(ctx, deviceID)
 	require.NoError(t, err)
@@ -176,7 +176,7 @@ func TestClientGetDiscoveryResourceWithBatchInterface(t *testing.T) {
 		errC := c.Close(context.Background())
 		require.NoError(t, errC)
 	}()
-	ctx, cancel := context.WithTimeout(context.Background(), TestTimeout)
+	ctx, cancel := context.WithTimeout(context.Background(), test.TestTimeout)
 	defer cancel()
 	deviceID, err = c.OwnDevice(ctx, deviceID)
 	require.NoError(t, err)
@@ -254,7 +254,7 @@ func TestClientGetDiscoveryResourceWithBatchInterfaceCreateAndDeleteResource(t *
 		errC := c.Close(context.Background())
 		require.NoError(t, errC)
 	}()
-	ctx, cancel := context.WithTimeout(context.Background(), TestTimeout)
+	ctx, cancel := context.WithTimeout(context.Background(), test.TestTimeout)
 	defer cancel()
 	deviceID, err = c.OwnDevice(ctx, deviceID)
 	require.NoError(t, err)
@@ -305,7 +305,7 @@ func TestClientGetConResourceByETag(t *testing.T) {
 		errC := c.Close(context.Background())
 		require.NoError(t, errC)
 	}()
-	ctx, cancel := context.WithTimeout(context.Background(), TestTimeout)
+	ctx, cancel := context.WithTimeout(context.Background(), test.TestTimeout)
 	defer cancel()
 	deviceID, err = c.OwnDevice(ctx, deviceID)
 	require.NoError(t, err)

client/maitenance_test.go

@@ -61,7 +61,7 @@ func TestClientFactoryReset(t *testing.T) {
 		errC := c.Close(context.Background())
 		require.NoError(t, errC)
 	}()
-	ctx, cancel := context.WithTimeout(context.Background(), TestTimeout)
+	ctx, cancel := context.WithTimeout(context.Background(), test.TestTimeout)
 	defer cancel()
 	_, err = c.OwnDevice(ctx, deviceID)
 	require.NoError(t, err)

client/observeDevices_test.go

@@ -55,7 +55,7 @@ func TestObserveDevicesAddedByIP(t *testing.T) {
 		require.NoError(t, errC)
 	}()
 
-	ctx, cancel := context.WithTimeout(context.Background(), TestTimeout*2)
+	ctx, cancel := context.WithTimeout(context.Background(), test.TestTimeout*2)
 	defer cancel()
 
 	h := makeTestDevicesObservationHandler()
@@ -110,7 +110,7 @@ func TestObserveDevices(t *testing.T) {
 		require.NoError(t, errC)
 	}()
 
-	ctx, cancel := context.WithTimeout(context.Background(), TestTimeout*2)
+	ctx, cancel := context.WithTimeout(context.Background(), test.TestTimeout*2)
 	defer cancel()
 
 	h := makeTestDevicesObservationHandler()

client/observeResource_test.go

@@ -95,7 +95,7 @@ func testDevice(t *testing.T, name string, runTest func(ctx context.Context, t *
 		require.NoError(t, errC)
 	}()
 
-	ctx, cancel := context.WithTimeout(context.Background(), TestTimeout)
+	ctx, cancel := context.WithTimeout(context.Background(), test.TestTimeout)
 	defer cancel()
 
 	deviceID, err = c.OwnDevice(ctx, deviceID)

client/offboardDevice.go

@@ -29,5 +29,5 @@ func (c *Client) OffboardDevice(ctx context.Context, deviceID string, opts ...Co
 		return err
 	}
 
-	return setCloudResource(ctx, links, d, "", "", "", "")
+	return setCloudResource(ctx, links, d, "", "", "", "", cfg.opts...)
 }

client/onboardDevice.go

@@ -21,14 +21,15 @@ import (
 	"fmt"
 
 	"github.com/plgd-dev/device/v2/client/core"
+	"github.com/plgd-dev/device/v2/pkg/net/coap"
 	"github.com/plgd-dev/device/v2/schema"
 	"github.com/plgd-dev/device/v2/schema/acl"
 	"github.com/plgd-dev/device/v2/schema/cloud"
 	"github.com/plgd-dev/device/v2/schema/maintenance"
 	"github.com/plgd-dev/device/v2/schema/softwareupdate"
 )
 
-func setCloudResource(ctx context.Context, links schema.ResourceLinks, d *core.Device, authorizationProvider, authorizationCode, cloudURL, cloudID string) error {
+func setCloudResource(ctx context.Context, links schema.ResourceLinks, d *core.Device, authorizationProvider, authorizationCode, cloudURL, cloudID string, options ...coap.OptionFunc) error {
 	ob := cloud.ConfigurationUpdateRequest{
 		AuthorizationProvider: authorizationProvider,
 		AuthorizationCode:     authorizationCode,
@@ -37,7 +38,7 @@ func setCloudResource(ctx context.Context, links schema.ResourceLinks, d *core.D
 	}
 
 	for _, l := range links.GetResourceLinks(cloud.ResourceType) {
-		return d.UpdateResource(ctx, l, ob, nil)
+		return d.UpdateResource(ctx, l, ob, nil, options...)
 	}
 
 	return fmt.Errorf("cloud resource not found")
@@ -88,7 +89,7 @@ func (c *Client) OnboardDevice(
 	opts ...CommonCommandOption,
 ) error {
 	cfg := applyCommonOptions(opts...)
-	d, links, err := c.GetDevice(ctx, deviceID, WithDiscoveryConfiguration(cfg.discoveryConfiguration))
+	d, links, err := c.GetDevice(ctx, deviceID, cfg)
 	if err != nil {
 		return err
 	}
@@ -117,5 +118,5 @@ func (c *Client) OnboardDevice(
 			CloudID:               cloudID,
 		})
 	}
-	return setCloudResource(ctx, links, d, authorizationProvider, authCode, cloudURL, cloudID)
+	return setCloudResource(ctx, links, d, authorizationProvider, authCode, cloudURL, cloudID, cfg.opts...)
 }

client/onboardDevice_test.go

@@ -69,7 +69,7 @@ func TestClientOnboardDevice(t *testing.T) {
 		errC := c.Close(context.Background())
 		require.NoError(t, errC)
 	}()
-	ctx, cancel := context.WithTimeout(context.Background(), TestTimeout)
+	ctx, cancel := context.WithTimeout(context.Background(), test.TestTimeout)
 	defer cancel()
 	deviceID, err = c.OwnDevice(ctx, deviceID)
 	require.NoError(t, err)

client/options.go

@@ -168,6 +168,13 @@ func (r ResourceQueryOption) applyOnUpdate(opts updateOptions) updateOptions {
 	return opts
 }
 
+func (r ResourceQueryOption) applyOnCommonCommand(opts commonCommandOptions) commonCommandOptions {
+	if r.resourceQuery != "" {
+		opts.opts = append(opts.opts, coap.WithQuery(r.resourceQuery))
+	}
+	return opts
+}
+
 type DiscoveryConfigurationOption struct {
 	cfg core.DiscoveryConfiguration
 }
@@ -457,6 +464,7 @@ func (r otmOption) applyOnOwn(opts ownOptions) ownOptions {
 }
 
 type commonCommandOptions struct {
+	opts                   []coap.OptionFunc
 	discoveryConfiguration core.DiscoveryConfiguration
 }
 
@@ -474,3 +482,8 @@ func applyCommonOptions(opts ...CommonCommandOption) commonCommandOptions {
 	}
 	return cfg
 }
+
+func (r commonCommandOptions) applyOnGetDevice(opts getDeviceOptions) getDeviceOptions {
+	opts.discoveryConfiguration = r.discoveryConfiguration
+	return opts
+}

client/updateResource_test.go

@@ -116,7 +116,7 @@ func TestClientUpdateResource(t *testing.T) {
 			wantErr: true,
 		},
 	}
-	ctx, cancel := context.WithTimeout(context.Background(), TestTimeout)
+	ctx, cancel := context.WithTimeout(context.Background(), test.TestTimeout)
 	defer cancel()
 
 	c, err := testClient.NewTestSecureClient()
@@ -228,7 +228,7 @@ func TestClientUpdateResourceInRFOTM(t *testing.T) {
 			wantErr: true,
 		},
 	}
-	ctx, cancel := context.WithTimeout(context.Background(), TestTimeout)
+	ctx, cancel := context.WithTimeout(context.Background(), test.TestTimeout)
 	defer cancel()
 
 	c, err := testClient.NewTestSecureClient()

cmd/ocfbridge/config.yaml

@@ -1,7 +1,7 @@
 apis:
   coap:
     id: 8f596b43-29c0-4147-8b40-e99268ab30f7
-    name: "my-bridge-example"
+    name: "bridge-example"
     externalAddress: "127.0.0.1:15683"
     maxMessageSize: 262144
-numGeneratedBridgedDevices: 3
+numGeneratedBridgedDevices: 1

go.mod

@@ -19,6 +19,7 @@ require (
 	go.uber.org/atomic v1.11.0
 	golang.org/x/sync v0.6.0
 	google.golang.org/grpc v1.60.1
+	gopkg.in/yaml.v3 v3.0.1
 )
 
 require (
@@ -37,7 +38,6 @@ require (
 	golang.org/x/sys v0.16.0 // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20240108191215-35c7eff3a6b1 // indirect
 	google.golang.org/protobuf v1.32.0 // indirect
-	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
 
 // note: github.com/pion/dtls/v2/pkg/net package is not yet available in release branches

test/test.go

@@ -37,6 +37,8 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
+const TestTimeout = time.Second * 8
+
 func MustGetHostname() string {
 	n, err := os.Hostname()
 	if err != nil {