Skip to content

Commit 19c2d66

Browse files
authored
Fix asserts and related stubs. (#206)
* Fix asserts and related stubs. * Address comments.
1 parent 4c3f886 commit 19c2d66

2 files changed

Lines changed: 48 additions & 72 deletions

File tree

handwritten/logging-winston/samples/test/logs.test.js

Lines changed: 38 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ function getSample () {
2828
var entryMock = {};
2929
var logMock = {
3030
entry: sinon.stub().returns(entryMock),
31-
write: sinon.stub().callsArgWith(1, null, apiResponseMock),
32-
delete: sinon.stub().callsArgWith(0, null, apiResponseMock),
33-
getEntries: sinon.stub().callsArgWith(0, null, entriesMock)
31+
write: sinon.stub().yields(null, apiResponseMock),
32+
delete: sinon.stub().yields(null, apiResponseMock),
33+
getEntries: sinon.stub().yields(null, entriesMock)
3434
};
3535
var loggingMock = {
3636
log: sinon.stub().returns(logMock),
37-
getEntries: sinon.stub().callsArgWith(1, null, entriesMock)
37+
getEntries: sinon.stub().yields(null, entriesMock)
3838
};
3939
var LoggingMock = sinon.stub().returns(loggingMock);
4040

@@ -62,27 +62,24 @@ describe('logging:entries', function () {
6262

6363
sample.program.listLogEntries(logName, callback);
6464

65-
assert(sample.mocks.log.getEntries.calledOnce, 'method called once');
66-
assert.equal(sample.mocks.log.getEntries.firstCall.args.length, 1, 'method received 1 argument');
67-
assert(callback.calledOnce, 'callback called once');
68-
assert.equal(callback.firstCall.args.length, 2, 'callback received 2 arguments');
69-
assert.ifError(callback.firstCall.args[0], 'callback did not receive error');
70-
assert.strictEqual(callback.firstCall.args[1], sample.mocks.entries, 'callback received result');
71-
assert(console.log.calledWith('Found %d entries!', sample.mocks.entries.length));
65+
assert.equal(sample.mocks.log.getEntries.calledOnce, true);
66+
assert.deepEqual(sample.mocks.log.getEntries.firstCall.args.slice(0, -1), []);
67+
assert.equal(callback.calledOnce, true);
68+
assert.deepEqual(callback.firstCall.args, [null, sample.mocks.entries]);
69+
assert.equal(console.log.calledOnce, true);
70+
assert.deepEqual(console.log.firstCall.args, ['Found %d entries!', sample.mocks.entries.length]);
7271
});
7372

7473
it('should handle error', function () {
7574
var error = new Error('error');
7675
var sample = getSample();
7776
var callback = sinon.stub();
78-
sample.mocks.log.getEntries = sinon.stub().callsArgWith(0, error);
77+
sample.mocks.log.getEntries = sinon.stub().yields(error);
7978

8079
sample.program.listLogEntries(logName, callback);
8180

82-
assert(callback.calledOnce, 'callback called once');
83-
assert.equal(callback.firstCall.args.length, 1, 'callback received 1 argument');
84-
assert(callback.firstCall.args[0], 'callback received error');
85-
assert.equal(callback.firstCall.args[0].message, error.message, 'error has correct message');
81+
assert.equal(callback.calledOnce, true);
82+
assert.deepEqual(callback.firstCall.args, [error]);
8683
});
8784
});
8885

@@ -93,32 +90,28 @@ describe('logging:entries', function () {
9390

9491
sample.program.listLogEntriesAdvanced(filter, limit, sort, callback);
9592

96-
assert(sample.mocks.logging.getEntries.calledOnce, 'method called once');
97-
assert.equal(sample.mocks.logging.getEntries.firstCall.args.length, 2, 'method received 2 arguments');
98-
assert.deepEqual(sample.mocks.logging.getEntries.firstCall.args[0], {
93+
assert.equal(sample.mocks.logging.getEntries.calledOnce, true);
94+
assert.deepEqual(sample.mocks.logging.getEntries.firstCall.args.slice(0, -1), [{
9995
pageSize: limit,
10096
filter: filter,
10197
orderBy: sort
102-
}, 'method received options');
103-
assert(callback.calledOnce, 'callback called once');
104-
assert.equal(callback.firstCall.args.length, 2, 'callback received 2 arguments');
105-
assert.ifError(callback.firstCall.args[0], 'callback did not receive error');
106-
assert.strictEqual(callback.firstCall.args[1], sample.mocks.entries, 'callback received result');
107-
assert(console.log.calledWith('Found %d entries!', sample.mocks.entries.length));
98+
}]);
99+
assert.equal(callback.calledOnce, true);
100+
assert.deepEqual(callback.firstCall.args, [null, sample.mocks.entries]);
101+
assert.equal(console.log.calledOnce, true);
102+
assert.deepEqual(console.log.firstCall.args, ['Found %d entries!', sample.mocks.entries.length]);
108103
});
109104

