Skip to content

Improve historical chart generation (uses git worktree instead of uns… #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Res260 merged 4 commits into from
Apr 5, 2026
Merged

Improve historical chart generation (uses git worktree instead of uns… #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
176bd4f
Improve historical chart generation (uses git worktree instead of uns…
Res260 Apr 5, 2026
110271d
Test `ctf stats` with charts and badges
Res260 Apr 5, 2026
da97e4c
ruff
Res260 Apr 5, 2026
0b59e81
fix
Res260 Apr 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ jobs:

- name: Install python dependencies
run: |
pip install -e .
pip install -e .[workflow]

- name: ruff
run: |
Expand All @@ -65,7 +65,7 @@ jobs:
# Run this in the test-ctf directory
working-directory: test-ctf
run: |
ctf --no-update-check stats
ctf --no-update-check stats --charts --generate-badges

- name: CTF list
# Run this in the test-ctf directory
Expand Down
167 changes: 101 additions & 66 deletions ctf/stats.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import os
import statistics
import subprocess
import tempfile
from datetime import datetime

import rich
Expand Down Expand Up @@ -59,7 +60,7 @@ def stats(
bool,
typer.Option(
"--historical",
help="Use in conjunction with --charts to generate historical data. ONLY USE THIS IF YOU KNOW WHAT YOU ARE DOING. THIS IS BAD CODE THAT WILL FUCK YOUR REPO IN UNEXPECTED WAYS.",
help="Use in conjunction with --charts to generate historical data over all merge commits.",
),
] = False,
) -> None:
Expand Down Expand Up @@ -311,79 +312,113 @@ def stats(
plt.clf()

if historical:
# Number of points and flags over time
historical_data = {}
commit_list = (
subprocess.check_output(
["git", "log", "--pretty=format:%H %ad", "--date=iso"]
with rich.progress.Progress(
"[progress.description]{task.description}",
rich.progress.BarColumn(),
"[progress.percentage]{task.percentage:>3.0f}%",
"({task.completed}/{task.total} commits)",
transient=True,
) as progress:
LOG.info("Collecting commits...")
# Number of points and flags over time
historical_data = {}
commit_list = (
subprocess.check_output(
["git", "log", "--pretty=format:%H %ad", "--date=iso"]
)
.decode()
.splitlines()[::-1]
)
.decode()
.splitlines()[::-1]
)
commit_list_with_date = []
for commit in commit_list:
hash, date = commit.split(" ", 1)
parsed_datetime = datetime.strptime(date, "%Y-%m-%d %H:%M:%S %z")
commit_list_with_date.append((parsed_datetime, hash))
commit_list_with_date = sorted(commit_list_with_date, key=lambda x: x[0])
subprocess.run(["git", "stash"], check=True)
for i, commit in list(enumerate(commit_list_with_date))[0:]:
parsed_datetime, hash = commit
# Check if the commit message has "Merge pull request" in it
commit_message = subprocess.run(
["git", "show", "-s", "--pretty=%B", hash],
check=True,
capture_output=True,
commit_list_with_date = []
for commit in commit_list:
hash, date = commit.split(" ", 1)
parsed_datetime = datetime.strptime(date, "%Y-%m-%d %H:%M:%S %z")
commit_list_with_date.append((parsed_datetime, hash))
commit_list_with_date = sorted(
commit_list_with_date, key=lambda x: x[0]
)
if "Merge pull request" in commit_message.stdout.decode():
LOG.debug(
f"{i + 1}/{len(commit_list_with_date)} Checking out commit: {commit}"
)
parsed_date = parsed_datetime.date()
task = progress.add_task(
description="Processing commits...",
total=len(commit_list_with_date),
)
with tempfile.TemporaryDirectory(prefix="ctf-historical-") as tmpdir:
worktree_path = os.path.join(tmpdir, "worktree")
subprocess.run(
["git", "checkout", hash], check=True, capture_output=True
["git", "worktree", "add", "--detach", worktree_path],
check=True,
capture_output=True,
)

# Execute your command here (replace with what you need)
result = (
try:
for i, commit in list(enumerate(commit_list_with_date))[0:]:
parsed_datetime, hash = commit
# Check if the commit message has "Merge pull request" in it
commit_message = subprocess.run(
["git", "show", "-s", "--pretty=%B", hash],
check=True,
capture_output=True,
)
if "Merge pull request" in commit_message.stdout.decode():
LOG.debug(
f"{i + 1}/{len(commit_list_with_date)} Checking out commit: {commit}"
)
parsed_date = parsed_datetime.date()
subprocess.run(
["git", "-C", worktree_path, "checkout", hash],
check=True,
capture_output=True,
)
result = (
subprocess.run(
["ctf", "--no-update-check", "stats"],
check=False,
capture_output=True,
text=True,
cwd=worktree_path,
),
)
if result[0].returncode == 0:
stats = json.loads(result[0].stdout)
total_points = stats["total_flags_value"]
total_flags = stats["number_of_flags"]
historical_data[parsed_date] = {
"total_points": total_points,
"total_flags": total_flags,
}
else:
LOG.warning(
f"Failed to get stats for commit {hash} ({parsed_date}). Error: {result[0].stderr[:100]}"
)
progress.update(task, advance=1)
finally:
subprocess.run(
["ctf", "stats"],
["git", "worktree", "remove", "--force", worktree_path],
check=False,
capture_output=True,
text=True,
),
)
if result[0].returncode == 0:
stats = json.loads(result[0].stdout)
total_points = stats["total_flags_value"]
total_flags = stats["number_of_flags"]
print(total_flags)
historical_data[parsed_date] = {
"total_points": total_points,
"total_flags": total_flags,
}
subprocess.run(["git", "checkout", "main"], check=True, capture_output=True)
subprocess.run(["git", "stash", "pop"], check=True)
)

all_dates = list(historical_data.keys())
all_points = [data["total_points"] for data in historical_data.values()]
n = len(all_dates)
step = max(1, (n - 1) // 9) if n > 1 else 1
label_indices = (
sorted(set(list(range(0, n, step)) + [n - 1])) if n else []
)

plt.plot(
historical_data.keys(),
[data["total_points"] for data in historical_data.values()],
label="Total Points",
)
# plt.plot(historical_data.keys(), [data["total_flags"] for data in historical_data.values()], label="Total Flags")
# plt.xticks(ticks=list(stats["number_of_points_per_track"].keys()), rotation=90)
plt.grid(True, linestyle="--", alpha=0.3)
plt.subplots_adjust(bottom=0.1)
plt.xlabel("Time")
plt.ylabel("Total points")
plt.title("Total points over time")
plt.xticks(rotation=90)
plt.subplots_adjust(bottom=0.2)
plt.subplot().set_ylim(
0, max([data["total_points"] for data in historical_data.values()]) + 10
)
plt.savefig(os.path.join(".charts", "points_over_time.png"))
plt.clf()
plt.plot(all_dates, all_points, label="Total Points")
plt.grid(True, linestyle="--", alpha=0.3)
plt.subplots_adjust(bottom=0.1)
plt.xlabel("Time")
plt.ylabel("Total points")
plt.title("Total points over time")
plt.xticks(
ticks=[all_dates[i] for i in label_indices],
labels=[str(all_dates[i]) for i in label_indices],
rotation=90,
)
plt.subplots_adjust(bottom=0.2)
plt.subplot().set_ylim(0, max(all_points) + 10 if all_points else 10)
plt.savefig(os.path.join(".charts", "points_over_time.png"))
plt.clf()

LOG.debug(msg="Done...")

Expand Down
Loading