Ci: PR workflow integration tests

.github/workflows/pull-request-ci.yml

@@ -9,12 +9,30 @@ on:
       - main
 env:
   project-directory: ./
-  DATABASE_URL: ${{ secrets.DATABASE_URL }}
+  DATABASE_URL: postgresql://postgres:postgres@postgres/postgres
 
 jobs:
   test:
     name: Run all tests
     runs-on: ubuntu-latest
+    container: node:16.12.0
+
+    # Service containers to run with `container-job`
+    services:
+      # Label used to access the service container
+      postgres:
+        # Docker Hub image
+        image: postgis/postgis:11-2.5-alpine
+        # Provide the password for postgres
+        env:
+          POSTGRES_PASSWORD: postgres
+        # Set health checks to wait until postgres has started
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js 16.x
@@ -23,13 +41,28 @@ jobs:
           node-version: '16.x'
 
       - name: npm clean install
-        run: npm ci
+        run: npm ci --ignore-scripts
 
       - name: Typescript compiles
         run: npm run build
 
       - name: Eslint
         run: npm run lint
 
-      - name: run tests
+      - name: install psql
+        run: |
+          apt-get update
+          apt-get install --yes --no-install-recommends postgresql-client
+
+      - name: Prepare DB
+        run: |
+          psql postgresql://postgres:postgres@postgres/postgres < database/schemas/public.sql
+          psql postgresql://postgres:postgres@postgres/postgres < database/schemas/wallet.sql
+
+      - name: Unit Tests
         run: npm test
+
+      - name: Integration Tests
+        run: npm run test-e2e
+        env:
+          SEED: true

.jest/globalSetup.ts

@@ -1,3 +1,32 @@
 import * as dotenv from 'dotenv';
 dotenv.config();
-export default function globalSetup() {}
+import 'tsconfig-paths/register';
+import tree from '@seeds/data/tree.json';
+import wallet from '@seeds/data/wallet.json';
+import species from '@seeds/data/species.json';
+import planter from '@seeds/data/planter.json';
+import country from '@seeds/data/country.json';
+import organization from '@seeds/data/organization.json';
+import token from '@seeds/data/token.json';
+import regionType from '@seeds/data/region_type.json';
+import knex, {
+  PublicTables,
+  SchemaNames,
+  WalletTables,
+} from 'infra/database/knex';
+
+export default async function globalSetup() {
+  if (process.env.SEED === 'true') {
+    await knex(PublicTables.Trees).insert(tree);
+    await knex(WalletTables.Wallet)
+      .withSchema(SchemaNames.Wallet)
+      .insert(wallet);
+    await knex(WalletTables.Token).withSchema(SchemaNames.Wallet).insert(token);
+    await knex(PublicTables.Species).insert(species);
+    await knex(PublicTables.Organizations).insert(organization);
+    await knex(PublicTables.Planters).insert(planter);
+    await knex(PublicTables.RegionType).insert(regionType);
+    await knex(PublicTables.Countries).insert(country);
+  }
+  knex.destroy();
+}

__tests__/e2e/countries.spec.ts

@@ -1,61 +1,75 @@
+import exampleCountry from '@seeds/data/country.json';
 import supertest from 'supertest';
-import app from '../../server/app';
+import app from 'app';
 
