Merge pull request #25 from rwth-acis/develop

v1.0.0

Author: pdolif

.github/images/logo.png

@@ -1 +1,60 @@
-# api-testing-bot
+<h1 align="center">
+  <img src="https://raw.githubusercontent.com/rwth-acis/api-testing-bot/main/.github/images/logo.png" width="120px"/><br/>
+  API Testing Bot
+</h1>
+
+<p align="center">
+<img src="https://github.com/rwth-acis/api-testing-bot/workflows/Java%20CI%20with%20Gradle/badge.svg?branch=main"/>
+</p>
+
+## ⚙️ Setup/Usage
+
+First, set up the bot in the [Social-Bot-Framework](https://github.com/rwth-acis/Social-Bot-Framework).
+Both the bot model and the NLU training data can be found in the `bot-model` directory.
+The bot uses a backend service which is included in this repository.
+The easiest way to use the service is to build (or pull) the Docker image and run the service as a container.
+The bot can be used in different ways and on different platforms:
+
+### 1. Usage with CAE & RocketChat
+
+If the bot is a member of a RocketChat channel that is linked to a CAE project, test cases can be modeled via chat.
+The bot can be triggered by sending a message such as "model a test".
+As soon as the modeling is completed, the test case is forwarded to the CAE and proposed there in the Test Editor.
+
+Dependencies:
+
+- [las2peer-project-service](https://github.com/rwth-acis/las2peer-project-service)
+- [CAE](https://github.com/rwth-acis/CAE)
+
+### 2. Usage on GitHub
+
+The bot may be used within GitHub repositories by connecting it to a GitHub app.
+Therefore, the app id and a private key are required.
+Please note that the private key needs to be converted from PKCS#1 to PKCS#8.
+In the bot model, the `Authentication Token` of the GitHub issue or pull request messenger needs to be set to `[App Id]:[App Private Key]`.
+Use the private key in PKCS#8 format, but remove the first and last line before copying it.
+Also, set the webhook URL of the app to `.../apitestingbot/github/webhook/{gitHubAppId}`.
+
+Then, the bot can be triggered within issues/pull requests by sending a message such as "model a test".
+Once a test case has been modeled, the bot generates Java JUnit test code and comments it.
+
+In pull requests, the bot may also propose spec-based test cases if it can access the developed service's OpenAPI documentation.
+Read the [repository adjustment guide](repo_adjustment_guide.md) for more information.
+
+Dependencies:
+
+- [CAE-Code-Generation-Service](https://github.com/rwth-acis/CAE-Code-Generation-Service)
+- [api-test-gen-service](https://github.com/rwth-acis/api-test-gen-service)
+
+
+## 🐳 Docker Environment Variables
+
+Depending on the use case different environment variables are required:
+
+| Environment Variable     | Description                                                                                  | Required?           |
+|--------------------------|----------------------------------------------------------------------------------------------|---------------------|
+| `BOT_MANAGER_URL`        | REST API URL of Bot Manager Service ending with `/SBFManager`.                               | Yes                 |
+| `CODEX_API_TOKEN`        | Token for accessing the OpenAI/Codex API.                                                    | Yes                 |
+| `CAE_BACKEND_URL`        | REST API URL of CAE Model Persistence Service ending with `/CAE`.                            | Only in 1. Use-case |
+| `GITHUB_APP_ID`          | Id of GitHub app that the bot should use.                                                    | Only in 2. Use-case |
+| `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 |

README.md

@@ -27,8 +27,15 @@ dependencies {
 
     implementation "org.openapitools.openapidiff:openapi-diff-core:2.1.0-beta.3"
     implementation "com.googlecode.json-simple:json-simple:1.1.1"
-    implementation "com.konghq:unirest-java:3.13.10"
-    implementation "i5:las2peer-api-test-model:0.1.6"
+    implementation "com.konghq:unirest-java:3.13.11"
+    implementation "i5:las2peer-api-test-model:1.0.0"
+
+    // GitHub API
+    implementation "org.kohsuke:github-api:1.308"
+    implementation "io.jsonwebtoken:jjwt-impl:0.11.5"
+    implementation "io.jsonwebtoken:jjwt-jackson:0.11.5"
+
+    implementation "com.github.javaparser:javaparser-core:3.24.4"
 }
 
 configurations {
@@ -263,4 +270,4 @@ jacocoTestReport {
     reports {
         xml.enabled true
     }
-}
+}

api-testing-bot/build.gradle

@@ -22,6 +22,18 @@ public class APITestingBot extends RESTService {
     private String botManagerURL;
     private String caeBackendURL;
 
+    /**
+     * Id of GitHub app that the bot uses.
+     */
+    private int gitHubAppId;
+
+    /**
+     * Private key of GitHub app that the bot uses.
+     */
+    private String gitHubAppPrivateKey;
+
+    private String codexAPIToken;
+
     public APITestingBot() {
         setFieldValues();
     }
@@ -63,7 +75,7 @@ public void sendAPIDocChangesMessage(String openAPIDocOld, String openAPIDocUpda
      * @param webhookPayload Payload of the webhook call
      * @return JSONObject that can be used as the content of a monitoring message to trigger a webhook call.
      */
-    private JSONObject createWebhook(String url, JSONObject webhookPayload) {
+    public static JSONObject createWebhook(String url, JSONObject webhookPayload) {
         JSONObject webhook = new JSONObject();
         webhook.put("url", url);
         webhook.put("payload", webhookPayload);
@@ -78,7 +90,7 @@ private JSONObject createWebhook(String url, JSONObject webhookPayload) {
      * @param channel   Channel to which the message should be posted.
      * @return JSONObject representing the payload for a webhook call to the SBF that will trigger a chat message.
      */
-    private JSONObject createWebhookPayload(String message, String messenger, String channel) {
+    public static JSONObject createWebhookPayload(String message, String messenger, String channel) {
         JSONObject webhookPayload = new JSONObject();
         webhookPayload.put("event", "chat_message");
         webhookPayload.put("message", message);
@@ -90,4 +102,20 @@ private JSONObject createWebhookPayload(String message, String messenger, String
     public String getCaeBackendURL() {
         return caeBackendURL;
     }
+
+    public String getBotManagerURL() {
+        return botManagerURL;
+    }
+
+    public int getGitHubAppId() {
+        return gitHubAppId;
+    }
+
+    public String getGitHubAppPrivateKey() {
+        return gitHubAppPrivateKey;
+    }
+
+    public String getCodexAPIToken() {
+        return codexAPIToken;
+    }
 }