Light

viniciusjssouza / typeorm-transactional-tests Goto Github PK

View Code? Open in Web Editor NEW

52.0 3.0 11.0 4.32 MB

Add transactional tests to typeorm projects

License: MIT License

TypeScript 100.00%

typeorm-transactional-tests's Introduction

TypeORM transactional tests

TypeORM does not provide builtin transactional tests. If your tests write to a non in-memory database, probably you have to truncate or erase all your tables for every test case.

This package allows the creation of transactional contexts during the test, starting a transaction in the begining of the test and rolling back at the end. This is a faster solution than truncate/delete, once nothing is really written to disk.

Install

npm install --save-dev typeorm-transactional-tests

Or with yarn:

npm install --save-dev typeorm-transactional-tests

Typeorm compatibility

Versions 1.x.x of this library is compatible with typeorm 0.2.x

Versions 2.x.x of this library is compatible with typeorm 0.3.x

Usage

Jest

To apply the transactional context with Jest, just start the context in an beforeEach block and finish it in an afterEach:

import {Connection, getConnection } from 'typeorm';
import { TransactionalTestContext } from 'typeorm-transactional-tests';

let connection: Connection;
let transactionalContext: TransactionalTestContext;

beforeEach(async () => {
    connection = getConnection();
    transactionalContext = new TransactionalTestContext(connection);
    await transactionalContext.start();    
});

afterEach(async () => {
    await transactionalContext.finish();
});

Also, it is possible to apply the context to all your tests using a global Jest setup file. Add a new file on your test folder:

import { TransactionalTestContext } from 'typeorm-transactional-tests'

// @ts-ignore
global.beforeEach(async () => await transactionalContext.start());

// @ts-ignore
global.afterEach(async () => await transactionalContext.finish());

And point the Jest configuration to it:

 "setupFilesAfterEnv": [
   "<rootDir>/test/support/transactionalContext.ts"
  ]

typeorm-transactional-tests's People

Contributors

Stargazers

Watchers

Forkers

williamdclt revfluence raphael-piccolin-kidsloop omerd-cyera andrew-chen-wang payalb imdudu1 cw1997 heemankim mgonyan voriteam

typeorm-transactional-tests's Issues

Not rolling back

Doesn't seem to be working:

# e2e.spec.ts

describe('e2e', () => {
  let app: INestApplication;

  beforeAll(async () => {
    const moduleFixture = await Test.createTestingModule({
      imports: [AppModule],
    }).compile();
    const appPreInit = moduleFixture.createNestApplication();
    app = await appPreInit.init();
  });

  afterAll(async () => {
    await app.close();
  });
});

# transactional-context.ts

// eslint-disable-next-line import/no-extraneous-dependencies
import { TransactionalTestContext } from 'typeorm-transactional-tests';
import { getConnection } from 'typeorm';

let transactionalContext: TransactionalTestContext;
let connection;

// @ts-ignore
global.beforeEach(async () => {
  connection = getConnection();
  transactionalContext = new TransactionalTestContext(connection);
  transactionalContext.start();
});

// @ts-ignore
global.afterEach(async () => {
  console.log('cleaning up..');
  transactionalContext.finish();
});

Output:

npm run test:e2e

> [email protected] test:e2e /Users/danklasson/Code/analyze/backend
> jest --config ./test/jest-e2e.json

  console.log node_modules/typeorm/platform/PlatformTools.js:197
    query: START TRANSACTION

  console.log node_modules/typeorm/platform/PlatformTools.js:197
    query: START TRANSACTION

  console.log node_modules/typeorm/platform/PlatformTools.js:197
    query: INSERT INTO `project`(`id`, `name`) VALUES (DEFAULT, ?) -- PARAMETERS: ["Ondricka, Stark and Breitenberg"]

  console.log node_modules/typeorm/platform/PlatformTools.js:197
    query: COMMIT

  console.log node_modules/typeorm/platform/PlatformTools.js:197
    query: SELECT `Project`.`id` AS `Project_id`, `Project`.`name` AS `Project_name` FROM `project` `Project`

  console.log src/project/project.e2e-spec.ts:33
    [ Project { id: 1, name: 'Ondricka, Stark and Breitenberg' } ]

 PASS  src/project/project.e2e-spec.ts
  e2e
    ✓ should fetch projects (137ms)
    ✓ should fetch projects2 (31ms)

