steps.py 45 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123
  1. import asyncio
  2. import collections
  3. import json
  4. import os
  5. import re
  6. import socket
  7. import subprocess
  8. import sys
  9. import threading
  10. import time
  11. from contextlib import closing
  12. from re import RegexFlag
  13. import aiohttp
  14. import numpy as np
  15. import openai
  16. from behave import step
  17. from behave.api.async_step import async_run_until_complete
  18. from huggingface_hub import hf_hub_download
  19. from prometheus_client import parser
  20. @step("a server listening on {server_fqdn}:{server_port}")
  21. def step_server_config(context, server_fqdn, server_port):
  22. context.server_fqdn = server_fqdn
  23. context.server_port = int(server_port)
  24. context.n_gpu_layer = None
  25. if 'PORT' in os.environ:
  26. context.server_port = int(os.environ['PORT'])
  27. print(f"$PORT set, overriding server port with to {context.server_port}")
  28. if 'FQDN' in os.environ:
  29. context.server_fqdn = os.environ['FQDN']
  30. print(f"$FQDN set, overriding server fqdn with to {context.server_fqdn}")
  31. if 'N_GPU_LAYERS' in os.environ:
  32. context.n_gpu_layer = int(os.environ['N_GPU_LAYERS'])
  33. print(f"$N_GPU_LAYERS set, overriding n_gpu_layer with to {context.n_gpu_layer}")
  34. context.base_url = f'http://{context.server_fqdn}:{context.server_port}'
  35. context.model_alias = None
  36. context.model_file = None
  37. context.model_url = None
  38. context.n_batch = None
  39. context.n_ubatch = None
  40. context.n_ctx = None
  41. context.n_ga = None
  42. context.n_ga_w = None
  43. context.n_predict = None
  44. context.n_prompts = 0
  45. context.n_server_predict = None
  46. context.n_slots = None
  47. context.prompt_prefix = None
  48. context.prompt_suffix = None
  49. context.server_api_key = None
  50. context.server_continuous_batching = False
  51. context.server_embeddings = False
  52. context.server_metrics = False
  53. context.server_process = None
  54. context.seed = None
  55. context.server_seed = None
  56. context.user_api_key = None
  57. context.tasks_result = []
  58. context.concurrent_tasks = []
  59. context.prompts = []
  60. @step('a model file {hf_file} from HF repo {hf_repo}')
  61. def step_download_hf_model(context, hf_file, hf_repo):
  62. context.model_file = hf_hub_download(repo_id=hf_repo, filename=hf_file)
  63. if context.debug:
  64. print(f"model file: {context.model_file}")
  65. @step('a model file {model_file}')
  66. def step_model_file(context, model_file):
  67. context.model_file = model_file
  68. @step('a model url {model_url}')
  69. def step_model_url(context, model_url):
  70. context.model_url = model_url
  71. @step('a model alias {model_alias}')
  72. def step_model_alias(context, model_alias):
  73. context.model_alias = model_alias
  74. @step('{seed:d} as server seed')
  75. def step_seed(context, seed):
  76. context.server_seed = seed
  77. @step('{ngl:d} GPU offloaded layers')
  78. def step_n_gpu_layer(context, ngl):
  79. if 'N_GPU_LAYERS' in os.environ:
  80. new_ngl = int(os.environ['N_GPU_LAYERS'])
  81. if context.debug:
  82. print(f"-ngl upgraded from {ngl} to {new_ngl}")
  83. ngl = new_ngl
  84. context.n_gpu_layer = ngl
  85. @step('{n_ctx:d} KV cache size')
  86. def step_n_ctx(context, n_ctx):
  87. context.n_ctx = n_ctx
  88. @step('{n_slots:d} slots')
  89. def step_n_slots(context, n_slots):
  90. context.n_slots = n_slots
  91. @step('{n_predict:d} server max tokens to predict')
  92. def step_server_n_predict(context, n_predict):
  93. context.n_server_predict = n_predict
  94. @step('continuous batching')
  95. def step_server_continuous_batching(context):
  96. context.server_continuous_batching = True
  97. @step('embeddings extraction')
  98. def step_server_embeddings(context):
  99. context.server_embeddings = True
  100. @step('prometheus compatible metrics exposed')
  101. def step_server_metrics(context):
  102. context.server_metrics = True
  103. @step("the server is starting")
  104. def step_start_server(context):
  105. start_server_background(context)
  106. attempts = 0
  107. max_attempts = 20
  108. if 'GITHUB_ACTIONS' in os.environ:
  109. max_attempts *= 2
  110. addrs = socket.getaddrinfo(context.server_fqdn, context.server_port, type=socket.SOCK_STREAM)
  111. family, typ, proto, _, sockaddr = addrs[0]
  112. while True:
  113. with closing(socket.socket(family, typ, proto)) as sock:
  114. result = sock.connect_ex(sockaddr)
  115. if result == 0:
  116. print("\x1b[33;46mserver started!\x1b[0m")
  117. return
  118. attempts += 1
  119. if attempts > max_attempts:
  120. assert False, "server not started"
  121. print(f"waiting for server to start, connect error code = {result}...")
  122. time.sleep(0.1)
  123. @step("the server is {expecting_status}")
  124. @async_run_until_complete
  125. async def step_wait_for_the_server_to_be_started(context, expecting_status):
  126. match expecting_status:
  127. case 'healthy':
  128. await wait_for_health_status(context, context.base_url, 200, 'ok',
  129. timeout=30)
  130. case 'ready' | 'idle':
  131. await wait_for_health_status(context, context.base_url, 200, 'ok',
  132. timeout=10,
  133. params={'fail_on_no_slot': 0, 'include_slots': 0},
  134. slots_idle=context.n_slots,
  135. slots_processing=0,
  136. expected_slots=[{'id': slot_id, 'state': 0}
  137. for slot_id in
  138. range(context.n_slots if context.n_slots else 1)])
  139. case 'busy':
  140. await wait_for_health_status(context, context.base_url, 503,
  141. 'no slot available',
  142. params={'fail_on_no_slot': 0, 'include_slots': 0},
  143. slots_idle=0,
  144. slots_processing=context.n_slots,
  145. expected_slots=[{'id': slot_id, 'state': 1}
  146. for slot_id in
  147. range(context.n_slots if context.n_slots else 1)])
  148. case _:
  149. assert False, "unknown status"
  150. @step('all slots are {expected_slot_status_string}')
  151. @async_run_until_complete
  152. async def step_all_slots_status(context, expected_slot_status_string):
  153. match expected_slot_status_string:
  154. case 'idle':
  155. expected_slot_status = 0
  156. case 'busy':
  157. expected_slot_status = 1
  158. case _:
  159. assert False, "unknown status"
  160. expected_slots = [{'id': slot_id, 'state': expected_slot_status}
  161. for slot_id in range(context.n_slots)]
  162. await request_slots_status(context, expected_slots)
  163. @step('a completion request with {api_error} api error')
  164. @async_run_until_complete
  165. async def step_request_completion(context, api_error):
  166. expect_api_error = api_error == 'raised'
  167. completion = await request_completion(context.prompts.pop(),
  168. context.base_url,
  169. debug=context.debug,
  170. n_predict=context.n_predict,
  171. seed=await completions_seed(context),
  172. expect_api_error=expect_api_error,
  173. user_api_key=context.user_api_key)
  174. context.tasks_result.append(completion)
  175. if context.debug:
  176. print(f"Completion response: {completion}")
  177. if expect_api_error:
  178. assert completion == 401, f"completion must be an 401 status code: {completion}"
  179. @step('{predicted_n:d} tokens are predicted matching {re_content}')
  180. def step_n_tokens_predicted_with_content(context, predicted_n, re_content):
  181. context.completion = context.tasks_result.pop()
  182. assert_n_tokens_predicted(context.completion, predicted_n, re_content)
  183. @step('{predicted_n:d} tokens are predicted')
  184. def step_n_tokens_predicted(context, predicted_n):
  185. context.completion = context.tasks_result.pop()
  186. assert_n_tokens_predicted(context.completion, predicted_n)
  187. @step('the completion is truncated')
  188. def step_assert_completion_truncated(context):
  189. step_assert_completion_truncated(context, '')
  190. @step('the completion is {truncated} truncated')
  191. def step_assert_completion_truncated(context, truncated):
  192. truncated = truncated != "not"
  193. assert context.completion['truncated'] == truncated, f'{context.completion}'
  194. @step('{n_prompt:d} prompt tokens are processed')
  195. def step_impl(context, n_prompt):
  196. assert n_prompt < 0 or n_prompt == context.completion['timings']['prompt_n'], f"n_prompt={context.completion['timings']['prompt_n']}"
  197. @step('a user prompt {user_prompt}')
  198. def step_user_prompt(context, user_prompt):
  199. context.prompts.append(user_prompt)
  200. context.n_prompts = len(context.prompts)
  201. @step('a system prompt {system_prompt}')
  202. def step_system_prompt(context, system_prompt):
  203. context.system_prompt = system_prompt
  204. @step('a model {model}')
  205. def step_model(context, model):
  206. context.model = model
  207. @step('{max_tokens:d} max tokens to predict')
  208. def step_max_tokens(context, max_tokens):
  209. context.n_predict = max_tokens
  210. @step('streaming is {enable_streaming}')
  211. def step_streaming(context, enable_streaming):
  212. context.enable_streaming = enable_streaming == 'enabled'
  213. @step('a user api key {user_api_key}')
  214. def step_user_api_key(context, user_api_key):
  215. context.user_api_key = user_api_key
  216. @step('no user api key')
  217. def step_no_user_api_key(context):
  218. context.user_api_key = None
  219. @step('a user api key ')
  220. def step_no_user_api_key_space(context):
  221. context.user_api_key = None
  222. @step('a server api key {server_api_key}')
  223. def step_server_api_key(context, server_api_key):
  224. context.server_api_key = server_api_key
  225. @step('{n_junk:d} as number of junk')
  226. def step_n_junk(context, n_junk):
  227. context.n_junk = n_junk
  228. @step('{n_batch:d} as batch size')
  229. def step_n_batch(context, n_batch):
  230. context.n_batch = n_batch
  231. @step('{n_ubatch:d} as ubatch size')
  232. def step_n_ubatch(context, n_ubatch):
  233. context.n_ubatch = n_ubatch
  234. @step('{seed:d} as seed')
  235. def step_seed(context, seed):
  236. context.seed = seed
  237. @step('a prefix prompt')
  238. def step_prompt_prefix(context):
  239. context.prompt_prefix = context_text(context)
  240. @step('a junk suffix prompt')
  241. def step_prompt_junk_suffix(context):
  242. context.prompt_junk_suffix = context_text(context)
  243. @step('a suffix prompt')
  244. def step_prompt_suffix(context):
  245. context.prompt_suffix = context_text(context)
  246. @step('{n_ga:d} group attention factor'
  247. ' to extend context size through self-extend')
  248. def step_impl(context, n_ga):
  249. context.n_ga = n_ga
  250. @step('{n_ga_w:d} group attention width to extend context size through self-extend')
  251. def step_impl(context, n_ga_w):
  252. context.n_ga_w = n_ga_w
  253. @step('a passkey prompt template')
  254. def step_prompt_passkey(context):
  255. context.prompt_passkey = context_text(context)
  256. @step('{n_prompts:d} fixed prompts')
  257. def step_fixed_prompts(context, n_prompts):
  258. context.prompts.extend([str(0)*(context.n_batch if context.n_batch is not None else 512) for i in range(n_prompts)])
  259. context.n_prompts = n_prompts
  260. @step('a "{passkey}" passkey challenge prompt with the passkey inserted every {i_pos:d} junk')
  261. def step_prompt_passkey(context, passkey, i_pos):
  262. prompt = ""
  263. for i in range(context.n_junk):
  264. if i % context.n_junk == i_pos:
  265. prompt += context.prompt_passkey # the passkey is already substituted
  266. prompt += context.prompt_junk_suffix
  267. if context.debug:
  268. passkey_highlight = "\x1b[33m" + passkey + "\x1b[0m"
  269. print(f"Passkey challenge:\n```{prompt.replace(passkey, passkey_highlight)}```")
  270. context.prompts.append(context.prompt_prefix + prompt + context.prompt_suffix)
  271. context.n_prompts = len(context.prompts)
  272. @step('an OAI compatible chat completions request with {api_error} api error')
  273. @async_run_until_complete
  274. async def step_oai_chat_completions(context, api_error):
  275. if context.debug:
  276. print(f"Submitting OAI compatible completions request...")
  277. expect_api_error = api_error == 'raised'
  278. completion = await oai_chat_completions(context.prompts.pop(),
  279. context.system_prompt,
  280. context.base_url,
  281. '/v1/chat',
  282. False,
  283. model=context.model if hasattr(context, 'model') else None,
  284. n_predict=context.n_predict
  285. if hasattr(context, 'n_predict') else None,
  286. enable_streaming=context.enable_streaming
  287. if hasattr(context, 'enable_streaming') else None,
  288. seed=await completions_seed(context),
  289. user_api_key=context.user_api_key
  290. if hasattr(context, 'user_api_key') else None,
  291. expect_api_error=expect_api_error)
  292. context.tasks_result.append(completion)
  293. if context.debug:
  294. print(f"Completion response: {completion}")
  295. if expect_api_error:
  296. assert completion == 401, f"completion must be an 401 status code: {completion}"
  297. if context.debug:
  298. print(f"Completion response: {completion}")
  299. @step('a prompt')
  300. def step_a_prompt(context):
  301. context.prompts.append(context_text(context))
  302. context.n_prompts = len(context.prompts)
  303. @step('a prompt {prompt}')
  304. def step_a_prompt_prompt(context, prompt):
  305. context.prompts.append(prompt)
  306. context.n_prompts = len(context.prompts)
  307. @step('concurrent completion requests')
  308. @async_run_until_complete()
  309. async def step_concurrent_completion_requests(context):
  310. await concurrent_requests(context,
  311. request_completion,
  312. # prompt is inserted automatically
  313. context.base_url,
  314. debug=context.debug,
  315. prompt_prefix=context.prompt_prefix,
  316. prompt_suffix=context.prompt_suffix,
  317. n_predict=context.n_predict if hasattr(context, 'n_predict') else None,
  318. seed=await completions_seed(context),
  319. user_api_key=context.user_api_key if hasattr(context,
  320. 'user_api_key') else None)
  321. @step('concurrent OAI completions requests')
  322. @async_run_until_complete
  323. async def step_oai_chat_completions(context):
  324. await concurrent_requests(context, oai_chat_completions,
  325. # user_prompt is inserted automatically
  326. context.system_prompt,
  327. context.base_url,
  328. '/v1/chat/completions',
  329. True, # async_client
  330. model=context.model
  331. if hasattr(context, 'model') else None,
  332. n_predict=context.n_predict
  333. if hasattr(context, 'n_predict') else None,
  334. enable_streaming=context.enable_streaming
  335. if hasattr(context, 'enable_streaming') else None,
  336. seed=await completions_seed(context),
  337. user_api_key=context.user_api_key
  338. if hasattr(context, 'user_api_key') else None)
  339. @step('concurrent OAI completions requests no v1')
  340. @async_run_until_complete
  341. async def step_oai_chat_completions(context):
  342. await concurrent_requests(context, oai_chat_completions,
  343. # user_prompt is inserted automatically
  344. context.system_prompt,
  345. context.base_url,
  346. '/chat/completions',
  347. True, # async_client
  348. model=context.model
  349. if hasattr(context, 'model') else None,
  350. n_predict=context.n_predict
  351. if hasattr(context, 'n_predict') else None,
  352. enable_streaming=context.enable_streaming
  353. if hasattr(context, 'enable_streaming') else None,
  354. seed=context.seed
  355. if hasattr(context, 'seed') else
  356. context.server_seed
  357. if hasattr(context, 'server_seed') else None,
  358. user_api_key=context.user_api_key
  359. if hasattr(context, 'user_api_key') else None)
  360. @step('all prompts are predicted')
  361. @async_run_until_complete
  362. async def step_all_prompts_are_predicted(context):
  363. await all_prompts_are_predicted(context)
  364. @step('all prompts are predicted with {n_expected_predicted:d} tokens')
  365. @async_run_until_complete
  366. async def step_all_prompts_are_predicted_with_n_tokens(context, n_expected_predicted):
  367. await all_prompts_are_predicted(context, n_expected_predicted)
  368. async def all_prompts_are_predicted(context, expected_predicted_n=None):
  369. n_completions = await gather_tasks_results(context)
  370. assert n_completions > 0
  371. for i in range(n_completions):
  372. assert_n_tokens_predicted(context.tasks_result.pop(), expected_predicted_n=expected_predicted_n)
  373. assert len(context.concurrent_tasks) == 0, f"{len(context.concurrent_tasks)} pending requests"
  374. @step('embeddings are computed for')
  375. @async_run_until_complete
  376. async def step_compute_embedding(context):
  377. context.n_prompts = 1
  378. context.embeddings = await request_embedding(context_text(context), base_url=context.base_url)
  379. @step('all embeddings are the same')
  380. @async_run_until_complete
  381. async def step_all_embeddings_are_the_same(context):
  382. n_embedding_requests = await gather_tasks_results(context)
  383. assert n_embedding_requests > 0
  384. embeddings = []
  385. for i in range(n_embedding_requests):
  386. embedding = context.tasks_result.pop().pop()
  387. embeddings.append(embedding)
  388. assert_embeddings(embedding)
  389. n = len(embeddings)
  390. for i in range(n-1):
  391. for j in range(i+1, n):
  392. embedding1 = np.array(embeddings[i])
  393. embedding2 = np.array(embeddings[j])
  394. if context.debug:
  395. print(f"embedding1: {embedding1[-8:]}")
  396. print(f"embedding2: {embedding2[-8:]}")
  397. similarity = np.dot(embedding1, embedding2) / (np.linalg.norm(embedding1) * np.linalg.norm(embedding2))
  398. msg = f"Similarity between {i} and {j}: {similarity:.10f}"
  399. if context.debug:
  400. print(f"{msg}")
  401. assert np.isclose(similarity, 1.0, rtol=1e-05, atol=1e-08, equal_nan=False), msg
  402. @step('embeddings are generated')
  403. def step_assert_embeddings(context):
  404. assert context.n_prompts == len(context.embeddings), (f"unexpected response:\n"
  405. f"context.n_prompts={context.n_prompts}\n"
  406. f"context.embeddings={context.embeddings}")
  407. for embedding in context.embeddings:
  408. assert_embeddings(embedding)
  409. @step('an OAI compatible embeddings computation request for')
  410. @async_run_until_complete
  411. async def step_oai_compute_embeddings(context):
  412. context.n_prompts = 1
  413. context.embeddings = await request_oai_embeddings(context_text(context),
  414. base_url=context.base_url,
  415. user_api_key=context.user_api_key,
  416. model=context.model)
  417. @step('an OAI compatible embeddings computation request for multiple inputs')
  418. @async_run_until_complete
  419. async def step_oai_compute_embeddings_multiple_inputs(context):
  420. context.embeddings = await request_oai_embeddings(context.prompts,
  421. base_url=context.base_url,
  422. user_api_key=context.user_api_key,
  423. model=context.model)
  424. context.prompts.clear()
  425. @step('concurrent embedding requests')
  426. @async_run_until_complete()
  427. async def step_concurrent_embedding_requests(context):
  428. await concurrent_requests(context,
  429. request_embedding,
  430. # prompt is inserted automatically
  431. base_url=context.base_url)
  432. @step('concurrent OAI embedding requests')
  433. @async_run_until_complete()
  434. async def step_concurrent_oai_embedding_requests(context):
  435. await concurrent_requests(context,
  436. request_oai_embeddings,
  437. # prompt is inserted automatically
  438. base_url=context.base_url,
  439. async_client=True,
  440. model=context.model)
  441. @step('all embeddings are generated')
  442. @async_run_until_complete()
  443. async def all_embeddings_are_generated(context):
  444. n_embedding_requests = await gather_tasks_results(context)
  445. assert n_embedding_requests == context.n_prompts
  446. for i in range(n_embedding_requests):
  447. assert_embeddings(context.tasks_result.pop().pop())
  448. @step('tokenizing')
  449. @async_run_until_complete
  450. async def step_tokenize(context):
  451. context.tokenized_text = context_text(context)
  452. async with aiohttp.ClientSession() as session:
  453. async with session.post(f'{context.base_url}/tokenize',
  454. json={
  455. "content": context.tokenized_text,
  456. }) as response:
  457. assert response.status == 200
  458. tokenize_json = await response.json()
  459. context.tokens = tokenize_json['tokens']
  460. @step('tokens can be detokenize')
  461. @async_run_until_complete
  462. async def step_detokenize(context):
  463. assert len(context.tokens) > 0
  464. async with aiohttp.ClientSession() as session:
  465. async with session.post(f'{context.base_url}/detokenize',
  466. json={
  467. "tokens": context.tokens,
  468. }) as response:
  469. assert response.status == 200
  470. detokenize_json = await response.json()
  471. # SPM tokenizer adds a whitespace prefix: https://github.com/google/sentencepiece/issues/15
  472. assert context.tokenized_text == detokenize_json['content'].strip()
  473. @step('an OPTIONS request is sent from {origin}')
  474. @async_run_until_complete
  475. async def step_options_request(context, origin):
  476. async with aiohttp.ClientSession() as session:
  477. headers = {'Authorization': f'Bearer {context.user_api_key}', 'Origin': origin}
  478. async with session.options(f'{context.base_url}/v1/chat/completions',
  479. headers=headers) as response:
  480. assert response.status == 200
  481. context.options_response = response
  482. @step('CORS header {cors_header} is set to {cors_header_value}')
  483. def step_check_options_header_value(context, cors_header, cors_header_value):
  484. assert context.options_response.headers[cors_header] == cors_header_value
  485. @step('prometheus metrics are exposed')
  486. @async_run_until_complete
  487. async def step_prometheus_metrics_exported(context):
  488. async with aiohttp.ClientSession() as session:
  489. async with await session.get(f'{context.base_url}/metrics') as metrics_response:
  490. assert metrics_response.status == 200
  491. assert metrics_response.headers['Content-Type'] == "text/plain; version=0.0.4"
  492. metrics_raw = await metrics_response.text()
  493. metric_exported = False
  494. if context.debug:
  495. print(f"/metrics answer:\n{metrics_raw}")
  496. context.metrics = {}
  497. for metric in parser.text_string_to_metric_families(metrics_raw):
  498. match metric.name:
  499. case "llamacpp:kv_cache_usage_ratio":
  500. assert len(metric.samples) > 0
  501. metric_exported = True
  502. context.metrics[metric.name] = metric
  503. assert int(metrics_response.headers["Process-Start-Time-Unix"]) > 0, "no header process start time"
  504. assert metric_exported, "No metrics exported"
  505. @step('metric {metric_name} is {metric_value:d}')
  506. def step_assert_metric_value(context, metric_name, metric_value):
  507. if metric_name not in context.metrics:
  508. assert False, f"no metric {metric_name} in {context.metrics.keys()}"
  509. assert context.metrics[metric_name].samples[0].value == metric_value, f"metric: {context.metrics[metric_name]}"
  510. @step('available models')
  511. def step_available_models(context):
  512. # openai client always expects an api_key
  513. openai.api_key = context.user_api_key if context.user_api_key is not None else 'nope'
  514. openai.api_base = f'{context.base_url}/v1'
  515. context.models = openai.Model.list().data
  516. @step('{n_model:d} models are supported')
  517. def step_supported_models(context, n_model):
  518. if context.debug:
  519. print("server models available:", context.models)
  520. assert len(context.models) == n_model
  521. @step('model {i_model:d} is {param} {preposition} {param_value}')
  522. def step_supported_models(context, i_model, param, preposition, param_value):
  523. assert i_model < len(context.models)
  524. model = context.models[i_model]
  525. param_value = param_value.split(' ', 1)[0]
  526. match param:
  527. case 'identified':
  528. value = model.id
  529. case 'trained':
  530. value = str(model.meta.n_ctx_train)
  531. case _:
  532. assert False, "param {param} not supported"
  533. assert param_value == value, f"model param {param} {value} != {param_value}"
  534. async def concurrent_requests(context, f_completion, *args, **kwargs):
  535. context.n_prompts = len(context.prompts)
  536. if context.debug:
  537. print(f"starting {context.n_prompts} concurrent completion requests...")
  538. assert context.n_prompts > 0
  539. for prompt_no in range(context.n_prompts):
  540. shifted_args = [context.prompts.pop(), *args]
  541. context.concurrent_tasks.append(asyncio.create_task(f_completion(*shifted_args, **kwargs)))
  542. await asyncio.sleep(0.1)
  543. async def request_completion(prompt,
  544. base_url,
  545. debug=False,
  546. prompt_prefix=None,
  547. prompt_suffix=None,
  548. n_predict=None,
  549. seed=None,
  550. expect_api_error=None,
  551. user_api_key=None):
  552. if debug:
  553. print(f"Sending completion request: {prompt}")
  554. origin = "my.super.domain"
  555. headers = {
  556. 'Origin': origin
  557. }
  558. if user_api_key is not None:
  559. if debug:
  560. print(f"Set user_api_key: {user_api_key}")
  561. headers['Authorization'] = f'Bearer {user_api_key}'
  562. async with aiohttp.ClientSession() as session:
  563. async with session.post(f'{base_url}/completion',
  564. json={
  565. "input_prefix": prompt_prefix,
  566. "prompt": prompt,
  567. "input_suffix": prompt_suffix,
  568. "n_predict": n_predict if n_predict is not None else -1,
  569. "seed": seed if seed is not None else 42
  570. },
  571. headers=headers,
  572. timeout=3600) as response:
  573. if expect_api_error is None or not expect_api_error:
  574. assert response.status == 200
  575. assert response.headers['Access-Control-Allow-Origin'] == origin
  576. return await response.json()
  577. else:
  578. return response.status
  579. async def oai_chat_completions(user_prompt,
  580. system_prompt,
  581. base_url,
  582. base_path,
  583. async_client,
  584. debug=False,
  585. model=None,
  586. n_predict=None,
  587. enable_streaming=None,
  588. seed=None,
  589. user_api_key=None,
  590. expect_api_error=None):
  591. if debug:
  592. print(f"Sending OAI Chat completions request: {user_prompt}")
  593. # openai client always expects an api key
  594. user_api_key = user_api_key if user_api_key is not None else 'nope'
  595. seed = seed if seed is not None else 42
  596. enable_streaming = enable_streaming if enable_streaming is not None else False
  597. payload = {
  598. "messages": [
  599. {
  600. "role": "system",
  601. "content": system_prompt,
  602. },
  603. {
  604. "role": "user",
  605. "content": user_prompt,
  606. }
  607. ],
  608. "model": model,
  609. "max_tokens": n_predict,
  610. "stream": enable_streaming,
  611. "seed": seed
  612. }
  613. completion_response = {
  614. 'content': '',
  615. 'timings': {
  616. 'predicted_n': 0,
  617. 'prompt_n': 0
  618. }
  619. }
  620. if async_client:
  621. origin = 'llama.cpp'
  622. headers = {'Authorization': f'Bearer {user_api_key}', 'Origin': origin}
  623. async with aiohttp.ClientSession() as session:
  624. async with session.post(f'{base_url}{base_path}',
  625. json=payload,
  626. headers=headers) as response:
  627. if enable_streaming:
  628. assert response.status == 200
  629. assert response.headers['Access-Control-Allow-Origin'] == origin
  630. assert response.headers['Content-Type'] == "text/event-stream"
  631. event_received = True
  632. while event_received:
  633. event_received = False
  634. async for line_in_bytes in response.content:
  635. line = line_in_bytes.decode('utf8')
  636. line = line.rstrip('\n').rstrip('\r')
  637. if line == '':
  638. continue
  639. event_data = line.split(': ', 1)
  640. assert event_data[0] == 'data', f'Bad event code received: ```{event_data}```'
  641. chunk_raw = event_data[1]
  642. chunk = json.loads(chunk_raw)
  643. assert len(chunk['choices']) == 1, f"no choices provided, line ```{line}```"
  644. delta = chunk['choices'][0]['delta']
  645. if 'content' in delta:
  646. completion_response['content'] += delta['content']
  647. completion_response['timings']['predicted_n'] += 1
  648. else:
  649. if expect_api_error is None or not expect_api_error:
  650. assert response.status == 200
  651. assert response.headers['Access-Control-Allow-Origin'] == origin
  652. assert response.headers['Content-Type'] == "application/json; charset=utf-8"
  653. chat_completion_raw = await response.json()
  654. completion_response = {
  655. 'content': chat_completion_raw['choices'][0]['message'],
  656. 'timings': {
  657. 'predicted_n': chat_completion_raw['usage']['completion_tokens'],
  658. 'prompt_n': chat_completion_raw['usage']['prompt_tokens']
  659. }
  660. }
  661. else:
  662. return response.status
  663. else:
  664. try:
  665. openai.api_key = user_api_key
  666. openai.api_base = f'{base_url}{base_path}'
  667. chat_completion = openai.Completion.create(
  668. messages=payload['messages'],
  669. model=model,
  670. max_tokens=n_predict,
  671. stream=enable_streaming,
  672. seed=seed
  673. )
  674. except openai.error.AuthenticationError as e:
  675. if expect_api_error is not None and expect_api_error:
  676. return 401
  677. else:
  678. assert False, f'error raised: {e}'
  679. if enable_streaming:
  680. for chunk in chat_completion:
  681. assert len(chunk.choices) == 1
  682. delta = chunk.choices[0].delta
  683. if 'content' in delta:
  684. completion_response['content'] += delta['content']
  685. completion_response['timings']['predicted_n'] += 1
  686. completion_response['truncated'] = chunk.choices[0].finish_reason != 'stop'
  687. else:
  688. assert len(chat_completion.choices) == 1
  689. completion_response = {
  690. 'content': chat_completion.choices[0].message.content,
  691. 'timings': {
  692. 'predicted_n': chat_completion.usage.completion_tokens,
  693. 'prompt_n': chat_completion.usage.prompt_tokens
  694. },
  695. 'truncated': chat_completion.choices[0].finish_reason != 'stop'
  696. }
  697. if debug:
  698. print("OAI response formatted to llama.cpp:", completion_response)
  699. return completion_response
  700. async def request_embedding(content, base_url=None):
  701. async with aiohttp.ClientSession() as session:
  702. async with session.post(f'{base_url}/embedding',
  703. json={
  704. "content": content,
  705. }) as response:
  706. assert response.status == 200
  707. response_json = await response.json()
  708. return [response_json['embedding']]
  709. async def request_oai_embeddings(input,
  710. base_url=None, user_api_key=None,
  711. model=None, async_client=False):
  712. # openai client always expects an api_key
  713. user_api_key = user_api_key if user_api_key is not None else 'nope'
  714. if async_client:
  715. origin = 'llama.cpp'
  716. headers=[]
  717. if user_api_key is not None:
  718. headers = {'Authorization': f'Bearer {user_api_key}', 'Origin': origin}
  719. async with aiohttp.ClientSession() as session:
  720. async with session.post(f'{base_url}/v1/embeddings',
  721. json={
  722. "input": input,
  723. "model": model,
  724. },
  725. headers=headers,
  726. timeout=3600) as response:
  727. assert response.status == 200, f"received status code not expected: {response.status}"
  728. assert response.headers['Access-Control-Allow-Origin'] == origin
  729. assert response.headers['Content-Type'] == "application/json; charset=utf-8"
  730. response_json = await response.json()
  731. assert response_json['model'] == model, f"invalid model received: {response_json['model']}"
  732. assert response_json['object'] == 'list'
  733. if isinstance(input, collections.abc.Sequence):
  734. embeddings = []
  735. for an_oai_embeddings in response_json['data']:
  736. embeddings.append(an_oai_embeddings['embedding'])
  737. else:
  738. embeddings = [response_json['data']['embedding']]
  739. return embeddings
  740. else:
  741. openai.api_key = user_api_key
  742. openai.api_base = f'{base_url}/v1'
  743. oai_embeddings = openai.Embedding.create(
  744. model=model,
  745. input=input,
  746. )
  747. if isinstance(input, collections.abc.Sequence):
  748. embeddings = []
  749. for an_oai_embeddings in oai_embeddings.data:
  750. embeddings.append(an_oai_embeddings.embedding)
  751. else:
  752. embeddings = [oai_embeddings.data.embedding]
  753. return embeddings
  754. def assert_n_tokens_predicted(completion_response, expected_predicted_n=None, re_content=None):
  755. content = completion_response['content']
  756. n_predicted = completion_response['timings']['predicted_n']
  757. assert len(content) > 0, "no token predicted"
  758. if re_content is not None:
  759. p = re.compile(re_content, flags=RegexFlag.IGNORECASE | RegexFlag.MULTILINE | RegexFlag.DOTALL)
  760. matches = p.finditer(content)
  761. last_match = 0
  762. highlighted = ''
  763. for match in matches:
  764. start, end = match.span()
  765. highlighted += content[last_match: start]
  766. highlighted += '\x1b[33m'
  767. highlighted += content[start: end]
  768. highlighted += '\x1b[0m'
  769. last_match = end
  770. highlighted += content[last_match:]
  771. if 'DEBUG' in os.environ and os.environ['DEBUG'] == 'ON':
  772. print(f"Checking completion response: {highlighted}")
  773. assert last_match > 0, f'/{re_content}/ must match ```{highlighted}```'
  774. if expected_predicted_n and expected_predicted_n > 0:
  775. assert n_predicted == expected_predicted_n, (f'invalid number of tokens predicted:'
  776. f' {n_predicted} <> {expected_predicted_n}')
  777. async def gather_tasks_results(context):
  778. n_tasks = len(context.concurrent_tasks)
  779. if context.debug:
  780. print(f"Waiting for all {n_tasks} tasks results...")
  781. for task_no in range(n_tasks):
  782. context.tasks_result.append(await context.concurrent_tasks.pop())
  783. n_completions = len(context.tasks_result)
  784. return n_completions
  785. async def wait_for_health_status(context,
  786. base_url,
  787. expected_http_status_code,
  788. expected_health_status,
  789. timeout=3,
  790. params=None,
  791. slots_idle=None,
  792. slots_processing=None,
  793. expected_slots=None):
  794. if context.debug:
  795. print(f"Starting checking for health for expected_health_status={expected_health_status}")
  796. interval = 0.5
  797. counter = 0
  798. if 'GITHUB_ACTIONS' in os.environ:
  799. timeout *= 2
  800. async with aiohttp.ClientSession() as session:
  801. while True:
  802. async with await session.get(f'{base_url}/health', params=params) as health_response:
  803. status_code = health_response.status
  804. health = await health_response.json()
  805. if context.debug:
  806. print(f"HEALTH - response for expected health status='{expected_health_status}' on "
  807. f"'{base_url}/health'?{params} is {health}\n")
  808. if (status_code == expected_http_status_code
  809. and health['status'] == expected_health_status
  810. and (slots_idle is None or health['slots_idle'] == slots_idle)
  811. and (slots_processing is None or health['slots_processing'] == slots_processing)):
  812. if expected_slots is not None:
  813. assert_slots_status(health['slots'], expected_slots)
  814. return
  815. if (status_code == expected_http_status_code
  816. and health['status'] == expected_health_status
  817. and (slots_idle is None or health['slots_idle'] == slots_idle)
  818. and (slots_processing is None or health['slots_processing'] == slots_processing)):
  819. if expected_slots is not None:
  820. assert_slots_status(health['slots'], expected_slots)
  821. return
  822. await asyncio.sleep(interval)
  823. counter += interval
  824. if counter >= timeout:
  825. # Sometimes health requests are triggered after completions are predicted
  826. if expected_http_status_code == 503:
  827. if len(context.tasks_result) == 0:
  828. print("\x1b[5;37;43mWARNING: forcing concurrent tasks,"
  829. " busy health check missed, probably too fast inference\x1b[0m\n")
  830. n_completions = await gather_tasks_results(context)
  831. if n_completions > 0:
  832. return
  833. assert False, f'{expected_health_status} timeout exceeded {counter}s>={timeout}'
  834. def assert_embeddings(embeddings):
  835. assert len(embeddings) > 0
  836. embeddings_computed = False
  837. for emb in embeddings:
  838. if not isinstance(emb, float):
  839. assert False, f"Bad embeddings: {embeddings}"
  840. if emb != 0:
  841. embeddings_computed = True
  842. assert embeddings_computed, f"Embeddings: {embeddings}"
  843. async def request_slots_status(context, expected_slots):
  844. async with aiohttp.ClientSession() as session:
  845. async with await session.get(f'{context.base_url}/slots') as slots_response:
  846. assert slots_response.status == 200
  847. slots = await slots_response.json()
  848. assert_slots_status(slots, expected_slots)
  849. def assert_slots_status(slots, expected_slots):
  850. assert len(slots) == len(expected_slots)
  851. for slot_id, (expected, slot) in enumerate(zip(expected_slots, slots)):
  852. for key in expected:
  853. assert expected[key] == slot[key], (f"invalid slot {slot_id}"
  854. f" expected[{key}] != slot[{key}]"
  855. f" = {expected[key]} != {slot[key]}")
  856. async def completions_seed(context):
  857. return context.seed if hasattr(context, 'seed') and context.seed is not None \
  858. else context.server_seed if hasattr(context, 'server_seed') else None
  859. def context_text(context):
  860. return context.text.replace('\r', '')
  861. def start_server_background(context):
  862. if os.name == 'nt':
  863. context.server_path = '../../../build/bin/Release/server.exe'
  864. else:
  865. context.server_path = '../../../build/bin/server'
  866. if 'LLAMA_SERVER_BIN_PATH' in os.environ:
  867. context.server_path = os.environ['LLAMA_SERVER_BIN_PATH']
  868. server_listen_addr = context.server_fqdn
  869. server_args = [
  870. '--host', server_listen_addr,
  871. '--port', context.server_port,
  872. ]
  873. if context.model_file:
  874. server_args.extend(['--model', context.model_file])
  875. if context.model_url:
  876. server_args.extend(['--model-url', context.model_url])
  877. if context.n_batch:
  878. server_args.extend(['--batch-size', context.n_batch])
  879. if context.n_ubatch:
  880. server_args.extend(['--ubatch-size', context.n_ubatch])
  881. if context.n_gpu_layer:
  882. server_args.extend(['--n-gpu-layers', context.n_gpu_layer])
  883. if context.server_continuous_batching:
  884. server_args.append('--cont-batching')
  885. if context.server_embeddings:
  886. server_args.append('--embedding')
  887. if context.server_metrics:
  888. server_args.append('--metrics')
  889. if context.model_alias:
  890. server_args.extend(['--alias', context.model_alias])
  891. if context.n_ctx:
  892. server_args.extend(['--ctx-size', context.n_ctx])
  893. if context.n_slots:
  894. server_args.extend(['--parallel', context.n_slots])
  895. if context.n_server_predict:
  896. server_args.extend(['--n-predict', context.n_server_predict])
  897. if context.server_api_key:
  898. server_args.extend(['--api-key', context.server_api_key])
  899. if context.n_ga:
  900. server_args.extend(['--grp-attn-n', context.n_ga])
  901. if context.n_ga_w:
  902. server_args.extend(['--grp-attn-w', context.n_ga_w])
  903. if context.debug:
  904. server_args.append('--verbose')
  905. if 'SERVER_LOG_FORMAT_JSON' not in os.environ:
  906. server_args.extend(['--log-format', "text"])
  907. print(f"starting server with: {context.server_path} {server_args}")
  908. flags = 0
  909. if 'nt' == os.name:
  910. flags |= subprocess.DETACHED_PROCESS
  911. flags |= subprocess.CREATE_NEW_PROCESS_GROUP
  912. flags |= subprocess.CREATE_NO_WINDOW
  913. pkwargs = {
  914. 'creationflags': flags,
  915. 'stdout': subprocess.PIPE,
  916. 'stderr': subprocess.PIPE
  917. }
  918. context.server_process = subprocess.Popen(
  919. [str(arg) for arg in [context.server_path, *server_args]],
  920. **pkwargs)
  921. def log_stdout(process):
  922. for line in iter(process.stdout.readline, b''):
  923. print(line.decode('utf-8'), end='')
  924. thread_stdout = threading.Thread(target=log_stdout, args=(context.server_process,))
  925. thread_stdout.start()
  926. def log_stderr(process):
  927. for line in iter(process.stderr.readline, b''):
  928. print(line.decode('utf-8'), end='', file=sys.stderr)
  929. thread_stderr = threading.Thread(target=log_stderr, args=(context.server_process,))
  930. thread_stderr.start()
  931. print(f"server pid={context.server_process.pid}, behave pid={os.getpid()}")