From a49ebef59dbf0e22045aaee72bfdff590ee898c3 Mon Sep 17 00:00:00 2001
From: Jonas Qvigstad <jonas.lund.qvigstad@gmail.com>
Date: Sun, 26 Mar 2023 23:30:26 +0200
Subject: [PATCH 01/10] Comments are now adjusted from cfg file

---
 eessi_bot_job_manager.py | 63 ++++++++++++++--------------------------
 pr_comments.cfg          | 25 ++++++++++++++++
 tasks/build.py           | 10 +++----
 3 files changed, 52 insertions(+), 46 deletions(-)
 create mode 100644 pr_comments.cfg

diff --git a/eessi_bot_job_manager.py b/eessi_bot_job_manager.py
index 3415ca19..0516f4cf 100644
--- a/eessi_bot_job_manager.py
+++ b/eessi_bot_job_manager.py
@@ -291,9 +291,10 @@ def process_new_job(self, new_job):
             # (c) add a row to the table
             # add row to status table if we found a comment
             if "comment_id" in new_job:
+                comments = config.read_config("pr_comments.cfg")["new_job"]
                 dt = datetime.now(timezone.utc)
                 update = "\n|%s|" % dt.strftime("%b %d %X %Z %Y")
-                update += "released|job awaits launch by Slurm scheduler|"
+                update += f"{comments['job_status']}|{comments['comment']}|"
                 update_comment(new_job["comment_id"], pr, update)
             else:
                 log(
@@ -363,12 +364,13 @@ def process_running_jobs(self, running_job):
 
         if "comment_id" in running_job:
             dt = datetime.now(timezone.utc)
-            running_msg = "job %s is running" % running_job['jobid']
+            comments = config.read_config("pr_comments.cfg")["running_job"]
+            running_msg = comments['comment'].format(job_id=running_job['jobid'])
             if "comment_body" in running_job and running_msg in running_job["comment_body"]:
                 log("Not updating comment, '%s' already found" % running_msg)
             else:
-                update = "\n|%s|" % dt.strftime("%b %d %X %Z %Y")
-                update += "running|" + running_msg
+                update = f"\n|{dt.strftime('%b %d %X %Z %Y')}|"
+                update += f"{comments['job_status']}|{running_msg}|"
                 update_comment(running_job["comment_id"], pullrequest, update)
         else:
             log(
@@ -463,20 +465,18 @@ def process_finished_job(self, finished_job):
 
         dt = datetime.now(timezone.utc)
 
+        comments = config.read_config("pr_comments.cfg")["finished_job"]
+        comment_update = f"\n|{dt.strftime('%b %d %X %Z %Y')}|"
+        comment_update += f"{comments['job_status']}|"
         if (no_missing_modules and targz_created and
                 len(eessi_tarballs) == 1):
             # We've got one tarball and slurm out messages are ok
             # Prepare a message with information such as
             #   (installation status, tarball name, tarball size)
-            comment_update = "\n|%s|finished|:grin: SUCCESS " % dt.strftime(
-                 "%b %d %X %Z %Y")
-
+            tarball_name = os.path.basename(eessi_tarballs[0])
             tarball_size = os.path.getsize(eessi_tarballs[0]) / 2**30
-            comment_update += "tarball <code>%s</code> (%.3f GiB) " % (
-                os.path.basename(eessi_tarballs[0]),
-                tarball_size,
-            )
-            comment_update += "in job dir|"
+            success_comment = comments["success"].format(tarball_name=tarball_name, tarball_size=tarball_size)
+            comment_update += f"{success_comment}|"
             # NOTE explicitly name repo in build job comment?
             # comment_update += '\nAwaiting approval to
             #  comment_update +=  ingest tarball into the repository.'
@@ -489,52 +489,33 @@ def process_finished_job(self, finished_job):
             # prepare a message with details about the above conditions and
             # update PR with a comment
 
-            comment_update = "\n|%s|finished|:cry: FAILURE <ul>" % dt.strftime(
-                "%b %d %X %Z %Y"
-            )
+            comment_update += f"{comments['failure']} <ul>"
             found_slurm_out = os.path.exists(slurm_out)
 
             if not found_slurm_out:
-                # no slurm out ... something went wrong with the job
-                comment_update += (
-                    "<li>No slurm output <code>%s</code> in job dir</li>"
-                    % os.path.basename(slurm_out)
-                )
+                # no slurm out ... something went wrong with the job f"<li> {} </li>"
+                comment_update += f"<li> {comments['no_slurm_out'].format(slurm_out=os.path.basename(slurm_out))} </li>"
             else:
-                comment_update += (
-                    "<li>Found slurm output <code>%s</code> in job dir</li>"
-                    % os.path.basename(slurm_out)
-                )
+                comment_update += f"<li> {comments['slurm_out'].format(slurm_out=os.path.basename(slurm_out))} </li>"
 
             if found_slurm_out and not no_missing_modules:
                 # Found slurm out, but doesn't contain message 'No missing modules!'
-                comment_update += (
-                    '<li>Slurm output lacks message "No missing modules!".</li>'
-                )
+                comment_update += f"<li> {comments['missing_modules']} </li>"
 
             if found_slurm_out and not targz_created:
                 # Found slurm out, but doesn't contain message
                 #   'eessi-.*-software-.*.tar.gz created!'
-                comment_update += (
-                    "<li>Slurm output lacks message about created tarball.</li>"
-                )
+                comment_update += f"<li> {comments['no_tarball_message']} </li>"
 
             if len(eessi_tarballs) == 0:
                 # no luck, job just seemed to have failed ...
-                comment_update += (
-                    "<li>No tarball matching <code>%s</code> found in job dir.</li>"
-                    % tarball_pattern.replace(r"*", r"\*")
-                )
+                comment_update += f"<li> {comments['no_matching_tarball']} </li>".format(tarball_pattern=tarball_pattern.replace(r"*", r"\*"))
 
             if len(eessi_tarballs) > 1:
                 # something's fishy, we only expected a single tar.gz file
-                comment_update += (
-                    "<li>Found %d tarballs in job dir - only 1 "
-                    "matching <code>%s</code> expected.</li>"
-                    % (
-                        len(eessi_tarballs),
-                        tarball_pattern.replace(r"*", r"\*"),
-                    )
+                comment_update += f"<li> {comments['multiple_tarballs']} </li>".format(
+                    num_tarballs=len(eessi_tarballs),
+                    tarball_pattern=tarball_pattern.replace(r"*", r"\*")
                 )
             comment_update += "</ul>|"
             # comment_update += '\nAn admin may investigate what went wrong.
diff --git a/pr_comments.cfg b/pr_comments.cfg
new file mode 100644
index 00000000..c5e19e90
--- /dev/null
+++ b/pr_comments.cfg
@@ -0,0 +1,25 @@
+[submitted_job]
+description = New job on instance {app_name} for architecture {arch_name} in job dir {symlink} 
+job_status = submitted 
+comment = job id {job_id} awaits release by job manager 
+
+[new_job]
+job_status = released 
+comment = job awaits launch by Slurm scheduler 
+
+[running_job]
+job_status = running_job 
+comment = job {job_id} is running 
+
+[finished_job]
+job_status = finished 
+
+success = :grin: SUCCESS tarball <code>{tarball_name}</code> ({tarball_size} GiB) in job dir 
+
+failure = :cry: FAILURE 
+no_slurm_out = No slurm output <code>{slurm_out}</code> in job dir 
+slurm_out = Found slurm output <code>{slurm_out}</code> in job dir 
+missing_modules = Slurm output lacks message "No missing modules!". 
+no_tarball_message = Slurm output lacks message about created tarball. 
+no_matching_tarball = No tarball matching <code>{tarball_pattern}</code> found in job dir. 
+multiple_tarballs = Found {num_tarballs} tarballs in job dir - only 1 matching <code>{tarball_pattern}</code> expected. 
\ No newline at end of file
diff --git a/tasks/build.py b/tasks/build.py
index dafb29d1..93237e77 100644
--- a/tasks/build.py
+++ b/tasks/build.py
@@ -361,13 +361,13 @@ def create_pr_comments(job, job_id, app_name, job_comment, pr, repo_name, gh, sy
     dt = datetime.now(timezone.utc)
 
     # construct initial job comment
-    job_comment = (f"New job on instance `{app_name}`"
-                   f" for architecture `{arch_name}`"
-                   f" in job dir `{symlink}`\n"
+    comments = config.read_config("pr_comments.cfg")["submitted_job"]
+    job_comment = (f"{comments['description']}\n"
                    f"|date|job status|comment|\n"
                    f"|----------|----------|------------------------|\n"
-                   f"|{dt.strftime('%b %d %X %Z %Y')}|submitted|"
-                   f"job id `{job_id}` awaits release by job manager|")
+                   f"|{dt.strftime('%b %d %X %Z %Y')}|"
+                   f"{comments['job_status']}|"
+                   f"{comments['comment']}|")
 
     # create comment to pull request
     repo = gh.get_repo(repo_name)

From 773f995ce7e30ce6d5f88203d0b2c0771e76945e Mon Sep 17 00:00:00 2001
From: Jonas Qvigstad <jonas.lund.qvigstad@gmail.com>
Date: Mon, 27 Mar 2023 13:51:06 +0200
Subject: [PATCH 02/10] Added code brackets in some comments

---
 pr_comments.cfg | 6 +++---
 tasks/build.py  | 2 +-
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/pr_comments.cfg b/pr_comments.cfg
index c5e19e90..7b8675db 100644
--- a/pr_comments.cfg
+++ b/pr_comments.cfg
@@ -1,7 +1,7 @@
 [submitted_job]
-description = New job on instance {app_name} for architecture {arch_name} in job dir {symlink} 
+description = New job on instance <code>{app_name}</code> for architecture <code>{arch_name}</code> in job dir <code>{symlink}</code> 
 job_status = submitted 
-comment = job id {job_id} awaits release by job manager 
+comment = job id <code>{job_id}</code> awaits release by job manager 
 
 [new_job]
 job_status = released 
@@ -9,7 +9,7 @@ comment = job awaits launch by Slurm scheduler
 
 [running_job]
 job_status = running_job 
-comment = job {job_id} is running 
+comment = job <code>{job_id}</code> is running 
 
 [finished_job]
 job_status = finished 
diff --git a/tasks/build.py b/tasks/build.py
index 93237e77..339309d7 100644
--- a/tasks/build.py
+++ b/tasks/build.py
@@ -367,7 +367,7 @@ def create_pr_comments(job, job_id, app_name, job_comment, pr, repo_name, gh, sy
                    f"|----------|----------|------------------------|\n"
                    f"|{dt.strftime('%b %d %X %Z %Y')}|"
                    f"{comments['job_status']}|"
-                   f"{comments['comment']}|")
+                   f"{comments['comment']}|".format(app_name=app_name, arch_name=arch_name, symlink=symlink, job_id=job_id))
 
     # create comment to pull request
     repo = gh.get_repo(repo_name)

From fbd30655eba545cc1d9523b1b5886481867045d3 Mon Sep 17 00:00:00 2001
From: Jonas Qvigstad <jonas.lund.qvigstad@gmail.com>
Date: Mon, 27 Mar 2023 15:31:20 +0200
Subject: [PATCH 03/10] Moved comments into app.cfg.example

---
 app.cfg.example          | 21 +++++++++++++++++++++
 eessi_bot_job_manager.py | 17 ++++++++---------
 pr_comments.cfg          | 25 -------------------------
 tasks/build.py           |  7 ++++---
 4 files changed, 33 insertions(+), 37 deletions(-)
 delete mode 100644 pr_comments.cfg

diff --git a/app.cfg.example b/app.cfg.example
index aa2db12a..b24f69d8 100644
--- a/app.cfg.example
+++ b/app.cfg.example
@@ -134,3 +134,24 @@ poll_interval = 60
 
 # full path to the command for manipulating existing jobs
 scontrol_command = /usr/bin/scontrol
+
+
+[submitted_job_comments]
+description = New job on instance `{app_name}` for architecture `{arch_name}` in job dir `{symlink}` test
+comment = job id `{job_id}` awaits release by job manager 
+
+[new_job_comments]
+comment = job awaits launch by Slurm scheduler 
+
+[running_job_comments]
+comment = job `{job_id}` is running 
+
+[finished_job_comments]
+success = :grin: SUCCESS tarball `{tarball_name}` ({tarball_size} GiB) in job dir 
+failure = :cry: FAILURE 
+no_slurm_out = No slurm output `{slurm_out}` in job dir 
+slurm_out = Found slurm output `{slurm_out}` in job dir 
+missing_modules = Slurm output lacks message "No missing modules!". 
+no_tarball_message = Slurm output lacks message about created tarball. 
+no_matching_tarball = No tarball matching `{tarball_pattern}` found in job dir. 
+multiple_tarballs = Found {num_tarballs} tarballs in job dir - only 1 matching `{tarball_pattern}` expected. 
\ No newline at end of file
diff --git a/eessi_bot_job_manager.py b/eessi_bot_job_manager.py
index 0516f4cf..b9503e07 100644
--- a/eessi_bot_job_manager.py
+++ b/eessi_bot_job_manager.py
@@ -291,10 +291,10 @@ def process_new_job(self, new_job):
             # (c) add a row to the table
             # add row to status table if we found a comment
             if "comment_id" in new_job:
-                comments = config.read_config("pr_comments.cfg")["new_job"]
+                comments = config.read_config()["new_job_comments"]
                 dt = datetime.now(timezone.utc)
-                update = "\n|%s|" % dt.strftime("%b %d %X %Z %Y")
-                update += f"{comments['job_status']}|{comments['comment']}|"
+                update = "\n|%s|released|" % dt.strftime("%b %d %X %Z %Y")
+                update += f"{comments['comment']}|"
                 update_comment(new_job["comment_id"], pr, update)
             else:
                 log(
@@ -364,13 +364,13 @@ def process_running_jobs(self, running_job):
 
         if "comment_id" in running_job:
             dt = datetime.now(timezone.utc)
-            comments = config.read_config("pr_comments.cfg")["running_job"]
+            comments = config.read_config()["running_job_comments"]
             running_msg = comments['comment'].format(job_id=running_job['jobid'])
             if "comment_body" in running_job and running_msg in running_job["comment_body"]:
                 log("Not updating comment, '%s' already found" % running_msg)
             else:
-                update = f"\n|{dt.strftime('%b %d %X %Z %Y')}|"
-                update += f"{comments['job_status']}|{running_msg}|"
+                update = f"\n|{dt.strftime('%b %d %X %Z %Y')}|running|"
+                update += f"{running_msg}|"
                 update_comment(running_job["comment_id"], pullrequest, update)
         else:
             log(
@@ -465,9 +465,8 @@ def process_finished_job(self, finished_job):
 
         dt = datetime.now(timezone.utc)
 
-        comments = config.read_config("pr_comments.cfg")["finished_job"]
-        comment_update = f"\n|{dt.strftime('%b %d %X %Z %Y')}|"
-        comment_update += f"{comments['job_status']}|"
+        comments = config.read_config()["finished_job_comments"]
+        comment_update = f"\n|{dt.strftime('%b %d %X %Z %Y')}|finished|"
         if (no_missing_modules and targz_created and
                 len(eessi_tarballs) == 1):
             # We've got one tarball and slurm out messages are ok
diff --git a/pr_comments.cfg b/pr_comments.cfg
deleted file mode 100644
index 7b8675db..00000000
--- a/pr_comments.cfg
+++ /dev/null
@@ -1,25 +0,0 @@
-[submitted_job]
-description = New job on instance <code>{app_name}</code> for architecture <code>{arch_name}</code> in job dir <code>{symlink}</code> 
-job_status = submitted 
-comment = job id <code>{job_id}</code> awaits release by job manager 
-
-[new_job]
-job_status = released 
-comment = job awaits launch by Slurm scheduler 
-
-[running_job]
-job_status = running_job 
-comment = job <code>{job_id}</code> is running 
-
-[finished_job]
-job_status = finished 
-
-success = :grin: SUCCESS tarball <code>{tarball_name}</code> ({tarball_size} GiB) in job dir 
-
-failure = :cry: FAILURE 
-no_slurm_out = No slurm output <code>{slurm_out}</code> in job dir 
-slurm_out = Found slurm output <code>{slurm_out}</code> in job dir 
-missing_modules = Slurm output lacks message "No missing modules!". 
-no_tarball_message = Slurm output lacks message about created tarball. 
-no_matching_tarball = No tarball matching <code>{tarball_pattern}</code> found in job dir. 
-multiple_tarballs = Found {num_tarballs} tarballs in job dir - only 1 matching <code>{tarball_pattern}</code> expected. 
\ No newline at end of file
diff --git a/tasks/build.py b/tasks/build.py
index 339309d7..5c9f7857 100644
--- a/tasks/build.py
+++ b/tasks/build.py
@@ -361,13 +361,14 @@ def create_pr_comments(job, job_id, app_name, job_comment, pr, repo_name, gh, sy
     dt = datetime.now(timezone.utc)
 
     # construct initial job comment
-    comments = config.read_config("pr_comments.cfg")["submitted_job"]
+    comments = config.read_config()["submitted_job_comments"]
     job_comment = (f"{comments['description']}\n"
                    f"|date|job status|comment|\n"
                    f"|----------|----------|------------------------|\n"
                    f"|{dt.strftime('%b %d %X %Z %Y')}|"
-                   f"{comments['job_status']}|"
-                   f"{comments['comment']}|".format(app_name=app_name, arch_name=arch_name, symlink=symlink, job_id=job_id))
+                   f"submitted|"
+                   f"{comments['comment']}|").format(app_name=app_name, arch_name=arch_name, symlink=symlink, job_id=job_id)
+                   
 
     # create comment to pull request
     repo = gh.get_repo(repo_name)

From 762400c2c579a4e9ec1e574236d5f2eb46e77a02 Mon Sep 17 00:00:00 2001
From: Jonas Qvigstad <jonas.lund.qvigstad@gmail.com>
Date: Mon, 27 Mar 2023 15:43:23 +0200
Subject: [PATCH 04/10] Updated comment in app.cfg.example

---
 app.cfg.example | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/app.cfg.example b/app.cfg.example
index b24f69d8..b18d5541 100644
--- a/app.cfg.example
+++ b/app.cfg.example
@@ -137,7 +137,7 @@ scontrol_command = /usr/bin/scontrol
 
 
 [submitted_job_comments]
-description = New job on instance `{app_name}` for architecture `{arch_name}` in job dir `{symlink}` test
+description = New job on instance `{app_name}` for architecture `{arch_name}` in job dir `{symlink}` 
 comment = job id `{job_id}` awaits release by job manager 
 
 [new_job_comments]

From 1147f46bce8a1e49ff39e42027d5961c22c61f4f Mon Sep 17 00:00:00 2001
From: Jonas Qvigstad <jonas.lund.qvigstad@gmail.com>
Date: Mon, 27 Mar 2023 15:49:55 +0200
Subject: [PATCH 05/10] Removed whitespace

---
 tasks/build.py | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/tasks/build.py b/tasks/build.py
index 5c9f7857..b2eee3f7 100644
--- a/tasks/build.py
+++ b/tasks/build.py
@@ -367,8 +367,10 @@ def create_pr_comments(job, job_id, app_name, job_comment, pr, repo_name, gh, sy
                    f"|----------|----------|------------------------|\n"
                    f"|{dt.strftime('%b %d %X %Z %Y')}|"
                    f"submitted|"
-                   f"{comments['comment']}|").format(app_name=app_name, arch_name=arch_name, symlink=symlink, job_id=job_id)
-                   
+                   f"{comments['comment']}|").format(app_name=app_name, 
+                                                     arch_name=arch_name, 
+                                                     symlink=symlink, 
+                                                     job_id=job_id)    
 
     # create comment to pull request
     repo = gh.get_repo(repo_name)

From 796a186851183dbeb8b43b63db1876bc7e5ba581 Mon Sep 17 00:00:00 2001
From: Jonas Qvigstad <jonas.lund.qvigstad@gmail.com>
Date: Tue, 28 Mar 2023 13:02:29 +0200
Subject: [PATCH 06/10] Added comment regarding regex in pr comments

---
 app.cfg.example | 2 +-
 tasks/build.py  | 8 ++++----
 2 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/app.cfg.example b/app.cfg.example
index b18d5541..39df7144 100644
--- a/app.cfg.example
+++ b/app.cfg.example
@@ -135,7 +135,7 @@ poll_interval = 60
 # full path to the command for manipulating existing jobs
 scontrol_command = /usr/bin/scontrol
 
-
+# variable 'comment' under 'submitted_job_comments' should not be changed as there are regular expression patterns matching it
 [submitted_job_comments]
 description = New job on instance `{app_name}` for architecture `{arch_name}` in job dir `{symlink}` 
 comment = job id `{job_id}` awaits release by job manager 
diff --git a/tasks/build.py b/tasks/build.py
index b2eee3f7..53d21df3 100644
--- a/tasks/build.py
+++ b/tasks/build.py
@@ -367,10 +367,10 @@ def create_pr_comments(job, job_id, app_name, job_comment, pr, repo_name, gh, sy
                    f"|----------|----------|------------------------|\n"
                    f"|{dt.strftime('%b %d %X %Z %Y')}|"
                    f"submitted|"
-                   f"{comments['comment']}|").format(app_name=app_name, 
-                                                     arch_name=arch_name, 
-                                                     symlink=symlink, 
-                                                     job_id=job_id)    
+                   f"{comments['comment']}|").format(app_name=app_name,
+                                                     arch_name=arch_name,
+                                                     symlink=symlink,
+                                                     job_id=job_id)
 
     # create comment to pull request
     repo = gh.get_repo(repo_name)

From 1aeb7b4ec94fb899d2d06b40080f54a8cadb2082 Mon Sep 17 00:00:00 2001
From: Jonas Qvigstad <jonas.lund.qvigstad@gmail.com>
Date: Wed, 29 Mar 2023 09:58:51 +0200
Subject: [PATCH 07/10] Fixed hound issues and issues from merging

---
 eessi_bot_job_manager.py | 4 +++-
 tasks/build.py           | 7 ++-----
 2 files changed, 5 insertions(+), 6 deletions(-)

diff --git a/eessi_bot_job_manager.py b/eessi_bot_job_manager.py
index 16250b1b..4d4e4794 100644
--- a/eessi_bot_job_manager.py
+++ b/eessi_bot_job_manager.py
@@ -508,7 +508,9 @@ def process_finished_job(self, finished_job):
 
             if len(eessi_tarballs) == 0:
                 # no luck, job just seemed to have failed ...
-                comment_update += f"<li> {comments['no_matching_tarball']} </li>".format(tarball_pattern=tarball_pattern.replace(r"*", r"\*"))
+                comment_update += f"<li> {comments['no_matching_tarball']} </li>".format(
+                    tarball_pattern=tarball_pattern.replace(r"*", r"\*")
+                )
 
             if len(eessi_tarballs) > 1:
                 # something's fishy, we only expected a single tar.gz file
diff --git a/tasks/build.py b/tasks/build.py
index a6ee7973..428fc5df 100644
--- a/tasks/build.py
+++ b/tasks/build.py
@@ -553,11 +553,8 @@ def create_pr_comments(job, job_id, app_name, job_comment, pr, repo_name, gh, sy
 
     # construct initial job comment
     comments = config.read_config()["submitted_job_comments"]
-    job_comment = (f"New job on instance `{app_name}`"
-                   f" for architecture `{arch_name}`"
-                   f" for repository `{job.repo_id}`"
-                   f" in job dir `{symlink}`\n"
-                   f"|date|job status|comment|\n"
+    job_comment = (f"{comments['description']}"
+                   f"\n|date|job status|comment|\n"
                    f"|----------|----------|------------------------|\n"
                    f"|{dt.strftime('%b %d %X %Z %Y')}|"
                    f"submitted|"

From 18f3fa0b136fd177aa8a252e8134123c259e6fb3 Mon Sep 17 00:00:00 2001
From: Jonas Qvigstad <jonas.lund.qvigstad@gmail.com>
Date: Fri, 31 Mar 2023 17:09:03 +0200
Subject: [PATCH 08/10] Add cfg settings as constants and settings check

---
 app.cfg.example            | 10 +++----
 eessi_bot_event_handler.py |  8 ++++--
 eessi_bot_job_manager.py   | 57 ++++++++++++++++++++++++++++----------
 tasks/build.py             | 16 +++++++----
 tools/config.py            | 18 ++++++++++++
 5 files changed, 81 insertions(+), 28 deletions(-)

diff --git a/app.cfg.example b/app.cfg.example
index 769b8182..9a4de158 100644
--- a/app.cfg.example
+++ b/app.cfg.example
@@ -141,14 +141,14 @@ scontrol_command = /usr/bin/scontrol
 
 # variable 'comment' under 'submitted_job_comments' should not be changed as there are regular expression patterns matching it
 [submitted_job_comments]
-description = New job on instance `{app_name}` for architecture `{arch_name}` in job dir `{symlink}` 
-comment = job id `{job_id}` awaits release by job manager 
+initial_comment = New job on instance `{app_name}` for architecture `{arch_name}` for repository `{repo_id}` in job dir `{symlink}` 
+awaits_release = job id `{job_id}` awaits release by job manager 
 
 [new_job_comments]
-comment = job awaits launch by Slurm scheduler 
+awaits_lauch = job awaits launch by Slurm scheduler 
 
 [running_job_comments]
-comment = job `{job_id}` is running 
+running_job = job `{job_id}` is running 
 
 [finished_job_comments]
 success = :grin: SUCCESS tarball `{tarball_name}` ({tarball_size} GiB) in job dir 
@@ -158,4 +158,4 @@ slurm_out = Found slurm output `{slurm_out}` in job dir
 missing_modules = Slurm output lacks message "No missing modules!". 
 no_tarball_message = Slurm output lacks message about created tarball. 
 no_matching_tarball = No tarball matching `{tarball_pattern}` found in job dir. 
-multiple_tarballs = Found {num_tarballs} tarballs in job dir - only 1 matching `{tarball_pattern}` expected. 
+multiple_tarballs = Found {num_tarballs} tarballs in job dir - only 1 matching `{tarball_pattern}` expected. 
\ No newline at end of file
diff --git a/eessi_bot_event_handler.py b/eessi_bot_event_handler.py
index e2444e63..14e30179 100644
--- a/eessi_bot_event_handler.py
+++ b/eessi_bot_event_handler.py
@@ -15,6 +15,7 @@
 #
 import waitress
 import sys
+import tasks.build as build
 
 from connections import github
 from tools import config
@@ -162,8 +163,11 @@ def main():
     """Main function."""
     opts = event_handler_parse()
 
-    # config is read to raise an exception early when the event_handler starts.
-    config.read_config()
+    required_config = {
+        build.SUBMITTED_JOB_COMMENTS: [build.INITIAL_COMMENT, build.AWAITS_RELEASE]
+    }
+    # config is read and checked for settings to raise an exception early when the event_handler starts.
+    config.check_required_cfg_settings(required_config)
     github.connect()
 
     if opts.file:
diff --git a/eessi_bot_job_manager.py b/eessi_bot_job_manager.py
index 4d4e4794..9c8cfc8b 100644
--- a/eessi_bot_job_manager.py
+++ b/eessi_bot_job_manager.py
@@ -43,6 +43,26 @@
 
 from pyghee.utils import log, error
 
+AWAITS_LAUCH = "awaits_lauch"
+FAILURE = "failure"
+FINISHED_JOB_COMMENTS = "finished_job_comments"
+NEW_JOB_COMMENTS = "new_job_comments"
+MISSING_MODULES = "missing_modules"
+MULTIPLE_TARBALLS = "multiple_tarballs"
+NO_MATCHING_TARBALL = "no_matching_tarball"
+NO_SLURM_OUT = "no_slurm_out"
+NO_TARBALL_MESSAGE = "no_tarball_message"
+RUNNING_JOB = "running_job"
+RUNNING_JOB_COMMENTS = "running_job_comments"
+SLURM_OUT = "slurm_out"
+SUCCESS = "success"
+
+REQUIRED_CONFIG = {
+    NEW_JOB_COMMENTS: [AWAITS_LAUCH],
+    RUNNING_JOB_COMMENTS: [RUNNING_JOB],
+    FINISHED_JOB_COMMENTS: [SUCCESS, FAILURE, NO_SLURM_OUT, SLURM_OUT, MISSING_MODULES, 
+                            NO_TARBALL_MESSAGE, NO_MATCHING_TARBALL, MULTIPLE_TARBALLS]
+}
 
 class EESSIBotSoftwareLayerJobManager:
     "main class for (Slurm) job manager of EESSI bot (separate process)"
@@ -291,10 +311,10 @@ def process_new_job(self, new_job):
             # (c) add a row to the table
             # add row to status table if we found a comment
             if "comment_id" in new_job:
-                comments = config.read_config()["new_job_comments"]
+                new_job_comments_cfg = config.read_config()[NEW_JOB_COMMENTS]
                 dt = datetime.now(timezone.utc)
                 update = "\n|%s|released|" % dt.strftime("%b %d %X %Z %Y")
-                update += f"{comments['comment']}|"
+                update += f"{new_job_comments_cfg[AWAITS_LAUCH]}|"
                 update_comment(new_job["comment_id"], pr, update)
             else:
                 log(
@@ -364,8 +384,8 @@ def process_running_jobs(self, running_job):
 
         if "comment_id" in running_job:
             dt = datetime.now(timezone.utc)
-            comments = config.read_config()["running_job_comments"]
-            running_msg = comments['comment'].format(job_id=running_job['jobid'])
+            running_job_comments_cfg = config.read_config()[RUNNING_JOB_COMMENTS]
+            running_msg = running_job_comments_cfg[RUNNING_JOB].format(job_id=running_job['jobid'])
             if "comment_body" in running_job and running_msg in running_job["comment_body"]:
                 log("Not updating comment, '%s' already found" % running_msg)
             else:
@@ -465,7 +485,7 @@ def process_finished_job(self, finished_job):
 
         dt = datetime.now(timezone.utc)
 
-        comments = config.read_config()["finished_job_comments"]
+        finished_job_comments_cfg = config.read_config()[FINISHED_JOB_COMMENTS]
         comment_update = f"\n|{dt.strftime('%b %d %X %Z %Y')}|finished|"
         if (no_missing_modules and targz_created and
                 len(eessi_tarballs) == 1):
@@ -474,7 +494,10 @@ def process_finished_job(self, finished_job):
             #   (installation status, tarball name, tarball size)
             tarball_name = os.path.basename(eessi_tarballs[0])
             tarball_size = os.path.getsize(eessi_tarballs[0]) / 2**30
-            success_comment = comments["success"].format(tarball_name=tarball_name, tarball_size=tarball_size)
+            success_comment = finished_job_comments_cfg[SUCCESS].format(
+                tarball_name=tarball_name,
+                tarball_size=tarball_size
+            )
             comment_update += f"{success_comment}|"
             # NOTE explicitly name repo in build job comment?
             # comment_update += '\nAwaiting approval to
@@ -488,33 +511,37 @@ def process_finished_job(self, finished_job):
             # prepare a message with details about the above conditions and
             # update PR with a comment
 
-            comment_update += f"{comments['failure']} <ul>"
+            comment_update += f"{finished_job_comments_cfg[FAILURE]} <ul>"
             found_slurm_out = os.path.exists(slurm_out)
 
             if not found_slurm_out:
                 # no slurm out ... something went wrong with the job f"<li> {} </li>"
-                comment_update += f"<li> {comments['no_slurm_out'].format(slurm_out=os.path.basename(slurm_out))} </li>"
+                comment_update += f"<li> {finished_job_comments_cfg[NO_SLURM_OUT]} </li>".format(
+                    slurm_out=os.path.basename(slurm_out)
+                )
             else:
-                comment_update += f"<li> {comments['slurm_out'].format(slurm_out=os.path.basename(slurm_out))} </li>"
+                comment_update += f"<li> {finished_job_comments_cfg[SLURM_OUT]} </li>".format(
+                    slurm_out=os.path.basename(slurm_out)
+                )
 
             if found_slurm_out and not no_missing_modules:
                 # Found slurm out, but doesn't contain message 'No missing modules!'
-                comment_update += f"<li> {comments['missing_modules']} </li>"
+                comment_update += f"<li> {finished_job_comments_cfg[MISSING_MODULES]} </li>"
 
             if found_slurm_out and not targz_created:
                 # Found slurm out, but doesn't contain message
                 #   'eessi-.*-software-.*.tar.gz created!'
-                comment_update += f"<li> {comments['no_tarball_message']} </li>"
+                comment_update += f"<li> {finished_job_comments_cfg[NO_TARBALL_MESSAGE]} </li>"
 
             if len(eessi_tarballs) == 0:
                 # no luck, job just seemed to have failed ...
-                comment_update += f"<li> {comments['no_matching_tarball']} </li>".format(
+                comment_update += f"<li> {finished_job_comments_cfg[NO_MATCHING_TARBALL]} </li>".format(
                     tarball_pattern=tarball_pattern.replace(r"*", r"\*")
                 )
 
             if len(eessi_tarballs) > 1:
                 # something's fishy, we only expected a single tar.gz file
-                comment_update += f"<li> {comments['multiple_tarballs']} </li>".format(
+                comment_update += f"<li> {finished_job_comments_cfg[MULTIPLE_TARBALLS]} </li>".format(
                     num_tarballs=len(eessi_tarballs),
                     tarball_pattern=tarball_pattern.replace(r"*", r"\*")
                 )
@@ -554,8 +581,8 @@ def main():
 
     opts = job_manager_parse()
 
-    # config is read to raise an exception early when the job_manager runs.
-    config.read_config()
+    # config is read and checked for settings to raise an exception early when the job_manager runs.
+    config.check_required_cfg_settings(REQUIRED_CONFIG)
     github.connect()
 
     job_manager = EESSIBotSoftwareLayerJobManager()
diff --git a/tasks/build.py b/tasks/build.py
index 428fc5df..b458ceb6 100644
--- a/tasks/build.py
+++ b/tasks/build.py
@@ -23,6 +23,7 @@
 from pyghee.utils import log, error
 from tools import config, run_cmd
 
+AWAITS_RELEASE = "awaits_release"
 BUILDENV = "buildenv"
 BUILD_JOB_SCRIPT = "build_job_script"
 CONTAINER_CACHEDIR = "container_cachedir"
@@ -30,10 +31,12 @@
 CVMFS_CUSTOMIZATIONS = "cvmfs_customizations"
 HTTP_PROXY = "http_proxy"
 HTTPS_PROXY = "https_proxy"
+INITIAL_COMMENT = "initial_comment"
 JOBS_BASE_DIR = "jobs_base_dir"
 LOAD_MODULES = "load_modules"
 LOCAL_TMP = "local_tmp"
 SLURM_PARAMS = "slurm_params"
+SUBMITTED_JOB_COMMENTS = "submitted_job_comments"
 SUBMIT_COMMAND = "submit_command"
 BUILD_PERMISSION = "build_permission"
 ARCHITECTURE_TARGETS = "architecturetargets"
@@ -552,16 +555,17 @@ def create_pr_comments(job, job_id, app_name, job_comment, pr, repo_name, gh, sy
     dt = datetime.now(timezone.utc)
 
     # construct initial job comment
-    comments = config.read_config()["submitted_job_comments"]
-    job_comment = (f"{comments['description']}"
+    submitted_job_comments_cfg = config.read_config()[SUBMITTED_JOB_COMMENTS]
+    job_comment = (f"{submitted_job_comments_cfg[INITIAL_COMMENT]}"
                    f"\n|date|job status|comment|\n"
                    f"|----------|----------|------------------------|\n"
                    f"|{dt.strftime('%b %d %X %Z %Y')}|"
                    f"submitted|"
-                   f"{comments['comment']}|").format(app_name=app_name,
-                                                     arch_name=arch_name,
-                                                     symlink=symlink,
-                                                     job_id=job_id)
+                   f"{submitted_job_comments_cfg[AWAITS_RELEASE]}|").format(app_name=app_name,
+                                                                            arch_name=arch_name,
+                                                                            symlink=symlink,
+                                                                            repo_id=job.repo_id,
+                                                                            job_id=job_id)
 
     # create comment to pull request
     repo = gh.get_repo(repo_name)
diff --git a/tools/config.py b/tools/config.py
index 837071da..c2250000 100644
--- a/tools/config.py
+++ b/tools/config.py
@@ -30,3 +30,21 @@ def read_config(path='app.cfg'):
         error(f"{fn}(): Unable to read configuration file {path}!\n{err}")
 
     return config
+
+def check_required_cfg_settings(req_settings, path="app.cfg"):
+    """
+    Reads the config file and checks if it contains the required settings, 
+    signaling an error if not
+    Args: 
+        req_settings (dict (str, list)): required settings
+        path (string): path to the configuration file
+    Returns: 
+        None
+    """
+    cfg = read_config()
+    for section in req_settings.keys():
+        if section not in cfg:
+            error(f'Missing section "{section}" in configuration file {path}.')
+        for item in req_settings[section]:
+            if item not in cfg[section]:
+                error(f'Missing configuration item "{item}" in section "{section}" of configuration file {path}.')
\ No newline at end of file

From be64cdca95f3413599f11b4beedc62c8c3b9c6b4 Mon Sep 17 00:00:00 2001
From: Jonas Qvigstad <jonas.lund.qvigstad@gmail.com>
Date: Fri, 31 Mar 2023 17:18:58 +0200
Subject: [PATCH 09/10] Resolved hound issues

---
 eessi_bot_job_manager.py |  2 +-
 tools/config.py          | 10 +++++-----
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/eessi_bot_job_manager.py b/eessi_bot_job_manager.py
index 9c8cfc8b..c7d3f996 100644
--- a/eessi_bot_job_manager.py
+++ b/eessi_bot_job_manager.py
@@ -60,7 +60,7 @@
 REQUIRED_CONFIG = {
     NEW_JOB_COMMENTS: [AWAITS_LAUCH],
     RUNNING_JOB_COMMENTS: [RUNNING_JOB],
-    FINISHED_JOB_COMMENTS: [SUCCESS, FAILURE, NO_SLURM_OUT, SLURM_OUT, MISSING_MODULES, 
+    FINISHED_JOB_COMMENTS: [SUCCESS, FAILURE, NO_SLURM_OUT, SLURM_OUT, MISSING_MODULES,
                             NO_TARBALL_MESSAGE, NO_MATCHING_TARBALL, MULTIPLE_TARBALLS]
 }
 
diff --git a/tools/config.py b/tools/config.py
index c2250000..51e1d54e 100644
--- a/tools/config.py
+++ b/tools/config.py
@@ -31,14 +31,14 @@ def read_config(path='app.cfg'):
 
     return config
 
+
 def check_required_cfg_settings(req_settings, path="app.cfg"):
     """
-    Reads the config file and checks if it contains the required settings, 
-    signaling an error if not
-    Args: 
+    Reads the config file and checks if it contains the required settings, signaling an error if not
+    Args:
         req_settings (dict (str, list)): required settings
         path (string): path to the configuration file
-    Returns: 
+    Returns:
         None
     """
     cfg = read_config()
@@ -47,4 +47,4 @@ def check_required_cfg_settings(req_settings, path="app.cfg"):
             error(f'Missing section "{section}" in configuration file {path}.')
         for item in req_settings[section]:
             if item not in cfg[section]:
-                error(f'Missing configuration item "{item}" in section "{section}" of configuration file {path}.')
\ No newline at end of file
+                error(f'Missing configuration item "{item}" in section "{section}" of configuration file {path}.')

From 3d39ee0b155388666f801d94f57ac6209071ade2 Mon Sep 17 00:00:00 2001
From: Jonas Qvigstad <jonas.lund.qvigstad@gmail.com>
Date: Fri, 31 Mar 2023 17:20:59 +0200
Subject: [PATCH 10/10] Fixed pep8 compliance

---
 eessi_bot_job_manager.py | 1 +
 1 file changed, 1 insertion(+)

diff --git a/eessi_bot_job_manager.py b/eessi_bot_job_manager.py
index c7d3f996..940162f0 100644
--- a/eessi_bot_job_manager.py
+++ b/eessi_bot_job_manager.py
@@ -64,6 +64,7 @@
                             NO_TARBALL_MESSAGE, NO_MATCHING_TARBALL, MULTIPLE_TARBALLS]
 }
 
+
 class EESSIBotSoftwareLayerJobManager:
     "main class for (Slurm) job manager of EESSI bot (separate process)"