Skip to content

add branch to challenges #197

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

Open
MilyMilo wants to merge 4 commits into
base: master
Choose a base branch
from
Open

add branch to challenges #197

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
f2a084c
add branch to challenges
MilyMilo Feb 5, 2026
7cd2dba
fix challenge push behavior
MilyMilo Feb 6, 2026
5f1f9a9
remove auto pull
MilyMilo Feb 6, 2026
3a7bef1
Merge remote-tracking branch 'origin/master' into milymilo/add-branch…
MilyMilo Feb 6, 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
160 changes: 79 additions & 81 deletions ctfcli/cli/challenges.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
LintException,
RemoteChallengeNotFound,
)
from ctfcli.utils.git import check_if_git_subrepo_is_installed, get_git_repo_head_branch
from ctfcli.utils.git import check_if_git_subrepo_is_installed, resolve_repo_url

log = logging.getLogger("ctfcli.cli.challenges")

Expand Down Expand Up @@ -157,8 +157,8 @@ def add(
if yaml_path:
challenge_key = challenge_key / yaml_path

# Add a new challenge to the config
config["challenges"][str(challenge_key)] = repo
# Add a new challenge to the config, with the branch if specified
config["challenges"][str(challenge_key)] = f"{repo}@{branch}" if branch else repo

if use_subrepo:
# Clone with subrepo if configured
Expand All @@ -171,8 +171,8 @@ def add(
cmd += ["-f"]
else:
# Otherwise default to the built-in subtree
head_branch = get_git_repo_head_branch(repo)
cmd = ["git", "subtree", "add", "--prefix", challenge_path, repo, head_branch, "--squash"]
_, target_branch = resolve_repo_url(repo, branch=branch)
cmd = ["git", "subtree", "add", "--prefix", challenge_path, repo, target_branch, "--squash"]

log.debug(f"call({cmd}, cwd='{project_path}')")
if subprocess.call(cmd, cwd=project_path) != 0:
Expand Down Expand Up @@ -211,8 +211,8 @@ def add(
click.secho(f"Could not process the challenge path: '{repo}'", fg="red")
return 1

def push(self, challenge: str | None = None, no_auto_pull: bool = False, quiet=False) -> int:
log.debug(f"push: (challenge={challenge}, no_auto_pull={no_auto_pull}, quiet={quiet})")
def push(self, challenge: str | None = None, quiet=False) -> int:
log.debug(f"push: (challenge={challenge}, quiet={quiet})")
config = Config()

if challenge:
Expand All @@ -226,91 +226,91 @@ def push(self, challenge: str | None = None, no_auto_pull: bool = False, quiet=F

failed_pushes = []

if quiet or len(challenges) <= 1:
context = contextlib.nullcontext(challenges)
else:
context = click.progressbar(challenges, label="Pushing challenges")

use_subrepo = config["config"].getboolean("use_subrepo", fallback=False)
if use_subrepo and not check_if_git_subrepo_is_installed():
click.secho("This project is configured to use git subrepo, but it's not installed.")
return 1

with context as context_challenges:
for challenge_instance in context_challenges:
click.echo()

# Get a relative path from project root to the challenge
# As this is what git subtree push requires
challenge_path = challenge_instance.challenge_directory.resolve().relative_to(config.project_path)
challenge_repo = config.challenges.get(str(challenge_path), None)
# Validate all challenges and check for uncommitted changes upfront
challenges_to_push = []
challenges_with_uncommitted_changes = []

# if we don't find the challenge by the directory,
# check if it's saved with a direct path to challenge.yml
if not challenge_repo:
challenge_repo = config.challenges.get(str(challenge_path / "challenge.yml"), None)
for challenge_instance in challenges:
# Get a relative path from project root to the challenge
challenge_path = challenge_instance.challenge_directory.resolve().relative_to(config.project_path)
challenge_repo = config.challenges.get(str(challenge_path), None)

if not challenge_repo:
click.secho(
f"Could not find added challenge '{challenge_path}' "
"Please check that the challenge is added to .ctf/config and that your path matches",
fg="red",
)
failed_pushes.append(challenge_instance)
continue
# if we don't find the challenge by the directory,
# check if it's saved with a direct path to challenge.yml
if not challenge_repo:
challenge_repo = config.challenges.get(str(challenge_path / "challenge.yml"), None)

if not challenge_repo.endswith(".git"):
click.secho(
f"Cannot push challenge '{challenge_path}', as it's not a git-based challenge",
fg="yellow",
)
failed_pushes.append(challenge_instance)
continue
if not challenge_repo:
click.secho(
f"Could not find added challenge '{challenge_path}' "
"Please check that the challenge is added to .ctf/config and that your path matches",
fg="red",
)
failed_pushes.append(challenge_instance)
continue

click.secho(f"Pushing '{challenge_path}' to '{challenge_repo}'", fg="blue")
challenge_repo, challenge_branch = resolve_repo_url(challenge_repo)

log.debug(
f"call(['git', 'status', '--porcelain'], cwd='{config.project_path / challenge_path}',"
f" stdout=subprocess.PIPE, text=True)"
)
git_status = subprocess.run(
["git", "status", "--porcelain"],
cwd=config.project_path / challenge_path,
stdout=subprocess.PIPE,
text=True,
if not challenge_repo.endswith(".git"):
click.secho(
f"Cannot push challenge '{challenge_path}', as it's not a git-based challenge",
fg="yellow",
)
failed_pushes.append(challenge_instance)
continue

if git_status.stdout.strip() == "" and git_status.returncode == 0:
click.secho(f"No changes to be pushed for {challenge_path}", fg="green")
continue
# Check for uncommitted changes
log.debug(
f"call(['git', 'status', '--porcelain'], cwd='{config.project_path / challenge_path}',"
f" stdout=subprocess.PIPE, text=True)"
)
git_status = subprocess.run(
["git", "status", "--porcelain"],
cwd=config.project_path / challenge_path,
stdout=subprocess.PIPE,
text=True,
)

log.debug(f"call(['git', 'add', '.'], cwd='{config.project_path / challenge_path}')")
git_add = subprocess.call(["git", "add", "."], cwd=config.project_path / challenge_path)
if git_status.stdout.strip() != "" and git_status.returncode == 0:
challenges_with_uncommitted_changes.append(challenge_path)

log.debug(
f"call(['git', 'commit', '-m', 'Pushing changes to {challenge_path}'], "
f"cwd='{config.project_path / challenge_path}')"
)
git_commit = subprocess.call(
["git", "commit", "-m", f"Pushing changes to {challenge_path}"],
cwd=config.project_path / challenge_path,
)
challenges_to_push.append((challenge_instance, challenge_path, challenge_repo, challenge_branch))

if any(r != 0 for r in [git_add, git_commit]):
click.secho(
"Could not commit the challenge changes. Please check git error messages above.",
fg="red",
)
failed_pushes.append(challenge_instance)
continue
# If any challenges have uncommitted changes, error out
if challenges_with_uncommitted_changes:
click.secho(
"Cannot push: the following challenges have uncommitted changes:",
fg="red",
)
for challenge_path in challenges_with_uncommitted_changes:
click.echo(f" - {challenge_path}")

click.echo()
click.secho("Please commit your changes before pushing.", fg="yellow")
return 1

# Push all challenges (working directory is clean)
if not quiet and len(challenges_to_push) > 1:
push_context = click.progressbar(challenges_to_push, label="Pushing challenges")
else:
push_context = contextlib.nullcontext(challenges_to_push)

with push_context as challenges_iterator:
for challenge_instance, challenge_path, challenge_repo, challenge_branch in challenges_iterator:
click.echo()
click.secho(f"Pushing '{challenge_path}' to '{challenge_repo}'", fg="blue")

if use_subrepo:
cmd = ["git", "subrepo", "push", challenge_path]
else:
head_branch = get_git_repo_head_branch(challenge_repo)
cmd = ["git", "subtree", "push", "--prefix", challenge_path, challenge_repo, head_branch]
cmd = ["git", "subtree", "push", "--prefix", challenge_path, challenge_repo, challenge_branch]

log.debug(f"call({cmd}, cwd='{config.project_path / challenge_path}')")
log.debug(f"call({cmd}, cwd='{config.project_path}')")
if subprocess.call(cmd, cwd=config.project_path) != 0:
click.secho(
"Could not push the challenge repository. Please check git error messages above.",
Expand All @@ -319,10 +319,6 @@ def push(self, challenge: str | None = None, no_auto_pull: bool = False, quiet=F
failed_pushes.append(challenge_instance)
continue

# if auto pull is not disabled
if not no_auto_pull:
self.pull(str(challenge_path), quiet=True)

if len(failed_pushes) == 0:
if not quiet:
click.secho("Success! All challenges pushed!", fg="green")
Expand Down Expand Up @@ -383,6 +379,8 @@ def pull(self, challenge: str | None = None, strategy: str = "fast-forward", qui
failed_pulls.append(challenge_instance)
continue

challenge_repo, challenge_branch = resolve_repo_url(challenge_repo)

if not challenge_repo.endswith(".git"):
click.secho(
f"Cannot pull challenge '{challenge_path}', as it's not a git-based challenge",
Expand All @@ -408,7 +406,6 @@ def pull(self, challenge: str | None = None, strategy: str = "fast-forward", qui
else:
click.secho(f"Cannot pull challenge - '{strategy}' is not a valid pull strategy", fg="red")
else:
head_branch = get_git_repo_head_branch(challenge_repo)
pull_env["GIT_MERGE_AUTOEDIT"] = "no"
cmd = [
"git",
Expand All @@ -417,7 +414,7 @@ def pull(self, challenge: str | None = None, strategy: str = "fast-forward", qui
"--prefix",
challenge_path,
challenge_repo,
head_branch,
challenge_branch,
"--squash",
]

Expand Down Expand Up @@ -527,11 +524,12 @@ def restore(self, challenge: str | None = None) -> int:
f"Restoring git repo '{challenge_source}' to '{challenge_key}'",
fg="blue",
)
head_branch = get_git_repo_head_branch(challenge_source)

challenge_source, challenge_branch = resolve_repo_url(challenge_source)

log.debug(
f"call(['git', 'subtree', 'add', '--prefix', '{challenge_key}', '{challenge_source}', "
f"'{head_branch}', '--squash'], cwd='{config.project_path}')"
f"'{challenge_branch}', '--squash'], cwd='{config.project_path}')"
)
git_subtree_add = subprocess.call(
[
Expand All @@ -541,7 +539,7 @@ def restore(self, challenge: str | None = None) -> int:
"--prefix",
challenge_key,
challenge_source,
head_branch,
challenge_branch,
"--squash",
],
cwd=config.project_path,
Expand Down
56 changes: 41 additions & 15 deletions ctfcli/utils/git.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,60 @@
from os import PathLike


def check_if_git_subrepo_is_installed() -> bool:
output = subprocess.run(["git", "subrepo"], capture_output=True, text=True)
return "git: 'subrepo' is not a git command" not in output.stderr
def resolve_repo_url(repo: str, branch: str | None = None) -> tuple[str, str | None]:
"""
Resolves a repo string to (clean_url, branch).

Resolution order:
1. The `branch` parameter, if provided
2. An inline @branch parsed from the repo string
3. The remote's HEAD branch, detected via git ls-remote

def get_git_repo_head_branch(repo: str) -> str | None:
"""
A helper method to get the reference of the HEAD branch of a git remote repo.
https://stackoverflow.com/a/41925348
Returns (url, None) if no branch can be determined.
"""
# Strip an inline @branch suffix if present
marker = ".git@"
idx = repo.rfind(marker)
if idx != -1:
inline_branch = repo[idx + 5 :]
repo = repo[: idx + 4] # clean URL up to .git
if not branch and inline_branch:
branch = inline_branch

# Branch already resolved
if branch:
return repo, branch

# Non-git paths have no remote to query
if not repo.endswith(".git"):
return repo, None

# Fall back to detecting the remote HEAD branch
# https://stackoverflow.com/a/41925348
try:
output = subprocess.check_output(["git", "ls-remote", "--symref", repo, "HEAD"], stderr=subprocess.DEVNULL)
output = subprocess.check_output(
["git", "ls-remote", "--symref", repo, "HEAD"],
stderr=subprocess.DEVNULL,
)

# if for some reason subprocess didn't error, but returned None or an empty byte-string - return None
# this can happen if a repository exists, but doesn't have a head branch
# repo exists but doesn't have a head branch
if type(output) != bytes or len(output) == 0:
return None
return repo, None

except subprocess.CalledProcessError:
return None
return repo, None

# otherwise process the output
output = output.decode().strip()
head_branch_line = output.split()[1]
if head_branch_line.startswith("refs/heads/"):
return head_branch_line[11:]
return repo, head_branch_line[11:]

return repo, None


return None
def check_if_git_subrepo_is_installed() -> bool:
output = subprocess.run(["git", "subrepo"], capture_output=True, text=True)
return "git: 'subrepo' is not a git command" not in output.stderr


def check_if_dir_is_inside_git_repo(cwd: str | PathLike | None = None) -> bool:
Expand Down
Loading