Add unit test to keep fake db clean

Emyrk · Emyrk · commit 21683d25cc37 · 2022-06-10T10:34:52.000-05:00
diff --git a/coderd/database/databasefake/databasefake.go b/coderd/database/databasefake/databasefake.go
@@ -958,25 +958,6 @@ func (q *fakeQuerier) GetParameterValueByScopeAndName(_ context.Context, arg dat
 	return database.ParameterValue{}, sql.ErrNoRows
 }
 
-func (q *fakeQuerier) GetTemplatesByIDs(_ context.Context, ids []uuid.UUID) ([]database.Template, error) {
-	q.mutex.RLock()
-	defer q.mutex.RUnlock()
-
-	templates := make([]database.Template, 0)
-	for _, template := range q.templates {
-		for _, id := range ids {
-			if template.ID.String() != id.String() {
-				continue
-			}
-			templates = append(templates, template)
-		}
-	}
-	if len(templates) == 0 {
-		return nil, sql.ErrNoRows
-	}
-	return templates, nil
-}
-
 func (q *fakeQuerier) GetOrganizationMemberByUserID(_ context.Context, arg database.GetOrganizationMemberByUserIDParams) (database.OrganizationMember, error) {
 	q.mutex.RLock()
 	defer q.mutex.RUnlock()
diff --git a/coderd/database/databasefake/databasefake_test.go b/coderd/database/databasefake/databasefake_test.go
@@ -0,0 +1,59 @@
+package databasefake_test
+
+import (
+	"fmt"
+	"reflect"
+	"testing"
+
+	"github.com/coder/coder/coderd/database"
+
+	"github.com/coder/coder/coderd/database/databasefake"
+)
+
+// TestExactMethods will ensure the fake database does not hold onto excessive
+// functions. The fake database is a manual implementation, so it is possible
+// we forget to delete functions that we remove. This unit test just ensures
+// we remove the extra methods.
+func TestExactMethods(t *testing.T) {
+	// extraFakeMethods contains the extra allowed methods that are not a part
+	// of the database.Store interface.
+	extraFakeMethods := map[string]string{
+		// Example
+		// "SortFakeLists": "Helper function used",
+	}
+
+	fake := reflect.TypeOf(databasefake.New())
+	fakeMethods := methods(fake)
+
+	store := reflect.TypeOf((*database.Store)(nil)).Elem()
+	storeMethods := methods(store)
+
+	// Store should be a subset
+	for k := range storeMethods {
+		_, ok := fakeMethods[k]
+		if !ok {
+			panic(fmt.Sprintf("This should never happen. FakeDB missing method %s, so doesn't fit the interface", k))
+		}
+		delete(storeMethods, k)
+		delete(fakeMethods, k)
+	}
+
+	for k := range fakeMethods {
+		_, ok := extraFakeMethods[k]
+		if ok {
+			continue
+		}
+		// If you are seeing this error, you have an extra function not required
+		// for the database.Store. If you still want to keep it, add it to
+		// 'extraFakeMethods' to allow it.
+		t.Errorf("Fake method '%s()' is excessive and not needed to fit interface, delete it", k)
+	}
+}
+
+func methods(rt reflect.Type) map[string]bool {
+	methods := make(map[string]bool)
+	for i := 0; i < rt.NumMethod(); i++ {
+		methods[rt.Method(i).Name] = true
+	}
+	return methods
+}
diff --git a/coderd/workspaces.go b/coderd/workspaces.go
@@ -151,7 +151,7 @@ func (api *API) workspaces(rw http.ResponseWriter, r *http.Request) {
 	if filter.OwnerUsername == "me" {
 		if !(filter.OwnerID == uuid.Nil || filter.OwnerID == apiKey.UserID) {
 			httpapi.Write(rw, http.StatusBadRequest, httpapi.Response{
-				Message: fmt.Sprintf("Cannot set both \"me\" in \"owner_name\" and use \"owner_id\"."),
+				Message: "Cannot set both \"me\" in \"owner_name\" and use \"owner_id\".",
 			})
 			return
 		}

Original file line number	Diff line number	Diff line change
`@@ -151,7 +151,7 @@ func (api API) workspaces(rw http.ResponseWriter, r http.Request) {`
`151`	`151`	`if filter.OwnerUsername == "me" {`
`152`	`152`	`if !(filter.OwnerID == uuid.Nil \|\| filter.OwnerID == apiKey.UserID) {`
`153`	`153`	`httpapi.Write(rw, http.StatusBadRequest, httpapi.Response{`
`154`		`- Message: fmt.Sprintf("Cannot set both \"me\" in \"owner_name\" and use \"owner_id\"."),`
	`154`	`+ Message: "Cannot set both \"me\" in \"owner_name\" and use \"owner_id\".",`
`155`	`155`	`})`
`156`	`156`	`return`
`157`	`157`	`}`