add comments

coder · AbhineetJain · Jun 16, 2022 · Jun 16, 2022 · Jun 16, 2022 · Jun 16, 2022
commit 345d1161f7dbd133b3e81a70ce754f517d8e4ce5
diff --git a/coderd/coderdtest/coderdtest.go b/coderd/coderdtest/coderdtest.go
@@ -79,6 +79,7 @@ func New(t *testing.T, options *Options) *codersdk.Client {
 	return client
 }
 
+// UseSQL returns true if a Postgres server is running and can be used for tests.
 func UseSQL() bool {
 	return os.Getenv("DB") != ""
 }

diff --git a/coderd/database/querier.go b/coderd/database/querier.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/users.sql b/coderd/database/queries/users.sql
@@ -23,6 +23,7 @@ LIMIT
 	1;
 
 -- name: GetActualUserCount :one
+-- Actual user count refers to the count of all users except the system user
 SELECT
 	COUNT(*)
 FROM

diff --git a/coderd/users_test.go b/coderd/users_test.go
@@ -23,7 +23,7 @@ import (
 
 func TestSystemUser(t *testing.T) {
 	if !coderdtest.UseSQL() {
-		t.Skip("There is no point in running this test.")
+		t.Skip("This test asserts that the system user is equivalent in SQL and the fake database.")
 	}
 
 	t.Parallel()
-Original file line number
+Diff line change
@@ Expand Up / @@ -23,6 +23,7 @@ LIMIT @@
 ;
     -- name: GetActualUserCount :one
+    -- Actual user count refers to the count of all users except the system user
     SELECT
     	COUNT(*)
     FROM
@@ Expand Down @@