Repository navigation
Expand file tree
/
Copy pathcli-smoke.ts
More file actions
342 lines (313 loc) · 11.4 KB
/
Copy pathcli-smoke.ts
File metadata and controls
342 lines (313 loc) · 11.4 KB
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
/**
* 배포 전 로컬 CLI smoke 테스트
*/
import { spawn } from 'node:child_process';
import path from 'node:path';
import {
CU_UPSTREAM_BLOCK_PATTERNS,
EMART24_UPSTREAM_403_PATTERNS,
SEVENELEVEN_UPSTREAM_403_PATTERNS,
} from '../../src/api/healthCheckDefinitions.js';
interface CommandResult {
exitCode: number;
stdout: string;
stderr: string;
}
type RunCommand = (command: string, args: string[]) => Promise<CommandResult>;
type WriteFn = (message: string) => void;
type Validator = (stdout: string, stderr: string) => string | null;
type SmokeService =
| 'daiso_jp'
| 'daiso'
| 'cu'
| 'gs25'
| 'seveneleven'
| 'emart24'
| 'oliveyoung'
| 'megabox'
| 'lottecinema'
| 'cgv'
| 'dtryx'
| 'opinet';
interface CliSmokeDeps {
runCommand?: RunCommand;
writeOut?: WriteFn;
writeErr?: WriteFn;
command?: string;
cliPath?: string;
service?: string;
}
const DEFAULT_CLI_PATH = path.resolve('dist/bin.js');
interface CliSmokeCommand {
service: SmokeService;
scenario: string;
args: string[];
expectedExitCode?: number;
degradedFailurePatterns?: string[];
validate: Validator;
}
function parseJson(stdout: string): unknown {
return JSON.parse(stdout.trim());
}
function isRecord(value: unknown): value is Record<string, unknown> {
return typeof value === 'object' && value !== null && !Array.isArray(value);
}
function validateHealth(stdout: string): string | null {
const payload = parseJson(stdout);
if (!isRecord(payload) || payload.status !== 'ok') {
return 'health 응답 status가 ok가 아닙니다';
}
return null;
}
function validateApiEnvelope(
stdout: string,
check?: (data: Record<string, unknown>) => string | null,
): string | null {
const payload = parseJson(stdout);
if (!isRecord(payload) || payload.success !== true || !isRecord(payload.data)) {
return 'API 응답이 success=true envelope가 아닙니다';
}
return typeof check === 'function' ? check(payload.data) : null;
}
function expectDataField(
key: string,
expected: string,
): (data: Record<string, unknown>) => string | null {
return (data) => {
if (data[key] !== expected) {
return `data.${key}가 ${expected}가 아닙니다`;
}
return null;
};
}
function validateStderrContains(expected: string): Validator {
return (_stdout, stderr) =>
stderr.includes(expected) ? null : `stderr에 "${expected}"가 없습니다`;
}
function validateJapanProduct(payload: Record<string, unknown>): string | null {
const valid = payload.country === 'JP' && payload.currency === 'JPY' &&
payload.id === '4550746075917' && typeof payload.name === 'string' && payload.name.trim().length > 0 &&
(typeof payload. 'boolean' || payload. null) &&
payload.storeInventorySupported === false;
return valid ? null : '일본 상품 상세의 필수 필드 또는 판매 가능 여부가 올바르지 않습니다';
}
function validateJapanCollection(payload: Record<string, unknown>, key: 'products' | 'stores'): string | null {
const items = payload[key];
const valid = payload.country === 'JP' && Array.isArray(items) && items.length > 0 &&
items.every((item) => isRecord(item) &&
typeof item.id === 'string' && item.id.trim().length > 0 &&
typeof item.name === 'string' && item.name.trim().length > 0 &&
(key === 'products' ? item.currency === 'JPY' : typeof item.brand === 'string' && item.brand.trim().length > 0));
return valid ? null : `일본 ${key}의 국가 또는 필수 필드가 올바르지 않습니다`;
}
export const CLI_SMOKE_COMMANDS: CliSmokeCommand[] = [
{ service: 'daiso', scenario: 'health', args: ['health'], validate: validateHealth },
{
service: 'daiso',
scenario: '상품명만 아는 사용자',
args: ['products', '수납박스', '--pageSize', '1', '--json'],
validate: validateApiEnvelope,
},
{
service: 'daiso',
scenario: '기본 위치 검색',
args: ['stores', '강남역', '--limit', '1', '--json'],
validate: validateApiEnvelope,
},
{
service: 'daiso',
scenario: '위치를 대강 말하는 사용자',
args: ['stores', '안산 중앙역', '--limit', '1', '--json'],
validate: validateApiEnvelope,
},
{
service: 'daiso',
scenario: '잘못된 옵션을 입력한 사용자',
args: ['inventory', '1034604', '--store', '강남역점'],
expectedExitCode: 1,
validate: validateStderrContains('알 수 없는 옵션: --store'),
},
{
service: 'daiso_jp',
scenario: '일본 다이소 상품 검색',
args: ['jp-products', 'ボウル', '--json'],
validate: (stdout) => validateApiEnvelope(stdout, (data) => validateJapanCollection(data, 'products')),
},
{
service: 'daiso_jp',
scenario: '일본 다이소 상품 상세',
args: ['jp-product', '4550746075917', '--json'],
validate: (stdout) => validateApiEnvelope(stdout, validateJapanProduct),
},
{
service: 'daiso_jp',
scenario: '일본 다이소 매장 검색',
args: ['jp-stores', '渋谷', '--json'],
validate: (stdout) => validateApiEnvelope(stdout, (data) => validateJapanCollection(data, 'stores')),
},
{
service: 'cu',
scenario: 'CU 매장 검색',
args: ['cu-stores', '강남', '--limit', '1', '--json'],
degradedFailurePatterns: CU_UPSTREAM_BLOCK_PATTERNS,
validate: (stdout) => validateApiEnvelope(stdout, expectDataField('keyword', '강남')),
},
{
service: 'gs25',
scenario: 'GS25 상품명 검색',
args: ['gs25-products', '콜라', '--limit', '1', '--json'],
validate: (stdout) => validateApiEnvelope(stdout, expectDataField('keyword', '콜라')),
},
{
service: 'gs25',
scenario: 'GS25 위치 검색',
args: ['gs25-stores', '강남', '--limit', '1', '--json'],
validate: (stdout) => validateApiEnvelope(stdout, expectDataField('keyword', '강남')),
},
{
service: 'seveneleven',
scenario: '세븐일레븐 상품명 검색',
args: ['seveneleven-products', '커피', '--size', '1', '--json'],
degradedFailurePatterns: SEVENELEVEN_UPSTREAM_403_PATTERNS,
validate: (stdout) => validateApiEnvelope(stdout, expectDataField('query', '커피')),
},
{
service: 'emart24',
scenario: '이마트24 상품명 검색',
args: ['emart24-products', '커피', '--pageSize', '1', '--json'],
degradedFailurePatterns: EMART24_UPSTREAM_403_PATTERNS,
validate: (stdout) => validateApiEnvelope(stdout, expectDataField('keyword', '커피')),
},
{
service: 'oliveyoung',
scenario: '올리브영 get 상품 검색',
args: ['get', '/api/oliveyoung/products', '--keyword', '선크림', '--size', '1', '--json'],
validate: (stdout) => validateApiEnvelope(stdout, expectDataField('keyword', '선크림')),
},
{
service: 'megabox',
scenario: '메가박스 위치 검색',
args: ['megabox-theaters', '강남', '--limit', '1', '--json'],
validate: (stdout) => validateApiEnvelope(stdout, expectDataField('keyword', '강남')),
},
{
service: 'lottecinema',
scenario: '롯데시네마 위치 검색',
args: ['lottecinema-theaters', '잠실', '--limit', '1', '--json'],
validate: (stdout) => validateApiEnvelope(stdout, expectDataField('keyword', '잠실')),
},
{
service: 'cgv',
scenario: 'CGV get 위치 검색',
args: ['get', '/api/cgv/theaters', '--keyword', '강남', '--limit', '1', '--json'],
validate: (stdout) => validateApiEnvelope(stdout, expectDataField('keyword', '강남')),
},
{
service: 'opinet',
scenario: '오피넷 전국 평균 유가 조회',
args: ['get', '/api/opinet/average', '--json'],
validate: (stdout) => validateApiEnvelope(stdout, expectDataField('provider', 'opinet')),
},
{
service: 'dtryx',
scenario: '디트릭스 상영작 조회',
args: ['get', '/api/dtryx/movies', '--cinemaCode', '000067', '--json'],
validate: (stdout) =>
validateApiEnvelope(stdout, (data) => {
const first = Array.isArray(data.movies) ? data.movies[0] : undefined;
return isRecord(first) &&
typeof first.movieCode === 'string' &&
typeof first.movieName === 'string'
? null
: '디트릭스 상영작의 movieCode 또는 movieName이 없습니다';
}),
},
];
function parseServiceArg(argv: string[]): string | undefined {
const serviceIndex = argv.indexOf('--service');
if (serviceIndex >= 0) {
return argv[serviceIndex + 1];
}
return process.env.CLI_SMOKE_SERVICE;
}
async function execCommand(command: string, args: string[]): Promise<CommandResult> {
return await new Promise<CommandResult>((resolve, reject) => {
const child = spawn(command, args, {
stdio: ['ignore', 'pipe', 'pipe'],
shell: false,
});
let stdout = '';
let stderr = '';
child.stdout?.setEncoding('utf8');
child.stderr?.setEncoding('utf8');
child.stdout?.on('data', (chunk) => {
stdout += chunk;
});
child.stderr?.on('data', (chunk) => {
stderr += chunk;
});
child.on('error', reject);
child.on('close', (code) => {
resolve({ exitCode: code ?? 1, stdout, stderr });
});
});
}
function matchesDegradedFailure(command: CliSmokeCommand, result: CommandResult): boolean {
const output = `${result.stdout}\n${result.stderr}`;
return command.degradedFailurePatterns?.some((pattern) => output.includes(pattern)) ?? false;
}
export async function runCliSmoke(deps: CliSmokeDeps = {}): Promise<number> {
const runCommand = deps.runCommand || execCommand;
const writeOut = deps.writeOut || ((message: string) => process.stdout.write(`${message}\n`));
const writeErr = deps.writeErr || ((message: string) => process.stderr.write(`${message}\n`));
const command = deps.command || process.execPath;
const cliPath = deps.cliPath || DEFAULT_CLI_PATH;
const service = deps.service || parseServiceArg(process.argv.slice(2));
const commands = service
? CLI_SMOKE_COMMANDS.filter((smokeCommand) => smokeCommand.service === service)
: CLI_SMOKE_COMMANDS;
if (commands.length === 0) {
writeErr(`CLI smoke 실패: 지원하지 않는 service=${service}`);
return 1;
}
for (const smokeCommand of commands) {
const { args, expectedExitCode = 0, validate } = smokeCommand;
const fullArgs = [cliPath, ...args];
writeOut(`CLI smoke 실행: ${command} ${fullArgs.join(' ')}`);
const result = await runCommand(command, fullArgs);
if (result.exitCode !== expectedExitCode) {
if (matchesDegradedFailure(smokeCommand, result)) {
writeErr(`CLI smoke degraded: ${args.join(' ')} known upstream issue`);
continue;
}
writeErr(`CLI smoke 실패: ${args.join(' ')} exited with ${result.exitCode}`);
if (result.stdout) {
writeErr(result.stdout.trim());
}
if (result.stderr) {
writeErr(result.stderr.trim());
}
return result.exitCode;
}
try {
const validationError = validate(result.stdout, result.stderr);
if (validationError) {
writeErr(`CLI smoke 검증 실패: ${args.join(' ')} - ${validationError}`);
writeErr(result.stdout.trim());
return 1;
}
} catch (error) {
const message = error instanceof Error ? error.message : '알 수 없는 오류';
writeErr(`CLI smoke 검증 실패: ${args.join(' ')} - ${message}`);
writeErr(result.stdout.trim());
return 1;
}
}
writeOut(`${commands.length} CLI smoke command(s) passed`);
return 0;
}
if (import.meta.url === `file://${process.argv[1]}`) {
runCliSmoke().then((exitCode) => {
process.exit(exitCode);
});
}