Service Testing and GitHub Testing Action Workflow

.env.example

@@ -1,5 +1,6 @@
 DATABASE_HOST=localhost
 DATABASE_PORT=5432
 DATABASE_NAME=securing-safe-food
+DATABASE_NAME_TEST=securing-safe-food-test
 DATABASE_USERNAME=postgres
 DATABASE_PASSWORD=PLACEHOLDER_PASSWORD

.github/workflows/backend-tests.yml

@@ -0,0 +1,30 @@
+on: [push, pull_request]
+
+jobs:
+  backend-tests:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:15
+        env:
+          POSTGRES_DB: securing-safe-food-test
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+        ports:
+          - 5432:5432
+    env:
+      DATABASE_HOST: 127.0.0.1
+      DATABASE_PORT: 5432
+      DATABASE_NAME_TEST: securing-safe-food-test
+      DATABASE_USERNAME: postgres
+      DATABASE_PASSWORD: postgres
+      NX_DAEMON: 'false'
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: yarn install
+      - run: yarn test
+
+

apps/backend/README.md

@@ -25,4 +25,12 @@ You can check that your database connection details are correct by running `nx s
 "LOG 🚀 Application is running on: http://localhost:3000/api"
 ```
 
-Finally, run `yarn run typeorm:migrate` to load all the tables into your database. If everything is set up correctly, you should see "Migration ... has been  executed successfully." in the terminal.
+Finally, run `yarn run typeorm:migrate` to load all the tables into your database. If everything is set up correctly, you should see "Migration ... has been  executed successfully." in the terminal.
+
+### Running backend tests
+
+1. Create a **separate** Postgres database (for example `securing-safe-food-test`).
+2. Add a `DATABASE_NAME_TEST` entry (and optionally `DATABASE_HOST/PORT/USERNAME/PASSWORD`) to your `.env` so the test data source can connect to that database.
+3. Run the backend test suite with `npx jest`.
+
+Each spec builds up the database and tables, tears it all down, and runs all the migrations on each tests. This ensures that we always have the most up to date data that we test with.

apps/backend/src/config/migrations.ts

@@ -0,0 +1,59 @@
+import { User1725726359198 } from '../migrations/1725726359198-User';
+import { AddTables1726524792261 } from '../migrations/1726524792261-addTables';
+import { ReviseTables1737522923066 } from '../migrations/1737522923066-reviseTables';
+import { UpdateUserRole1737816745912 } from '../migrations/1737816745912-UpdateUserRole';
+import { UpdatePantriesTable1737906317154 } from '../migrations/1737906317154-updatePantriesTable';
+import { UpdateDonations1738697216020 } from '../migrations/1738697216020-updateDonations';
+import { UpdateDonationColTypes1741708808976 } from '../migrations/1741708808976-UpdateDonationColTypes';
+import { UpdatePantriesTable1738172265266 } from '../migrations/1738172265266-updatePantriesTable';
+import { UpdatePantriesTable1739056029076 } from '../migrations/1739056029076-updatePantriesTable';
+import { AssignmentsPantryIdNotUnique1758384669652 } from '../migrations/1758384669652-AssignmentsPantryIdNotUnique';
+import { UpdateOrdersTable1740367964915 } from '../migrations/1740367964915-updateOrdersTable';
+import { UpdateFoodRequests1744051370129 } from '../migrations/1744051370129-updateFoodRequests';
+import { UpdateRequestTable1741571847063 } from '../migrations/1741571847063-updateRequestTable';
+import { RemoveOrderIdFromRequests1744133526650 } from '../migrations/1744133526650-removeOrderIdFromRequests';
+import { AddOrders1739496585940 } from '../migrations/1739496585940-addOrders';
+import { AddingEnumValues1760538239997 } from '../migrations/1760538239997-AddingEnumValues';
+import { UpdateColsToUseEnumType1760886499863 } from '../migrations/1760886499863-UpdateColsToUseEnumType';
+import { UpdatePantriesTable1742739750279 } from '../migrations/1742739750279-updatePantriesTable';
+import { RemoveOrdersDonationId1761500262238 } from '../migrations/1761500262238-RemoveOrdersDonationId';
+import { AddVolunteerPantryUniqueConstraint1760033134668 } from '../migrations/1760033134668-AddVolunteerPantryUniqueConstraint';
+import { AllergyFriendlyToBoolType1763963056712 } from '../migrations/1763963056712-AllergyFriendlyToBoolType';
+import { UpdatePantryUserFieldsFixed1764350314832 } from '../migrations/1764350314832-UpdatePantryUserFieldsFixed';
+import { RemoveMultipleVolunteerTypes1764811878152 } from '../migrations/1764811878152-RemoveMultipleVolunteerTypes';
+import { RemoveUnusedStatuses1764816885341 } from '../migrations/1764816885341-RemoveUnusedStatuses';
+import { UpdatePantryFields1763762628431 } from '../migrations/1763762628431-UpdatePantryFields';
+import { PopulateDummyData1768501812134 } from '../migrations/1768501812134-populateDummyData';
+import { RemovePantryFromOrders1769316004958 } from '../migrations/1769316004958-RemovePantryFromOrders';
+
+const schemaMigrations = [
+  User1725726359198,
+  AddTables1726524792261,
+  ReviseTables1737522923066,
+  UpdateUserRole1737816745912,
+  UpdatePantriesTable1737906317154,
+  UpdateDonations1738697216020,
+  UpdateDonationColTypes1741708808976,
+  UpdatePantriesTable1738172265266,
+  UpdatePantriesTable1739056029076,
+  AssignmentsPantryIdNotUnique1758384669652,
+  AddOrders1739496585940,
+  UpdateOrdersTable1740367964915,
+  UpdateRequestTable1741571847063,
+  UpdateFoodRequests1744051370129,
+  RemoveOrderIdFromRequests1744133526650,
+  AddingEnumValues1760538239997,
+  UpdateColsToUseEnumType1760886499863,
+  UpdatePantriesTable1742739750279,
+  RemoveOrdersDonationId1761500262238,
+  UpdatePantryFields1763762628431,
+  AddVolunteerPantryUniqueConstraint1760033134668,
+  AllergyFriendlyToBoolType1763963056712,
+  UpdatePantryUserFieldsFixed1764350314832,
+  RemoveMultipleVolunteerTypes1764811878152,
+  RemoveUnusedStatuses1764816885341,
+  PopulateDummyData1768501812134,
+  RemovePantryFromOrders1769316004958,
+];
+
+export default schemaMigrations;

