Merge pull request #107 from RodrigoMNardi/feature/allow-multiple-repos-and-ci

Allow multiples repos and GitHub Apps

Author: RodrigoMNardi

README.md

@@ -209,6 +209,32 @@ If you need to uninstall RVM, you can do so with the following command:
 rvm implode
 ```
 
+# Multiple Repositories
+
+## GitHub Repositories
+
+The GitHub Hook Server is designed to work with multiple repositories.
+To add a new repository, you need to create a new entry in the `config.yml` file.
+The `config.yml` file is located in the root directory of the project.
+
+### Example Configuration
+
+```yaml
+github_apps:
+  - login: 1234567
+    cert: github_private_key.pem
+    repo: 'opensourcerouting/frr-ci-test'
+
+  - login: 9876543
+    cert: github_private_key.pem
+    repo: 'RodrigoMNardi/frr' 
+```
+
+### Configuration Parameters
+- `login`: The GitHub login for the application.
+- `cert`: The path to the private key file for the GitHub application.
+- `repo`: The GitHub repository to monitor.
+
 # Console
 
 The bin/console script allows you to interact with the application in an interactive Ruby (IRB) session. 

lib/github/build_plan.rb

@@ -97,6 +97,10 @@ def create_pull_request
     end
 
     def start_new_execution
+      create_pull_request if @pull_request.nil?
+
+      @check_suite.pull_request = @pull_request
+
       Github::UserInfo.new(@payload.dig('pull_request', 'user', 'id'), check_suite: @check_suite)
 
       @bamboo_plan_run = BambooCi::PlanRun.new(@check_suite, logger_level: @logger.level)

lib/github/check.rb

@@ -18,9 +18,19 @@
 require_relative '../helpers/configuration'
 
 module Github
+  # Class responsible for interacting with GitHub's Check API.
+  #
+  # This class provides methods to authenticate with GitHub, fetch pull request information,
+  # manage check runs, and handle comments and reactions on pull requests.
+  #
+  # @attr_reader [Object] app the authenticated GitHub app client.
+  # @attr_reader [Object] check_suite the check suite associated with the pull request.
   class Check
     attr_reader :app, :check_suite
 
+    # Initializes a new Github::Check object.
+    #
+    # @param check_suite [Object] the check suite associated with the pull request.
     def initialize(check_suite)
       @check_suite = check_suite
       @config = GitHubApp::Configuration.instance.config
@@ -29,10 +39,21 @@ def initialize(check_suite)
       authenticate_app
     end
 
+    # Fetches information about a pull request.
+    #
+    # @param pr_id [Integer] the pull request ID.
+    # @param repo [String] the repository name.
+    # @return [Hash] the pull request information.
     def pull_request_info(pr_id, repo)
       @app.pull_request(repo, pr_id).to_h
     end
 
+    # Fetches commits associated with a pull request.
+    #
+    # @param pr_id [Integer] the pull request ID.
+    # @param repo [String] the repository name.
+    # @param page [Integer] the page number for pagination.
+    # @return [Array<Hash>] the list of commits.
     def fetch_pull_request_commits(pr_id, repo, page)
       @app.pull_request_commits(
         repo,
@@ -42,6 +63,12 @@ def fetch_pull_request_commits(pr_id, repo, page)
       )
     end
 
+    # Adds a comment to a pull request.
+    #
+    # @param pr_id [Integer] the pull request ID.
+    # @param comment [String] the comment text.
+    # @param repo [String] the repository name.
+    # @return [Hash] the added comment information.
     def add_comment(pr_id, comment, repo)
       @app.add_comment(
         repo,
@@ -50,18 +77,36 @@ def add_comment(pr_id, comment, repo)
       ).to_h
     end
 
+    # Adds a thumbs-up reaction to a comment.
+    #
+    # @param repo [String] the repository name.
+    # @param comment_id [Integer] the comment ID.
     def comment_reaction_thumb_up(repo, comment_id)
       @app.create_issue_comment_reaction(repo, comment_id, '+1')
     end
 
+    # Adds a thumbs-down reaction to a comment.
+    #
+    # @param repo [String] the repository name.
+    # @param comment_id [Integer] the comment ID.
     def comment_reaction_thumb_down(repo, comment_id)
       @app.create_issue_comment_reaction(repo, comment_id, '-1')
     end
 
+    # Fetches check runs for a specific commit SHA.
+    #
+    # @param repo [String] the repository name.
+    # @param sha [String] the commit SHA.
+    # @param status [String] the status of the check runs to fetch.
+    # @return [Array<Hash>] the list of check runs.
     def check_runs_for_ref(repo, sha, status: 'queued')
       @app.check_runs_for_ref(repo, sha, status: status)
     end
 
+    # Creates a new check run.
+    #
+    # @param name [String] the name of the check run.
+    # @return [Hash] the created check run information.
     def create(name)
       @app.create_check_run(
         @check_suite.pull_request.repository,
@@ -70,30 +115,64 @@ def create(name)
       )
     end
 
+    # Updates the status of a check run to 'queued'.
+    #
+    # @param check_ref [Integer] the check run reference ID.
+    # @param output [Hash] the output information for the check run.
+    # @return [Hash] the updated check run information.
     def queued(check_ref, output = {})
       basic_status(check_ref, 'queued', output)
     end
 
+    # Updates the status of a check run to 'in_progress'.
+    #
+    # @param check_ref [Integer] the check run reference ID.
+    # @param output [Hash] the output information for the check run.
+    # @return [Hash] the updated check run information.
     def in_progress(check_ref, output = {})
       basic_status(check_ref, 'in_progress', output)
     end
 
+    # Updates the status of a check run to 'cancelled'.
+    #
+    # @param check_ref [Integer] the check run reference ID.
+    # @param output [Hash] the output information for the check run.
+    # @return [Hash] the updated check run information.
     def cancelled(check_ref, output = {})
       completed(check_ref, 'completed', 'cancelled', output)
     end
 
+    # Updates the status of a check run to 'success'.
+    #
+    # @param check_ref [Integer] the check run reference ID.
+    # @param output [Hash] the output information for the check run.
+    # @return [Hash] the updated check run information.
     def success(check_ref, output = {})
       completed(check_ref, 'completed', 'success', output)
     end
 
+    # Updates the status of a check run to 'failure'.
+    #
+    # @param check_ref [Integer] the check run reference ID.
+    # @param output [Hash] the output information for the check run.
+    # @return [Hash] the updated check run information.
     def failure(check_ref, output = {})
       completed(check_ref, 'completed', 'failure', output)
     end
 
+    # Updates the status of a check run to 'skipped'.
+    #
+    # @param check_ref [Integer] the check run reference ID.
+    # @param output [Hash] the output information for the check run.
+    # @return [Hash] the updated check run information.
     def skipped(check_ref, output = {})
       completed(check_ref, 'completed', 'skipped', output)
     end
 
+    # Fetches a specific check run.
+    #
+    # @param check_ref [Integer] the check run reference ID.
+    # @return [Hash] the check run information.
     def get_check_run(check_ref)
       @app.check_run(@check_suite.pull_request.repository, check_ref).to_h
     end
@@ -106,6 +185,10 @@ def signature
       @config.dig('auth_signature', 'password')
     end
 
+    # Fetches the username associated with a GitHub user.
+    #
+    # @param username [String] the GitHub username.
+    # @return [Hash, false] the user information if found, otherwise false.
     def fetch_username(username)
       @app.user(username)
     rescue StandardError
@@ -114,6 +197,12 @@ def fetch_username(username)
 
     private
 
+    # Updates the status of a check run.
+    #
+    # @param check_ref [Integer] the check run reference ID.
+    # @param status [String] the status of the check run.
+    # @param output [Hash] the output information for the check run.
+    # @return [Hash] the updated check run information.
     def basic_status(check_ref, status, output)
       opts = {
         status: status
@@ -133,6 +222,13 @@ def basic_status(check_ref, status, output)
       resp
     end
 
+    # Completes a check run with a specific conclusion.
+    #
+    # @param check_ref [Integer] the check run reference ID.
+    # @param status [String] the status of the check run.
+    # @param conclusion [String] the conclusion of the check run.
+    # @param output [Hash] the output information for the check run.
+    # @return [Hash] the updated check run information.
     # PS: Conclusion and status are the same name from GitHub Check doc.
     # https://docs.github.com/en/rest/checks/runs?apiVersion=2022-11-28#update-a-check-run
     def completed(check_ref, status, conclusion, output)
@@ -163,26 +259,68 @@ def completed(check_ref, status, conclusion, output)
       end
     end
 
+    # Authenticates the GitHub app.
+    #
+    # This method attempts to authenticate the GitHub app by repository. If the
+    # authentication by repository fails or the check suite is nil, it falls back
+    # to authenticating the default GitHub app.
+    #
+    # @raise [RuntimeError] if the GitHub authentication fails.
     def authenticate_app
-      @config['github_apps'].each do |app|
-        payload = generate_payload(app)
+      github_app_by_repo
+
+      github_default_app if @check_suite.nil? or @app.nil?
+    end
 
-        rsa = OpenSSL::PKey::RSA.new(File.read(app['cert']))
+    # Authenticates the GitHub app by repository.
+    #
+    # This method finds the GitHub app configuration for the repository associated
+    # with the check suite and creates a GitHub app client using that configuration.
+    def github_app_by_repo
+      app =
+        @config['github_apps'].find do |entry|
+          entry.key? 'repo' and entry['repo'] == @check_suite.pull_request.repository
+        end
 
-        jwt = JWT.encode(payload, rsa, 'RS256')
+      @logger.info("github_app_by_repo: #{app.inspect}")
 
-        authenticate(jwt)
+      create_app(app) unless app.nil?
+    end
+
+    def github_default_app
+      @config['github_apps'].each do |app|
+        create_app(app)
 
         break unless @app.nil?
       end
 
       raise 'Github Authentication Failed' if @app.nil?
     end
 
+    # Creates a GitHub app client.
+    #
+    # @param app [Hash] the app configuration.
+    def create_app(app)
+      payload = generate_payload(app)
+
+      rsa = OpenSSL::PKey::RSA.new(File.read(app['cert']))
+
+      jwt = JWT.encode(payload, rsa, 'RS256')
+
+      authenticate(jwt)
+    end
+
+    # Generates a payload for authentication.
+    #
+    # @param app [Hash] the app configuration.
+    # @return [Hash] the generated payload.
     def generate_payload(app)
       { iat: Time.now.to_i, exp: Time.now.to_i + (10 * 60) - 30, iss: app['login'] }
     end
 
+    # Authenticates the GitHub app with a JWT.
+    #
+    # @param jwt [String] the JWT token.
     def authenticate(jwt)
       @authenticate_app = Octokit::Client.new(bearer_token: jwt)
 
@@ -195,6 +333,12 @@ def authenticate(jwt)
       @app = Octokit::Client.new(bearer_token: token)
     end
 
+    # Sends an update to GitHub for a check run.
+    #
+    # @param check_ref [Integer] the check run reference ID.
+    # @param opts [Hash] the options for the update.
+    # @param conclusion [String] the conclusion of the check run.
+    # @return [Hash] the updated check run information.
     def send_update(check_ref, opts, conclusion)
       resp =
         @app.update_check_run(

lib/github/parsers/pull_request_commit.rb

@@ -10,14 +10,25 @@
 
 module Github
   module Parsers
+    # Class responsible for parsing pull request commits.
     class PullRequestCommit
+      # Initializes a new PullRequestCommit parser.
+      #
+      # @param repo [String] the repository name.
+      # @param pr_id [Integer] the pull request ID.
       def initialize(repo, pr_id)
         @repo = repo
         @pr_id = pr_id
 
-        @github_check = Github::Check.new(nil)
+        pull_request = PullRequest.find_by(github_pr_id: pr_id)
+
+        @github_check = Github::Check.new(pull_request.check_suites.last)
       end
 
+      # Finds a commit by its SHA.
+      #
+      # @param sha256 [String] the SHA256 hash of the commit.
+      # @return [Hash, nil] the commit data if found, otherwise nil.
       def find_by_sha(sha256)
         return nil if sha256.nil?
 
@@ -37,6 +48,9 @@ def find_by_sha(sha256)
         nil
       end
 
+      # Retrieves the last commit in the pull request.
+      #
+      # @return [Hash, nil] the last commit data if found, otherwise nil.
       def last_commit_in_pr
         page = 1
         last_commit = nil

lib/github/re_run/comment.rb

@@ -54,7 +54,7 @@ def sha256_or_comment?
 
       def comment_flow
         commit = fetch_last_commit_or_sha256
-        github_check = Github::Check.new(nil)
+        github_check = fetch_github_check
         pull_request_info = github_check.pull_request_info(pr_id, repo)
         pull_request = fetch_or_create_pr(pull_request_info)
 
@@ -68,6 +68,20 @@ def comment_flow
         check_suite
       end
 
+      # Fetches the GitHub check associated with the pull request.
+      #
+      # This method finds the pull request by its GitHub PR ID and then retrieves
+      # the last check suite associated with that pull request. It then initializes
+      # a new `Github::Check` object with the last check suite.
+      #
+      # @return [Github::Check] the GitHub check associated with the pull request.
+      #
+      # @raise [ActiveRecord::RecordNotFound] if the pull request is not found.
+      def fetch_github_check
+        pull_request = PullRequest.find_by(github_pr_id: pr_id)
+        Github::Check.new(pull_request.check_suites.last)
+      end
+
       def create_check_suite_by_commit(commit, pull_request, pull_request_info)
         CheckSuite.create(
           pull_request: pull_request,