Skip to content

Commit

Permalink
Add fake behaviors to sandbox (#1815)
Browse files Browse the repository at this point in the history
  • Loading branch information
@nivsherf @mroderick
nivsherf authored and mroderick committed Jun 24, 2018
1 parent 8816e1a commit a3cf98f
Show file tree
Hide file tree
Showing 3 changed files with 184 additions and 14 deletions.
1 change: 0 additions & 1 deletion lib/sinon.js
View file
Expand Up @@ -13,7 +13,6 @@ var stub = require("./sinon/stub");
var apiMethods = {
createSandbox: createSandbox,
assert: require("./sinon/assert"),
fake: require("./sinon/fake"),
match: require("./sinon/match"),
spyCall: require("./sinon/call"),

Expand Down
22 changes: 22 additions & 0 deletions lib/sinon/sandbox.js
View file
Expand Up @@ -11,6 +11,7 @@ var sinonClock = require("./util/fake_timers");
var sinonMock = require("./mock");
var sinonSpy = require("./spy");
var sinonStub = require("./stub");
var sinonFake = require("./fake");
var valueToString = require("./util/core/value-to-string");
var fakeServer = require("nise").fakeServer;
var fakeXhr = require("nise").fakeXhr;
Expand Down Expand Up @@ -305,6 +306,27 @@ function Sandbox() {
return stubbed;
};

sandbox.fake = function fake(f) { // eslint-disable-line no-unused-vars
var s = sinonFake.apply(sinonFake, arguments);

push.call(collection, s);

return s;
};

Object.keys(sinonFake).forEach(function (key) {
var fakeBehavior = sinonFake[key];
if (typeof fakeBehavior === "function") {
sandbox.fake[key] = function () {
var s = fakeBehavior.apply(fakeBehavior, arguments);

push.call(collection, s);

return s;
};
}
});

sandbox.useFakeTimers = function useFakeTimers(args) {
var clock = sinonClock.useFakeTimers.call(null, args);

Expand Down
175 changes: 162 additions & 13 deletions test/sandbox-test.js
View file
Expand Up @@ -10,7 +10,7 @@ var fakeServerWithClock = require("nise").fakeServerWithClock;
var fakeServer = require("nise").fakeServer;
var Sandbox = require("../lib/sinon/sandbox");
var createSandbox = require("../lib/sinon/create-sandbox");
var fake = require("../lib/sinon/fake");
var sinonFake = require("../lib/sinon/fake");
var sinonSpy = require("../lib/sinon/spy");
var sinonStub = require("../lib/sinon/stub");
var sinonConfig = require("../lib/sinon/util/core/get-config");
Expand Down Expand Up @@ -388,6 +388,146 @@ describe("Sandbox", function () {
});
});

describe(".fake", function () {
it("should return a fake", function () {
var sandbox = createSandbox();
var fake = sandbox.fake();

assert.isFunction(fake);
assert.equals(fake.displayName, "fake");
});

it("should add a fake to the internal collection", function () {
var sandbox = createSandbox();
var fakes = sandbox.getFakes();
var expected;

expected = sandbox.fake();

assert.isTrue(fakes.indexOf(expected) !== -1);
});

describe(".returns", function () {
it("should return a fake behavior", function () {
var sandbox = createSandbox();
var fake = sandbox.fake.returns();

assert.isFunction(fake);
assert.equals(fake.displayName, "fake");
});

it("should add a fake behavior to the internal collection", function () {
var sandbox = createSandbox();
var fakes = sandbox.getFakes();
var expected;

expected = sandbox.fake.returns();

assert.isTrue(fakes.indexOf(expected) !== -1);
});
});

describe(".throws", function () {
it("should return a fake behavior", function () {
var sandbox = createSandbox();
var fake = sandbox.fake.throws();

assert.isFunction(fake);
assert.equals(fake.displayName, "fake");
});

it("should add a fake behavior to the internal collection", function () {
var sandbox = createSandbox();
var fakes = sandbox.getFakes();
var expected;

expected = sandbox.fake.throws();

assert.isTrue(fakes.indexOf(expected) !== -1);
});
});

describe(".resolves", function () {
it("should return a fake behavior", function () {
var sandbox = createSandbox();
var fake = sandbox.fake.resolves();

assert.isFunction(fake);
assert.equals(fake.displayName, "fake");
});

it("should add a fake behavior to the internal collection", function () {
var sandbox = createSandbox();
var fakes = sandbox.getFakes();
var expected;

expected = sandbox.fake.resolves();

assert.isTrue(fakes.indexOf(expected) !== -1);
});
});

describe(".rejects", function () {
it("should return a fake behavior", function () {
var sandbox = createSandbox();
var fake = sandbox.fake.rejects();

assert.isFunction(fake);
assert.equals(fake.displayName, "fake");
});

it("should add a fake behavior to the internal collection", function () {
var sandbox = createSandbox();
var fakes = sandbox.getFakes();
var expected;

expected = sandbox.fake.rejects();

assert.isTrue(fakes.indexOf(expected) !== -1);
});
});

describe(".yields", function () {
it("should return a fake behavior", function () {
var sandbox = createSandbox();
var fake = sandbox.fake.yields();

assert.isFunction(fake);
assert.equals(fake.displayName, "fake");
});

it("should add a fake behavior to the internal collection", function () {
var sandbox = createSandbox();
var fakes = sandbox.getFakes();
var expected;

expected = sandbox.fake.yields();

assert.isTrue(fakes.indexOf(expected) !== -1);
});
});

describe(".yieldsAsync", function () {
it("should return a fake behavior", function () {
var sandbox = createSandbox();
var fake = sandbox.fake.yieldsAsync();

assert.isFunction(fake);
assert.equals(fake.displayName, "fake");
});

it("should add a fake behavior to the internal collection", function () {
var sandbox = createSandbox();
var fakes = sandbox.getFakes();
var expected;

expected = sandbox.fake.yieldsAsync();

assert.isTrue(fakes.indexOf(expected) !== -1);
});
});
});

describe(".verifyAndRestore", function () {
beforeEach(function () {
this.sandbox = createSandbox();
Expand Down Expand Up @@ -514,10 +654,10 @@ describe("Sandbox", function () {
}
};

sandbox.replace(object, "property", fake());
sandbox.replace(object, "property", sinonFake());

assert.exception(function () {
sandbox.replace(object, "property", fake());
sandbox.replace(object, "property", sinonFake());
}, {message: "Attempted to replace property which is already replaced"});
});

Expand Down Expand Up @@ -556,7 +696,7 @@ describe("Sandbox", function () {
};

assert.exception(function () {
sandbox.replace(object, "foo", fake());
sandbox.replace(object, "foo", sinonFake());
}, {message: "Use sandbox.replaceGetter for replacing getters"});
});
});
Expand All @@ -572,7 +712,7 @@ describe("Sandbox", function () {
};

assert.exception(function () {
sandbox.replace(object, "foo", fake());
sandbox.replace(object, "foo", sinonFake());
}, {message: "Use sandbox.replaceSetter for replacing setters"});
});
});
Expand All @@ -591,13 +731,13 @@ describe("Sandbox", function () {
}
};

