Skip to main content

Unit testing in NodeJS with Jest


  • Install Jest
  • Run npm install jest --save-dev
  • In package.json set in directories "test": "tests" and in scripts "test": "jest"
  • Run npm test in terminal
  • Add a test folder to the project
  • Inside test folder add file named after the file name that has functions that you want to test
  • Inside this file write your test
  • test('Test Name', () => {});
  • Run npm test
  • Change test file
test('Test Name', () => {
  throw new Error('Something Failed');
});
  • Suppose we have a file named lib.js with following code
module.exports.absolute = function(num) {
  if(num >= 0 ) return num;
  return -num;
}
  • Now we test it
  • Create a test file in test folder named lib.test.js
const lib = require('../lib');

test('absolute - should return a positive number if input is positve number', () => {
  expect(lib.absolute(1)).toBe(1);
});

test('absolute - should return a positive number if input is zero', () => {
  expect(lib.absolute(0)).toBe(0);
});

test('absolute - should return a positive number if input is negative number', () => {
  expect(lib.absolute(-1)).toBe(1);
});
  • Run npm test
  • All three passes
  • Let's group the above three tests using describe
const lib = require('../lib');

describe('absolute', () => {
  it('should return a positive number if input is positve number', () => {
    expect(lib.absolute(1)).toBe(1);
  });

  it('should return a positive number if input is zero', () => {
    expect(lib.absolute(0)).toBe(0);
  });

  it('should return a positive number if input is negative number', () => {
    expect(lib.absolute(-1)).toBe(1);
  });
});
  • it can be used instead of test
  • Let us now try an see similar testing for strings
  • Suppose we have a function for string manipulation as follows:
module.exports.greet = function(name) {
  return `Hello ${name}!`;
}
  • Now we write a test for it in our test file
const lib = require('../lib');

describe('greet', () => {
  it('should return a greeting Hello <name>!', () => {
    expect(lib.greet("Vinit")).toBe("Hello Vinit!");
  });

  it('should return a greeting with the name', () => {
    expect(lib.greet("Vinit")).toMatch(/Vinit/);
  });

  it('should return a string that contains the name', () => {
    expect(lib.greet("Vinit")).toContain("Vinit");
  });
});
  • Running this test will check the result in three different ways
    • First checks if result is exactly the same
    • Second and third checks if result contains the name.
    • Second does that with Regex
  • Now let us test arrays
  • Let's create a function that returns an array
const lib = require('../lib');

describe('getCurrencies', () => {
  it('too general', () => {
    expect(lib.getCurrencies()).toBeDefined();
    expect(lib.getCurrencies()).not.toBeNull();
  });

  it('too specific', () => {
    const result = lib.getCurrencies();
    expect(result[0]).toBe('USD');
    expect(result[0]).toBe('INR');
    expect(result[0]).toBe('EUR');
    expect(result.length).toBe(3);
  });

  it('should return an array of currency codes containing USD, INR, EUR', () => {
    const result = lib.getCurrencies();
    expect(result).toContain('USD');
    expect(result).toContain('INR');
    expect(result).toContain('EUR');
  });

  it('should return an array of currency codes containing USD, INR, EUR', () => {
    const result = lib.getCurrencies();
    expect(result).toEqual(expect.arrayContaining(['EUR','INR','USD']));
  });
});

  • Testing Objects

const lib = require('../lib');

describe('getProducts', () => {
  it('should return the product with given id', () => {
    // too specific
    expect(lib.getProduct(1)).toEqual({ id: 1, price: 10 });
    expect(lib.getProduct(1)).toMatchObject({ id: 1, price: 10 });
    expect(lib.getProduct(1)).toHaveProperty({ id: 1 });
  });
});
  • Note: We use toEqual here and not toBe, because toBe matches the location, which are different for both, while toEqual matches the values at the locations, which are same
  • toMatchObject is used when I am not sure if the key value pairs mentioned are all that are. There could be more.
  • toHaveProperty only checks if the object exists
TESTING ERRORS

  • Testing if a function throws error where required

describe('registerUser', () => {
  it('should throw error if username is falsy', () => {
    // null, undefined, NaN, "", 0, or false
    const args = [null, undefined, NaN, "", 0, false];
    args.forEach(a => {
      expect(() => { lib.registerUser(a) }).toThrow();
    });
  });

  it('should return a user object if valid username is passed', () => {
    const result = lib.registerUser('Vinit');
    expect(result).toMatchObject({ username: 'Vinit' });
    expect(result.id).toBeGreaterThan(0);
  });
});

        Comments

        Popular posts from this blog

        Python - Mathematical Functions - Hexadecimal, Binary, Exponential, Absolute, Round

        🐍 Some mathematical functions are in-built in python. Here are some of them. Convert Decimal to Hexadecimal hex(246) Output: '0xf6' hex(512) Output: '0x200' 0x is prefix to all hexadecimal numbers in output. The number after 0x is the hexadecimal value. Convert Decimal to Binary bin(1234) Output: '0b10011010010' bin(246) Output: '0b11110110' bin(512) Output: '0b1000000000' Exponential Function pow() function is similar to num1**num2, but it comes useful when you want to execute (num1**num2)%num3. Passing three arguments to pow(), does this. pow(3,4) Output: 81 This works just like 3**4 pow(3,4,5) Output: 1 But this, works equivalent to (3**4)%5. Either of the two ways can be used. At this point I feel (3**4)%5 is better, as anybody reading the code will understand what is being done immediately. While with pow(2,3,4), the person may have to refer to documentation to understand how this function works. Absolute Value The function abs() is used ...

        Two Ways of rendering in React Examples

        Two Ways of rendering in React Examples 1 - Render twice HTML < div id = "p1" ></ div > < div id = "p2" ></ div > CSS . person { display : inline - block ; margin : 10px ; border : 1px solid # eee ; box - shadow : 0 2px 2px # ccc ; } JAVASCRIPT (Babel) function Person ( props ) { return ( < div className = ' person "> < h1 >{ props . name }</ h1 > < p > Age :{ props . age }</ p > </ div > ); } ReactDOM . render (< Person name = "VK" age = "29" />, document . querySselector ( '#p1' )); ReactDOM . render (< Person name = "HK" age = "28" />, document . querySselector ( '#p2' )); 2 Render all at once HTML < div id = "app" ></ div > CSS . person { display : inline - block ; margin : 1...

        Binary Tree Traversal in Python - In Order, Pre Order, Post Order

        Binary Tree Traversal in Python - In Order, Pre Order, Post Order Run the code here to see output:  https://repl.it/@VinitKhandelwal/iterative-traversal-of-binary-tree # Node Class to Create Object of Nodes class Node (): def __init__ ( self , value , left= None , right= None ): self .value = value self .left = left self .right = right # Creation of a Binary Tree class BinaryTree (): def __init__ ( self , mylist ): self .mylist = mylist self .root=Node ( None ) for value in self .mylist : self .curr= self .root self ._add ( value ) def _add ( self , value ): if self .curr.value == None : self .curr.value = value else : if self .curr.value > value : if self .curr.left == None : self .curr.left = Node ( value ) else : self .curr = self .curr.left self ._add ( value ) else : if self...