[TM-1452] Sync database by running one isolated test first.

.github/workflows/pull-request.yml

@@ -18,6 +18,10 @@ jobs:
         with:
           fetch-depth: 0
 
+      - uses: KengoTODA/actions-setup-docker-compose@v1
+        with:
+          version: '2.29.1'
+
       # This enables task distribution via Nx Cloud
       # Run this command as early as possible, before dependencies are installed
       # Learn more at https://nx.dev/ci/reference/nx-cloud-cli#npx-nxcloud-startcirun
@@ -33,10 +37,20 @@ jobs:
 
       - run: NX_CLOUD_DISTRIBUTED_EXECUTION=false npx nx run-many -t lint build
 
-      - uses: KengoTODA/actions-setup-docker-compose@v1
-        with:
-          version: '2.29.1'
-
-      - run: docker-compose up -d
-
-      - run: NX_CLOUD_DISTRIBUTED_EXECUTION=false npx nx run-many -t test --coverage --passWithNoTests
+      - run: |
+          docker-compose build --no-cache
+          docker-compose up -d
+          cat <<- SQL | docker-compose exec -T mariadb mysql -h localhost -u root -proot
+            drop database if exists terramatch_microservices_test;
+            create database terramatch_microservices_test;
+            grant all on terramatch_microservices_test.* to 'wri'@'%';
+          SQL
+          NX_CLOUD_DISTRIBUTED_EXECUTION=false npx nx run-many -t test --projects database
+          NX_CLOUD_DISTRIBUTED_EXECUTION=false npx nx run-many -t test --coverage --passWithNoTests
+
+      # First run just the small database test to get the test database synced to the current schema
+      # in a clean way. For some reason, the `run-many` is necessary here. If this line simply uses
+      # nx test database, the connection to the DB gets cut off before the sync is complete.
+#      - run: NX_CLOUD_DISTRIBUTED_EXECUTION=false npx nx run-many -t test --projects database
+#
+#      - run: NX_CLOUD_DISTRIBUTED_EXECUTION=false npx nx run-many -t test --coverage --passWithNoTests

docker-compose.yml

@@ -13,3 +13,5 @@ services:
       MYSQL_DATABASE: "terramatch_microservices_test"
       MYSQL_USER: "wri"
       MYSQL_PASSWORD: "wri"
+networks:
+  default:

jest.config.ts

@@ -1,5 +1,5 @@
-import { getJestProjectsAsync } from '@nx/jest';
+import { getJestProjectsAsync } from "@nx/jest";
 
 export default async () => ({
-  projects: await getJestProjectsAsync(),
+  projects: await getJestProjectsAsync()
 });

jest.preset.js

@@ -1,4 +1,4 @@
-const nxPreset = require('@nx/jest/preset').default;
+const nxPreset = require("@nx/jest/preset").default;
 
 module.exports = {
   ...nxPreset,
@@ -8,9 +8,9 @@ module.exports = {
       branches: 85,
       functions: 95,
       lines: 95,
-      statements: 95,
+      statements: 95
     }
   },
 
-  setupFilesAfterEnv: ['./setup-jest.ts'],
-}
+  setupFilesAfterEnv: ["./jest/setup-jest.ts"]
+};

jest/setup-jest.ts

@@ -0,0 +1,26 @@
+import { Sequelize } from "sequelize-typescript";
+import { FactoryGirl, SequelizeAdapter } from "factory-girl-ts";
+import * as Entities from "@terramatch-microservices/database/entities";
+
+let sequelize: Sequelize;
+
+beforeAll(async () => {
+  // To create this database, run the ./setup-test-database.sh script.
+  sequelize = new Sequelize({
+    dialect: "mariadb",
+    host: "localhost",
+    port: 3360,
+    username: "wri",
+    password: "wri",
+    database: "terramatch_microservices_test",
+    models: Object.values(Entities),
+    logging: false
+  });
+
+  await sequelize.sync();
+  FactoryGirl.setAdapter(new SequelizeAdapter());
+});
+
+afterAll(async () => {
+  await sequelize.close();
+});

libs/common/src/lib/policies/user.policy.spec.ts

@@ -1,15 +1,16 @@
-import { Test, TestingModule } from '@nestjs/testing';
-import { PolicyService } from './policy.service';
-import { mockPermissions, mockUserId } from './policy.service.spec';
-import { User } from '@terramatch-microservices/database/entities';
-import { UnauthorizedException } from '@nestjs/common';
+import { Test, TestingModule } from "@nestjs/testing";
+import { PolicyService } from "./policy.service";
+import { mockPermissions, mockUserId } from "./policy.service.spec";
+import { User } from "@terramatch-microservices/database/entities";
+import { UnauthorizedException } from "@nestjs/common";
+import { UserFactory } from "@terramatch-microservices/database/factories";
 
