aboutsummaryrefslogtreecommitdiffstats
path: root/packages/assert/test/assert_test.ts
blob: 0af493bda07ec4ad2b6d245f6a1843c8561dc10e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
import { schemas } from '@0xproject/json-schemas';
import { BigNumber } from '@0xproject/utils';
import * as chai from 'chai';
import * as dirtyChai from 'dirty-chai';
import 'mocha';

import { assert } from '../src/index';

chai.config.includeStack = true;
chai.use(dirtyChai);
const expect = chai.expect;

describe('Assertions', () => {
    const variableName = 'variable';
    describe('#isBigNumber', () => {
        it('should not throw for valid input', () => {
            const validInputs = [new BigNumber(23), new BigNumber('45')];
            validInputs.forEach(input => expect(assert.isBigNumber.bind(assert, variableName, input)).to.not.throw());
        });
        it('should throw for invalid input', () => {
            const invalidInputs = ['test', 42, false, { random: 'test' }, undefined];
            invalidInputs.forEach(input => expect(assert.isBigNumber.bind(assert, variableName, input)).to.throw());
        });
    });
    describe('#isValidBaseUnitAmount', () => {
        it('should not throw for valid input', () => {
            const validInputs = [new BigNumber(23), new BigNumber('45000000')];
            validInputs.forEach(input =>
                expect(assert.isValidBaseUnitAmount.bind(assert, variableName, input)).to.not.throw(),
            );
        });
        it('should throw for invalid input', () => {
            const invalidInputs = [0, undefined, new BigNumber(3.145), 3.145, new BigNumber(-400)];
            invalidInputs.forEach(input =>
                expect(assert.isValidBaseUnitAmount.bind(assert, variableName, input)).to.throw(),
            );
        });
    });
    describe('#isString', () => {
        it('should not throw for valid input', () => {
            const validInputs = ['hello', 'goodbye'];
            validInputs.forEach(input => expect(assert.isString.bind(assert, variableName, input)).to.not.throw());
        });
        it('should throw for invalid input', () => {
            const invalidInputs = [42, false, { random: 'test' }, undefined, new BigNumber(45)];
            invalidInputs.forEach(input => expect(assert.isString.bind(assert, variableName, input)).to.throw());
        });
    });
    describe('#isFunction', () => {
        it('should not throw for valid input', () => {
            const validInputs = [BigNumber, assert.isString];
            validInputs.forEach(input => expect(assert.isFunction.bind(assert, variableName, input)).to.not.throw());
        });
        it('should throw for invalid input', () => {
            const invalidInputs = [42, false, { random: 'test' }, undefined, new BigNumber(45)];
            invalidInputs.forEach(input => expect(assert.isFunction.bind(assert, variableName, input)).to.throw());
        });
    });
    describe('#isHexString', () => {
        it('should not throw for valid input', () => {
            const validInputs = [
                '0x61a3ed31B43c8780e905a260a35faefEc527be7516aa11c0256729b5b351bc33',
                '0x40349190569279751135161d22529dc25add4f6069af05be04cacbda2ace2254',
            ];
            validInputs.forEach(input => expect(assert.isHexString.bind(assert, variableName, input)).to.not.throw());
        });
        it('should throw for invalid input', () => {
            const invalidInputs = [
                42,
                false,
                { random: 'test' },
                undefined,
                new BigNumber(45),
                '0x61a3ed31B43c8780e905a260a35faYfEc527be7516aa11c0256729b5b351bc33',
            ];
            invalidInputs.forEach(input => expect(assert.isHexString.bind(assert, variableName, input)).to.throw());
        });
    });
    describe('#isETHAddressHex', () => {
        it('should not throw for valid input', () => {
            const validInputs = [
                '0x0000000000000000000000000000000000000000',
                '0x6fffd0ae3f7d88c9b4925323f54c6e4b2918c5fd',
                '0x12459c951127e0c374ff9105dda097662a027093',
            ];
            validInputs.forEach(input =>
                expect(assert.isETHAddressHex.bind(assert, variableName, input)).to.not.throw(),
            );
        });
        it('should throw for invalid input', () => {
            const invalidInputs = [
                42,
                false,
                { random: 'test' },
                undefined,
                new BigNumber(45),
                '0x6FFFd0ae3f7d88c9b4925323f54c6e4b2918c5fd',
                '0x6FFFd0ae3f7d88c9b4925323f54c6e4',
            ];
            invalidInputs.forEach(input => expect(assert.isETHAddressHex.bind(assert, variableName, input)).to.throw());
        });
    });
    describe('#doesBelongToStringEnum', () => {
        enum TestEnums {
            Test1 = 'Test1',
            Test2 = 'Test2',
        }
        it('should not throw for valid input', () => {
            const validInputs = [TestEnums.Test1, TestEnums.Test2];
            validInputs.forEach(input =>
                expect(assert.doesBelongToStringEnum.bind(assert, variableName, input, TestEnums)).to.not.throw(),
            );
        });
        it('should throw for invalid input', () => {
            const invalidInputs = [42, false, { random: 'test' }, undefined, new BigNumber(45)];
            invalidInputs.forEach(input =>
                expect(assert.doesBelongToStringEnum.bind(assert, variableName, input, TestEnums)).to.throw(),
            );
        });
    });
    describe('#hasAtMostOneUniqueValue', () => {
        const errorMsg = 'more than one unique value';
        it('should not throw for valid input', () => {
            const validInputs = [['hello'], ['goodbye', 'goodbye', 'goodbye']];
            validInputs.forEach(input =>
                expect(assert.hasAtMostOneUniqueValue.bind(assert, input, errorMsg)).to.not.throw(),
            );
        });
        it('should throw for invalid input', () => {
            const invalidInputs = [['hello', 'goodbye'], ['goodbye', 42, false, false]];
            invalidInputs.forEach(input =>
                expect(assert.hasAtMostOneUniqueValue.bind(assert, input, errorMsg)).to.throw(),
            );
        });
    });
    describe('#isNumber', () => {
        it('should not throw for valid input', () => {
            const validInputs = [42, 0, 21e42];
            validInputs.forEach(input => expect(assert.isNumber.bind(assert, variableName, input)).to.not.throw());
        });
        it('should throw for invalid input', () => {
            const invalidInputs = [false, { random: 'test' }, undefined, new BigNumber(45)];
            invalidInputs.forEach(input => expect(assert.isNumber.bind(assert, variableName, input)).to.throw());
        });
    });
    describe('#isBoolean', () => {
        it('should not throw for valid input', () => {
            const validInputs = [true, false];
            validInputs.forEach(input => expect(assert.isBoolean.bind(assert, variableName, input)).to.not.throw());
        });
        it('should throw for invalid input', () => {
            const invalidInputs = [42, { random: 'test' }, undefined, new BigNumber(45)];
            invalidInputs.forEach(input => expect(assert.isBoolean.bind(assert, variableName, input)).to.throw());
        });
    });
    describe('#isWeb3Provider', () => {
        it('should not throw for valid input', () => {
            const validInputs = [{ send: () => 45 }, { sendAsync: () => 45 }];
            validInputs.forEach(input =>
                expect(assert.isWeb3Provider.bind(assert, variableName, input)).to.not.throw(),
            );
        });
        it('should throw for invalid input', () => {
            const invalidInputs = [42, { random: 'test' }, undefined, new BigNumber(45)];
            invalidInputs.forEach(input => expect(assert.isWeb3Provider.bind(assert, variableName, input)).to.throw());
        });
    });
    describe('#doesConformToSchema', () => {
        const schema = schemas.addressSchema;
        it('should not throw for valid input', () => {
            const validInputs = [
                '0x6fffd0ae3f7d88c9b4925323f54c6e4b2918c5fd',
                '0x12459c951127e0c374ff9105dda097662a027093',
            ];
            validInputs.forEach(input =>
                expect(assert.doesConformToSchema.bind(assert, variableName, input, schema)).to.not.throw(),
            );
        });
        it('should throw for invalid input', () => {
            const invalidInputs = [42, { random: 'test' }, undefined, new BigNumber(45)];
            invalidInputs.forEach(input =>
                expect(assert.doesConformToSchema.bind(assert, variableName, input, schema)).to.throw(),
            );
        });
    });
    describe('#isHttpUrl', () => {
        it('should not throw for valid input', () => {
            const validInputs = [
                'http://www.google.com',
                'https://api.example-relayer.net',
                'https://api.radarrelay.com/0x/v0/',
                'https://zeroex.beta.radarrelay.com:8000/0x/v0/',
            ];
            validInputs.forEach(input => expect(assert.isHttpUrl.bind(assert, variableName, input)).to.not.throw());
        });
        it('should throw for invalid input', () => {
            const invalidInputs = [
                42,
                { random: 'test' },
                undefined,
                new BigNumber(45),
                'ws://www.api.example-relayer.net',
                'www.google.com',
                'api.example-relayer.net',
                'user:password@api.example-relayer.net',
                '//api.example-relayer.net',
            ];
            invalidInputs.forEach(input => expect(assert.isHttpUrl.bind(assert, variableName, input)).to.throw());
        });
    });
    describe('#isUri', () => {
        it('should not throw for valid input', () => {
            const validInputs = [
                'http://www.google.com',
                'https://api.example-relayer.net',
                'https://api.radarrelay.com/0x/v0/',
                'https://zeroex.beta.radarrelay.com:8000/0x/v0/',
                'ws://www.api.example-relayer.net',
                'wss://www.api.example-relayer.net',
                'user:password@api.example-relayer.net',
            ];
            validInputs.forEach(input => expect(assert.isUri.bind(assert, variableName, input)).to.not.throw());
        });
        it('should throw for invalid input', () => {
            const invalidInputs = [
                42,
                { random: 'test' },
                undefined,
                new BigNumber(45),
                'www.google.com',
                'api.example-relayer.net',
                '//api.example-relayer.net',
            ];
            invalidInputs.forEach(input => expect(assert.isUri.bind(assert, variableName, input)).to.throw());
        });
    });
    describe('#assert', () => {
        const assertMessage = 'assert not satisfied';
        it('should not throw for valid input', () => {
            expect(assert.assert.bind(assert, true, assertMessage)).to.not.throw();
        });
        it('should throw for invalid input', () => {
            expect(assert.assert.bind(assert, false, assertMessage)).to.throw();
        });
    });
    describe('#typeAssertionMessage', () => {
        it('should render correct message', () => {
            expect(assert.typeAssertionMessage('variable', 'string', 'number')).to.equal(
                `Expected variable to be of type string, encountered: number`,
            );
        });
    });
});