apps/backend/src/config/typeorm.ts

@@ -1,33 +1,7 @@
 import { registerAs } from '@nestjs/config';
 import { PluralNamingStrategy } from '../strategies/plural-naming.strategy';
 import { DataSource, DataSourceOptions } from 'typeorm';
-import { User1725726359198 } from '../migrations/1725726359198-User';
-import { AddTables1726524792261 } from '../migrations/1726524792261-addTables';
-import { ReviseTables1737522923066 } from '../migrations/1737522923066-reviseTables';
-import { UpdateUserRole1737816745912 } from '../migrations/1737816745912-UpdateUserRole';
-import { UpdatePantriesTable1737906317154 } from '../migrations/1737906317154-updatePantriesTable';
-import { UpdateDonations1738697216020 } from '../migrations/1738697216020-updateDonations';
-import { UpdateDonationColTypes1741708808976 } from '../migrations/1741708808976-UpdateDonationColTypes';
-import { UpdatePantriesTable1738172265266 } from '../migrations/1738172265266-updatePantriesTable';
-import { UpdatePantriesTable1739056029076 } from '../migrations/1739056029076-updatePantriesTable';
-import { AssignmentsPantryIdNotUnique1758384669652 } from '../migrations/1758384669652-AssignmentsPantryIdNotUnique';
-import { UpdateOrdersTable1740367964915 } from '../migrations/1740367964915-updateOrdersTable';
-import { UpdateFoodRequests1744051370129 } from '../migrations/1744051370129-updateFoodRequests';
-import { UpdateRequestTable1741571847063 } from '../migrations/1741571847063-updateRequestTable';
-import { RemoveOrderIdFromRequests1744133526650 } from '../migrations/1744133526650-removeOrderIdFromRequests';
-import { AddOrders1739496585940 } from '../migrations/1739496585940-addOrders';
-import { AddingEnumValues1760538239997 } from '../migrations/1760538239997-AddingEnumValues';
-import { UpdateColsToUseEnumType1760886499863 } from '../migrations/1760886499863-UpdateColsToUseEnumType';
-import { UpdatePantriesTable1742739750279 } from '../migrations/1742739750279-updatePantriesTable';
-import { RemoveOrdersDonationId1761500262238 } from '../migrations/1761500262238-RemoveOrdersDonationId';
-import { AddVolunteerPantryUniqueConstraint1760033134668 } from '../migrations/1760033134668-AddVolunteerPantryUniqueConstraint';
-import { AllergyFriendlyToBoolType1763963056712 } from '../migrations/1763963056712-AllergyFriendlyToBoolType';
-import { UpdatePantryUserFieldsFixed1764350314832 } from '../migrations/1764350314832-UpdatePantryUserFieldsFixed';
-import { RemoveMultipleVolunteerTypes1764811878152 } from '../migrations/1764811878152-RemoveMultipleVolunteerTypes';
-import { RemoveUnusedStatuses1764816885341 } from '../migrations/1764816885341-RemoveUnusedStatuses';
-import { UpdatePantryFields1763762628431 } from '../migrations/1763762628431-UpdatePantryFields';
-import { PopulateDummyData1768501812134 } from '../migrations/1768501812134-populateDummyData';
-import { RemovePantryFromOrders1769316004958 } from '../migrations/1769316004958-RemovePantryFromOrders';
+import schemaMigrations from './migrations';
 
 const config = {
   type: 'postgres',
@@ -39,37 +13,7 @@ const config = {
   autoLoadEntities: true,
   synchronize: false,
   namingStrategy: new PluralNamingStrategy(),
-  // Glob patterns (e.g. ../migrations/**.ts) are deprecated, so we have to manually specify each migration
-  // TODO: see if there's still a way to dynamically load all migrations
-  migrations: [
-    User1725726359198,
-    AddTables1726524792261,
-    ReviseTables1737522923066,
-    UpdateUserRole1737816745912,
-    UpdatePantriesTable1737906317154,
-    UpdateDonations1738697216020,
-    UpdateDonationColTypes1741708808976,
-    UpdatePantriesTable1738172265266,
-    UpdatePantriesTable1739056029076,
-    AssignmentsPantryIdNotUnique1758384669652,
-    AddOrders1739496585940,
-    UpdateOrdersTable1740367964915,
-    UpdateRequestTable1741571847063,
-    UpdateFoodRequests1744051370129,
-    RemoveOrderIdFromRequests1744133526650,
-    AddingEnumValues1760538239997,
-    UpdateColsToUseEnumType1760886499863,
-    UpdatePantriesTable1742739750279,
-    RemoveOrdersDonationId1761500262238,
-    UpdatePantryFields1763762628431,
-    AddVolunteerPantryUniqueConstraint1760033134668,
-    AllergyFriendlyToBoolType1763963056712,
-    UpdatePantryUserFieldsFixed1764350314832,
-    RemoveMultipleVolunteerTypes1764811878152,
-    RemoveUnusedStatuses1764816885341,
-    PopulateDummyData1768501812134,
-    RemovePantryFromOrders1769316004958,
-  ],
+  migrations: [...schemaMigrations],
 };
 
 export default registerAs('typeorm', () => config);

apps/backend/src/config/typeormTestDataSource.ts

@@ -0,0 +1,36 @@
+import 'dotenv/config';
+import { DataSource, DataSourceOptions } from 'typeorm';
+import { PluralNamingStrategy } from '../strategies/plural-naming.strategy';
+import { Order } from '../orders/order.entity';
+import { Pantry } from '../pantries/pantries.entity';
+import { User } from '../users/user.entity';
+import { Donation } from '../donations/donations.entity';
+import { FoodManufacturer } from '../foodManufacturers/manufacturer.entity';
+import { FoodRequest } from '../foodRequests/request.entity';
+import { DonationItem } from '../donationItems/donationItems.entity';
+import { Allocation } from '../allocations/allocations.entity';
+import schemaMigrations from './migrations';
+
+const testConfig: DataSourceOptions = {
+  type: 'postgres',
+  host: process.env.DATABASE_HOST ?? '127.0.0.1',
+  port: process.env.DATABASE_PORT ? parseInt(process.env.DATABASE_PORT) : 5432,
+  database: process.env.DATABASE_NAME_TEST ?? 'securing-safe-food-test',
+  username: process.env.DATABASE_USERNAME ?? 'postgres',
+  password: process.env.DATABASE_PASSWORD ?? 'postgres',
+  synchronize: false,
+  namingStrategy: new PluralNamingStrategy(),
+  entities: [
+    Order,
+    Pantry,
+    User,
+    Donation,
+    FoodManufacturer,
+    FoodRequest,
+    DonationItem,
+    Allocation,
+  ],
+  migrations: schemaMigrations,
+};
+
+export const testDataSource = new DataSource(testConfig);