{"id":25963475,"url":"https://github.com/beincom/bic-notification-perf-load","last_synced_at":"2025-08-31T14:03:50.235Z","repository":{"id":248653936,"uuid":"829260202","full_name":"beincom/bic-notification-perf-load","owner":"beincom","description":null,"archived":false,"fork":false,"pushed_at":"2024-07-17T11:16:31.000Z","size":960,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-08-31T14:03:10.696Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/beincom.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2024-07-16T04:52:24.000Z","updated_at":"2024-07-17T11:16:35.000Z","dependencies_parsed_at":"2025-03-04T20:39:00.991Z","dependency_job_id":"8f1e382c-72bb-4574-b083-9373c129aea1","html_url":"https://github.com/beincom/bic-notification-perf-load","commit_stats":null,"previous_names":["beincom/bic-notification-perf-load"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/beincom/bic-notification-perf-load","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beincom%2Fbic-notification-perf-load","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beincom%2Fbic-notification-perf-load/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beincom%2Fbic-notification-perf-load/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beincom%2Fbic-notification-perf-load/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/beincom","download_url":"https://codeload.github.com/beincom/bic-notification-perf-load/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beincom%2Fbic-notification-perf-load/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272988919,"owners_count":25026961,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-31T02:00:09.071Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2025-03-04T20:38:53.401Z","updated_at":"2025-08-31T14:03:50.206Z","avatar_url":"https://github.com/beincom.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \n  ![banner](https://www.beincom.app/_next/image?url=%2F_next%2Fstatic%2Fmedia%2Flogo_beincom_icon_and_text_only_post_alpha.539e3bfb.webp\u0026w=640\u0026q=75)\n\n# Test with K6\n\n\u003c/div\u003e\n\nBIC E2E and Performance test.\n\n## Installation\n\n1. Install dependencies\n\n```bash\nyarn\n```\n\n2. Set environment variables\n\n```bash\n$ cp .example.env .env\n\n# open .env and modify the environment variables (if needed)\n```\n\n## Running the Test using Makefile\n\n1. Build k6 with extensions\n\n```bash\nmake build-extension\n```\n\n2. Run test with parameters\n\n```bash\nmake run extensions=\"dashboard,elasticsearch\" report=\"dashboard/report.html\"\n```\n\nRecognized parameters:\n\n- `extensions`: K6 extensions for output (separate by `,`, options: `dashboard`, `elasticsearch`).\n- `report`: File name for exporting the report (used if dashboard extension is included).\n\nIf using `elasticsearch` metrics are stored in the index `k6-metrics`, which is automatically created by the [xk6-output-elasticsearch](https://github.com/elastic/xk6-output-elasticsearch) extension.\n\n## Running the Test manual\n\n1. Build script test\n\n```bash\nyarn build\n```\n\n2. Build k6 with extensions\n\n### For Linux\n```bash\ndocker run --rm -it -u \"$(id -u):$(id -g)\" -v \"${PWD}:/xk6\" grafana/xk6 build v0.43.1 --with github.com/oleiade/xk6-kv --with github.com/grafana/xk6-dashboard@v0.7.3-alpha.1 --with github.com/Juandavi1/xk6-prompt@0.0.2 --with github.com/gpiechnik2/xk6-httpagg@v1.0.0 --with github.com/elastic/xk6-output-elasticsearch@v0.3.0\n```\n\n### For MacOS\n```bash\ndocker run --rm -it -e GOOS=darwin -u \"$(id -u):$(id -g)\" -v \"${PWD}:/xk6\" grafana/xk6 build v0.43.1 --with github.com/oleiade/xk6-kv --with github.com/grafana/xk6-dashboard@v0.7.3-alpha.1 --with github.com/Juandavi1/xk6-prompt@0.0.2 --with github.com/gpiechnik2/xk6-httpagg@v1.0.0 --with github.com/elastic/xk6-output-elasticsearch@v0.3.0\n```\n\n### For Windows\n```bash\ndocker run --rm -it -e GOOS=windows -u \"$(id -u):$(id -g)\" -v \"${PWD}:/xk6\" grafana/xk6 build v0.43.1 --output k6.exe --with github.com/oleiade/xk6-kv --with github.com/grafana/xk6-dashboard@v0.7.3-alpha.1 --with github.com/Juandavi1/xk6-prompt@0.0.2 --with github.com/gpiechnik2/xk6-httpagg@v1.0.0 --with github.com/elastic/xk6-output-elasticsearch@v0.3.0\n```\n\n3. Run the test\n\n```bash\n./k6 run --out dashboard=report=dashboard/report.html dist/main.test.js\n```\n\nRun with output elasticsearch. The metrics are stored in the index `k6-metrics` which will be automatically created by extension [xk6-output-elasticsearch](https://github.com/elastic/xk6-output-elasticsearch)\n```bash\nexport K6_ELASTICSEARCH_URL=xxx\nexport K6_ELASTICSEARCH_USER=xxx\nexport K6_ELASTICSEARCH_PASSWORD=xxx\n\n./k6 run --out dashboard=report=dashboard/report.html --out output-elasticsearch dist/main.test.js\n```\n\n## Output Results\n\n### [HTTP Aggregation (httpagg)](https://github.com/gpiechnik2/xk6-httpagg)\n\n- By default, the httpagg report is exported to `dashboard/httpagg-report.html`.\n\n### [Dashboard](https://github.com/grafana/xk6-dashboard)\n\n- By default, the dashboard report is exported to `dashboard/report.html`.\n\n- If the report parameter is provided when running the test, the report is exported to the specified path.\n\n### [Elasticsearch](https://github.com/elastic/xk6-output-elasticsearch)\n\n- Metrics are stored in the index `k6-metrics`, automatically created by the xk6-output-elasticsearch extension.\n\n## Writing own tests\n\nHouse rules for writing tests:\n\n- The test code is located in `src` folder\n- The entry points for the tests need to have \"_test_\" word in the name to distinguish them from auxiliary files. You can change the entry [here](./webpack.config.js#L8).\n- If static files are required then add them to `./assets` folder. Its content gets copied to the destination folder (`dist`) along with compiled scripts.\n\n## Steps to run the seed data\n\n1. Change config\n\n- Update config in `config.ts` if you need.\n- Update `communityIndex` in `scripts/main.script.ts` to change the community for create contents.\n\n2. Run the seed\n\n```bash\nyarn create-data\n```\n\n### Transpiling and Bundling\n\nBy default, k6 can only run ES5.1 JavaScript code. To use TypeScript, we have to set up a bundler that converts TypeScript to JavaScript code.\n\nThis project uses `Babel` and `Webpack` to bundle the different files - using the configuration of the [`webpack.config.js`](./webpack.config.js) file.\n\nIf you want to learn more, check out [Bundling node modules in k6](https://k6.io/docs/using-k6/modules#bundling-node-modules).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeincom%2Fbic-notification-perf-load","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbeincom%2Fbic-notification-perf-load","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeincom%2Fbic-notification-perf-load/lists"}