this.sandbox.replaceGetter(object, "foo", fake.returns(expected));
this.sandbox.replaceGetter(object, "foo", sinonFake.returns(expected));

assert.equals(object.foo, expected);
});

it("should return replacement", function () {
var replacement = fake.returns("baz");
var replacement = sinonFake.returns("baz");
var object = {
get foo() {
return "bar";
Expand All @@ -611,7 +751,7 @@ describe("Sandbox", function () {

it("should replace an inherited property", function () {
var expected = "baz";
var replacement = fake.returns(expected);
var replacement = sinonFake.returns(expected);
var existing = "existing";
var object = Object.create({
get foo() {
Expand Down Expand Up @@ -652,7 +792,7 @@ describe("Sandbox", function () {
}
};

this.sandbox.replaceGetter(object, "foo", fake.returns(expected));
this.sandbox.replaceGetter(object, "foo", sinonFake.returns(expected));

this.sandbox.restore();

Expand All @@ -667,10 +807,10 @@ describe("Sandbox", function () {
}
};

sandbox.replaceGetter(object, "foo", fake.returns("one"));
sandbox.replaceGetter(object, "foo", sinonFake.returns("one"));

assert.exception(function () {
sandbox.replaceGetter(object, "foo", fake.returns("two"));
sandbox.replaceGetter(object, "foo", sinonFake.returns("two"));
}, {message: "Attempted to replace foo which is already replaced"});
});
});
Expand Down Expand Up @@ -779,10 +919,10 @@ describe("Sandbox", function () {
set foo(value) {}
};

sandbox.replaceSetter(object, "foo", fake());
sandbox.replaceSetter(object, "foo", sinonFake());

assert.exception(function () {
sandbox.replaceSetter(object, "foo", fake.returns("two"));
sandbox.replaceSetter(object, "foo", sinonFake.returns("two"));
}, {message: "Attempted to replace foo which is already replaced"});
});
});
Expand Down Expand Up @@ -821,6 +961,15 @@ describe("Sandbox", function () {
assert(fake0.resetHistory.called);
assert(fake1.resetHistory.called);
});

it("resets fake behaviours", function () {
var fake = this.sandbox.fake();
fake(1234);

this.sandbox.reset();

assert.equals(fake.getCalls(), []);
});
});

describe(".resetBehavior", function () {
Expand Down

0 comments on commit a3cf98f

Please sign in to comment.