Test Suites: 1 passed, 1 total
Tests:       2 passed, 2 total
Snapshots:   0 total
Time:        4.581s, estimated 5s
Ran all test suites.

  console.log test/test.transactional-context.ts:17
    cleaning up..

  console.log node_modules/typeorm/platform/PlatformTools.js:197
    query: ROLLBACK

  console.log node_modules/typeorm/platform/PlatformTools.js:197
    query: START TRANSACTION

  console.log node_modules/typeorm/platform/PlatformTools.js:197
    query: START TRANSACTION

  console.log node_modules/typeorm/platform/PlatformTools.js:197
    query: INSERT INTO `project`(`id`, `name`) VALUES (DEFAULT, ?) -- PARAMETERS: ["Daugherty, Lesch and Schmidt"]

  console.log node_modules/typeorm/platform/PlatformTools.js:197
    query: COMMIT

  console.log node_modules/typeorm/platform/PlatformTools.js:197
    query: SELECT `Project`.`id` AS `Project_id`, `Project`.`name` AS `Project_name` FROM `project` `Project`

  console.log src/project/project.e2e-spec.ts:53
    [ Project { id: 1, name: 'Ondricka, Stark and Breitenberg' },
      Project { id: 2, name: 'Daugherty, Lesch and Schmidt' } ]

  console.log test/test.transactional-context.ts:17
    cleaning up..

  console.log node_modules/typeorm/platform/PlatformTools.js:197
    query: ROLLBACK

Plans for upgrade to typeorm 0.3?

Are there any plans to update this lib to typeorm 0.3?

Something wrong with the Connection type

Code Sample

  beforeAll(async () => {
    const connection = getConnection()
    const transactionalContext = new TransactionalTestContext(connection)

    await transactionalContext.start()
  })

Type Error

Error Message

Argument of type 'import("~/node_modules/typeorm/connection/Connection").Connection' is not assignable to parameter of type 'import("~/node_modules/typeorm-transactional-tests/node_modules/typeorm/connection/Connection").Connection'.
  Types of property 'options' are incompatible.
    Type 'import("~/node_modules/typeorm/connection/ConnectionOptions").ConnectionOptions' is not assignable to type 'import("~/node_modules/typeorm-transactional-tests/node_modules/typeorm/connection/ConnectionOptions").ConnectionOptions'.
      Type 'MysqlConnectionOptions' is not assignable to type 'ConnectionOptions'.
        Type 'import("~/node_modules/typeorm/driver/mysql/MysqlConnectionOptions").MysqlConnectionOptions' is not assignable to type 'import("~/node_modules/typeorm-transactional-tests/node_modules/typeorm/driver/mysql/MysqlConnectionOptions").MysqlConnectionOptions'.
          Types of property 'entities' are incompatible.
            Type '(string | Function | import("~/node_modules/typeorm/entity-schema/EntitySchema").EntitySchema<any>)[] | undefined' is not assignable to type '(string | Function | import("~/node_modules/typeorm-transactional-tests/node_modules/typeorm/entity-schema/EntitySchema").EntitySchema<any>)[] | undefined'.
              Type '(string | Function | import("~/node_modules/typeorm/entity-schema/EntitySchema").EntitySchema<any>)[]' is not assignable to type '(string | Function | import("~/node_modules/typeorm-transactional-tests/node_modules/typeorm/entity-schema/EntitySchema").EntitySchema<any>)[]'.
                Type 'string | Function | import("~/node_modules/typeorm/entity-schema/EntitySchema").EntitySchema<any>' is not assignable to type 'string | Function | import("~/node_modules/typeorm-transactional-tests/node_modules/typeorm/entity-schema/EntitySchema").EntitySchema<any>'.
                  Type 'EntitySchema<any>' is not assignable to type 'string | Function | EntitySchema<any>'.
                    Type 'import("~/node_modules/typeorm/entity-schema/EntitySchema").EntitySchema<any>' is not assignable to type 'import("~/node_modules/typeorm-transactional-tests/node_modules/typeorm/entity-schema/EntitySchema").EntitySchema<any>'.
                      The types of 'options.type' are incompatible between these types.
                        Type '"regular" | "view" | "junction" | "closure" | "closure-junction" | "entity-child" | undefined' is not assignable to type '"regular" | "junction" | "closure" | "closure-junction" | "entity-child" | undefined'.
                          Type '"view"' is not assignable to type '"regular" | "junction" | "closure" | "closure-junction" | "entity-child" | undefined'.ts(2345)

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.