feat: basic test setup with db

Author: bashleigh

.env.dist

@@ -0,0 +1,15 @@
+MYSQL_ROOT_PASSWORD=root
+MYSQL_DATABASE=polymorphic
+MYSQL_USER=root
+MYSQL_PASSWORD=root
+
+TYPEORM_CONNECTION=mysql
+TYPEORM_HOST=localhost
+TYPEORM_PORT=3306
+TYPEORM_DATABASE=polymorphic
+TYPEORM_USERNAME=root
+TYPEORM_PASSWORD=root
+TYPEORM_ENTITIES=src/__tests__/**/*.entity.ts
+TYPEORM_SYNCHRONIZE=true
+TYPEORM_LOGGING=true
+TYPEORM_SUBSCRIBERS=src/__tests__/**/*.subscriber.ts

.gitignore

@@ -1,3 +1,4 @@
 /node_modules/
 dist/
 coverage/
+.env

.npmignore

@@ -1,3 +1,4 @@
 src
 .idea
 .travis.yml
+docker-compose.yml

docker-compose.yml

@@ -0,0 +1,8 @@
+version: "3"
+
+services:
+  db:
+    image: mysql:5.7
+    env_file: .env
+    ports: 
+      - 3306:3306

package.json

@@ -25,16 +25,36 @@
     "format": "prettier --write \"**/*.ts\"",
     "build": "rm -rf ./dist && tsc && npm run build:index",
     "build:index": "rm -rf ./index.js ./index.d.ts && tsc -d --skipLibCheck ./index.ts",
-    "prepublish": "npm run format && npm run build"
+    "prepublish": "npm run format && npm run build",
+    "setup:test": "node_modules/.bin/ts-node node_modules/.bin/typeorm schema:sync",
+    "test": "jest"
   },
   "devDependencies": {
+    "@types/jest": "^26.0.19",
     "@types/node": "^14.14.14",
+    "dotenv": "^8.2.0",
+    "jest": "^26.6.3",
+    "mysql": "^2.18.1",
     "prettier": "^2.2.1",
     "reflect-metadata": "^0.1.13",
+    "ts-jest": "^26.4.4",
     "typeorm": "^0.2.29",
     "typescript": "^4.1.3"
   },
   "peerDependencies": {
     "typeorm": "^0.2.29"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".spec.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "coverageDirectory": "../coverage"
   }
 }

src/__tests__/entities/advert.entity.ts

@@ -0,0 +1,21 @@
+import { Column, Entity, PrimaryGeneratedColumn } from 'typeorm';
+import { PolymorphicParent } from '../../../dist';
+import { MerchantEntity } from './merchant.entity';
+import { UserEntity } from './user.entity';
+
+@Entity('adverts')
+export class AdvertEntity {
+  @PrimaryGeneratedColumn()
+  id: number;
+
+  @PolymorphicParent(() => [UserEntity, MerchantEntity], {
+    eager: true,
+  })
+  owner: UserEntity | MerchantEntity;
+
+  @Column()
+  entityId: number;
+
+  @Column()
+  entityType: string;
+}

src/__tests__/entities/merchant.entity.ts

@@ -0,0 +1,14 @@
+import { Entity, PrimaryGeneratedColumn } from 'typeorm';
+import { PolymorphicChildren } from '../../../dist';
+import { AdvertEntity } from './advert.entity';
+
+@Entity('merchants')
+export class MerchantEntity {
+  @PrimaryGeneratedColumn()
+  id: number;
+
+  @PolymorphicChildren(() => AdvertEntity, {
+    eager: false,
+  })
+  adverts: AdvertEntity[];
+}

src/__tests__/entities/user.entity.ts

@@ -0,0 +1,14 @@
+import { Entity, PrimaryGeneratedColumn } from 'typeorm';
+import { PolymorphicChildren } from '../../../dist';
+import { AdvertEntity } from './advert.entity';
+
+@Entity('users')
+export class UserEntity {
+  @PrimaryGeneratedColumn()
+  id: number;
+
+  @PolymorphicChildren(() => AdvertEntity, {
+    eager: false,
+  })
+  adverts: AdvertEntity[];
+}

src/__tests__/polymorphic.repository.spec.ts

@@ -0,0 +1,43 @@
+import { Connection, createConnection } from 'typeorm';
+import { AdvertEntity } from './entities/advert.entity';
+import { UserEntity } from './entities/user.entity';
+import { config } from 'dotenv';
+import { resolve } from 'path';
+import { AdvertRepository } from './repository/advert.repository';
+
+describe('AbstractPolymorphicRepository', () => {
+  let connection: Connection;
+  beforeAll(async () => {
+    config({
+      path: resolve(__dirname, '.', '..', '..', '.env'),
+    });
+
+    connection = await createConnection({
+      type: 'mysql',
+      host: process.env.TYPEORM_HOST,
+      port: parseInt(process.env.TYPEORM_PORT, 10),
+      username: process.env.TYPEORM_USERNAME,
+      password: process.env.TYPEORM_PASSWORD,
+      entities: ['./*/**/*.entity.ts'],
+      synchronize: process.env.TYPEORM_SYNCHRONIZE === 'true',
+      database: process.env.TYPEORM_DATABASE,
+    });
+  });
+
+  afterAll(async () => {
+    await connection.close();
+  });
+
+  it('Can create', async () => {
+    const repository = connection.getCustomRepository(AdvertRepository);
+
+    const user = new UserEntity();
+
+    const result = repository.create({
+      owner: user,
+    });
+
+    expect(result).toBeInstanceOf(AdvertEntity);
+    expect(result.owner).toBeInstanceOf(UserEntity);
+  });
+});

src/__tests__/repository/advert.repository.ts

@@ -0,0 +1,6 @@
+import { EntityRepository } from 'typeorm';
+import { AbstractPolymorphicRepository } from '../../polymorphic.repository';
+import { AdvertEntity } from '../entities/advert.entity';
+
+@EntityRepository(AdvertEntity)
+export class AdvertRepository extends AbstractPolymorphicRepository<AdvertEntity> {}

src/__tests__/repository/user.repository.ts

@@ -0,0 +1,4 @@
+import { AbstractPolymorphicRepository } from '../../../dist';
+import { UserEntity } from '../entities/user.entity';
+
+export class UserRepository extends AbstractPolymorphicRepository<UserEntity> {}