feat!: move closer to test double definitions #150

crookse · 2022-04-11T21:58:48Z

Overview of commits

feat: add Fake()
feat: add Dummy()
feat: new mock methods (expects(), method(), verifyExpectations())
feat: pre-programmed method implementation for faking/mocking methods
feat: add interfaces so that they can be returned for improved type hinting
refactor: mocks to use mixin
refactor!: stubs (no need to stub a class to stub its members)
refactor: types are now stricter and provide better type hinting
test: test fakes, dummies, mocks, stubs and move tests files into unit/mod

Updated README

See the new README here.

Refactor and add features to be closer to test double definitions

Test double definitions can be found here: https://martinfowler.com/bliki/TestDouble.html

Currently, we only have:

Mocks
Dummies
Fakes
Stubs (breaking changes made in this PR)

Still need to add in spies.

Stub()

Before, we created a stub via Stub(someObject) and then we could call someObject.stub(...). This didn't make sense per definition. The definition is:

Stubs provide canned answers to calls made during the test, usually not responding at all to anything outside what's programmed in for the test.

We shouldn't have to call stub on an object to make it stub-able. Instead we should call Stub(theObjectReceivingTheStub, theDataMemberToStub, optionalValueTheStubShouldReturn). API looks like the below now:

class Server {
  public greeting = "hello";

  public methodThatLogs() {
    console.log("Server running.");
  }
}

const server = new Server();

Stub(server, "greeting", "you got changed");
assertEquals(server.greeting, "you got changed");

Stub(server, "greeting");
assertEquals(server.greeting, null);

// `is_stubbed` should be added when stubbing an object
assertEquals("is_stubbed" in server, true);

Use mixin for mock

Introduces using a mixin to create a mock so that calling private methods and returning this also works in a mock. For example, the old mock implementation wouldn't work when someComplexMethod() below would return this and call this.#setSomethingOne() and this.#setSomethingTwo() because the context of this was the mock object and not the original object. It needs to be an instance of the original object. That's where the mixin comes in. Basically, mocks are now extensions of the original so that mock instanceof original === true. This approach also fixes the getter/setter issue from https://github.com/drashland/rhum/pull/148/files.

class TestObjectFourBuilder {
  #something_one?: string;
  #something_two?: string;
  ...
  ...
  ...
  someComplexMethod(): this {
    this.#setSomethingOne();
    this.#setSomethingTwo();
    return this;
  }
  ...
  ...
  ...
}

Add mock.method(...).willReturn(...)

class TestObjectThree {
  public test(): string { return "World"; }
}

const mock = new MockBuilder(TestObjectThree).create();
assertEquals(mock.is_mock, true);

// Original returns "World"
assertEquals(mock.test(), "World");

// Don't fully pre-program the method. This should cause an error during
// assertions.
mock
  .method("test")
  .willReturn({
    name: "something"
  });

assertEquals(mock.test(), {name: "something"});
assertEquals(mock.calls.test, 2);
assertEquals(mock.calls.hello, 2);

Add mock.method(...).willThrow(...)

class TestObjectThree {
  public test(): string { return "World"; }
}

const mock = new MockBuilder(TestObjectThree).create();
assertEquals(mock.is_mock, true);

// Original returns "World"
assertEquals(mock.test(), "World");

// Make the original method throw RandomError
mock
  .method("test")
  .willThrow(new RandomError("Random error message."))

assertThrows(
  () => mock.test(),
  RandomError,
  "Random error message."
);
assertEquals(mock.calls.test, 2);

Add mock.expects(...).toBeCalled(...)

const mock = new MockBuilder(TestObjectThree).create();
assertEquals(mock.is_mock, true);

mock.expects("hello").toBeCalled(2);

mock.test(); // Calls .hello() under the hood twice

mock.verifyExpectations(); // Must be called to verify the .expects() calls

Add Fake()

Fakes kind of act like mocks, but they do not have calls and expectations like mocks.

