test: add acceptance-level tests for repository.execute()

acceptance/repository-mongodb/package.json

@@ -24,6 +24,7 @@
     "@loopback/eslint-config": "^9.0.0",
     "@loopback/repository": "^2.11.0",
     "@loopback/repository-tests": "^0.12.11",
+    "@loopback/testlab": "^3.2.2",
     "@types/node": "^10.17.28",
     "loopback-connector-mongodb": "^5.3.0",
     "tslib": "^2.0.1"

acceptance/repository-mongodb/src/__tests__/mongodb-repository-execute.acceptance.ts

@@ -0,0 +1,63 @@
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/test-repository-mongodb
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {
+  DefaultTransactionalRepository,
+  Entity,
+  juggler,
+  model,
+  property,
+} from '@loopback/repository';
+import {expect, toJSON} from '@loopback/testlab';
+import {MONGODB_CONFIG} from './mongodb.datasource';
+
+describe('MongoDB repository.execute()', () => {
+  it('executes a custom MongoDB query', async () => {
+    const db = new juggler.DataSource(MONGODB_CONFIG);
+
+    @model()
+    class Product extends Entity {
+      @property({id: true, generated: true})
+      id: string;
+
+      @property({required: true})
+      name: string;
+
+      @property()
+      owner: string;
+    }
+
+    const repo = new DefaultTransactionalRepository<Product, string, {}>(
+      Product,
+      db,
+    );
+    await db.automigrate(Product.modelName);
+    await repo.create({name: 'Pen', owner: 'bajtos'});
+    await repo.create({name: 'Car', owner: 'admin'});
+    await repo.create({name: 'Chair', owner: 'admin'});
+
+    // MongoDB's aggregate() command returns an AggregationCursor instance
+    const cursor = await repo.execute('Product', 'aggregate', [
+      {
+        $group: {
+          _id: '$owner',
+          count: {$sum: 1},
+        },
+      },
+      {
+        $sort: {
+          _id: 1,
+        },
+      },
+    ]);
+    // Fetch all items from the cursor at once
+    const result = await cursor.toArray();
+
+    expect(toJSON(result)).to.deepEqual([
+      {_id: 'admin', count: 2},
+      {_id: 'bajtos', count: 1},
+    ]);
+  });
+});

acceptance/repository-mongodb/tsconfig.json

@@ -15,6 +15,9 @@
     },
     {
       "path": "../../packages/repository/tsconfig.json"
+    },
+    {
+      "path": "../../packages/testlab/tsconfig.json"
     }
   ]
 }

acceptance/repository-mysql/package.json

@@ -24,6 +24,7 @@
     "@loopback/eslint-config": "^9.0.0",
     "@loopback/repository": "^2.11.0",
     "@loopback/repository-tests": "^0.12.11",
+    "@loopback/testlab": "^3.2.2",
     "@types/node": "^10.17.28",
     "loopback-connector-mysql": "^5.4.4",
     "tslib": "^2.0.1"

acceptance/repository-mysql/src/__tests__/mysql-repository-execute.acceptance.ts

@@ -0,0 +1,43 @@
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/test-repository-mysql
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {
+  DefaultTransactionalRepository,
+  Entity,
+  juggler,
+  model,
+  property,
+} from '@loopback/repository';
+import {expect, toJSON} from '@loopback/testlab';
+import {MYSQL_CONFIG} from './mysql.datasource';
+
+describe('MySQL repository.execute()', () => {
+  it('executes a parameterized native SQL query', async () => {
+    const db = new juggler.DataSource(MYSQL_CONFIG);
+
+    @model()
+    class Product extends Entity {
+      @property({id: true, generated: true})
+      id: number;
+
+      @property({required: true})
+      name: string;
+    }
+
+    const repo = new DefaultTransactionalRepository<Product, number, {}>(
+      Product,
+      db,
+    );
+    await db.automigrate(Product.modelName);
+    const pen = await repo.create({name: 'Pen'});
+    await repo.create({name: 'Car'});
+
+    const result = await repo.execute('SELECT * FROM Product WHERE name = ?', [
+      'Pen',
+    ]);
+
+    expect(toJSON(result)).to.deepEqual([toJSON(pen)]);
+  });
+});

acceptance/repository-mysql/tsconfig.json