-describe('UserPolicy', () => {
+describe("UserPolicy", () => {
   let service: PolicyService;
 
   beforeEach(async () => {
     const module: TestingModule = await Test.createTestingModule({
-      providers: [PolicyService],
+      providers: [PolicyService]
     }).compile();
 
     service = module.get<PolicyService>(PolicyService);
@@ -19,21 +20,21 @@ describe('UserPolicy', () => {
     jest.restoreAllMocks();
   });
 
-  it('allows reading any user as admin', async () => {
+  it("allows reading any user as admin", async () => {
     mockUserId(123);
-    mockPermissions('users-manage');
-    await expect(service.authorize('read', new User())).resolves.toBeUndefined();
-  })
+    mockPermissions("users-manage");
+    await expect(service.authorize("read", new User())).resolves.toBeUndefined();
+  });
 
-  it('disallows reading other users as non-admin', async () => {
+  it("disallows reading other users as non-admin", async () => {
     mockUserId(123);
     mockPermissions();
-    await expect(service.authorize('read', new User())).rejects.toThrow(UnauthorizedException);
-  })
+    await expect(service.authorize("read", new User())).rejects.toThrow(UnauthorizedException);
+  });
 
-  it('allows reading own user as non-admin', async () => {
+  it("allows reading own user as non-admin", async () => {
     mockUserId(123);
     mockPermissions();
-    await expect(service.authorize('read', new User({ id: 123 }))).resolves.toBeUndefined();
-  })
+    await expect(service.authorize("read", await UserFactory.build({ id: 123 }))).resolves.toBeUndefined();
+  });
 });

libs/database/jest.config.ts

@@ -1,11 +1,19 @@
 /* eslint-disable */
 export default {
-  displayName: 'database',
-  preset: '../../jest.preset.js',
-  testEnvironment: 'node',
+  displayName: "database",
+  preset: "../../jest.preset.js",
+  testEnvironment: "node",
   transform: {
-    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+    "^.+\\.[tj]s$": ["ts-jest", { tsconfig: "<rootDir>/tsconfig.spec.json" }]
   },
-  moduleFileExtensions: ['ts', 'js', 'html'],
-  coverageDirectory: '../../coverage/libs/database',
+  moduleFileExtensions: ["ts", "js", "html"],
+  coverageDirectory: "../../coverage/libs/database",
+  coverageThreshold: {
+    global: {
+      branches: 0,
+      functions: 0,
+      lines: 0,
+      statements: 0
+    }
+  }
 };

libs/database/src/lib/database.module.spec.ts

@@ -0,0 +1,9 @@
+import * as Entities from "./entities";
+
+describe("DatabaseModule", () => {
+  it("Successfully syncs the database schema", async () => {
+    for (const Entity of Object.values(Entities)) {
+      await expect(Entity.sequelize?.getQueryInterface().tableExists(Entity.tableName)).resolves.toBe(true);
+    }
+  });
+});

libs/database/src/lib/entities/delayed-job.entity.ts

@@ -1,17 +1,8 @@
-import {
-  AllowNull,
-  AutoIncrement,
-  Column,
-  Default,
-  Index,
-  Model,
-  PrimaryKey,
-  Table,
-} from 'sequelize-typescript';
-import { BIGINT, INTEGER, JSON, STRING, UUID } from 'sequelize';
+import { AllowNull, AutoIncrement, Column, Default, Index, Model, PrimaryKey, Table } from "sequelize-typescript";
+import { BIGINT, INTEGER, JSON, STRING, UUID } from "sequelize";
 
-@Table({ tableName: 'delayed_jobs', underscored: true })
-export class DelayedJob extends Model {
+@Table({ tableName: "delayed_jobs", underscored: true })
+export class DelayedJob extends Model<DelayedJob> {
   @PrimaryKey
   @AutoIncrement
   @Column(BIGINT.UNSIGNED)
@@ -21,7 +12,7 @@ export class DelayedJob extends Model {
   @Column(UUID)
   uuid: string;
 
-  @Default('pending')
+  @Default("pending")
   @Column(STRING)
   status: string;
 

libs/database/src/lib/entities/framework-user.entity.ts

@@ -1,10 +1,10 @@
-import { AutoIncrement, Column, ForeignKey, Model, PrimaryKey, Table } from 'sequelize-typescript';
-import { BIGINT } from 'sequelize';
-import { Framework } from './framework.entity';
-import { User } from './user.entity';
+import { AutoIncrement, Column, ForeignKey, Model, PrimaryKey, Table } from "sequelize-typescript";
+import { BIGINT } from "sequelize";
+import { Framework } from "./framework.entity";
+import { User } from "./user.entity";
 
-@Table({ tableName: 'framework_user', underscored: true })
-export class FrameworkUser extends Model {
+@Table({ tableName: "framework_user", underscored: true })
+export class FrameworkUser extends Model<FrameworkUser> {
   @PrimaryKey
   @AutoIncrement
   @Column(BIGINT.UNSIGNED)

libs/database/src/lib/entities/framework.entity.ts

@@ -1,9 +1,9 @@
-import { AutoIncrement, Column, Model, PrimaryKey, Table } from 'sequelize-typescript';
-import { BIGINT, STRING } from 'sequelize';
+import { AutoIncrement, Column, Model, PrimaryKey, Table } from "sequelize-typescript";
+import { BIGINT, STRING } from "sequelize";
 
 // A quick stub to get the information needed for users/me
-@Table({ tableName: 'frameworks', underscored: true })
-export class Framework extends Model {
+@Table({ tableName: "frameworks", underscored: true })
+export class Framework extends Model<Framework> {
   @PrimaryKey
   @AutoIncrement
   @Column(BIGINT.UNSIGNED)

libs/database/src/lib/entities/indicator-output-field-monitoring.entity.ts

@@ -4,7 +4,7 @@ import { SitePolygon } from "./site-polygon.entity";
 import { INDICATOR_SLUGS, IndicatorSlug } from "../constants";
 
 @Table({ tableName: "indicator_output_field_monitoring", underscored: true, paranoid: true })
-export class IndicatorOutputFieldMonitoring extends Model {
+export class IndicatorOutputFieldMonitoring extends Model<IndicatorOutputFieldMonitoring> {
   @PrimaryKey
   @AutoIncrement
   @Column(BIGINT.UNSIGNED)

libs/database/src/lib/entities/indicator-output-hectares.entity.ts

@@ -4,7 +4,7 @@ import { SitePolygon } from "./site-polygon.entity";
 import { INDICATOR_SLUGS, IndicatorSlug } from "../constants";
 
 @Table({ tableName: "indicator_output_hectares", underscored: true, paranoid: true })
-export class IndicatorOutputHectares extends Model {
+export class IndicatorOutputHectares extends Model<IndicatorOutputHectares> {
   @PrimaryKey
   @AutoIncrement
   @Column(BIGINT.UNSIGNED)

libs/database/src/lib/entities/indicator-output-msu-carbon.entity.ts

@@ -4,7 +4,7 @@ import { SitePolygon } from "./site-polygon.entity";
 import { INDICATOR_SLUGS, IndicatorSlug } from "../constants";
 
 @Table({ tableName: "indicator_output_msu_carbon", underscored: true, paranoid: true })
-export class IndicatorOutputMsuCarbon extends Model {
+export class IndicatorOutputMsuCarbon extends Model<IndicatorOutputMsuCarbon> {
   @PrimaryKey
   @AutoIncrement
   @Column(BIGINT.UNSIGNED)

libs/database/src/lib/entities/indicator-output-tree-count.entity.ts

@@ -4,7 +4,7 @@ import { SitePolygon } from "./site-polygon.entity";
 import { INDICATOR_SLUGS, IndicatorSlug } from "../constants";
 
 @Table({ tableName: "indicator_output_tree_count", underscored: true, paranoid: true })
-export class IndicatorOutputTreeCount extends Model {
+export class IndicatorOutputTreeCount extends Model<IndicatorOutputTreeCount> {
   @PrimaryKey
   @AutoIncrement
   @Column(BIGINT.UNSIGNED)

libs/database/src/lib/entities/indicator-output-tree-cover-loss.entity.ts

@@ -4,7 +4,7 @@ import { SitePolygon } from "./site-polygon.entity";
 import { INDICATOR_SLUGS, IndicatorSlug } from "../constants";
 
 @Table({ tableName: "indicator_output_tree_cover_loss", underscored: true, paranoid: true })
-export class IndicatorOutputTreeCoverLoss extends Model {
+export class IndicatorOutputTreeCoverLoss extends Model<IndicatorOutputTreeCoverLoss> {
   @PrimaryKey
   @AutoIncrement
   @Column(BIGINT.UNSIGNED)

libs/database/src/lib/entities/indicator-output-tree-cover.entity.ts

@@ -4,7 +4,7 @@ import { SitePolygon } from "./site-polygon.entity";
 import { INDICATOR_SLUGS, IndicatorSlug } from "../constants";
 
 @Table({ tableName: "indicator_output_tree_cover", underscored: true, paranoid: true })
-export class IndicatorOutputTreeCover extends Model {
+export class IndicatorOutputTreeCover extends Model<IndicatorOutputTreeCover> {
   @PrimaryKey
   @AutoIncrement
   @Column(BIGINT.UNSIGNED)

libs/database/src/lib/entities/model-has-role.entity.ts

@@ -1,9 +1,9 @@
-import { Column, ForeignKey, Model, Table } from 'sequelize-typescript';
-import { Role } from './role.entity';
-import { BIGINT, STRING } from 'sequelize';
+import { Column, ForeignKey, Model, Table } from "sequelize-typescript";
+import { Role } from "./role.entity";
+import { BIGINT, STRING } from "sequelize";
 
-@Table({ tableName: 'model_has_roles', underscored: true, timestamps: false })
-export class ModelHasRole extends Model {
+@Table({ tableName: "model_has_roles", underscored: true, timestamps: false })
+export class ModelHasRole extends Model<ModelHasRole> {
   @ForeignKey(() => Role)
   @Column({ type: BIGINT.UNSIGNED, primaryKey: true })
   roleId: number;

libs/database/src/lib/entities/organisation-user.entity.ts

@@ -1,10 +1,10 @@
-import { AutoIncrement, Column, ForeignKey, Model, PrimaryKey, Table } from 'sequelize-typescript';
-import { BIGINT, STRING } from 'sequelize';
-import { Organisation } from './organisation.entity';
-import { User } from './user.entity';
+import { AutoIncrement, Column, ForeignKey, Model, PrimaryKey, Table } from "sequelize-typescript";
+import { BIGINT, STRING } from "sequelize";
+import { Organisation } from "./organisation.entity";
+import { User } from "./user.entity";
 
-@Table({ tableName: 'organisation_user', underscored: true, timestamps: false })
-export class OrganisationUser extends Model {
+@Table({ tableName: "organisation_user", underscored: true, timestamps: false })
+export class OrganisationUser extends Model<OrganisationUser> {
   @PrimaryKey
   @AutoIncrement
   @Column(BIGINT.UNSIGNED)

libs/database/src/lib/entities/organisation.entity.ts

@@ -2,7 +2,7 @@ import { AllowNull, AutoIncrement, Column, Default, Index, Model, PrimaryKey, Ta
 import { BIGINT, BOOLEAN, DATE, DECIMAL, ENUM, INTEGER, STRING, TEXT, TINYINT, UUID } from "sequelize";
 
 @Table({ tableName: "organisations", underscored: true })
-export class Organisation extends Model {
+export class Organisation extends Model<Organisation> {
   @PrimaryKey
   @AutoIncrement
   @Column(BIGINT.UNSIGNED)

libs/database/src/lib/entities/permission.entity.ts

@@ -1,8 +1,8 @@
-import { AutoIncrement, Column, Model, PrimaryKey, Table } from 'sequelize-typescript';
-import { BIGINT, QueryTypes, STRING } from 'sequelize';
+import { AutoIncrement, Column, Model, PrimaryKey, Table } from "sequelize-typescript";
+import { BIGINT, QueryTypes, STRING } from "sequelize";
 
-@Table({ tableName: 'permissions', underscored: true })
-export class Permission extends Model {
+@Table({ tableName: "permissions", underscored: true })
+export class Permission extends Model<Permission> {
   @PrimaryKey
   @AutoIncrement
   @Column(BIGINT.UNSIGNED)
@@ -35,8 +35,8 @@ export class Permission extends Model {
             model_has_roles.model_id = :modelId
     `,
       {
-        replacements: { modelType: 'App\\Models\\V2\\User', modelId: userId },
-        type: QueryTypes.SELECT,
+        replacements: { modelType: "App\\Models\\V2\\User", modelId: userId },
+        type: QueryTypes.SELECT
       }
     )) as { name: string }[];
 

libs/database/src/lib/entities/point-geometry.entity.ts

@@ -4,7 +4,7 @@ import { Point } from "geojson";
 import { User } from "./user.entity";
 
 @Table({ tableName: "point_geometry", underscored: true, paranoid: true })
-export class PointGeometry extends Model {
+export class PointGeometry extends Model<PointGeometry> {
   @PrimaryKey
   @AutoIncrement
   @Column(BIGINT.UNSIGNED)

libs/database/src/lib/entities/polygon-geometry.entity.ts

@@ -4,7 +4,7 @@ import { Polygon } from "geojson";
 import { User } from "./user.entity";
 
 @Table({ tableName: "polygon_geometry", underscored: true, paranoid: true })
-export class PolygonGeometry extends Model {
+export class PolygonGeometry extends Model<PolygonGeometry> {
   @PrimaryKey
   @AutoIncrement
   @Column(BIGINT.UNSIGNED)