@revoloo/cypress6/packages/reporter/cypress/integration/unit/hook_model_spec.ts

Cypress.io end to end testing tool

import sinon from 'sinon'

import CommandModel from '../../../src/commands/command-model'
import ErrModel from '../../../src/errors/err-model'
import Hook from '../../../src/hooks/hook-model'

describe('Hook model', () => {
  let hook: Hook

  beforeEach(() => {
    hook = new Hook({
      hookId: 'h1',
      hookName: 'before each',
    })
  })

  context('#addCommand', () => {
    it('adds the command to its command collection', () => {
      const command1: Partial<CommandModel> = { isMatchingEvent: () => {
        return false
      } }

      hook.addCommand(command1 as CommandModel)

      expect(hook.commands.length).to.equal(1)

      const command2: Partial<CommandModel> = {}

      hook.addCommand(command2 as CommandModel)
      expect(hook.commands.length).to.equal(2)
    })

    it('numbers commands incrementally when not events', () => {
      const command1: Partial<CommandModel> = { event: false, isMatchingEvent: () => {
        return false
      } }

      hook.addCommand(command1 as CommandModel)
      expect(command1.number).to.equal(1)

      const command2: Partial<CommandModel> = { event: false }

      hook.addCommand(command2 as CommandModel)
      expect(command2.number).to.equal(2)
    })

    it('does not number event commands', () => {
      const command1: Partial<CommandModel> = { event: false, isMatchingEvent: () => {
        return false
      } }

      hook.addCommand(command1 as CommandModel)
      expect(command1.number).to.equal(1)

      const command2: Partial<CommandModel> = { event: true, isMatchingEvent: () => {
        return false
      } }

      hook.addCommand(command2 as CommandModel)
      expect(command2.number).to.be.undefined

      const command3: Partial<CommandModel> = { event: false }

      hook.addCommand(command3 as CommandModel)
      expect(command3.number).to.equal(2)
    })

    it('does not number studio commands', () => {
      hook.isStudio = true

      const command1: Partial<CommandModel> = { event: false, isMatchingEvent: () => {
        return false
      } }

      hook.addCommand(command1 as CommandModel)
      expect(command1.number).to.be.undefined

      const command2: Partial<CommandModel> = { event: false, number: 3, isMatchingEvent: () => {
        return false
      } }

      hook.addCommand(command2 as CommandModel)
      expect(command2.number).to.equal(3)
    })

    it('only numbers studio visit commands', () => {
      hook.isStudio = true

      const command1: Partial<CommandModel> = { event: false, name: 'visit', isMatchingEvent: () => {
        return false
      } }

      hook.addCommand(command1 as CommandModel)
      expect(command1.number).to.equal(1)

      const command2: Partial<CommandModel> = { event: false, isMatchingEvent: () => {
        return false
      } }

      hook.addCommand(command2 as CommandModel)
      expect(command2.number).to.be.undefined
    })

    it('adds command as duplicate if it matches the last command', () => {
      const addDuplicate = sinon.spy()
      const command1: Partial<CommandModel> = { event: true, isMatchingEvent: () => {
        return true
      }, addDuplicate }

      hook.addCommand(command1 as CommandModel)

      const command2: Partial<CommandModel> = { event: true }

      hook.addCommand(command2 as CommandModel)

      expect(addDuplicate).to.be.calledWith(command2)
    })
  })

  context('#commandMatchingErr', () => {
    it('returns last command to match the error', () => {
      const matchesButIsntLast: Partial<CommandModel> = {
        // @ts-ignore
        err: { message: 'matching error message' } as ErrModel,
        isMatchingEvent: () => {
          return false
        },
      }

      hook.addCommand(matchesButIsntLast as CommandModel)

      const doesntMatch: Partial<CommandModel> = {
        // @ts-ignore
        err: { message: 'other error message' } as ErrModel,
        isMatchingEvent: () => {
          return false
        },
      }

      hook.addCommand(doesntMatch as CommandModel)

      const matches: Partial<CommandModel> = {
        err: { message: 'matching error message' } as ErrModel,
      }

      hook.addCommand(matches as CommandModel)

      expect(hook.commandMatchingErr({ message: 'matching error message' } as ErrModel)).to.eql(matches)
    })

    it('returns undefined when no match', () => {
      const noMatch1: Partial<CommandModel> = {
        // @ts-ignore
        err: { message: 'some error message' } as ErrModel,
        isMatchingEvent: () => {
          return false
        },
      }

      hook.addCommand(noMatch1 as CommandModel)

      const noMatch2: Partial<CommandModel> = {
        // @ts-ignore
        err: { message: 'other error message' } as ErrModel,
      }

      hook.addCommand(noMatch2 as CommandModel)

      expect(hook.commandMatchingErr({ message: 'matching error message' } as ErrModel)).to.be.undefined
    })
  })

  context('#aliasesWithDuplicates', () => {
    const addCommand = (alias: string, hasDuplicates = false) => {
      const command: Partial<CommandModel> = {
        isMatchingEvent: () => {
          return false
        },
        alias,
        hasDuplicates,
      }

      return hook.addCommand(command as CommandModel)
    }

    it('returns duplicates marked with hasDuplicates and those that appear multiple times in the commands array', () => {
      addCommand('foo')
      addCommand('bar')
      addCommand('foo')
      addCommand('baz', true)

      expect(hook.aliasesWithDuplicates).to.include('foo')
      expect(hook.aliasesWithDuplicates).to.include('baz')
      expect(hook.aliasesWithDuplicates).to.not.include('bar')
    })

    // https://github.com/cypress-io/cypress/issues/4411
    it('returns the same array instance if it has not changed', () => {
      let dupes = hook.aliasesWithDuplicates

      addCommand('foo')
      expect(dupes).to.deep.eq([])

      addCommand('bar')
      expect(hook.aliasesWithDuplicates === dupes).to.be.true

      addCommand('foo')
      dupes = hook.aliasesWithDuplicates
      expect(dupes).to.deep.eq(['foo'])

      addCommand('foo')
      expect(hook.aliasesWithDuplicates === dupes).to.be.true
    })
  })

  context('#removeCommand', () => {
    it('removes commands by ids', () => {
      const command1: Partial<CommandModel> = { id: 1, isMatchingEvent: () => {
        return false
      } }

      hook.addCommand(command1 as CommandModel)

      const command2: Partial<CommandModel> = { id: 2, isMatchingEvent: () => {
        return false
      } }

      hook.addCommand(command2 as CommandModel)

      expect(hook.commands.length).to.equal(2)

      hook.removeCommand(1)
      expect(hook.commands.length).to.equal(1)
      expect(hook.commands[0].id).to.equal(2)
    })
  })
})