Skip to content

Commit

Permalink
align new CSV file; account for fail submissions Script to post comme…
Browse files Browse the repository at this point in the history 
…nts on Feedback PRs #20
  • Loading branch information
@ssardina
ssardina committed Aug 7, 2024
1 parent 1b8acd8 commit 8979607
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 38 deletions.
81 changes: 50 additions & 31 deletions gh_pr_feedback_comment.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ def p0_template(mapping):
|**Git repo:** | {mapping['URL-REPO']} |
|**Timestamp submission:** | {mapping['TIMESTAMP']} |
|**Commit marked:** | {mapping['COMMIT']} |
|**No of commits:** | {mapping['NOCOM']} |
|**Commit ratio (<1 is bad)** | {mapping['RATIO']} |
|**No of commits:** | {mapping['SE-NOCOM']} |
|**Commit ratio (<1 is bad)** | {mapping['SE-RATIO']} |
|**Days late (if any):** | {mapping['DYS LATE']} |
|**Certified (no certification = 0 marks)?** | {mapping['CERTIFICATION']} |
Expand All @@ -81,35 +81,35 @@ def p0_template(mapping):
|**Q2:** | {mapping['Q2-TOT']} |
|**Q3:** | {mapping['Q3-TOT']} |
## Software Engineering (SE) (discount) weights
| | |
|:--------------------------------------|--------------------:|
|**Merged feedback PR:** | {mapping['PR-MERG']} |
|**Commits with invalid username:** | {mapping['BAD-USR']} |
|**Commit quality:** | {mapping['SEPROB?']} |
## Software Engineering (SE) (discount) weights (if any)
| | |
|:--------------------------------------|---------------------:|
|**Merged feedback PR:** | {mapping['SE-PRMER']} |
|**Commits with invalid username:** | {mapping['SE-GHUSR']} |
|**Commit quality:** | {mapping['SE-LOWRAT']} |
## Summary of results
| | |
|:--------------------------------------|--------------------:|
|**Raw points collected (out of 3):** | {mapping['POINTS']} |
|**SE weight adjustment (1 if none):** | {mapping['WEIGHT']} |
|**Late penalty % (if any):** | {mapping['LATE PEN']} |
|**Final marks (out of 100%):** | {mapping['MARKS']} |
|**Grade:** | {mapping['GRADE']} |
|**Marking report:** | See comment before |
|**Notes (if any)** | {mapping['NOTE']} |
| | |
|:------------------------------------------|----------------------:|
|**Raw points collected (out of 3):** | {mapping['POINTS']} |
|**Total weight adjustment (1 if none):** | {mapping['WEIGHT']} |
|**Late penalty % (if any):** | {mapping['LATE PEN']} |
|**Final marks (out of 100%):** | {mapping['MARKS']} |
|**Grade:** | {mapping['GRADE']} |
|**Marking report:** | See comment before |
|**Notes (if any)** | {mapping['NOTE']} |
"""


def load_comment_dictionary(file_path: str) -> dict:
def load_marking_dict(file_path: str) -> dict:
"""
Load the comment dictionary from a CSV file
Load the marking dictionary from a CSV file; keys are GH username
"""
comment_dict = {}
with open(file_path, "r") as f:
reader = csv.DictReader(f)
for row in reader:
comment_dict[row["GHU"]] = make_template("p0", row)
comment_dict[row["GHU"]] = row
return comment_dict


Expand Down Expand Up @@ -140,7 +140,7 @@ def load_comment_dictionary(file_path: str) -> dict:
)
exit(0)

comments = load_comment_dictionary(args.MARKING_CSV)
marking_dict = load_marking_dict(args.MARKING_CSV)

###############################################
# Authenticate to GitHub
Expand Down Expand Up @@ -170,33 +170,52 @@ def load_comment_dictionary(file_path: str) -> dict:
repo_url = f"https://github.com/{repo_name}"
logging.info(f"Processing repo {k}/{no_repos}: {repo_id} ({repo_url})...")

if repo_id not in marking_dict:
logging.error(f"\t Repo {repo_name} not found in {args.MARKING_CSV}.")
no_errors += 1
errors.append(repo_id)
continue

repo = g.get_repo(repo_name)
try:
pr_feedback = repo.get_issue(number=1) # get the first PR - feedback

# get the first PR - feedback
# see we cannot use .get_pull(1) bc it involves reviewing the PRs!
pr_feedback = repo.get_issue(number=1)

# get the marking data for the student/repo
marking_repo = marking_dict[repo_id]
if marking_repo["COMMIT"] is None:
logging.warning(f"\t Repo {repo_name} has no tag submission.")
comment = pr_feedback.create_comment(
f"Dear @{repo_id}: no submission tag found; no marking as per spec."
)
continue
elif marking_repo["CERTIFICATION"] != "Yes":
logging.warning(f"\t Repo {repo_name} has no certification.")
comment = pr_feedback.create_comment(
f"Dear @{repo_id}: no certification; no marking as per spec."
)
continue

# Now there is a proper submission; issue the autograder report & feedback summary
# create a new comment with the automarker report
with open(
os.path.join(args.REPORT_FOLDER, f"{repo_id}.txt"), "r"
) as report:
report_text = report.read()
comment = pr_feedback.create_comment(
f"# Full autograder report \n\n {report_text}"
f"# Full autograder report \n\n ```{report_text}```"
)

# create a new comment with the final marking/feedback table results
feedback_text = make_template("p0", marking_repo)
comment = pr_feedback.create_comment(
f"Dear @{repo_id}: find here the feedback and resuls for the project. \n\n {comments[repo_id]}"
f"Dear @{repo_id}: find here the FEEDBACK & RESULTS for the project. \n\n {feedback_text}"
)
except GithubException as e:
logging.error(f"\t Error in repo {repo_name}: {e}")
no_errors += 1
errors.append(repo_id)
except KeyError as e:
logging.error(
f"\t Error in repo {repo_name}: {repo_id} not found in {args.MARKING_CSV}."
)
no_errors += 1
errors.append(repo_id)
except FileNotFoundError as e:
logging.error(
f"\t Error in repo {repo_name}: report file {repo_id}.txt not found in {args.REPORT_FOLDER}."
Expand Down
15 changes: 8 additions & 7 deletions util.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,26 @@
CSV_REPO_ID = "REPO_ID"


def get_repos_from_csv(csv_file, team_ids=None):
def get_repos_from_csv(csv_file, repos_ids=None):
"""
Collect list of teams with their git URL links from a csv file
:param csv_file: file where csv data is with two fields TEAM and GIT
:param team_ids: list of specific names or None
:return: a list of teams, each team is a dictionary with info (name, url, etc)
:param repos_ids: list of specific repo names or None
:return: a list of dictionaries for each repo (name, url, etc)
e.g., {'ORG_NAME': 'RMIT-COSC1127-1125-AI24', 'ASSIGNMENT': 'p0-warmup', 'REPO_ID': 'msardina', 'REPO_NAME': 'RMIT-COSC1127-1125-AI24/p0-warmup-msardina', 'REPO_URL': '[email protected]:RMIT-COSC1127-1125-AI24/p0-warmup-msardina.git'}
"""

# Get the list of ALL teams with their GIT URL from the CSV file
with open(csv_file, "r") as f:
teams_reader = csv.DictReader(f, delimiter=",")
teams = list(teams_reader)
repos = list(teams_reader)

# If specific team ids given, just keep those them only
if team_ids is not None:
teams = [t for t in teams if t[CSV_REPO_ID] in team_ids]
if repos_ids is not None:
repos = [t for t in repos if t[CSV_REPO_ID] in repos_ids]

return teams
return repos


def open_gitHub(token_file=None, token=None, user=None, password=None):
Expand Down

0 comments on commit 8979607

Please sign in to comment.