mirror of
https://github.com/cypress-io/cypress.git
synced 2026-04-29 11:32:15 -05:00
Jennifer Shehane
50379024ac
* Update wording of task error message to be more specific about promise resolution value for cy.task * update tests / snapshots to match new err msg Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com>
53 lines
3.2 KiB
CoffeeScript
53 lines
3.2 KiB
CoffeeScript
require("../spec_helper")
|
|
|
|
_ = require("lodash")
|
|
Promise = require("bluebird")
|
|
plugins = require("#{root}lib/plugins")
|
|
task = require("#{root}lib/task")
|
|
|
|
fail = (message) -> throw new Error(message)
|
|
|
|
describe "lib/task", ->
|
|
beforeEach ->
|
|
@pluginsFile = "cypress/plugins"
|
|
sinon.stub(plugins, "execute").resolves("result")
|
|
sinon.stub(plugins, "has").returns(true)
|
|
|
|
it "executes the 'task' plugin", ->
|
|
task.run(@pluginsFile, { task: "some:task", arg: "some:arg", timeout: 1000 }).then ->
|
|
expect(plugins.execute).to.be.calledWith("task", "some:task", "some:arg")
|
|
|
|
it "resolves the result of the 'task' plugin", ->
|
|
task.run(@pluginsFile, { task: "some:task", arg: "some:arg", timeout: 1000 }).then (result) ->
|
|
expect(result).to.equal("result")
|
|
|
|
it "throws if 'task' event is not registered", ->
|
|
plugins.has.returns(false)
|
|
|
|
task.run(@pluginsFile, { timeout: 1000 }).catch (err) =>
|
|
expect(err.message).to.equal("The 'task' event has not been registered in the plugins file. You must register it before using cy.task()\n\nFix this in your plugins file here:\n#{@pluginsFile}\n\nhttps://on.cypress.io/api/task")
|
|
|
|
it "throws if 'task' event resolves __cypress_unhandled__", ->
|
|
plugins.execute.withArgs("task").resolves("__cypress_unhandled__")
|
|
plugins.execute.withArgs("_get:task:keys").resolves(["foo", "bar"])
|
|
task.run(@pluginsFile, { task: "some:task", arg: "some:arg", timeout: 1000 }).catch (err) =>
|
|
expect(err.message).to.equal("The task 'some:task' was not handled in the plugins file. The following tasks are registered: foo, bar\n\nFix this in your plugins file here:\n#{@pluginsFile}\n\nhttps://on.cypress.io/api/task")
|
|
|
|
it "throws if 'task' event resolves undefined", ->
|
|
plugins.execute.withArgs("task").resolves(undefined)
|
|
plugins.execute.withArgs("_get:task:body").resolves("function () {}")
|
|
task.run(@pluginsFile, { task: "some:task", arg: "some:arg", timeout: 1000 }).catch (err) =>
|
|
expect(err.message).to.equal("The task 'some:task' returned undefined. You must return a value, null, or a promise that resolves to a value or null to indicate that the task was handled.\n\nThe task handler was:\n\nfunction () {}\n\nFix this in your plugins file here:\n#{@pluginsFile}\n\nhttps://on.cypress.io/api/task")
|
|
|
|
it "throws if 'task' event resolves undefined - without task body", ->
|
|
plugins.execute.withArgs("task").resolves(undefined)
|
|
plugins.execute.withArgs("_get:task:body").resolves("")
|
|
task.run(@pluginsFile, { task: "some:task", arg: "some:arg", timeout: 1000 }).catch (err) =>
|
|
expect(err.message).to.equal("The task 'some:task' returned undefined. You must return a value, null, or a promise that resolves to a value or null to indicate that the task was handled.\n\nFix this in your plugins file here:\n#{@pluginsFile}\n\nhttps://on.cypress.io/api/task")
|
|
|
|
it "throws if it times out", ->
|
|
plugins.execute.withArgs("task").resolves(Promise.delay(250))
|
|
plugins.execute.withArgs("_get:task:body").resolves("function () {}")
|
|
task.run(@pluginsFile, { task: "some:task", arg: "some:arg", timeout: 10 }).catch (err) =>
|
|
expect(err.message).to.equal("The task handler was:\n\nfunction () {}\n\nFix this in your plugins file here:\n#{@pluginsFile}\n\nhttps://on.cypress.io/api/task")
|