@jamesives/github-sponsors-readme-action/__tests__/util.test.ts

This GitHub Action will automatically add your GitHub Sponsors to your README. It can be configured in multiple ways allowing you to display and breakdown your sponsors by price tier with fallbacks.

import {
  checkParameters,
  extractErrorMessage,
  suppressSensitiveInformation,
  isNullOrUndefined
} from '../src/util'

describe('util', () => {
  describe('isNullOrUndefined', () => {
    it('should return true if the value is null', async () => {
      const value = null
      expect(isNullOrUndefined(value)).toBeTruthy()
    })

    it('should return true if the value is undefined', async () => {
      const value = undefined
      expect(isNullOrUndefined(value)).toBeTruthy()
    })

    it('should return false if the value is defined', async () => {
      const value = 'montezuma'
      expect(isNullOrUndefined(value)).toBeFalsy()
    })

    it('should return false if the value is empty string', async () => {
      const value = ''
      expect(isNullOrUndefined(value)).toBeTruthy()
    })
  })

  describe('hasRequiredParameters', () => {
    it('should fail if there is no provided Access Token', () => {
      const action = {
        file: 'README.test.md',
        template: '* {{ url }}',
        minimum: 0,
        maximum: 0,
        marker: 'sponsors',
        organization: false,
        fallback: '',
        activeOnly: true,
        includePrivate: false
      }

      try {
        checkParameters(action)
      } catch (error) {
        expect(extractErrorMessage(error)).toMatch(
          'No deployment token was provided. You must provide the action with a Personal Access Token scoped to user:read and org:read.'
        )
      }
    })

    it('should not fail if it has all of the parameters', () => {
      const action = {
        token: 'montezuma',
        file: 'README.test.md',
        template: '* {{ url }}',
        minimum: 0,
        maximum: 0,
        marker: 'sponsors',
        organization: false,
        fallback: '',
        activeOnly: true,
        includePrivate: false
      }

      const response = checkParameters(action)
      expect(response).toBe(undefined)
    })
  })

  describe('suppressSensitiveInformation', () => {
    it('should replace any sensitive information with ***', async () => {
      const action = {
        token: 'insanelyimportanttokendonotsteal',
        file: 'README.test.md',
        template: '* {{ url }}',
        minimum: 0,
        maximum: 0,
        marker: 'sponsors',
        organization: false,
        fallback: '',
        activeOnly: true,
        includePrivate: false
      }

      const string = `This is an error message! It contains ${action.token} and ${action.token} again!`
      expect(suppressSensitiveInformation(string, action)).toBe(
        'This is an error message! It contains *** and *** again!'
      )
    })
  })

  describe('extractErrorMessage', () => {
    it('gets the message of a Error', () => {
      expect(extractErrorMessage(new Error('a error message'))).toBe(
        'a error message'
      )
    })

    it('gets the message of a string', () => {
      expect(extractErrorMessage('a error message')).toBe('a error message')
    })

    it('gets the message of a object', () => {
      expect(extractErrorMessage({special: 'a error message'})).toBe(
        `{"special":"a error message"}`
      )
    })
  })
})