Skip to content

Commit

Permalink
Added Admin Comment field to Job Information Table (#101)
Browse files Browse the repository at this point in the history 
Added Admin Comment field to Job Information Table
  • Loading branch information
@jitkang
jitkang authored Nov 21, 2023
1 parent 101eb89 commit 3b414d4
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 28 deletions.
4 changes: 4 additions & 0 deletions etc/slurm-mail/templates/job-table.tpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@
<td>Work dir:</td>
<td>$WORKDIR</td>
</tr>
<tr class="jobEnd">
<td>Admin Comment:</td>
<td>$ADMIN_COMMENT</td>
</tr>
<tr>
<td>Comment:</td>
<td>$COMMENT</td>
Expand Down
3 changes: 3 additions & 0 deletions src/slurmmail/cli.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,7 @@ def __process_spool_file(
"WorkDir",
"Elapsed",
"ExitCode",
"AdminComment",
"Comment",
"Cluster",
"NodeList",
Expand Down Expand Up @@ -244,6 +245,7 @@ def __process_spool_file(
job = Job(options.datetime_format, job_id)

job.cluster = sacct_dict["Cluster"]
job.admin_comment = sacct_dict["AdminComment"]
job.comment = sacct_dict["Comment"]
job.cpus = int(sacct_dict["NCPUS"])
job.group = sacct_dict["Group"]
Expand Down Expand Up @@ -379,6 +381,7 @@ def __process_spool_file(
ELAPSED=str(timedelta(seconds=job.elapsed)),
EXIT_STATE=job.state,
EXIT_CODE=job.exit_code,
ADMIN_COMMENT=job.admin_comment,
COMMENT=job.comment,
MEMORY=job.requested_mem_str,
MAX_MEMORY=job.max_rss_str,
Expand Down
1 change: 1 addition & 0 deletions src/slurmmail/slurm.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ def __init__(

self.array_id: Optional[int] = array_id
self.cluster: Optional[str] = None
self.admin_comment: Optional[str] = None
self.comment: Optional[str] = None
self.elapsed: Optional[int] = 0
self.exit_code: Optional[int] = None
Expand Down
56 changes: 28 additions & 28 deletions tests/unit/test_cli.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -476,8 +476,8 @@ def test_job_began(
}
""",
):
sacct_output = "1|root|root|all|1674333232|Unknown|RUNNING|500M||1|00:00:00|1|/|00:00:11|0:0||test|node01|01:00:00|60|1|test.jcf\n" # noqa
sacct_output += "1.batch||||1674333232|Unknown|RUNNING|||1|00:00:00|1||00:00:11|0:0||test|node01|||1.batch|batch" # noqa
sacct_output = "1|root|root|all|1674333232|Unknown|RUNNING|500M||1|00:00:00|1|/|00:00:11|0:0|||test|node01|01:00:00|60|1|test.jcf\n" # noqa
sacct_output += "1.batch||||1674333232|Unknown|RUNNING|||1|00:00:00|1||00:00:11|0:0|||test|node01|||1.batch|batch" # noqa
mock_slurmmail_cli_run_command.side_effect = [(0, sacct_output, "")]
slurmmail.cli.__dict__["__process_spool_file"](
pathlib.Path("/tmp/foo"),
Expand Down Expand Up @@ -511,8 +511,8 @@ def test_job_ended(
}
""",
):
sacct_output = "2|root|root|all|1674340451|1674340571|COMPLETED|500M||1|00:00.010|1|/root|00:02:00|0:0||test|node01|01:00:00|60|2|test.jcf\n" # noqa
sacct_output += "2.batch||||1674340451|1674340571|COMPLETED||4880K|1|00:00.010|1||00:02:00|0:0||test|node01|||2.batch|batch" # noqa
sacct_output = "2|root|root|all|1674340451|1674340571|COMPLETED|500M||1|00:00.010|1|/root|00:02:00|0:0|||test|node01|01:00:00|60|2|test.jcf\n" # noqa
sacct_output += "2.batch||||1674340451|1674340571|COMPLETED||4880K|1|00:00.010|1||00:02:00|0:0|||test|node01|||2.batch|batch" # noqa
scontrol_output = (
"JobId=2 JobName=test.jcf UserId=root(0) GroupId=root(0) MCS_label=N/A"
" Priority=4294901758 Nice=0 Account=root QOS=normal JobState=COMPLETED"
Expand Down Expand Up @@ -579,8 +579,8 @@ def test_job_ended_tail_file(
mock_slurmmail_cli_process_spool_file_options.tail_exe = pathlib.Path(
"/usr/bin/tail"
)
sacct_output = "2|root|root|all|1674340451|1674340571|COMPLETED|500M||1|00:00.010|1|/root|00:02:00|0:0||test|node01|01:00:00|60|2|test.jcf\n" # noqa
sacct_output += "2.batch||||1674340451|1674340571|COMPLETED||4880K|1|00:00.010|1||00:02:00|0:0||test|node01|||2.batch|batch" # noqa
sacct_output = "2|root|root|all|1674340451|1674340571|COMPLETED|500M||1|00:00.010|1|/root|00:02:00|0:0|||test|node01|01:00:00|60|2|test.jcf\n" # noqa
sacct_output += "2.batch||||1674340451|1674340571|COMPLETED||4880K|1|00:00.010|1||00:02:00|0:0|||test|node01|||2.batch|batch" # noqa
scontrol_output = (
"JobId=2 JobName=test.jcf UserId=root(0) GroupId=root(0) MCS_label=N/A"
" Priority=4294901758 Nice=0 Account=root QOS=normal JobState=COMPLETED"
Expand Down Expand Up @@ -640,8 +640,8 @@ def test_job_array_began_summary(
}
""",
):
sacct_output = "7_0|root|root|all|1675460419|Unknown|RUNNING|500M||1|00:00:00|1|/root|00:00:43|0:0||test|node01|00:05:00|5|8|test.jcf\n" # noqa
sacct_output += "7_0.batch||||1675460419|Unknown|RUNNING|||1|00:00:00|1||00:00:43|0:0||test|node01|||8.batch|batch\n" # noqa
sacct_output = "7_0|root|root|all|1675460419|Unknown|RUNNING|500M||1|00:00:00|1|/root|00:00:43|0:0|||test|node01|00:05:00|5|8|test.jcf\n" # noqa
sacct_output += "7_0.batch||||1675460419|Unknown|RUNNING|||1|00:00:00|1||00:00:43|0:0|||test|node01|||8.batch|batch\n" # noqa
sacct_output += (
"7_1|root|root|all|Unknown|Unknown|PENDING|500M||1|00:00:00|1|/root|00:00:00|0:0||test|None" # noqa
" assigned|00:05:00|5|7|test.jcf"
Expand Down Expand Up @@ -679,10 +679,10 @@ def test_job_array_ended_summary(
}
""",
):
sacct_output = "7_0|root|root|all|1675460419|1675460599|COMPLETED|500M||1|00:00.010|1|/root|00:03:00|0:0||test|node01|00:05:00|5|8|test.jcf\n" # noqa
sacct_output += "7_0.batch||||1675460419|1675460599|COMPLETED||4832K|1|00:00.010|1||00:03:00|0:0||test|node01|||8.batch|batch\n" # noqa
sacct_output += "7_1|root|root|all|1675460599|1675460779|COMPLETED|500M||1|00:00.010|1|/root|00:03:00|0:0||test|node01|00:05:00|5|7|test.jcf\n" # noqa
sacct_output += "7_1.batch||||1675460599|1675460779|COMPLETED||4784K|1|00:00.010|1||00:03:00|0:0||test|node01|||7.batch|batch" # noqa
sacct_output = "7_0|root|root|all|1675460419|1675460599|COMPLETED|500M||1|00:00.010|1|/root|00:03:00|0:0|||test|node01|00:05:00|5|8|test.jcf\n" # noqa
sacct_output += "7_0.batch||||1675460419|1675460599|COMPLETED||4832K|1|00:00.010|1||00:03:00|0:0|||test|node01|||8.batch|batch\n" # noqa
sacct_output += "7_1|root|root|all|1675460599|1675460779|COMPLETED|500M||1|00:00.010|1|/root|00:03:00|0:0|||test|node01|00:05:00|5|7|test.jcf\n" # noqa
sacct_output += "7_1.batch||||1675460599|1675460779|COMPLETED||4784K|1|00:00.010|1||00:03:00|0:0|||test|node01|||7.batch|batch" # noqa
scontrol_output_1 = (
"JobId=8 ArrayJobId=7 ArrayTaskId=0 JobName=test.jcf UserId=root(0)"
" GroupId=root(0) MCS_label=N/A Priority=4294901756 Nice=0 Account=root"
Expand Down Expand Up @@ -777,10 +777,10 @@ def test_job_array_ended_no_summary(
}
""",
):
sacct_output = "7_0|root|root|all|1675460419|1675460599|COMPLETED|500M||1|00:00.010|1|/root|00:03:00|0:0||test|node01|00:05:00|5|8|test.jcf\n" # noqa
sacct_output += "7_0.batch||||1675460419|1675460599|COMPLETED||4832K|1|00:00.010|1||00:03:00|0:0||test|node01|||8.batch|batch\n" # noqa
sacct_output += "7_1|root|root|all|1675460599|1675460779|COMPLETED|500M||1|00:00.010|1|/root|00:03:00|0:0||test|node01|00:05:00|5|7|test.jcf\n" # noqa
sacct_output += "7_1.batch||||1675460599|1675460779|COMPLETED||4784K|1|00:00.010|1||00:03:00|0:0||test|node01|||7.batch|batch" # noqa
sacct_output = "7_0|root|root|all|1675460419|1675460599|COMPLETED|500M||1|00:00.010|1|/root|00:03:00|0:0|||test|node01|00:05:00|5|8|test.jcf\n" # noqa
sacct_output += "7_0.batch||||1675460419|1675460599|COMPLETED||4832K|1|00:00.010|1||00:03:00|0:0|||test|node01|||8.batch|batch\n" # noqa
sacct_output += "7_1|root|root|all|1675460599|1675460779|COMPLETED|500M||1|00:00.010|1|/root|00:03:00|0:0|||test|node01|00:05:00|5|7|test.jcf\n" # noqa
sacct_output += "7_1.batch||||1675460599|1675460779|COMPLETED||4784K|1|00:00.010|1||00:03:00|0:0|||test|node01|||7.batch|batch" # noqa
scontrol_output_1 = (
"JobId=8 ArrayJobId=7 ArrayTaskId=0 JobName=test.jcf UserId=root(0)"
" GroupId=root(0) MCS_label=N/A Priority=4294901756 Nice=0 Account=root"
Expand Down Expand Up @@ -879,8 +879,8 @@ def test_job_ended_scontrol_failure(
}
""",
):
sacct_output = "2|root|root|all|1674340451|1674340571|COMPLETED|500M||1|00:00.010|1|/root|00:02:00|0:0||test|node01|01:00:00|60|2|test.jcf\n" # noqa
sacct_output += "2.batch||||1674340451|1674340571|COMPLETED||4880K|1|00:00.010|1||00:02:00|0:0||test|node01|||2.batch|batch" # noqa
sacct_output = "2|root|root|all|1674340451|1674340571|COMPLETED|500M||1|00:00.010|1|/root|00:02:00|0:0|||test|node01|01:00:00|60|2|test.jcf\n" # noqa
sacct_output += "2.batch||||1674340451|1674340571|COMPLETED||4880K|1|00:00.010|1||00:02:00|0:0|||test|node01|||2.batch|batch" # noqa
mock_slurmmail_cli_run_command.side_effect = [
(0, sacct_output, ""),
(1, "error", "error"),
Expand Down Expand Up @@ -918,8 +918,8 @@ def test_job_ended_unlimited_wallclock(
}
""",
):
sacct_output = "2|root|root|all|1674340451|1674340571|COMPLETED|500M||1|00:00.010|1|/root|00:02:00|0:0||test|node01|UNLIMITED||2|test.jcf\n" # noqa
sacct_output += "2.batch||||1674340451|1674340571|COMPLETED||4880K|1|00:00.010|1||00:02:00|0:0||test|node01|||2.batch|batch" # noqa
sacct_output = "2|root|root|all|1674340451|1674340571|COMPLETED|500M||1|00:00.010|1|/root|00:02:00|0:0|||test|node01|UNLIMITED||2|test.jcf\n" # noqa
sacct_output += "2.batch||||1674340451|1674340571|COMPLETED||4880K|1|00:00.010|1||00:02:00|0:0|||test|node01|||2.batch|batch" # noqa
scontrol_output = (
"JobId=2 JobName=test.jcf UserId=root(0) GroupId=root(0) MCS_label=N/A"
" Priority=4294901758 Nice=0 Account=root QOS=normal JobState=COMPLETED"
Expand Down Expand Up @@ -977,8 +977,8 @@ def test_job_ended_bad_wallclock(
}
""",
):
sacct_output = "2|root|root|all|1674340451|1674340571|COMPLETED|500M||1|00:00.010|1|/root|00:02:00|0:0||test|node01|01:00:00|bad_wc|2|test.jcf\n" # noqa
sacct_output += "2.batch||||1674340451|1674340571|COMPLETED||4880K|1|00:00.010|1||00:02:00|0:0||test|node01|||2.batch|batch" # noqa
sacct_output = "2|root|root|all|1674340451|1674340571|COMPLETED|500M||1|00:00.010|1|/root|00:02:00|0:0|||test|node01|01:00:00|bad_wc|2|test.jcf\n" # noqa
sacct_output += "2.batch||||1674340451|1674340571|COMPLETED||4880K|1|00:00.010|1||00:02:00|0:0|||test|node01|||2.batch|batch" # noqa
scontrol_output = (
"JobId=2 JobName=test.jcf UserId=root(0) GroupId=root(0) MCS_label=N/A"
" Priority=4294901758 Nice=0 Account=root QOS=normal JobState=COMPLETED"
Expand Down Expand Up @@ -1037,8 +1037,8 @@ def test_job_ended_bad_end_ts(
}
""",
):
sacct_output = "2|root|root|all|1674340451|bad_ts|COMPLETED|500M||1|00:00.010|1|/root|00:02:00|0:0||test|node01|01:00:00|60|2|test.jcf\n" # noqa
sacct_output += "2.batch||||1674340451|bad_ts|COMPLETED||4880K|1|00:00.010|1||00:02:00|0:0||test|node01|||2.batch|batch" # noqa
sacct_output = "2|root|root|all|1674340451|bad_ts|COMPLETED|500M||1|00:00.010|1|/root|00:02:00|0:0|||test|node01|01:00:00|60|2|test.jcf\n" # noqa
sacct_output += "2.batch||||1674340451|bad_ts|COMPLETED||4880K|1|00:00.010|1||00:02:00|0:0|||test|node01|||2.batch|batch" # noqa
scontrol_output = (
"JobId=2 JobName=test.jcf UserId=root(0) GroupId=root(0) MCS_label=N/A"
" Priority=4294901758 Nice=0 Account=root QOS=normal JobState=COMPLETED"
Expand Down Expand Up @@ -1096,8 +1096,8 @@ def test_job_timelimit_reached(
}
""",
):
sacct_output = "3|root|root|all|1674340908|1674340980|TIMEOUT|500M||1|00:00.009|1|/root|00:01:12|0:0||test|node01|00:01:00|1|3|test.jcf\n" # noqa
sacct_output += "3.batch||||1674340908|1674340980|CANCELLED||4876K|1|00:00.009|1||00:01:12|0:15||test|node01|||3.batch|batch" # noqa
sacct_output = "3|root|root|all|1674340908|1674340980|TIMEOUT|500M||1|00:00.009|1|/root|00:01:12|0:0|||test|node01|00:01:00|1|3|test.jcf\n" # noqa
sacct_output += "3.batch||||1674340908|1674340980|CANCELLED||4876K|1|00:00.009|1||00:01:12|0:15|||test|node01|||3.batch|batch" # noqa
scontrol_output = (
"JobId=3 JobName=test.jcf UserId=root(0) GroupId=root(0) MCS_label=N/A"
" Priority=4294901757 Nice=0 Account=root QOS=normal JobState=TIMEOUT"
Expand Down Expand Up @@ -1154,8 +1154,8 @@ def test_job_timelimit_50pc_reached(
}
""",
):
sacct_output = "3|root|root|all|1674770321|Unknown|RUNNING|500M||1|00:00:00|1|/root|00:02:22|0:0||test|node01|00:04:00|4|3|test.jcf\n" # noqa
sacct_output += "3.batch||||1674770321|Unknown|RUNNING|||1|00:00:00|1||00:02:22|0:0||test|node01|||3.batch|batch" # noqa
sacct_output = "3|root|root|all|1674770321|Unknown|RUNNING|500M||1|00:00:00|1|/root|00:02:22|0:0|||test|node01|00:04:00|4|3|test.jcf\n" # noqa
sacct_output += "3.batch||||1674770321|Unknown|RUNNING|||1|00:00:00|1||00:02:22|0:0|||test|node01|||3.batch|batch" # noqa
mock_slurmmail_cli_run_command.side_effect = [(0, sacct_output, "")]
slurmmail.cli.__dict__["__process_spool_file"](
pathlib.Path("/tmp/foo"),
Expand Down

0 comments on commit 3b414d4

Please sign in to comment.