crossbench/pinpoint/list_builds.py

# Copyright 2025 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

from __future__ import annotations

import dataclasses
import datetime
import logging
from typing import Any

from tabulate import tabulate

from crossbench.pinpoint import requests
from crossbench.pinpoint.api import PINPOINT_BUILDS_API_URL_TEMPLATE
from crossbench.pinpoint.format_time import DATETIME_FORMAT, format_time
from crossbench.pinpoint.helper import annotate


@dataclasses.dataclass(frozen=True)
class Build:
  """Represents a Pinpoint build.

  Attributes:
    commit: The hash of the commit associated with the build.
    date: The date and time when the build was created in format
      "%Y-%m-%d %H:%M:%S".
  """
  commit: str
  date: str


def list_builds(bot: str, limit: int) -> None:
  """Fetches and displays recent successful builds for a given bot."""
  builds = fetch_builds(bot)
  _display_builds(builds[:limit])


def fetch_builds(bot: str) -> list[Build]:
  url = PINPOINT_BUILDS_API_URL_TEMPLATE.format(bot=bot)

  with annotate(f"Fetching recent builds for '{bot}'"):
    response = requests.get(url)
    response.raise_for_status()
    return _convert_json_to_builds(response.json())


def _convert_json_to_builds(builds_json: dict[str, Any]) -> list[Build]:
  builds = []
  for build in builds_json["builds"]:
    if build.get("status") != "SUCCESS":
      continue

    commit = build.get("input", {}).get("gitilesCommit", {}).get("id")
    if not commit:
      continue

    try:
      end_time = build.get("endTime")
      datetime_obj = datetime.datetime.fromisoformat(
          end_time.replace("Z", "+00:00"))
      date = datetime_obj.strftime(DATETIME_FORMAT)
    except ValueError:
      logging.warning("Invalid date format: %s", end_time)
      continue

    builds.append(Build(commit, date))

  builds.sort(key=lambda build: build.date, reverse=True)
  return builds


def _display_builds(builds: list[Build]) -> None:
  headers = ["Commit", "Date"]
  table_data = [[build.commit, format_time(build.date)] for build in builds]
  print(tabulate(table_data, headers=headers))