Skip to content
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.

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

Add task to show added / removed invoke tasks #31967

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
56 changes: 55 additions & 1 deletion tasks/diff.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,21 @@
"""

import datetime
import json
import os
import tempfile
from datetime import timedelta

from invoke import task
from invoke.exceptions import Exit

from tasks.build_tags import get_default_build_tags
from tasks.flavor import AgentFlavor
from tasks.go import GOARCH_MAPPING, GOOS_MAPPING
from tasks.libs.common.color import color_message
from tasks.libs.common.color import Color, color_message
from tasks.libs.common.datadog_api import create_count, send_metrics
from tasks.libs.common.git import check_uncommitted_changes, get_commit_sha, get_current_branch
from tasks.libs.common.worktree import agent_context
from tasks.release import _get_release_json_value

BINARIES: dict[str, dict] = {
Expand Down Expand Up @@ -230,3 +233,54 @@ def patch_summary(diff):
elif line.startswith("-"):
remove_count += 1
return add_count, remove_count


@task
def invoke_tasks(ctx, diff_date: str | None = None):
"""Shows the added / removed invoke tasks since diff_date with their description.

Args:
diff_date: The date to compare the tasks to ('YY/MM/DD' format). Will be the last 30 days if not provided.
"""

if not diff_date:
diff_date = (datetime.datetime.now() - timedelta(days=30)).strftime('%Y/%m/%d')

def get_tasks() -> dict[str, str]:
tasks = json.loads(ctx.run('invoke --list -F json', hide=True).stdout)

def get_tasks_rec(collection, prefix='', res=None):
res = res or {}

if isinstance(collection, dict):
newpref = prefix + collection['name']

for task in collection['tasks']:
res[newpref + '.' + task['name']] = task['help']

for subtask in collection['collections']:
get_tasks_rec(subtask, newpref + '.', res)

return res

# Remove 'tasks.' prefix
return {name.removeprefix(tasks['name'] + '.'): desc for name, desc in get_tasks_rec(tasks).items()}

old_commit = ctx.run(f"git rev-list -n 1 --before='{diff_date} 23:59' HEAD", hide=True).stdout.strip()
with agent_context(ctx, commit=old_commit):
old_tasks = get_tasks()
current_tasks = get_tasks()

all_tasks = set(old_tasks.keys()).union(current_tasks.keys())
removed_tasks = {task for task in all_tasks if task not in current_tasks}
added_tasks = {task for task in all_tasks if task not in old_tasks}

print(f'* {color_message("Removed tasks", Color.BOLD)}:')
print('\n'.join(sorted(f'- {name}' for name in removed_tasks)))

print(f'\n* {color_message("Added tasks", Color.BOLD)}:')
for name, description in sorted((name, current_tasks[name]) for name in added_tasks):
line = '+ ' + name
if description:
line += ': ' + description
print(line)
21 changes: 15 additions & 6 deletions tasks/libs/common/worktree.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
LOCAL_DIRECTORY = Path.cwd().resolve()


def init_env(ctx, branch: str | None = None):
def init_env(ctx, branch: str | None = None, commit: str | None = None):
"""Will prepare the environment for commands applying to a worktree.

To be used before each worktree section.
Expand Down Expand Up @@ -51,8 +51,16 @@ def init_env(ctx, branch: str | None = None):
ctx.run(f"git -C '{WORKTREE_DIRECTORY}' checkout '{branch}'", hide=True)

if not os.environ.get("AGENT_WORKTREE_NO_PULL"):
# TODO A
CelianR marked this conversation as resolved.
Show resolved Hide resolved
print(branch)
ctx.run(f"git -C '{WORKTREE_DIRECTORY}' pull", hide=True)

if commit:
if not os.environ.get("AGENT_WORKTREE_NO_PULL"):
ctx.run(f"git -C '{WORKTREE_DIRECTORY}' fetch", hide=True)

ctx.run(f"git -C '{WORKTREE_DIRECTORY}' checkout '{commit}'", hide=True)


def remove_env(ctx):
"""Will remove the environment for commands applying to a worktree."""
Expand All @@ -66,14 +74,14 @@ def is_worktree():
return Path.cwd().resolve() == WORKTREE_DIRECTORY.resolve()


def enter_env(ctx, branch: str | None, skip_checkout=False):
def enter_env(ctx, branch: str | None, skip_checkout=False, commit: str | None = None):
"""Enters the worktree environment."""

if not branch:
if not (branch or commit):
assert skip_checkout, 'skip_checkout must be set to True if branch is None'

if not skip_checkout:
init_env(ctx, branch)
init_env(ctx, branch, commit=commit)
else:
assert WORKTREE_DIRECTORY.is_dir(), "Worktree directory is not present and skip_checkout is set to True"

Expand All @@ -92,12 +100,13 @@ def exit_env():


@contextmanager
def agent_context(ctx, branch: str | None, skip_checkout=False):
def agent_context(ctx, branch: str | None = None, skip_checkout=False, commit: str | None = None):
"""Applies code to the worktree environment if the branch is not None.

Args:
branch: The branch to switch to. If None, will enter the worktree environment without switching branch (ensures that skip_checkout is True).
skip_checkout: If True, the branch will not be checked out (no pull will be performed too).
commit: The commit to checkout. Is used instead of branch if provided.

Usage:
> with agent_context(ctx, branch):
Expand All @@ -111,7 +120,7 @@ def agent_context(ctx, branch: str | None, skip_checkout=False):

try:
# Enter
enter_env(ctx, branch, skip_checkout=skip_checkout)
enter_env(ctx, branch, skip_checkout=skip_checkout, commit=commit)

yield
finally:
Expand Down
Loading