test: add initial unit tests for logging library (#17)

* test: add initial unit tests for logging library

* add tests to workflow

* fix devDependencies

* add missing new line

.github/workflows/pull-request.yaml

@@ -20,8 +20,8 @@ jobs:
       - name: Lint
         run: cd src && npm run lint
 
-      # - name: Unit test
-      #   run: yarn test
+      - name: Unit test
+        run: cd src && npm test
 
   test-build:
     runs-on: ubuntu-latest

.gitignore

@@ -2,4 +2,5 @@
 .whisper
 data/*
 
-node_modules
+node_modules
+coverage

src/log.js

@@ -17,11 +17,11 @@ const info = (message, optionalMessage = '') => {
 }
 
 const debug = (message, optionalMessage = '') => {
-  if (process.env.DEBUG === true) console.log(`[DEBUG] ${message}`, optionalMessage)
+  if (process.env.DEBUG === 'true') console.log(`[DEBUG] ${message}`, optionalMessage)
 }
 
 const notice = (message, optionalMessage = '') => {
-  console.log(message, optionalMessage)
+  console.log(chalk.white(message), optionalMessage)
 }
 
 module.exports = {

src/log.test.js

@@ -0,0 +1,60 @@
+/* eslint-env jest */
+const chalk = require('chalk')
+const log = require('./log')
+
+jest.spyOn(console, 'log').mockImplementation()
+
+describe('log', () => {
+  beforeEach(() => {
+
+  })
+
+  afterEach(() => {
+    jest.resetAllMocks()
+    delete process.env.DEBUG
+  })
+
+  const levels = [
+    { level: 'error', color: 'red' },
+    { level: 'success', color: 'green' },
+    { level: 'warn', color: 'yellow' },
+    { level: 'info', color: 'cyan' },
+    { level: 'notice', color: 'white' }
+  ]
+
+  for (const test of levels) {
+    describe(`${test.level}()`, () => {
+      it(`should output ${test.level} message`, () => {
+        log[test.level]('test')
+        expect(console.log).toBeCalledWith(chalk[test.color]('test'), '')
+      })
+      it(`should output ${test.level} with optional message`, () => {
+        log[test.level]('test', { msg: 'testing' })
+        expect(console.log).toBeCalledWith(chalk[test.color]('test'), { msg: 'testing' })
+      })
+    })
+  }
+
+  // separate test since it uses an env variable
+  describe('debug()', () => {
+    it('should not output debug message', () => {
+      log.debug('test')
+      expect(console.log).toBeCalledTimes(0)
+    })
+    it('should not output debug with optional message', () => {
+      log.debug('test', { msg: 'testing' })
+      expect(console.log).toBeCalledTimes(0)
+    })
+
+    it('should output debug message', () => {
+      process.env.DEBUG = true
+      log.debug('test')
+      expect(console.log).toBeCalledWith('[DEBUG] test', '')
+    })
+    it('should output debug with optional message', () => {
+      process.env.DEBUG = true
+      log.debug('test', { msg: 'testing' })
+      expect(console.log).toBeCalledWith('[DEBUG] test', { msg: 'testing' })
+    })
+  })
+})