implement initial discover service #4665

JohnN193 · 2024-12-31T21:16:49Z

Initial implementation of the discover service in Go. Currently working on GetModelsFromModules in a separate branch to make it easier on reviewers

ticket: https://viam.atlassian.net/browse/RSDK-9620

JohnN193 · 2024-12-31T21:17:33Z

go.mod

@@ -431,3 +431,5 @@ require (
 	github.com/ziutek/mymysql v1.5.4 // indirect
 	golang.org/x/exp v0.0.0-20240904232852-e7e105dedf7e
 )
+
+replace go.viam.com/api => github.com/johnn193/api v0.0.0-20241231164642-99f059defc82


will revert once api is merged

JohnN193 · 2024-12-31T21:30:19Z

services/discovery/server_test.go

+	return discovery.NewRPCServiceServer(injectSvc).(pb.DiscoveryServiceServer), injectDiscovery, injectDiscovery2, nil
+}
+
+func TestDiscoveryDo(t *testing.T) {


since this is literally copy/paste from the generic service I should probably remove this test, but I'm also fine with leaving it in case we are worried this will somehow break

It is good to test all APIs of a service to ensure that there is adequate coverage. I can't imagine it breaking - but say someone with no context joins viam in the future and removes the DoCommands accidentally - good to have all these tests fail :) . It does not have to be separate from your other test, you can add an injected DoCommand to the injected service in your test.

Good test to have with DoComamnd are: 1. test that it returns errors if no DoCommand is implemented with resource.Named, and 2. responds with the expected responses when a DoCommand is implemented.

yeah I just copied the testing structure that other services had, which is why it was separate. Moved all tests into the same test function based on feedback.

JohnN193 · 2025-01-03T20:43:47Z

services/discovery/server_test.go

+// this was taken from proto_conversion_test.go
+//
+//nolint:thelper
+func validateComponent(t *testing.T, actual, expected resource.Config) {


this is the same function as in proto_conversion_test.go

unsure if theres a good spot to put this function to use it in both spots, or if its fine to leave here

randhid

Looks good with a few nits. I think we use pointers when we want to return structs very fast, check with Nick S if that return type should be changed to just an array of resource.Configs rather than an array of pointers.

services/discovery/discovery.go

services/discovery/server.go

services/discovery/discovery.go

randhid

A few nits - almost there!

randhid · 2025-01-07T18:55:25Z

testutils/inject/discovery_service.go

+	DiscoverResourcesFunc func(ctx context.Context, extra map[string]any) ([]resource.Config, error)
+	DoFunc                func(ctx context.Context, cmd map[string]interface{}) (map[string]interface{}, error)
+}
+


We also usually have a New function for the injected resource. Maybe this wasn't added to all of the inject utils, but it's good the add to create a new injected service - usually takes a name - here's an example of implementation:

rdk/testutils/inject/base.go

Line 30 in a8263b2

func NewBase(name string) *Base {

randhid · 2025-01-07T18:57:24Z

app/billing_client_test.go

@@ -101,18 +101,22 @@ func usageCostTypeToProto(costType UsageCostType) pb.UsageCostType {
 	case UsageCostTypeUnspecified:
 		return pb.UsageCostType_USAGE_COST_TYPE_UNSPECIFIED
 	case UsageCostTypeDataUpload:
+		//nolint:deprecated,staticcheck


@jr22, heads up, we're adding points here to unblock John's pr so the linter doesn't yell at uss - I see the API pr deprecating these constants was merged yesterday https://github.com/viamrobotics/api/pull/612/files

randhid · 2025-01-07T18:58:24Z

services/discovery/client.go

+	if err != nil {
+		return nil, err
+	}
+	discoveredConfigs := []resource.Config{}


Move this above line 64 so it's closer to where it's populated.

randhid · 2025-01-07T19:01:27Z

services/discovery/client_test.go

+	workingDiscovery := &inject.DiscoveryService{}
+	failingDiscovery := &inject.DiscoveryService{}
+
+	testComponents := []resource.Config{createTestComponent("component-1"), createTestComponent("component-2")}
+
+	workingDiscovery.DiscoverResourcesFunc = func(ctx context.Context, extra map[string]any) ([]resource.Config, error) {
+		return testComponents, nil
+	}
+	failingDiscovery.DiscoverResourcesFunc = func(ctx context.Context, extra map[string]any) ([]resource.Config, error) {
+		return nil, errDiscoverFailed
+	}
+	workingDiscovery.DoFunc = testutils.EchoFunc
+	failingDiscovery.DoFunc = func(
+		ctx context.Context,
+		cmd map[string]interface{},
+	) (
+		map[string]interface{},
+		error,
+	) {
+		return nil, errDoFailed
+	}


I like this organization better because the working service and failing service functions are grouped together - but if you like yours please feel free to leave as is and resolve this comment. Very minor point here as this is a test.

Suggested change

workingDiscovery := &inject.DiscoveryService{}

failingDiscovery := &inject.DiscoveryService{}

testComponents := []resource.Config{createTestComponent("component-1"), createTestComponent("component-2")}

workingDiscovery.DiscoverResourcesFunc = func(ctx context.Context, extra map[string]any) ([]resource.Config, error) {

return testComponents, nil

}

failingDiscovery.DiscoverResourcesFunc = func(ctx context.Context, extra map[string]any) ([]resource.Config, error) {

return nil, errDiscoverFailed

}

workingDiscovery.DoFunc = testutils.EchoFunc

failingDiscovery.DoFunc = func(

ctx context.Context,

cmd map[string]interface{},

) (

map[string]interface{},

error,

) {

return nil, errDoFailed

}

testComponents := []resource.Config{createTestComponent("component-1"), createTestComponent("component-2")}

workingDiscovery := &inject.DiscoveryService{}

workingDiscovery.DiscoverResourcesFunc = func(ctx context.Context, extra map[string]any) ([]resource.Config, error) {

return testComponents, nil

}

workingDiscovery.DoFunc = testutils.EchoFunc

failingDiscovery := &inject.DiscoveryService{}

failingDiscovery.DiscoverResourcesFunc = func(ctx context.Context, extra map[string]any) ([]resource.Config, error) {

return nil, errDiscoverFailed

}

failingDiscovery.DoFunc = func(

ctx context.Context,

cmd map[string]interface{},

) (

map[string]interface{},

error,

) {

return nil, errDoFailed

}

implement initial discover service

c1f2897

viambot added the safe to test This pull request is marked safe to test from a trusted zone label Dec 31, 2024

JohnN193 commented Dec 31, 2024

View reviewed changes

add initial server test

719daa2

viambot added safe to test This pull request is marked safe to test from a trusted zone and removed safe to test This pull request is marked safe to test from a trusted zone labels Dec 31, 2024

add initial client test

584e4a2

viambot added safe to test This pull request is marked safe to test from a trusted zone and removed safe to test This pull request is marked safe to test from a trusted zone labels Jan 3, 2025

add discovery specific tests

e6b230f

viambot added safe to test This pull request is marked safe to test from a trusted zone and removed safe to test This pull request is marked safe to test from a trusted zone labels Jan 3, 2025

lint

fa5359f

viambot added safe to test This pull request is marked safe to test from a trusted zone and removed safe to test This pull request is marked safe to test from a trusted zone labels Jan 3, 2025

JohnN193 commented Jan 3, 2025

View reviewed changes

JohnN193 requested review from randhid and martha-johnston January 3, 2025 20:47

randhid requested changes Jan 3, 2025

View reviewed changes

services/discovery/discovery.go Outdated Show resolved Hide resolved

services/discovery/discovery.go Show resolved Hide resolved

services/discovery/server.go Show resolved Hide resolved

services/discovery/discovery.go Outdated Show resolved Hide resolved

bump api

8cd995d