Draft: Generic bot configuration System

README.md

@@ -206,14 +206,8 @@ Notes:
 - Installation as a GitHub App is still in an experimental stage
 and you may frequently receive requests to expand permissions.
 
-- All the repositories that use the bot and belong to the same
-owner must install the bot using the same method (GitHub App or
-regular user).
-
-- If you were previously using the legacy installation method,
-make sure you disable any previously set up GitHub webhooks when
-switching to the GitHub App, otherwise the bot will receive every
-request twice.
+- The bot requires GitHub App installation. The legacy installation
+method using Personal Access Tokens (PAT) is no longer supported.
 
 The bot can be installed as a GitHub App to either your account or
 organization ([link to app](https://github.com/apps/coqbot-app)).
@@ -271,32 +265,6 @@ Once you finish the installation, follow these steps:
   configuration file becomes `BOT_NAME.toml` where `BOT_NAME` is the name
   of the bot.
 
-### As a regular user account (legacy)
-
-The bot used to be given access to each of your GitHub repositories as a
-regular GitHub user account (**@coqbot**). This installation method is
-still supported for repositories that haven't migrated to the GitHub App
-yet. Here are the steps to follow in addition to those described in the 
-`As GitHub App` section:
-
-- In your GitHub repository:
-
-  - go to "Settings" / "Manage access" to add
-    [**@coqbot**](https://github.com/coqbot) as a collaborator with
-    the "Write" role (so that it can push status checks, and set
-    labels).
-
-    Currently, every invitation requires a manual validation, so there
-    may be some lag before **@coqbot** can push status checks
-    to your repository.
-
-  - go to "Settings" / "Webhooks" and add one webhook with URL
-    <https://coqbot.herokuapp.com/github> that will only be triggered
-    at least by pull request events, and if you want to use the issue
-    milestone feature, by issue events as well.  Make sure you change
-    the "content/type" value to "application/json".
-
-
 
 ## Architecture ##
 
@@ -352,7 +320,6 @@ to [Heroku](https://www.heroku.com/). Simply follow the official
 The bot will need to read a few environment variables so make sure
 these are configured in your Heroku app:
 
-- `GITHUB_ACCESS_TOKEN` (can also be defined in the configuration file as `github.api_token`)
 - `GITLAB_ACCESS_TOKEN` (can also be defined for each GitLab instance through the configuration file as `api_token` or through an environment variable whose name is defined in the configuration file as `api_token_env_var`)
 - `GITHUB_WEBHOOK_SECRET` (can also be defined in the configuration file as `github.webhook_secret`)
 - `GITLAB_WEBHOOK_SECRET` (can also be defined in the configuration file as `gitlab.webhook_secret`, will default to `GITHUB_WEBHOOK_SECRET` if not defined)

src/bench_utils.ml → bot-components/Bench_utils.ml

@@ -1,10 +1,10 @@
 open Base
-open Bot_components
 open GitLab_types
 open GitHub_types
 open Utils
 open HTTP_utils
 open String_utils
+open CI_utils
 open Lwt.Infix
 
 module BenchResults = struct
@@ -74,8 +74,8 @@ let fetch_bench_results ~job_info () =
   | Ok summary_table -> (
       (* The tables include how many entries there are, this is useful
          information to know. *)
-      let* slow_number = Ci_minimization.parse_quantity slow_table "slow" in
-      let* fast_number = Ci_minimization.parse_quantity fast_table "fast" in
+      let* slow_number = parse_quantity slow_table "slow" in
+      let* fast_number = parse_quantity fast_table "fast" in
       match (slow_number, fast_number) with
       | Error e, _ | _, Error e ->
           Lwt.return_error (f "Fetch bench regex issue: %s" e)

bot-components/Bench_utils.mli

@@ -0,0 +1,43 @@
+module BenchResults : sig
+  type t =
+    { summary_table: string
+    ; failures: string
+    ; slow_table: string
+    ; slow_number: int
+    ; fast_table: string
+    ; fast_number: int }
+end
+
+val fetch_bench_results :
+     job_info:GitLab_types.ci_common_info GitLab_types.job_info
+  -> unit
+  -> (BenchResults.t, string) Result.t Lwt.t
+
+val bench_text : (BenchResults.t, string) Result.t -> string Lwt.t
+
+val bench_comment :
+     bot_info:Bot_info.t
+  -> owner:string
+  -> repo:string
+  -> number:int
+  -> gitlab_url:string
+  -> ?check_url:string
+  -> (BenchResults.t, string) Result.t
+  -> unit Lwt.t
+
+val update_bench_status :
+     bot_info:Bot_info.t
+  -> job_info:GitLab_types.ci_common_info GitLab_types.job_info
+  -> string * string
+  -> external_id:string
+  -> number:int option
+  -> unit Lwt.t
+
+val run_bench :
+     bot_info:Bot_info.t
+  -> ?org:string
+  -> ?team:string
+  -> ?gitlab_domain:string
+  -> ?key_value_pairs:(string * string) list
+  -> GitHub_types.comment_info
+  -> unit Lwt.t

bot-components/Bot_info.ml

@@ -2,19 +2,25 @@ open Base
 
 type t =
   { gitlab_instances: (string, string * string) Hashtbl.t
-  ; github_pat: string
   ; github_install_token: string option
   ; github_name: string
   ; email: string
   ; domain: string
-  ; app_id: int }
+  ; app_id: int
+  ; api_timeout: float
+        (** API timeout in seconds for GitHub/GitLab queries. Defaults to 5.0 if not set. *)
+  }
 
+(* Returns the GitHub installation token. Requires installation token to be set. *)
 let github_token bot_info =
   match bot_info.github_install_token with
   | Some t ->
       t
   | None ->
-      bot_info.github_pat
+      (* TODO: use Result.t later *)
+      failwith
+        "GitHub installation token is required. Please ensure the GitHub App \
+         is installed and an installation token is available."
 
 let gitlab_name_and_token bot_info gitlab_domain =
   match Hashtbl.find bot_info.gitlab_instances gitlab_domain with
@@ -27,3 +33,5 @@ let gitlab_name_and_token bot_info gitlab_domain =
 
 let gitlab_token bot_info gitlab_domain =
   gitlab_name_and_token bot_info gitlab_domain |> Result.map ~f:snd
+
+let gitlab_instances_keys bot_info = Hashtbl.keys bot_info.gitlab_instances

bot-components/Bot_info.mli

@@ -1,14 +1,18 @@
 type t =
   { gitlab_instances: (string, string * string) Base.Hashtbl.t
-  ; github_pat: string
   ; github_install_token: string option
   ; github_name: string
   ; email: string
   ; domain: string
-  ; app_id: int }
+  ; app_id: int
+  ; api_timeout: float
+        (** API timeout in seconds for GitHub/GitLab queries. Defaults to 5.0 if not set. *)
+  }
 
 val github_token : t -> string
 
 val gitlab_token : t -> string -> (string, string) Result.t
 
 val gitlab_name_and_token : t -> string -> (string * string, string) Result.t
+
+val gitlab_instances_keys : t -> string list