110105
it('should handle error', function () {
111106
var error = new Error('error');
112107
var sample = getSample();
113108
var callback = sinon.stub();
114-
sample.mocks.logging.getEntries = sinon.stub().callsArgWith(1, error);
109+
sample.mocks.logging.getEntries = sinon.stub().yields(error);
115110

116111
sample.program.listLogEntriesAdvanced(null, null, null, callback);
117112

118-
assert(callback.calledOnce, 'callback called once');
119-
assert.equal(callback.firstCall.args.length, 1, 'callback received 1 argument');
120-
assert(callback.firstCall.args[0], 'callback received error');
121-
assert.equal(callback.firstCall.args[0].message, error.message, 'error has correct message');
113+
assert.equal(callback.calledOnce, true);
114+
assert.deepEqual(callback.firstCall.args, [error]);
122115
});
123116
});
124117

@@ -129,27 +122,24 @@ describe('logging:entries', function () {
129122

130123
sample.program.writeLogEntry(logName, callback);
131124

132-
assert(sample.mocks.log.write.calledOnce, 'method called once');
133-
assert.equal(sample.mocks.log.write.firstCall.args.length, 2, 'method received 2 arguments');
134-
assert(callback.calledOnce, 'callback called once');
135-
assert.equal(callback.firstCall.args.length, 2, 'callback received 2 arguments');
136-
assert.ifError(callback.firstCall.args[0], 'callback did not receive error');
137-
assert.strictEqual(callback.firstCall.args[1], sample.mocks.apiResponse, 'callback received result');
138-
assert(console.log.calledWith('Wrote to %s', logName));
125+
assert.equal(sample.mocks.log.write.calledOnce, true);
126+
assert.deepEqual(sample.mocks.log.write.firstCall.args.slice(0, -1), [[sample.mocks.log.entry(), sample.mocks.log.entry()]]);
127+
assert.equal(callback.calledOnce, true);
128+
assert.deepEqual(callback.firstCall.args, [null, sample.mocks.apiResponse]);
129+
assert.equal(console.log.calledOnce, true);
130+
assert.deepEqual(console.log.firstCall.args, ['Wrote to %s', logName]);
139131
});
140132

141133
it('should handle error', function () {
142134
var error = new Error('error');
143135
var sample = getSample();
144136
var callback = sinon.stub();
145-
sample.mocks.log.write = sinon.stub().callsArgWith(1, error);
137+
sample.mocks.log.write = sinon.stub().yields(error);
146138

147139
sample.program.writeLogEntry(logName, callback);
148140

149-
assert(callback.calledOnce, 'callback called once');
150-
assert.equal(callback.firstCall.args.length, 1, 'callback received 1 argument');
151-
assert(callback.firstCall.args[0], 'callback received error');
152-
assert.equal(callback.firstCall.args[0].message, error.message, 'error has correct message');
141+
assert.equal(callback.calledOnce, true);
142+
assert.deepEqual(callback.firstCall.args, [error]);
153143
});
154144
});
155145

@@ -177,14 +167,12 @@ describe('logging:entries', function () {
177167
var error = new Error('error');
178168
var sample = getSample();
179169
var callback = sinon.stub();
180-
sample.mocks.log.write = sinon.stub().callsArgWith(1, error);
170+
sample.mocks.log.write = sinon.stub().yields(error);
181171

182172
sample.program.writeLogEntryAdvanced(logName, {}, callback);
183173

184-
assert(callback.calledOnce, 'callback called once');
185-
assert.equal(callback.firstCall.args.length, 1, 'callback received 1 argument');
186-
assert(callback.firstCall.args[0], 'callback received error');
187-
assert.equal(callback.firstCall.args[0].message, error.message, 'error has correct message');
174+
assert.equal(callback.calledOnce, true);
175+
assert.deepEqual(callback.firstCall.args, [error]);
188176
});
189177
});
190178

