commands.cy.js

const { _ } = Cypress

describe('src/cy/commands/commands', () => {
  beforeEach(() => {
    cy.visit('/fixtures/dom.html')
  })

  it('can invoke commands by name', () => {
    const body = cy.$$('body')

    cy
    .get('body').then(($body) => {
      expect($body.get(0)).to.eq(body.get(0))
    })
    .command('get', 'body').then(($body) => {
      expect($body.get(0)).to.eq(body.get(0))
    })
  })

  it('can invoke child commands by name', () => {
    const div = cy.$$('body>div:first')

    cy
    .get('body').find('div:first').then(($div) => {
      expect($div.get(0)).to.eq(div.get(0))
    })
    .get('body').command('find', 'div:first').then(($div) => {
      expect($div.get(0)).to.eq(div.get(0))
    })
  })

  it('does not add cmds to cy.commands queue', () => {
    cy.command('get', 'body').then(() => {
      const names = cy.queue.names()

      expect(names).to.deep.eq(['visit', 'get', 'then'])
    })
  })

  context('custom commands', () => {
    beforeEach(() => {
      Cypress.Commands.add('dashboard.selectWindows', () => {
        cy
        .get('[contenteditable]')
        .first()
      })

      Cypress.Commands.add('login', { prevSubject: true }, (subject, email) => {
        cy
        .wrap(subject.find('input:first'))
        .type(email)
      })
    })

    it('works with custom commands', () => {
      const input = cy.$$('input:first')

      cy
      .get('input:first')
      .parent()
      .command('login', 'brian@foo.com')
      .then(($input) => {
        expect($input.get(0)).to.eq(input.get(0))
      })
    })

    it('works with namespaced commands', () => {
      const ce = cy.$$('[contenteditable]').first()

      cy
      .command('dashboard.selectWindows').then(($ce) => {
        expect($ce.get(0)).to.eq(ce.get(0))
      })
    })

    it('throws when attempting to add an existing command', (done) => {
      cy.on('fail', (err) => {
        expect(err.message).to.eq('`Cypress.Commands.add()` is used to create new commands, but `get` is an existing Cypress command.\n\nPlease use `Cypress.Commands.overwrite()` if you would like to overwrite an existing command.\n')
        expect(err.docsUrl).to.eq('https://on.cypress.io/custom-commands')

        done()
      })

      Cypress.Commands.add('get', () => {
        cy
        .get('[contenteditable]')
        .first()
      })
    })

    it('throws when attempting to add an existing query', (done) => {
      cy.on('fail', (err) => {
        expect(err.message).to.eq('`Cypress.Commands.addQuery()` is used to create new queries, but `get` is an existing Cypress command or query, or is reserved internally by Cypress.\n\n If you want to override an existing command or query, use `Cypress.Commands.overrideQuery()` instead.')
        expect(err.docsUrl).to.eq('https://on.cypress.io/api/custom-queries')

        done()
      })

      Cypress.Commands.addQuery('get', () => {
        cy
        .get('[contenteditable]')
        .first()
      })
    })

    it('allows calling .add with hover / mount', () => {
      let calls = 0

      Cypress.Commands.add('hover', () => {
        calls++
      })

      Cypress.Commands.add('mount', () => {
        calls++
      })

      cy.mount()
      cy.hover()
      cy.then(() => {
        expect(calls).to.eq(2)
      })
    })

    it('throws when attempting to add a command with the same name as an internal function', (done) => {
      cy.on('fail', (err) => {
        expect(err.message).to.eq('`Cypress.Commands.add()` cannot create a new command named `addCommand` because that name is reserved internally by Cypress.')
        expect(err.docsUrl).to.eq('https://on.cypress.io/custom-commands')

        done()
      })

      Cypress.Commands.add('addCommand', () => {
        cy
        .get('[contenteditable]')
        .first()
      })
    })

    it('throws when attempting to add a query with the same name as an internal function', (done) => {
      cy.on('fail', (err) => {
        expect(err.message).to.eq('`Cypress.Commands.addQuery()` cannot create a new query named `addCommand` because that name is reserved internally by Cypress.')
        expect(err.docsUrl).to.eq('https://on.cypress.io/api/custom-queries')

        done()
      })

      Cypress.Commands.addQuery('addCommand', () => {
        cy
        .get('[contenteditable]')
        .first()
      })
    })
  })

  context('errors', () => {
    it('throws when cannot find command by name', (done) => {
      cy.on('fail', (err) => {
        const cmds = _.keys(Cypress.Chainer.prototype)

        expect(cmds.length).to.be.gt(1)
        expect(err.message).to.eq(`Could not find a command for: \`fooDoesNotExist\`.\n\nAvailable commands are: \`${cmds.join('`, `')}\`.\n`)
        expect(err.docsUrl).to.eq('https://on.cypress.io/api')

        done()
      })

      cy.get('body').command('fooDoesNotExist', 'bar', 'baz')
    })
  })
})