@@ -15,6 +15,9 @@
     },
     {
       "path": "../../packages/repository/tsconfig.json"
+    },
+    {
+      "path": "../../packages/testlab/tsconfig.json"
     }
   ]
 }

acceptance/repository-postgresql/package.json

@@ -24,6 +24,7 @@
     "@loopback/eslint-config": "^9.0.0",
     "@loopback/repository": "^2.11.0",
     "@loopback/repository-tests": "^0.12.11",
+    "@loopback/testlab": "^3.2.2",
     "@types/node": "^10.17.28",
     "loopback-connector-postgresql": "^5.0.2",
     "tslib": "^2.0.1"

acceptance/repository-postgresql/setup.sh

@@ -1 +1,2 @@
 source ./node_modules/loopback-connector-postgresql/setup.sh
+export POSTGRESQL_DATABASE=repository_tests

acceptance/repository-postgresql/src/__tests__/postgresql-repository-execute.acceptance.ts

@@ -0,0 +1,45 @@
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/test-repository-postgresql
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {
+  DefaultTransactionalRepository,
+  Entity,
+  juggler,
+  model,
+  property,
+} from '@loopback/repository';
+import {expect, toJSON} from '@loopback/testlab';
+import {POSTGRESQL_CONFIG} from './postgresql.datasource';
+
+describe('PostgreSQL repository.execute()', () => {
+  // FIXME(bajtos) This test passes when executed in isolation, but fails
+  // on connection timeout when executed after repository-test suite.
+  it.skip('executes a parameterized native SQL query', async () => {
+    const db = new juggler.DataSource(POSTGRESQL_CONFIG);
+
+    @model()
+    class Product extends Entity {
+      @property({id: true, generated: true})
+      id: number;
+
+      @property({required: true})
+      name: string;
+    }
+
+    const repo = new DefaultTransactionalRepository<Product, number, {}>(
+      Product,
+      db,
+    );
+    await db.automigrate(Product.modelName);
+    const pen = await repo.create({name: 'Pen'});
+    await repo.create({name: 'Car'});
+
+    const result = await repo.execute('SELECT * FROM Product WHERE name = $1', [
+      'Pen',
+    ]);
+
+    expect(toJSON(result)).to.deepEqual([toJSON(pen)]);
+  });
+});

acceptance/repository-postgresql/tsconfig.json

@@ -15,6 +15,9 @@
     },
     {
       "path": "../../packages/repository/tsconfig.json"
+    },
+    {
+      "path": "../../packages/testlab/tsconfig.json"
     }
   ]
 }

packages/repository-tests/src/crud-test-suite.ts

@@ -48,9 +48,16 @@ export function crudRepositoryTestSuite(
     );
     before(
       withCrudCtx(function setupGlobalDataSource(ctx: CrudTestContext) {
+        debug('Initializing the shared datasource instance.');
         ctx.dataSource = new juggler.DataSource(ctx.dataSourceOptions);
       }),
     );
+    after(
+      withCrudCtx(function destroyGlobalDataSource(ctx: CrudTestContext) {
+        debug('Disconnecting the shared datasource instance.');
+        return ctx.dataSource.disconnect();
+      }),
+    );
 
     let testFiles = [];
 

packages/repository-tests/src/crud/transactions.suite.ts

@@ -60,6 +60,8 @@ export function transactionSuite(
         >;
         let tx: Transaction | undefined;
         let ds: juggler.DataSource;
+        let ds2: juggler.DataSource;
+
         before(
           withCrudCtx(async function setupRepository(ctx: CrudTestContext) {
             ds = ctx.dataSource;
@@ -85,6 +87,13 @@ export function transactionSuite(
           }
         });
 
+        afterEach(async () => {
+          if (ds2) {
+            ds2.disconnect();
+            (ds2 as unknown) = undefined;
+          }
+        });
+
         it('retrieves model instance once transaction is committed', async () => {
           tx = await repo.beginTransaction(IsolationLevel.READ_COMMITTED);
           const created = await repo.create(
@@ -149,7 +158,7 @@ export function transactionSuite(
           const ds2Options = Object.assign({}, dataSourceOptions);
           ds2Options.name = 'anotherDataSource';
           ds2Options.database = ds2Options.database + '_new';
-          const ds2 = new juggler.DataSource(ds2Options);
+          ds2 = new juggler.DataSource(ds2Options);
           const anotherRepo = new repositoryClass(Product, ds2);
           await ds2.automigrate(Product.name);