@@ -208,14 +196,12 @@ describe('logging:entries', function () {
208196
var error = new Error('error');
209197
var sample = getSample();
210198
var callback = sinon.stub();
211-
sample.mocks.log.delete = sinon.stub().callsArgWith(0, error);
199+
sample.mocks.log.delete = sinon.stub().yields(error);
212200

213201
sample.program.deleteLog(logName, callback);
214202

215-
assert(callback.calledOnce, 'callback called once');
216-
assert.equal(callback.firstCall.args.length, 1, 'callback received 1 argument');
217-
assert(callback.firstCall.args[0], 'callback received error');
218-
assert.equal(callback.firstCall.args[0].message, error.message, 'error has correct message');
203+
assert.equal(callback.calledOnce, true);
204+
assert.deepEqual(callback.firstCall.args, [error]);
219205
});
220206
});
221207

handwritten/logging-winston/samples/test/sinks.test.js

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -93,10 +93,8 @@ describe('logging:sinks', function () {
9393

9494
sample.program.createSink(sinkName, bucketName, filter, callback);
9595

96-
assert(callback.calledOnce, 'callback called once');
97-
assert.equal(callback.firstCall.args.length, 1, 'callback received 1 argument');
98-
assert(callback.firstCall.args[0], 'callback received error');
99-
assert.equal(callback.firstCall.args[0].message, error.message, 'error has correct message');
96+
assert.equal(callback.calledOnce, true);
97+
assert.deepEqual(callback.firstCall.args, [error]);
10098
});
10199
});
102100

@@ -124,10 +122,8 @@ describe('logging:sinks', function () {
124122

125123
sample.program.getSinkMetadata(sinkName, callback);
126124

127-
assert(callback.calledOnce, 'callback called once');
128-
assert.equal(callback.firstCall.args.length, 1, 'callback received 1 argument');
129-
assert(callback.firstCall.args[0], 'callback received error');
130-
assert.equal(callback.firstCall.args[0].message, error.message, 'error has correct message');
125+
assert.equal(callback.calledOnce, true);
126+
assert.deepEqual(callback.firstCall.args, [error]);
131127
});
132128
});
133129

@@ -155,10 +151,8 @@ describe('logging:sinks', function () {
155151

156152
sample.program.listSinks(callback);
157153

158-
assert(callback.calledOnce, 'callback called once');
159-
assert.equal(callback.firstCall.args.length, 1, 'callback received 1 argument');
160-
assert(callback.firstCall.args[0], 'callback received error');
161-
assert.equal(callback.firstCall.args[0].message, error.message, 'error has correct message');
154+
assert.equal(callback.calledOnce, true);
155+
assert.deepEqual(callback.firstCall.args, [error]);
162156
});
163157
});
164158

@@ -189,10 +183,8 @@ describe('logging:sinks', function () {
189183

190184
sample.program.updateSink(sinkName, filter, callback);
191185

192-
assert(callback.calledOnce, 'callback called once');
193-
assert.equal(callback.firstCall.args.length, 1, 'callback received 1 argument');
194-
assert(callback.firstCall.args[0], 'callback received error');
195-
assert.equal(callback.firstCall.args[0].message, error.message, 'error has correct message');
186+
assert.equal(callback.calledOnce, true);
187+
assert.deepEqual(callback.firstCall.args, [error]);
196188
});
197189
});
198190

@@ -220,10 +212,8 @@ describe('logging:sinks', function () {
220212

221213
sample.program.deleteSink(sinkName, callback);
222214

223-
assert(callback.calledOnce, 'callback called once');
224-
assert.equal(callback.firstCall.args.length, 1, 'callback received 1 argument');
225-
assert(callback.firstCall.args[0], 'callback received error');
226-
assert.equal(callback.firstCall.args[0].message, error.message, 'error has correct message');
215+
assert.equal(callback.calledOnce, true);
216+
assert.deepEqual(callback.firstCall.args, [error]);
227217
});
228218
});
229219

0 commit comments

Comments
 (0)