[server] don't start DB if already running

Author: svenefftinge

components/gitpod-db/src/project-db.spec.db.ts

@@ -4,16 +4,15 @@
  * See License.AGPL.txt in the project root for license information.
  */
 
-import * as chai from "chai";
-const expect = chai.expect;
+import { Project } from "@gitpod/gitpod-protocol";
 import { suite, test } from "@testdeck/mocha";
-import { TypeORM } from "./typeorm/typeorm";
-import { TypeORMUserDBImpl } from "./typeorm/user-db-impl";
+import * as chai from "chai";
 import { testContainer } from "./test-container";
+import { resetDB } from "./test/reset-db";
 import { ProjectDBImpl } from "./typeorm/project-db-impl";
-import { DBProject } from "./typeorm/entity/db-project";
-import { DBUser } from "./typeorm/entity/db-user";
-import { Project } from "@gitpod/gitpod-protocol";
+import { TypeORM } from "./typeorm/typeorm";
+import { TypeORMUserDBImpl } from "./typeorm/user-db-impl";
+const expect = chai.expect;
 
 @suite
 class ProjectDBSpec {
@@ -30,9 +29,7 @@ class ProjectDBSpec {
 
     async wipeRepo() {
         const typeorm = testContainer.get<TypeORM>(TypeORM);
-        const manager = await typeorm.getConnection();
-        await manager.getRepository(DBProject).delete({});
-        await manager.getRepository(DBUser).delete({});
+        await resetDB(typeorm);
     }
 
     @test()

components/gitpod-db/src/team-db.spec.db.ts

@@ -13,11 +13,8 @@ import { testContainer } from "./test-container";
 import { TeamDBImpl } from "./typeorm/team-db-impl";
 import { TypeORMUserDBImpl } from "./typeorm/user-db-impl";
 import { TypeORM } from "./typeorm/typeorm";
-import { DBTeam } from "./typeorm/entity/db-team";
-import { DBTeamMembership } from "./typeorm/entity/db-team-membership";
-import { DBUser } from "./typeorm/entity/db-user";
-import { DBIdentity } from "./typeorm/entity/db-identity";
 import { Connection } from "typeorm";
+import { resetDB } from "./test/reset-db";
 
 @suite
 class TeamDBSpec {
@@ -34,12 +31,7 @@ class TeamDBSpec {
 
     async wipeRepo() {
         const typeorm = testContainer.get<TypeORM>(TypeORM);
-        const manager = await typeorm.getConnection();
-        await manager.getRepository(DBTeam).delete({});
-        await manager.getRepository(DBTeamMembership).delete({});
-        await manager.getRepository(DBUser).delete({});
-        await manager.getRepository(DBIdentity).delete({});
-        await manager.query("delete from d_b_oidc_client_config;");
+        await resetDB(typeorm);
     }
 
     @test(timeout(10000))

components/gitpod-db/src/test/reset-db.ts

@@ -0,0 +1,37 @@
+/**
+ * Copyright (c) 2023 Gitpod GmbH. All rights reserved.
+ * Licensed under the GNU Affero General Public License (AGPL).
+ * See License.AGPL.txt in the project root for license information.
+ */
+
+import { DBGitpodToken } from "../typeorm/entity/db-gitpod-token";
+import { DBIdentity } from "../typeorm/entity/db-identity";
+import { DBOAuthAuthCodeEntry } from "../typeorm/entity/db-oauth-auth-code";
+import { DBOneTimeSecret } from "../typeorm/entity/db-one-time-secret";
+import { DBProject } from "../typeorm/entity/db-project";
+import { DBTeam } from "../typeorm/entity/db-team";
+import { DBTeamMembership } from "../typeorm/entity/db-team-membership";
+import { DBUser } from "../typeorm/entity/db-user";
+import { DBWorkspace } from "../typeorm/entity/db-workspace";
+import { DBWorkspaceInstance } from "../typeorm/entity/db-workspace-instance";
+import { TypeORM } from "../typeorm/typeorm";
+import { isBuiltinUser } from "../user-db";
+
+export async function resetDB(typeorm: TypeORM) {
+    const conn = await typeorm.getConnection();
+    // delete all users except the builtin users
+    const users = await conn.getRepository(DBUser).find();
+    await conn.getRepository(DBUser).remove(users.filter((u) => !isBuiltinUser(u.id)));
+
+    await conn.getRepository(DBTeam).clear();
+    await conn.getRepository(DBTeamMembership).clear();
+    await conn.getRepository(DBProject).clear();
+    await conn.getRepository(DBIdentity).clear();
+    await conn.getRepository(DBWorkspace).clear();
+    await conn.getRepository(DBWorkspaceInstance).clear();
+    await conn.getRepository(DBGitpodToken).clear();
+    await conn.getRepository(DBOAuthAuthCodeEntry).clear();
+    await conn.getRepository(DBOneTimeSecret).clear();
+    // we don't have a typeorm entity for this table
+    await conn.query("DELETE FROM d_b_oidc_client_config;");
+}

components/gitpod-db/src/typeorm/auth-code-repository-db.spec.db.ts

@@ -10,9 +10,9 @@ import { AuthCodeRepositoryDB } from "./auth-code-repository-db";
 import { UserDB } from "../user-db";
 import { DBOAuthAuthCodeEntry } from "./entity/db-oauth-auth-code";
 import { TypeORM } from "./typeorm";
-import { DBUser } from "./entity/db-user";
 import * as chai from "chai";
 import { User } from "@gitpod/gitpod-protocol";
+import { resetDB } from "../test/reset-db";
 const expect = chai.expect;
 
 @suite(timeout(10000))
@@ -30,9 +30,7 @@ export class AuthCodeRepositoryDBSpec {
 
     async wipeRepo() {
         const typeorm = testContainer.get<TypeORM>(TypeORM);
-        const manager = await typeorm.getConnection();
-        await manager.getRepository(DBOAuthAuthCodeEntry).delete({});
-        await manager.getRepository(DBUser).delete({});
+        await resetDB(typeorm);
     }
 
     @test()

components/gitpod-db/src/typeorm/one-time-secret-db-impl.spec.db.ts

@@ -7,10 +7,10 @@
 import { suite, test, timeout } from "@testdeck/mocha";
 import { testContainer } from "../test-container";
 import { TypeORM } from "./typeorm";
-import { DBUser } from "./entity/db-user";
 import * as chai from "chai";
 import { OneTimeSecretDB } from "../one-time-secret-db";
 import { DBOneTimeSecret } from "./entity/db-one-time-secret";
+import { resetDB } from "../test/reset-db";
 const expect = chai.expect;
 
 @suite(timeout(10000))
@@ -27,9 +27,7 @@ export class OneTimeSecretSpec {
 
     async wipeRepo() {
         const typeorm = testContainer.get<TypeORM>(TypeORM);
-        const manager = await typeorm.getConnection();
-        await manager.getRepository(DBOneTimeSecret).delete({});
-        await manager.getRepository(DBUser).delete({});
+        await resetDB(typeorm);
     }
 
     @test()

components/gitpod-db/src/typeorm/team-db-impl.spec.db.ts

@@ -4,15 +4,14 @@
  * See License.AGPL.txt in the project root for license information.
  */
 
+import { ApplicationError, ErrorCodes } from "@gitpod/gitpod-protocol/lib/messaging/error";
 import { suite, test, timeout } from "@testdeck/mocha";
+import * as chai from "chai";
+import { TeamDB } from "../team-db";
 import { testContainer } from "../test-container";
+import { resetDB } from "../test/reset-db";
 import { UserDB } from "../user-db";
 import { TypeORM } from "./typeorm";
-import { DBUser } from "./entity/db-user";
-import * as chai from "chai";
-import { TeamDB } from "../team-db";
-import { DBTeam } from "./entity/db-team";
-import { ErrorCodes, ApplicationError } from "@gitpod/gitpod-protocol/lib/messaging/error";
 const expect = chai.expect;
 
 @suite(timeout(10000))
@@ -30,9 +29,7 @@ export class TeamDBSpec {
 
     async wipeRepo() {
         const typeorm = testContainer.get<TypeORM>(TypeORM);
-        const manager = await typeorm.getConnection();
-        await manager.getRepository(DBTeam).delete({});
-        await manager.getRepository(DBUser).delete({});
+        await resetDB(typeorm);
     }
 
     @test()

components/gitpod-db/src/user-db.spec.db.ts

@@ -14,10 +14,7 @@ import { DBIdentity } from "./typeorm/entity/db-identity";
 import { TypeORMUserDBImpl } from "./typeorm/user-db-impl";
 import { TypeORMWorkspaceDBImpl } from "./typeorm/workspace-db-impl";
 import { TypeORM } from "./typeorm/typeorm";
-import { DBUser } from "./typeorm/entity/db-user";
-import { DBWorkspace } from "./typeorm/entity/db-workspace";
-import { DBWorkspaceInstance } from "./typeorm/entity/db-workspace-instance";
-import { DBGitpodToken } from "./typeorm/entity/db-gitpod-token";
+import { resetDB } from "./test/reset-db";
 
 const _IDENTITY1: Identity = {
     authProviderId: "GitHub",
@@ -55,12 +52,7 @@ class UserDBSpec {
 
     async wipeRepos() {
         const typeorm = testContainer.get<TypeORM>(TypeORM);
-        const mnr = await typeorm.getConnection();
-        await mnr.getRepository(DBUser).delete({});
-        await mnr.getRepository(DBIdentity).delete({});
-        await mnr.getRepository(DBWorkspace).delete({});
-        await mnr.getRepository(DBWorkspaceInstance).delete({});
-        await mnr.getRepository(DBGitpodToken).delete({});
+        await resetDB(typeorm);
     }
 
     // Copy to avoid pollution

components/server/package.json

@@ -21,9 +21,8 @@
     "test:unit": "TS_NODE_FILES=true mocha --opts mocha.opts './**/*.spec.ts' --exclude './node_modules/**'",
     "test:db": "TS_NODE_FILES=true mocha --opts mocha.opts './**/*.spec.db.ts' --exclude './node_modules/**'",
     "start-services": "yarn start-testdb && yarn start-redis && yarn start-spicedb",
-    "stop-services": "yarn stop-testdb && yarn stop-redis && yarn stop-spicedb",
-    "start-testdb": "leeway run components/gitpod-db:init-testdb",
-    "stop-testdb": "docker stop test-mysql || true && docker rm test-mysql || true",
+    "stop-services": "yarn stop-redis && yarn stop-spicedb",
+    "start-testdb": "if netstat -tuln | grep ':23306 '; then echo 'Mysql is already running.'; else leeway run components/gitpod-db:init-testdb; fi",
     "start-spicedb": "leeway run components/spicedb:start-spicedb",
     "stop-spicedb": "leeway run components/spicedb:stop-spicedb",
     "start-redis": "if netstat -tuln | grep ':6379 '; then echo 'Redis is already running.'; else docker run --rm --name test-redis -p 6379:6379 -d redis; fi",

components/server/src/orgs/organization-service.spec.db.ts

@@ -12,9 +12,9 @@ import * as chai from "chai";
 import { Container } from "inversify";
 import "mocha";
 import { expectError } from "../projects/projects-service.spec.db";
-import { resetDB } from "../test/reset-db";
 import { createTestContainer } from "../test/service-testing-container-module";
 import { OrganizationService } from "./organization-service";
+import { resetDB } from "@gitpod/gitpod-db/lib/test/reset-db";
 
 const expect = chai.expect;
 

components/server/src/orgs/usage-service.spec.db.ts

@@ -25,7 +25,7 @@ import { createTestContainer } from "../test/service-testing-container-module";
 import { UserService } from "../user/user-service";
 import { OrganizationService } from "./organization-service";
 import { UsageService } from "./usage-service";
-import { resetDB } from "../test/reset-db";
+import { resetDB } from "@gitpod/gitpod-db/lib/test/reset-db";
 
 const expect = chai.expect;
 

components/server/src/projects/projects-service.spec.db.ts

@@ -15,7 +15,7 @@ import { createTestContainer } from "../test/service-testing-container-module";
 import { ProjectsService } from "./projects-service";
 import { ApplicationError, ErrorCode, ErrorCodes } from "@gitpod/gitpod-protocol/lib/messaging/error";
 import { SpiceDBAuthorizer } from "../authorization/spicedb-authorizer";
-import { resetDB } from "../test/reset-db";
+import { resetDB } from "@gitpod/gitpod-db/lib/test/reset-db";
 
 const expect = chai.expect;
 

components/server/src/test/reset-db.ts

@@ -10,7 +10,7 @@ import { Container } from "inversify";
 import { createTestContainer } from "../test/service-testing-container-module";
 import { UserService } from "./user-service";
 import { TypeORM } from "@gitpod/gitpod-db/lib";
-import { resetDB } from "../test/reset-db";
+import { resetDB } from "@gitpod/gitpod-db/lib/test/reset-db";
 
 const expect = chai.expect;