// Assert that a fake can make a class take a shortcut
const fakeServiceDoingShortcut = Fake(Repository).create();
fakeServiceDoingShortcut.method("findAllUsers").willReturn("shortcut");
const resourceWithShortcut = new Resource(
  fakeServiceDoingShortcut,
);
resourceWithShortcut.getUsers();
assertEquals(fakeServiceDoingShortcut.anotha_one_called, false);
assertEquals(fakeServiceDoingShortcut.do_something_called, false);
assertEquals(fakeServiceDoingShortcut.do_something_else_called, false);

// Assert that the fake service is not yet doing a shortcut
const fakeServiceNotDoingShortcut = Fake(Repository).create();
const resourceWithoutShortcut = new Resource(
  fakeServiceNotDoingShortcut,
);
resourceWithoutShortcut.getUsers();
assertEquals(fakeServiceNotDoingShortcut.anotha_one_called, true);
assertEquals(fakeServiceNotDoingShortcut.do_something_called, true);
assertEquals(fakeServiceNotDoingShortcut.do_something_else_called, true);

Add Dummy()

Dummies are empty objects of an instance of something. For example, Dummy(Hello) instanceof Hello === true. This makes it a little bit easier to fill in parameter lists where parameters must be instances of something.

const mockServiceOne = Mock(ServiceOne).create();
const dummy3 = Dummy(ServiceThree);

const resource = new Resource(
  mockServiceOne,
  Dummy(ServiceTwo),
  dummy3,
);

resource.callServiceOne();
assertEquals(mockServiceOne.calls.methodServiceOne, 1);

Dummies can also be created without having to specify constructor arguments.

class Hello {
  constructor(
    arg1: SomethingOne,
    arg2: SomethingTwo,
    arg3: SomethingThree,
  ) {
    ...
    ...
    ...
  }
}

const dummy = Dummy(Hello); // works without throwing error

* test: fix tests and use Deno.test for merging into Rhum v2 * chore: fix comment Co-authored-by: Edward Bebbington <[email protected]>

…s-dummies-fakes

…blank Stub() call return stub function

ebebbington

Omg this is beautiful eric, usual minor things but my god the code is sexy

ebebbington · 2022-04-12T21:14:50Z

README.md

-    <img src="https://img.shields.io/badge/Tutorials-YouTube-red">
-  </a>
-</p>
+# Drash


doneski: cc0ebdf

ebebbington · 2022-04-12T21:17:03Z

extend.js

+// deno-lint-ignore-file
+// This code was bundled using `deno bundle` and it's not recommended to edit it manually
+
+class Base {


wha dis doing here ;)

LOL test files

donezo: 92bd978

ebebbington · 2022-04-12T21:17:15Z

extend.ts

@@ -0,0 +1,9 @@
+class Base {
+  public base_prop = "base prop";
+}


same as above, test file you committed?

dooonnnne: 92bd978

ebebbington · 2022-04-12T21:20:09Z

src/mock/mock_mixin.ts

+    //////////////////////////////////////////////////////////////////////////////
+    // FILE MARKER - CONSTRUCTOR /////////////////////////////////////////////////
+    //////////////////////////////////////////////////////////////////////////////
+
+    /**
+     * @param original - The original object to mock.
+     * @param methodsToTrack - The original object's method to make trackable.
+     */
+    public init(original: OriginalObject, methodsToTrack: string[]) {
+      this.#original = original;
+      this.#calls = this.#constructCallsProperty(methodsToTrack);
+    }


constructor needs to be updated with methods - public

actually that is below so maybe rm that comment block and move method?

moved them stuffs: 08e47ef

ebebbington and others added 23 commits April 9, 2022 15:32

fix: Mocking a class with getters doesnt set default initialised value

e610abc

fix tests

2c48237

fmt

5111da2