-describe('', () => {
-  it('countries/6632544', async () => {
-    const response = await supertest(app).get('/countries/6632544');
-    expect(response.status).toBe(200);
-    expect(response.body).toMatchObject({
-      id: 6632544,
-      name: 'China',
-    });
+it('countries/6632544', async () => {
+  const response = await supertest(app).get(`/countries/${exampleCountry.id}`);
+  expect(response.status).toBe(200);
+  expect(response.body).toMatchObject({
+    id: 6632544,
+    name: 'China',
   });
+});
 
-  // 103.819073145824,36.5617653792527
-  it('countries?lat=36.5617653792527&lon=103.819073145824', async () => {
-    const response = await supertest(app).get(
-      '/countries?lat=36.5617653792527&lon=103.819073145824',
-    );
+// 103.819073145824,36.5617653792527
+it('countries?lat=36.5617653792527&lon=103.819073145824', async () => {
+  const response = await supertest(app).get(
+    '/countries?lat=36.5617653792527&lon=103.819073145824',
+  );
+  expect(response.status).toBe(200);
+  expect(response.body.countries[0]).toMatchObject({
+    id: 6632544,
+    name: 'China',
+  });
+});
+
+it.skip(
+  'countries/leaderboard',
+  async () => {
+    const response = await supertest(app).get('/countries/leaderboard');
     expect(response.status).toBe(200);
     expect(response.body.countries[0]).toMatchObject({
-      id: 6632544,
-      name: 'China',
+      id: expect.any(Number),
+      name: expect.any(String),
+      planted: expect.any(String),
+      centroid: expect.stringMatching(/coordinates/),
     });
+  },
+  1000 * 60,
+);
+
+it('countries/v2/6632544', async () => {
+  const response = await supertest(app).get('/countries/v2/6632544');
+  expect(response.status).toBe(200);
+  expect(response.body).toMatchObject({
+    id: 6632544,
+    name: 'China',
   });
+});
 
-  it('countries/v2/6632544', async () => {
-    const response = await supertest(app).get('/countries/v2/6632544');
-    expect(response.status).toBe(200);
-    expect(response.body).toMatchObject({
-      id: 6632544,
-      name: 'China',
-    });
+// 103.819073145824,36.5617653792527
+it('countries/v2/?lat=36.5617653792527&lon=103.819073145824', async () => {
+  const response = await supertest(app).get(
+    '/countries/v2/?lat=36.5617653792527&lon=103.819073145824',
+  );
+  expect(response.status).toBe(200);
+  expect(response.body.countries[0]).toMatchObject({
+    id: 6632544,
+    name: 'China',
   });
+});
 
-  // 103.819073145824,36.5617653792527
-  it('countries/v2/?lat=36.5617653792527&lon=103.819073145824', async () => {
-    const response = await supertest(app).get(
-      '/countries/v2/?lat=36.5617653792527&lon=103.819073145824',
-    );
+it(
+  'countries/leaderboard',
+  async () => {
+    const response = await supertest(app).get('/countries/leaderboard');
     expect(response.status).toBe(200);
     expect(response.body.countries[0]).toMatchObject({
-      id: 6632544,
-      name: 'China',
+      id: expect.any(Number),
+      name: expect.any(String),
+      planted: expect.any(String),
+      centroid: expect.stringMatching(/coordinates/),
     });
-  });
-
-  it(
-    'countries/leaderboard',
-    async () => {
-      const response = await supertest(app).get('/countries/leaderboard');
-      expect(response.status).toBe(200);
-      expect(response.body.countries[0]).toMatchObject({
-        id: expect.any(Number),
-        name: expect.any(String),
-        planted: expect.any(String),
-        centroid: expect.stringMatching(/coordinates/),
-      });
-    },
-    1000 * 60,
-  );
-});
+  },
+  1000 * 60,
+);

__tests__/e2e/organizations.spec.ts

@@ -1,37 +1,39 @@
+import exampleOrganization from '@seeds/data/organization.json';
+import examplePlanter from '@seeds/data/planter.json';
 import supertest from 'supertest';
-import app from '../../server/app';
+import app from 'app';
 
-describe('organizations', () => {
-  it('organizations/{id}', async () => {
-    const response = await supertest(app).get('/organizations/1');
+it('organizations/{id}', async () => {
+  const response = await supertest(app).get(
+    `/organizations/${exampleOrganization.id}`,
+  );
+  expect(response.status).toBe(200);
+  expect(response.body).toMatchObject({
+    id: exampleOrganization.id,
+    links: {
+      featured_trees: expect.stringMatching(/trees/),
+      associated_planters: expect.stringMatching(/planters/),
+      species: expect.stringMatching(/species/),
+    },
+  });
+});
+
+it(
+  'organizations?planter_id=1&limit=1',
+  async () => {
+    const response = await supertest(app).get(
+      `/organizations?planter_id=${examplePlanter.id}&limit=1`,
+    );
     expect(response.status).toBe(200);
-    expect(response.body).toMatchObject({
-      id: 1,
+    expect(response.body.organizations).toBeInstanceOf(Array);
+    expect(response.body.organizations[0]).toMatchObject({
+      id: expect.any(Number),
       links: {
         featured_trees: expect.stringMatching(/trees/),
         associated_planters: expect.stringMatching(/planters/),
         species: expect.stringMatching(/species/),
       },
     });
-  });
-
-  it(
-    'organizations?planter_id=1&limit=1',
-    async () => {
-      const response = await supertest(app).get(
-        '/organizations?planter_id=1&limit=1',
-      );
-      expect(response.status).toBe(200);
-      expect(response.body.organizations).toBeInstanceOf(Array);
-      expect(response.body.organizations[0]).toMatchObject({
-        id: expect.any(Number),
-        links: {
-          featured_trees: expect.stringMatching(/trees/),
-          associated_planters: expect.stringMatching(/planters/),
-          species: expect.stringMatching(/species/),
-        },
-      });
-    },
-    1000 * 30,
-  );
-});
+  },
+  1000 * 30,
+);

__tests__/e2e/planters.spec.ts

@@ -1,49 +1,55 @@
+import exampleOrganization from '@seeds/data/organization.json';
+import examplePlanter from '@seeds/data/planter.json';
 import supertest from 'supertest';
-import app from '../../server/app';
+import app from 'app';
 
-describe('planters', () => {
-  it('planters/{id}', async () => {
-    const response = await supertest(app).get('/planters/1');
+it('planters/{id}', async () => {
+  const response = await supertest(app).get(`/planters/${examplePlanter.id}`);
+  expect(response.status).toBe(200);
+  expect(response.body).toMatchObject({
+    id: examplePlanter.id,
+    links: {
+      featured_trees: expect.stringMatching(/trees/),
+      associated_organizations: expect.stringMatching(/organizations/),
+      species: expect.stringMatching(/species/),
+    },
+  });
+});
+
+// route is bugged: https://github.com/Greenstand/treetracker-query-api/issues/93
+it.skip(
+  'planters?organization_id=1&limit=1',
+  async () => {
+    const response = await supertest(app).get(
+      `/planters?organization_id=${exampleOrganization.id}&limit=1`,
+    );
     expect(response.status).toBe(200);
-    expect(response.body).toMatchObject({
-      id: 1,
+    expect(response.body.planters).toBeInstanceOf(Array);
+    console.log(response.body.planters[0]);
+    expect(response.body.planters[0]).toMatchObject({
+      id: examplePlanter.id,
+      organization_id: exampleOrganization.id,
       links: {
         featured_trees: expect.stringMatching(/trees/),
         associated_organizations: expect.stringMatching(/organizations/),
         species: expect.stringMatching(/species/),
       },
     });
-  });
+  },
+  1000 * 30,
+);
 
-  it(
-    'planters?organization_id=1&limit=1',
-    async () => {
-      const response = await supertest(app).get(
-        '/planters?organization_id=1&limit=1',
-      );
-      expect(response.status).toBe(200);
-      expect(response.body.planters).toBeInstanceOf(Array);
-      expect(response.body.planters[0]).toMatchObject({
-        id: 1,
-        organization_id: 1,
-        links: {
-          featured_trees: expect.stringMatching(/trees/),
-          associated_organizations: expect.stringMatching(/organizations/),
-          species: expect.stringMatching(/species/),
-        },
-      });
-    },
-    1000 * 30,
+it('planters?keyword=da&limit=1', async () => {
+  const keyword = examplePlanter.first_name.slice(0, 2);
+  const response = await supertest(app).get(
+    `/planters?keyword=${keyword}&limit=1`,
   );
-
-  it('planters?keyword=da&limit=1', async () => {
-    const response = await supertest(app).get('/planters?keyword=da&limit=1');
-    expect(response.status).toBe(200);
-    expect(response.body.planters).toBeInstanceOf(Array);
-    expect(response.body.planters.length <= 1).toBe(true);
-    expect(
-      /^da/.test(response.body.planters[0].first_name) ||
-        /^da/.test(response.body.planters[0].last_name),
-    ).toBe(true);
-  });
+  expect(response.status).toBe(200);
+  expect(response.body.planters).toBeInstanceOf(Array);
+  expect(response.body.planters.length <= 1).toBe(true);
+  const regexp = RegExp(`^${keyword}`);
+  expect(
+    regexp.test(response.body.planters[0].first_name) ||
+      regexp.test(response.body.planters[0].last_name),
+  ).toBe(true);
 });