feat: Provide User with actionable error message when no tables are c…

…onfigured for syncing (#1243)  ---
cloudquery · Sep 22, 2023 · e53d952 · e53d952 · github-actions · Sep 22, 2023
1 parent 41c15cf
commit e53d952
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 6 deletions.
diff --git a/scheduler/scheduler.go b/scheduler/scheduler.go
@@ -31,6 +31,8 @@ const (
 	otelName               = "schedule"
 )
 
+var ErrNoTables = errors.New("no tables specified for syncing, review `tables` and `skip_tables` in your config and specify at least one table to sync")
+
 const (
 	StrategyDFS Strategy = iota
 	StrategyRoundRobin
@@ -219,7 +221,7 @@ func (s *Scheduler) Sync(ctx context.Context, client schema.ClientMeta, tables s
 	ctx, span := otel.Tracer(otelName).Start(ctx, "Sync")
 	defer span.End()
 	if len(tables) == 0 {
-		return nil
+		return ErrNoTables
 	}
 
 	syncClient := &syncClient{

diff --git a/scheduler/scheduler_test.go b/scheduler/scheduler_test.go
@@ -80,6 +80,10 @@ func testTableResolverPanic() *schema.Table {
 	}
 }
 
+func testNoTables() *schema.Table {
+	return nil
+}
+
 func testTablePreResourceResolverPanic() *schema.Table {
 	return &schema.Table{
 		Name:                "test_table_pre_resource_resolver_panic",
@@ -132,6 +136,7 @@ type syncTestCase struct {
 	table             *schema.Table
 	data              []scalar.Vector
 	deterministicCQID bool
+	err               error
 }
 
 var syncTestCases = []syncTestCase{
@@ -152,6 +157,12 @@ var syncTestCases = []syncTestCase{
 		data:  nil,
 	},
 
+	{
+		table: testNoTables(),
+		data:  nil,
+		err:   ErrNoTables,
+	},
+
 	{
 		table: testTableRelationSuccess(),
 		data: []scalar.Vector{
@@ -210,8 +221,12 @@ func TestScheduler(t *testing.T) {
 	for _, strategy := range AllStrategies {
 		for _, tc := range syncTestCases {
 			tc := tc
-			tc.table = tc.table.Copy(nil)
-			t.Run(tc.table.Name+"_"+strategy.String(), func(t *testing.T) {
+			testName := "No table_" + strategy.String()
+			if tc.table != nil {
+				tc.table = tc.table.Copy(nil)
+				testName = tc.table.Name + "_" + strategy.String()
+			}
+			t.Run(testName, func(t *testing.T) {
 				testSyncTable(t, tc, strategy, tc.deterministicCQID)
 			})
 		}
@@ -220,8 +235,9 @@ func TestScheduler(t *testing.T) {
 
 func testSyncTable(t *testing.T, tc syncTestCase, strategy Strategy, deterministicCQID bool) {
 	ctx := context.Background()
-	tables := []*schema.Table{
-		tc.table,
+	tables := []*schema.Table{}
+	if tc.table != nil {
+		tables = append(tables, tc.table)
 	}
 	c := testExecutionClient{}
 	opts := []Option{
@@ -230,7 +246,8 @@ func testSyncTable(t *testing.T, tc syncTestCase, strategy Strategy, determinist
 	}
 	sc := NewScheduler(opts...)
 	msgs := make(chan message.SyncMessage, 10)
-	if err := sc.Sync(ctx, &c, tables, msgs, WithSyncDeterministicCQID(deterministicCQID)); err != nil {
+	err := sc.Sync(ctx, &c, tables, msgs, WithSyncDeterministicCQID(deterministicCQID))
+	if err != tc.err {
 		t.Fatal(err)
 	}
 	close(msgs)