Ways to imitate typeORM repository

Question

Ways to imitate typeORM repository

Looking for some guidance on writing tests and mocking the typeORM repository. I've tried a few approaches, but couldn't quite figure it out, particularly with the @InjectRepository method. Any suggestions?

import { AfterRoutesInit, Service } from '@tsed/common';
import { TypeORMService } from '@tsed/typeorm';
import { Connection, Repository } from 'typeorm';
import { DbAccount } from '../entity/DbAccount';
import { DbAddress } from '../entity/DbAddress';
import { Account } from '../models/Account';
import { Address } from '../models/address';
import { Pageable } from '../models/api_common/Pageable';

@Service()
export default class AccountService implements AfterRoutesInit {
    private repository: Repository<DbAccount>;
    private addressRepository: Repository<DbAddress>;

    constructor(private typeORMService: TypeORMService) { }

    $afterRoutesInit(): void | Promise<any> {
        const connection: Connection = this.typeORMService.get('default');
        this.repository = connection.getRepository(DbAccount);
        this.addressRepository = connection.getRepository(DbAddress);
    }

    async delete(accountId: string): Promise<void> {
        await this.repository.delete(accountId);

        return;
    }

}

typescript unit-testing mocking repository typeorm

Answer 1

Answer №1

Just in case your problem has not been resolved yet, here is a solution:

import {TestContext} from "@tsed/testing";
import {TypeORMService} from "@tsed/typeorm";
import {expect} from "chai";
import * as Sinon from "sinon";
import {AccountService} from "./AccountService";
import {DbAccount} from "./DbAccount";
import {DbAddress} from "./DbAddress";

describe("AccountService", () => {
  before(() => TestContext.create());
  after(() => TestContext.reset());
  describe("afterRoutesInit()", () => {
    it("should initialize repository when afterRoutesInit event is emitted", () => {
      // GIVEN
      const connection = {
        getRepository: Sinon.stub()
      };
      const typeORMService = {
        get: Sinon.stub().returns(connection)
      };
      const dbAccountRepository = {name: "dbAccountRepository"};
      const dbAddressRepository = {name: "dbAddressRepository"};

      connection.getRepository
        .withArgs(DbAccount).returns(dbAccountRepository);
      connection.getRepository
        .withArgs(DbAddress).returns(dbAddressRepository);

      const service = TestContext.invoke<AccountService>(AccountService, [
        {
          provide: TypeORMService,
          use: typeORMService
        }
      ]);

      // WHEN
      service.$afterRoutesInit();

      // THEN
      expect(typeORMService.get).to.have.been.calledWithExactly("default");
      expect(service.repository).to.deep.eq(dbAccountRepository);
      expect(service.addressRepository).to.deep.eq(dbAddressRepository);
    });
  });
});

Note: I utilized chai and sinon for writing unit tests :)

Answer 2

Just in case your problem has not been resolved yet, here is a solution:

import {TestContext} from "@tsed/testing";
import {TypeORMService} from "@tsed/typeorm";
import {expect} from "chai";
import * as Sinon from "sinon";
import {AccountService} from "./AccountService";
import {DbAccount} from "./DbAccount";
import {DbAddress} from "./DbAddress";

describe("AccountService", () => {
  before(() => TestContext.create());
  after(() => TestContext.reset());
  describe("afterRoutesInit()", () => {
    it("should initialize repository when afterRoutesInit event is emitted", () => {
      // GIVEN
      const connection = {
        getRepository: Sinon.stub()
      };
      const typeORMService = {
        get: Sinon.stub().returns(connection)
      };
      const dbAccountRepository = {name: "dbAccountRepository"};
      const dbAddressRepository = {name: "dbAddressRepository"};

      connection.getRepository
        .withArgs(DbAccount).returns(dbAccountRepository);
      connection.getRepository
        .withArgs(DbAddress).returns(dbAddressRepository);

      const service = TestContext.invoke<AccountService>(AccountService, [
        {
          provide: TypeORMService,
          use: typeORMService
        }
      ]);

      // WHEN
      service.$afterRoutesInit();

      // THEN
      expect(typeORMService.get).to.have.been.calledWithExactly("default");
      expect(service.repository).to.deep.eq(dbAccountRepository);
      expect(service.addressRepository).to.deep.eq(dbAddressRepository);
    });
  });
});

Note: I utilized chai and sinon for writing unit tests :)

Answer 3

Answer №2

This is my preferred approach.

import chai from 'chai';
import {UserService, User} from 'myApp';

describe('User service Unit tests:', () => {
   const expect = chai.expect;
   
   beforeEach(() => {
    // Set up test environment
   })

   afterEach(() => {
     // Clean up after each test
   })

   it('register() creates a new user successfully', (done) => {
      // Test logic for user registration 
   }) 
})

Answer 4

This is my preferred approach.

import chai from 'chai';
import {UserService, User} from 'myApp';

describe('User service Unit tests:', () => {
   const expect = chai.expect;
   
   beforeEach(() => {
    // Set up test environment
   })

   afterEach(() => {
     // Clean up after each test
   })

   it('register() creates a new user successfully', (done) => {
      // Test logic for user registration 
   }) 
})

Ways to imitate typeORM repository

Answer №1

Answer №2

Similar questions

The latest update of WebStorm in 2016.3 has brought to light an error related to the experimental support for decorators, which may undergo changes in forthcoming

core.js:12853 Error encountered when trying to use 'ngIf' on a 'div' element that is not recognized as a valid property

Is there a TypeScript rule called "no-function-constructor-with-string-args" that needs an example?

Choosing from a list in Angular

How can variables from state be imported into a TypeScript file?

Angular service unit test failed to execute

Utilizing the power of Typescript in Express 4.x

Issue: Module './App' not found in webpackSolution: Check if the module path is

Guide to making type-safe web service requests using Typescript

bringing TypeScript functions into another file

Incorporating the Chartist plugin into an Angular 5 application

Using TypeScript to define attributes by merging specified attribute names with variable attribute names

Using TypeScript with Selenium

Ways to eliminate unnecessary items from a JavaScript object array and generate a fresh array

Monitor constantly to determine if an element is within the visible portion of the screen

Step-by-step guide on filtering an array of objects using Vuejs and TypeScript

The functionality of Angular's mat-autocomplete is hindered when it comes to utilizing options generated by a function

Add information to an array by simply modifying the existing data that shares the same key/value pair

Encountered an issue with retrieving schema during self-referencing validation with openapi generator

"Encountered a problem when trying to access properties within a