{"id":18794125,"url":"https://github.com/yandex-cloud-examples/yc-load-testing-gitlab-ci","last_synced_at":"2026-02-12T09:03:16.172Z","repository":{"id":240893668,"uuid":"781412323","full_name":"yandex-cloud-examples/yc-load-testing-gitlab-ci","owner":"yandex-cloud-examples","description":"Настройка запуска нагрузочных тестов из GitLab CI.","archived":false,"fork":false,"pushed_at":"2025-02-16T11:26:28.000Z","size":82,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-09-12T01:14:54.814Z","etag":null,"topics":["cicd","gitlab","gitlab-runner","load-testing","yandex-cloud","yandexcloud","yc-cli"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yandex-cloud-examples.png","metadata":{"files":{"readme":"README-howto-add-test.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-04-03T10:32:43.000Z","updated_at":"2024-05-30T19:32:27.000Z","dependencies_parsed_at":"2024-05-21T10:31:21.287Z","dependency_job_id":"07d845fa-57e8-4e15-bfa8-3234f01c44e2","html_url":"https://github.com/yandex-cloud-examples/yc-load-testing-gitlab-ci","commit_stats":null,"previous_names":["yandex-cloud-examples/yc-load-testing-gitlab-ci"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/yandex-cloud-examples/yc-load-testing-gitlab-ci","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yandex-cloud-examples%2Fyc-load-testing-gitlab-ci","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yandex-cloud-examples%2Fyc-load-testing-gitlab-ci/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yandex-cloud-examples%2Fyc-load-testing-gitlab-ci/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yandex-cloud-examples%2Fyc-load-testing-gitlab-ci/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yandex-cloud-examples","download_url":"https://codeload.github.com/yandex-cloud-examples/yc-load-testing-gitlab-ci/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yandex-cloud-examples%2Fyc-load-testing-gitlab-ci/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29362205,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-12T08:51:36.827Z","status":"ssl_error","status_checked_at":"2026-02-12T08:51:26.849Z","response_time":55,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cicd","gitlab","gitlab-runner","load-testing","yandex-cloud","yandexcloud","yc-cli"],"created_at":"2024-11-07T21:28:15.867Z","updated_at":"2026-02-12T09:03:16.158Z","avatar_url":"https://github.com/yandex-cloud-examples.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Как описывать тесты, которые необходимо запускать в CI\n\nКонфигурация каждого теста должна лежать в отдельной папке. Имя конфигурационного файла должно соответствовать маске `test-config*.yaml`.\n\n---\n\n### TL;DR\n\n_**Примеры описанных тестов можно посмотреть [тут](sample-tests/README.md).**_\n\nВ папку с файлами конфигурации можно добавить следующие файлы:\n- В файле `meta.json` можно описать свойства теста (все поля опциональны):\n    ```yaml\n    # имя теста\n    name: str\n    # описание теста\n    description: str\n    # лейблы теста\n    labels: {\"test-label\": \"value\"}\n    # лейблы агентов, на которых тест нужно запускать\n    agent_labels: {\"agent-label\": \"value\"}\n    # количество агентов на каждый файл с конфигурацией\n    multi: 1 \n    # массив с описанием откуда брать внешние файлы (вне репозитория)\n    external_data: [{\"name\": \"\", \"s3bucket\": \"\", \"s3file\": \"\"}]\n    ```\n- В файле `check_summary.sh` можно написать валидацию `yc loadtesting test get $test_id`\n- В файле `check_report.sh` можно написать валидацию `yc loadtesting test get-report-tables $test_id`\n\n---\n\n### Конфигурация теста через `meta.json`\n\nНекоторые настройки теста можно определить в файле `meta.json`.\n\n- имя теста:\n\n    ```json\n    {\n        \"name\": \"smoke\"\n    }\n    ```\n- описание теста:\n\n    ```json\n    {\n        \"description\": \"If this test fails... ALARM!!!!!!!!!\"\n    }\n    ```\n- метки теста:\n    ```json\n    {\n        \"labels\": {\n            \"k1\": \"v1\",\n            \"k2\": \"v2\"\n        }\n    }\n    ```\n- требования к агенту, через спецификацию меток, которые должны быть у него проставлены:\n    ```json\n    {\n        \"agent_labels\": {\n            \"net\": \"1gb\",\n            \"disk\": \"ssd\"\n        }\n    }\n    ```\n\n---\n\n### Передача тестовых данных на агент\n\n#### Из репозитория:\n\n_Так как, в общем случае, скачивание агентом файлов напрямую из репозитория невозможно, необходимо использовать промежуточное хранилище, к которому будет доступ и у агента, и у CI. В качестве такого промежуточного хранилища предлагается использовать Object Storage._\n\nПри указании имени бакета через переменную среды `YC_LT_DATA_BUCKET`:\n1. все дополнительные файлы в папке с тестом загружаются в бакет `YC_LT_DATA_BUCKET` (т.е. все файлы, кроме служебных `meta.json`, `config*.yaml` и т.д.)\n2. для передачи списка необходимых файлов агенту, информация о них добавляется в запрос на создание теста\n3. по завершении теста, загруженные на первом шаге файлы удаляются из бакета\n\n_**WARNING: У сервисного аккаунта, с которым запускается агент, должны быть права на чтение файлов из этого бакета.**_  \n_**WARNING2: У сервисного аккаунта, от лица которого создаются тесты, должны быть права на загрузку файлов в этот бакет.**_\n\n#### Из бакета Object Storage:\n\n_Данный способ подходит в тех случаях, когда вы планируете использовать тестовые данные, которые изначально хранятся в Object Storage_\n\nВ файле `meta.json` можно описать секцию `external_data`, в которой должно быть определен список из структур, определяющих имя бакета, имя файла в бакете, и имя, которое агент даст файлу при скачивании.\n\n_**WARNING: У сервисного аккаунта, с которым запускается агент, должны быть права на чтение файлов из указанных бакетов.**_\n\nПример:\n```json\n{\n    \"external_data\": [\n        {\n            \"s3bucket\": \"loadtesting-data\",\n            \"s3file\": \"folder/user-data.json\",\n            \"name\": \"data.json\"\n        },\n        {\n            \"s3bucket\": \"loadtesting-data\",\n            \"s3file\": \"folder/payload.uri\",\n            \"name\": \"payload.uri\"\n        }\n    ]\n}\n```\n\n---\n\n### Запуск теста на нескольких агентах одновременно (мультитест)\n\nВ файле `meta.json` можно указать параметр `multi`, присвоив ему значение, равное желаемому количеству агентов, на которых тест будет выполняться одновременно.\n\n```json\n{\n    \"multi\": 3\n}\n```\n\n_**WARNING: если на момент запуска теста, необходимое количество агентов не будет подключено к сервису, тест не запустится.**_\n\n---\n\n### Валидация результатов проведенного теста в CI\n\nПо умолчанию, система запуска уже выполняет некоторые проверки. В каждом тесте эти проверки можно переопределить, добавив в папку с тестом проверочные скрипты `check_summary.sh` и `check_result.sh`.\n\nПо завершению выполнения теста, эти скрипты будут вызваны в виде, аналогичном следующему:\n\n```sh\n# download results\n\nyc --format json loadtesting test get \"$test_id\" \u003e summary.json\nyc --format json loadtesting test get-report-table \"$test_id\" \u003e report.json\n\n# check\n\nbash $test_dir/check_summary.sh summary.json\nrc1=$?\n\nbash $test_dir/check_report.sh report.json\nrc2=$?\n\n((rc1 == 0 \u0026\u0026 rc2 == 0))\n```\n\nТест считается упавшим, если один из скриптов завершился с ошибкой (`exit_code != 0`).\n\n_**Прим: полностью выключить проверки можно, указав YC_LT_SKIP_TEST_CHECK=1**_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyandex-cloud-examples%2Fyc-load-testing-gitlab-ci","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyandex-cloud-examples%2Fyc-load-testing-gitlab-ci","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyandex-cloud-examples%2Fyc-load-testing-gitlab-ci/lists"}