test fixes (#149)

a8df3f2

* test: fix tests and use Deno.test for merging into Rhum v2 * chore: fix comment Co-authored-by: Edward Bebbington <[email protected]>

feat(mock): add mock.method(...).willReturn(...);

289c455

chore: cleaning up

caf0ea8

feat: add mock.method(...).willThrow(...)

62fed94

test: mock.method().willThrow() and mock.method().willReturn()

fd258ac

feat: add mixin for mock

df28899

fix: issue with redefining getters and setters

d5833f1

test: testing current implementations thus far

73996ee

Merge branch 'feat/mock-as-mixin' into feat/configurable-methods-spie…

c2fa3de

…s-dummies-fakes

chore: deno fmt

3ee8e39

Merge branch 'fix-getters' into feat/new-mock-methods

6a1e98b

feat: add dummy logic

6299ba2

chore: clean up

8f5f5d9

chore: move mock logic into mock folder

825748b

feat: fakes

0689930

Merge branch 'feat/dummies' into feat/new-mock-methods

dc303a5

chore: deno fmt

647bd2d

chore: fix doc block

0cb4c75

feat: add method expectation calls for mocks

937c23f

chore: fix param name

3d00a25

crookse changed the title ~~feat: new mock methods~~ feat: move closer to test double definitions Apr 12, 2022

crookse added 6 commits April 11, 2022 22:54

test: add test creating dummy without constructor args

b45e231

chore: make setter adjacent to getter

4d05200

chore: make file marker comment bigger

37cacc0

refactor!: change stub to only stub data members

49e9fbe

feat: new readme

5cfcaab

docs: update README to state Gerard Meszaros

05c66d2

crookse force-pushed the feat/new-mock-methods branch from a14ef67 to 05c66d2 Compare April 12, 2022 03:19

crookse added 4 commits April 11, 2022 23:20

chore: state Gerard Meszaros in doc blocks

15dd9cd

fix: accidentally removed Constructor type import

b1e4c77

chore: deno fmt and clean up

cf1297f

refactor!: shorten syntax to stub class properties and methods; make …

1e9d2c5

…blank Stub() call return stub function

ebebbington added the Type: Minor Merging this pull request results in a minor version increment label Apr 12, 2022

ebebbington requested changes Apr 12, 2022

View reviewed changes

crookse requested a review from Guergeiro April 13, 2022 00:28

crookse added 5 commits April 12, 2022 21:22

chore: cleaning up

50e9dc5

chore: remove other mock test file

ca2b88e

fix: change README title to Rhum

cc0ebdf

chore: remove playground files

92bd978

chore: remove constructor comment; move init method down

08e47ef

crookse changed the title ~~feat: move closer to test double definitions~~ feat!: move closer to test double definitions Apr 13, 2022

ebebbington approved these changes Apr 13, 2022

View reviewed changes

crookse merged commit d3fbffe into breaking-remove-runner Apr 14, 2022

crookse deleted the feat/new-mock-methods branch April 14, 2022 01:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: move closer to test double definitions #150

feat!: move closer to test double definitions #150

crookse commented Apr 11, 2022 •

edited

Loading

ebebbington left a comment

ebebbington Apr 12, 2022

crookse Apr 12, 2022

crookse Apr 13, 2022

ebebbington Apr 12, 2022

crookse Apr 12, 2022

crookse Apr 13, 2022

ebebbington Apr 12, 2022

crookse Apr 13, 2022

ebebbington Apr 12, 2022

ebebbington Apr 12, 2022

crookse Apr 13, 2022

feat!: move closer to test double definitions #150

feat!: move closer to test double definitions #150

Conversation

crookse commented Apr 11, 2022 • edited Loading

Overview of commits

Updated README

Refactor and add features to be closer to test double definitions

Stub()

Use mixin for mock

Add mock.method(...).willReturn(...)

Add mock.method(...).willThrow(...)

Add mock.expects(...).toBeCalled(...)

Add Fake()

Add Dummy()

ebebbington left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crookse commented Apr 11, 2022 •

edited

Loading