-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathintegration_http_api.test.ts
258 lines (191 loc) · 11 KB
/
integration_http_api.test.ts
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
254
255
256
257
258
import dotenv from 'dotenv';
import { HttpResponse } from '../src/lib/FetchHttpClient';
import { HttpApiClient } from '../src/lib/HttpApiClient';
import { HttpApi } from '../src/lib/HttpApi';
import { IpAddrInfoResult } from '../src/lib/IpAddrInfoTypes';
import { ALL_FIELDS } from '../src/constants';
import { just_lat_lng, delay_ms } from './integration_test_constants';
dotenv.config();
const Server = new HttpApi;
const Client = new HttpApiClient;
// Start/stop HTTP API before/after testing
beforeAll( async() => {
await Server.start();
} );
afterAll( async() => {
await Server.stop();
} );
let first_ran = false;
// Sleep for configured delay between each test
beforeEach( ( done ) => {
if( ! first_ran ) {
first_ran = true;
return done();
}
setTimeout( done, delay_ms );
} );
describe( 'HTTP API Integration', () => {
test( 'Healthcheck passes', async() => {
const response = await Client.check_health();
expect( response ).toBe( true );
} );
test( 'Bad healthcheck returns false', async() => {
// Set the client port to something garbage
const SussyClient = new HttpApiClient;
SussyClient.port = 1;
const response = await SussyClient.check_health();
expect( response ).toBe( false );
} );
test( 'Successful IP lookup 8.8.8.8 - query all fields', async() => {
const response = await Client.lookup_ip( '8.8.8.8', ALL_FIELDS ) as HttpResponse;
response.response_data as IpAddrInfoResult;
expect( response.response_data.success ).toBe( true );
expect( response.response_data.query_start_at ).toBeInstanceOf( Date );
expect( response.response_data.query_stop_at ).toBeInstanceOf( Date );
expect( typeof response.response_data.query_ms ).toBe( 'number' );
expect( response.response_data.query_ms ).toBeGreaterThan( 0 );
// Check no errors
expect( Array.isArray( response.response_data.errors ) ).toBe( true );
expect( response.response_data.errors.length ).toBe( 0 );
// Check nested 'data' properties
expect( response.response_data.data?.queried_ip_addr ).toBe( '8.8.8.8' );
expect( response.response_data.data?.query_status ).toBe( 'success' );
expect( response.response_data.data?.query_message ).toBeUndefined();
expect( response.response_data.data?.country ).toBe( 'United States' );
expect( response.response_data.data?.country_code ).toBe( 'US' );
expect( response.response_data.data?.continent ).toBe( 'North America' );
expect( response.response_data.data?.continent_code ).toBe( 'NA' );
expect( response.response_data.data?.region ).toBe( 'VA' );
expect( response.response_data.data?.region_name ).toBe( 'Virginia' );
expect( response.response_data.data?.city ).toBe( 'Ashburn' );
expect( response.response_data.data?.district ).toBe( '' );
expect( response.response_data.data?.zip ).toBe( '20149' );
expect( response.response_data.data?.lat ).toBe( 39.03 );
expect( response.response_data.data?.lon ).toBe( -77.5 );
expect( response.response_data.data?.timezone ).toBe( 'America/New_York' );
expect( response.response_data.data?.offset ).toBe( -14400 );
expect( response.response_data.data?.isp ).toBe( 'Google LLC' );
expect( response.response_data.data?.org ).toBe( 'Google Public DNS' );
expect( response.response_data.data?.as ).toBe( 'AS15169 Google LLC' );
expect( response.response_data.data?.as_name ).toBe( 'GOOGLE' );
expect( response.response_data.data?.is_mobile ).toBe( false );
expect( response.response_data.data?.is_proxy ).toBe( false );
expect( response.response_data.data?.is_hosting ).toBe( true );
expect( response.response_data.data?.reverse ).toBe( 'dns.google' );
} );
test( 'Successful IP lookup 8.8.8.8 - query some fields', async() => {
const response = await Client.lookup_ip( '8.8.8.8', just_lat_lng ) as HttpResponse;
response.response_data as IpAddrInfoResult;
expect( response.response_data.success ).toBe( true );
expect( response.response_data.query_start_at ).toBeInstanceOf( Date );
expect( response.response_data.query_stop_at ).toBeInstanceOf( Date );
expect( typeof response.response_data.query_ms ).toBe( 'number' );
expect( response.response_data.query_ms ).toBeGreaterThan( 0 );
// Check no errors
expect( Array.isArray( response.response_data.errors ) ).toBe( true );
expect( response.response_data.errors.length ).toBe( 0 );
// Check nested 'data' properties
expect( response.response_data.data?.query_status ).toBe( 'success' );
expect( response.response_data.data?.lat ).toBe( 39.03 );
expect( response.response_data.data?.lon ).toBe( -77.5 );
expect( response.response_data.data?.queried_ip_addr ).toBe( '8.8.8.8' );
expect( response.response_data.data?.query_message ).toBeUndefined();
expect( response.response_data.data?.country ).toBeUndefined();
expect( response.response_data.data?.country_code ).toBeUndefined();
expect( response.response_data.data?.continent ).toBeUndefined();
expect( response.response_data.data?.continent_code ).toBeUndefined();
expect( response.response_data.data?.region ).toBeUndefined();
expect( response.response_data.data?.region_name ).toBeUndefined();
expect( response.response_data.data?.city ).toBeUndefined();
expect( response.response_data.data?.district ).toBeUndefined();
expect( response.response_data.data?.zip ).toBeUndefined();
expect( response.response_data.data?.timezone ).toBeUndefined();
expect( response.response_data.data?.offset ).toBeUndefined();
expect( response.response_data.data?.isp ).toBeUndefined();
expect( response.response_data.data?.org ).toBeUndefined();
expect( response.response_data.data?.as ).toBeUndefined();
expect( response.response_data.data?.as_name ).toBeUndefined();
expect( response.response_data.data?.is_mobile ).toBeUndefined();
expect( response.response_data.data?.is_proxy ).toBeUndefined();
expect( response.response_data.data?.is_hosting ).toBeUndefined();
expect( response.response_data.data?.reverse ).toBeUndefined();
} );
test( 'Failed IP lookup 8.8.8.X - invalid IP address', async() => {
const response = await Client.lookup_ip( '8.8.8.X', [ 'isp' ] ) as HttpResponse;
response.response_data as IpAddrInfoResult;
console.log( response );
expect( response.response_data.success ).toBe( false );
expect( response.response_data.query_start_at ).toBeUndefined();
expect( response.response_data.query_stop_at ).toBeUndefined();
expect( response.response_data.query_ms ).toBeUndefined();
expect( Array.isArray( response.response_data.errors ) ).toBe( true );
expect( response.response_data.errors.length ).toBe( 1 );
expect( response.response_data.errors ).toContain( 'IP address format invalid' );
expect( response.response_data.data ).toBeUndefined();
} );
test( 'Failed IP lookup "" - empty IP address', async() => {
const response = await Client.lookup_ip( '', [ 'isp' ] ) as HttpResponse;
response.response_data as IpAddrInfoResult;
expect( response.response_data.success ).toBe( false );
expect( response.response_data.query_start_at ).toBeUndefined();
expect( response.response_data.query_stop_at ).toBeUndefined();
expect( response.response_data.query_ms ).toBeUndefined();
expect( Array.isArray( response.response_data.errors ) ).toBe( true );
expect( response.response_data.errors.length ).toBe( 2 );
expect( response.response_data.errors ).toContain( 'IP address format invalid' );
expect( response.response_data.errors ).toContain( 'IP address cannot be empty' );
expect( response.response_data.data ).toBeUndefined();
} );
test( 'Failed IP lookup 10.255.255.1 - not routable/private range', async() => {
const response = await Client.lookup_ip( '10.255.255.1', [ 'isp' ] ) as HttpResponse;
response.response_data as IpAddrInfoResult;
expect( response.response_data.success ).toBe( false );
expect( response.status_code ).toBe( 400 );
expect( response.response_data.query_start_at ).toBeInstanceOf( Date );
expect( response.response_data.query_stop_at ).toBeInstanceOf( Date );
expect( typeof response.response_data.query_ms ).toBe( 'number' );
expect( response.response_data.query_ms ).toBeGreaterThan( 0 );
expect( Array.isArray( response.response_data.errors ) ).toBe( true );
expect( response.response_data.errors.length ).toBe( 2 );
expect( response.response_data.errors ).toContain( 'API response status "fail" != "success"' );
expect( response.response_data.errors ).toContain( 'API error message "private range"' );
expect( response.response_data.data ).toBeUndefined();
} );
test( 'Throws exception [from HttpApiClient]', async() => {
// Set the client port to something garbage
const SussyClient = new HttpApiClient;
SussyClient.port = 1;
// Should be able to check for error instance here but TypeError does not show equivalent
await expect( SussyClient.lookup_ip( '8.8.8.8', [ 'isp' ] ) )
.rejects
.toThrow( /* TypeError */ );
} );
test( 'Throws exception [from IpApiClient] - Test IP 10.255.255.2', async() => {
const response = await Client.lookup_ip( '10.255.255.2', [ 'isp' ] );
expect( response.status_code ).toBe( 500 );
expect( response.response_data?.success ).toBe( false );
expect( response.response_data?.errors ).toEqual( [ 'Unexpected exception occured! Check console/log output for more details' ] );
} );
test( 'Handles non-200 response - Test IP 10.255.255.3', async() => {
const response = await Client.lookup_ip( '10.255.255.3', [ 'isp' ] );
expect( response.status_code ).toBe( 400 );
expect( response.response_data?.success ).toBe( false );
expect( response.response_data?.errors ).toContain( 'Non-200 status code returned from API call - is 400' );
} );
test( 'Successful IP lookup 8.8.8.8 - status added if not explictly asked for', async() => {
const response = await Client.lookup_ip( '8.8.8.8', [] ) as HttpResponse;
response.response_data as IpAddrInfoResult;
expect( response.response_data.success ).toBe( true );
// Ensure status field gets added back on
expect( response.response_data.data?.query_status ).toBe( 'success' );
} );
test( 'Server stop after stopped throws', async() => {
// Stop server (is in running state)
await Server.stop();
await expect( Server.stop() )
.rejects
.toThrow();
// Restart so in known-state for more tests
await Server.start();
} );
} );