Move merged PR job directories to trash_bin_dir

eessi_bot_event_handler.py

@@ -18,6 +18,7 @@
 
 # Standard library imports
 import sys
+from datetime import datetime, timezone
 
 # Third party imports (anything installed into the local Python environment)
 from pyghee.lib import create_app, get_event_info, PyGHee, read_event_from_json
@@ -28,8 +29,9 @@
 from connections import github
 from tasks.build import check_build_permission, get_architecture_targets, get_repo_cfg, \
     request_bot_build_issue_comments, submit_build_jobs
-from tasks.deploy import deploy_built_artefacts
-from tools import config
+from tasks.deploy import deploy_built_artefacts, determine_job_dirs
+from tasks.clean_up import move_to_trash_bin
+from tools import config, cvmfs_repository
 from tools.args import event_handler_parse
 from tools.commands import EESSIBotCommand, EESSIBotCommandError, \
     contains_any_bot_command, get_bot_command
@@ -599,6 +601,61 @@ def start(self, app, port=3000):
         self.log(log_file_info)
         waitress.serve(app, listen='*:%s' % port)
 
+    def handle_pull_request_merged_event(self, event_info, pr):
+        """
+        Handle events of type pull_request with the action merged. Main action
+        is to scan directories used and move them to the trash_bin.
+
+        Args:
+        event_info (dict): event received by event_handler
+        pr (github.PullRequest.PullRequest): instance representing the pull request
+
+        Returns:
+        github.IssueComment.IssueComment instance or None (note, github refers to
+        PyGithub, not the github from the internal connections module)
+        """
+
+        # Detect event and only act if PR is merged
+        request_body = event_info['raw_request_body']
+        action = request_body['action']
+
+        if action == 'merged':
+            self.log("PR merged: scanning directories used by PR")
+            self.log(f"merge '{action}' action is handled")
+        else:
+            self.log(f"merge action '{action}' not handled")
+            return
+        # at this point we know that we are handling a new merge
+        # NOTE: Permissions to merge are already handled through GitHub, we
+        # don't need to check here
+
+        clean_up_comments_cfg = self.cfg[config.SECTION_CLEAN_UP_COMMENTS]
+        # 1) determine the jobs that have been run for the PR
+        job_dirs = determine_job_dirs(pr.number)
+
+        # 2) Get trash_bin_dir from configs
+        trash_bin_root_dir = self.cfg[config.SECTION_MERGED_PR][config.MERGED_PR_SETTING_TRASH_BIN_ROOT_DIR]
+        repo_cfg = get_repo_cfg(self.cfg)
+        repo_name = repo_cfg[cvmfs_repository.REPOS_CFG_REPO_NAME]
+        dt = datetime.now(timezone.utc)
+        trash_bin_dir = "/".join([trash_bin_root_dir, repo_name, dt.strftime('%Y%m%d')])
+
+        # Subdirectory with date of move. Also with repository name. Handle symbolic links (later?)
+        # cron job deletes symlinks?
+
+        # 3) move the directories to the trash_bin
+        self.log("Moving directories to trash_bin")
+        move_to_trash_bin(trash_bin_dir, job_dirs)
+
+        # 4) report move to pull request?
+        repo_name = pr.base.repo.full_name
+        gh = github.get_instance()
+        repo = gh.get_repo(repo_name)
+        pull_request = repo.get_pull(pr.number)
+        moved_comment = clean_up_comments_cfg[config.CLEAN_UP_COMMENTS_SETTING_MOVED_COMMENT]
+        issue_comment = pull_request.create_issue_comment(moved_comment)
+        return issue_comment
+
 
 def main():
     """

tasks/clean_up.py

@@ -0,0 +1,39 @@
+# This file is part of the EESSI build-and-deploy bot,
+# see https://github.com/EESSI/eessi-bot-software-layer
+#
+# The bot helps with requests to add software installations to the
+# EESSI software layer, see https://github.com/EESSI/software-layer
+#
+# author: Bob Droege (@bedroge)
+# author: Kenneth Hoste (@boegel)
+# author: Hafsa Naeem (@hafsa-naeem)
+# author: Jacob Ziemke (@jacobz137)
+# author: Jonas Qvigstad (@jonas-lq)
+# author: Lara Ramona Peeters (@laraPPr)
+# author: Pedro Santos Neves (@Neves-P)
+# author: Thomas Roeblitz (@trz42)
+#
+# license: GPLv2
+#
+
+# Standard library imports
+import sys
+
+# Third party imports (anything installed into the local Python environment)
+from pyghee.utils import log
+
+# Local application imports (anything from EESSI/eessi-bot-software-layer)
+from tools import run_cmd
+
+
+def move_to_trash_bin(trash_bin_dir, job_dirs):
+    funcname = sys._getframe().f_code.co_name
+    log(f"{funcname}(): trash_bin_dir = {trash_bin_dir}")
+
+    move_cmd = ["mkdir -p trash_bin_dir && mv -t", trash_bin_dir]
+    for job_dir in job_dirs:
+        move_cmd.append(job_dir)
+        ' '.join(move_cmd)
+        out, err, ec = run_cmd(move_cmd, 'Move job directories to trash_bin', raise_on_error=False)
+
+    return

tools/config.py

@@ -105,6 +105,12 @@
 SUBMITTED_JOB_COMMENTS_SETTING_INITIAL_COMMENT = 'initial_comment'
 SUBMITTED_JOB_COMMENTS_SETTING_AWAITS_RELEASE = 'awaits_release'
 
+SECTION_MERGED_PR = 'merged_pr'
+MERGED_PR_SETTING_TRASH_BIN_ROOT_DIR = 'trash_bin_dir'
+
+SECTION_CLEAN_UP_COMMENTS = 'clean_up_comments'
+CLEAN_UP_COMMENTS_SETTING_MOVED_COMMENT = 'moved_comment'
+
 
 def read_config(path='app.cfg'):
     """