{"id":23477376,"url":"https://github.com/rwth-acis/api-testing-bot","last_synced_at":"2025-10-11T05:33:21.955Z","repository":{"id":50465068,"uuid":"519178951","full_name":"rwth-acis/api-testing-bot","owner":"rwth-acis","description":"REST API test modeling (chat-) bot usable on GitHub \u0026 in the CAE. Uses OpenAI Codex for natural language test description understanding.","archived":false,"fork":false,"pushed_at":"2023-07-26T07:16:46.000Z","size":240,"stargazers_count":1,"open_issues_count":5,"forks_count":1,"subscribers_count":16,"default_branch":"main","last_synced_at":"2025-06-05T12:08:22.011Z","etag":null,"topics":["bot","codex","devops-bot"],"latest_commit_sha":null,"homepage":"","language":"Java","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/rwth-acis.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":"2022-07-29T10:47:50.000Z","updated_at":"2022-12-28T18:00:33.000Z","dependencies_parsed_at":"2024-12-24T18:40:18.724Z","dependency_job_id":null,"html_url":"https://github.com/rwth-acis/api-testing-bot","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/rwth-acis/api-testing-bot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2Fapi-testing-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2Fapi-testing-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2Fapi-testing-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2Fapi-testing-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rwth-acis","download_url":"https://codeload.github.com/rwth-acis/api-testing-bot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2Fapi-testing-bot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279006321,"owners_count":26084085,"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-10-11T02:00:06.511Z","response_time":55,"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":["bot","codex","devops-bot"],"created_at":"2024-12-24T18:26:48.297Z","updated_at":"2025-10-11T05:33:21.941Z","avatar_url":"https://github.com/rwth-acis.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/rwth-acis/api-testing-bot/main/.github/images/logo.png\" width=\"120px\"/\u003e\u003cbr/\u003e\n  API Testing Bot\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://github.com/rwth-acis/api-testing-bot/workflows/Java%20CI%20with%20Gradle/badge.svg?branch=main\"/\u003e\n\u003c/p\u003e\n\n## ⚙️ Setup/Usage\n\nFirst, set up the bot in the [Social-Bot-Framework](https://github.com/rwth-acis/Social-Bot-Framework).\nBoth the bot model and the NLU training data can be found in the `bot-model` directory.\nThe bot uses a backend service which is included in this repository.\nThe easiest way to use the service is to build (or pull) the Docker image and run the service as a container.\nThe bot can be used in different ways and on different platforms:\n\n### 1. Usage with CAE \u0026 RocketChat\n\nIf the bot is a member of a RocketChat channel that is linked to a CAE project, test cases can be modeled via chat.\nThe bot can be triggered by sending a message such as \"model a test\".\nAs soon as the modeling is completed, the test case is forwarded to the CAE and proposed there in the Test Editor.\n\nDependencies:\n\n- [las2peer-project-service](https://github.com/rwth-acis/las2peer-project-service)\n- [CAE](https://github.com/rwth-acis/CAE)\n\n### 2. Usage on GitHub\n\nThe bot may be used within GitHub repositories by connecting it to a GitHub app.\nTherefore, the app id and a private key are required.\nPlease note that the private key needs to be converted from PKCS#1 to PKCS#8.\nIn the bot model, the `Authentication Token` of the GitHub issue or pull request messenger needs to be set to `[App Id]:[App Private Key]`.\nUse the private key in PKCS#8 format, but remove the first and last line before copying it.\nAlso, set the webhook URL of the app to `.../apitestingbot/github/webhook/{gitHubAppId}`.\n\nThen, the bot can be triggered within issues/pull requests by sending a message such as \"model a test\".\nOnce a test case has been modeled, the bot generates Java JUnit test code and comments it.\n\nIn pull requests, the bot may also propose spec-based test cases if it can access the developed service's OpenAPI documentation.\nRead the [repository adjustment guide](repo_adjustment_guide.md) for more information.\n\nDependencies:\n\n- [CAE-Code-Generation-Service](https://github.com/rwth-acis/CAE-Code-Generation-Service)\n- [api-test-gen-service](https://github.com/rwth-acis/api-test-gen-service)\n\n\n## 🐳 Docker Environment Variables\n\nDepending on the use case different environment variables are required:\n\n| Environment Variable     | Description                                                                                  | Required?           |\n|--------------------------|----------------------------------------------------------------------------------------------|---------------------|\n| `BOT_MANAGER_URL`        | REST API URL of Bot Manager Service ending with `/SBFManager`.                               | Yes                 |\n| `CODEX_API_TOKEN`        | Token for accessing the OpenAI/Codex API.                                                    | Yes                 |\n| `CAE_BACKEND_URL`        | REST API URL of CAE Model Persistence Service ending with `/CAE`.                            | Only in 1. Use-case |\n| `GITHUB_APP_ID`          | Id of GitHub app that the bot should use.                                                    | Only in 2. Use-case |\n| `GITHUB_APP_PRIVATE_KEY` | Private key of GitHub app that the bot should use (already needs to be converted to PKCS#8). | Only in 2. Use-case |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frwth-acis%2Fapi-testing-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frwth-acis%2Fapi-testing-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frwth-acis%2Fapi-testing-bot/lists"}