ci-buildbot 0.11.0__py3-none-any.whl

ci_buildbot/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.11.0"

ci_buildbot/cli.py

@@ -0,0 +1,420 @@
+#!/usr/bin/env python
+import pprint
+import sys
+
+import click
+import slack
+from slack.errors import SlackApiError
+
+import ci_buildbot
+
+from .messages import (
+    ArchiveCodeMessage,
+    DeployfishDeployFailureMessage,
+    DeployfishDeployStartMessage,
+    DeployfishDeploySuccessMessage,
+    DeployfishTasksDeployFailureMessage,
+    DeployfishTasksDeployStartMessage,
+    DeployfishTasksDeploySuccessMessage,
+    DockerFailureMessage,
+    DockerStartMessage,
+    DockerSuccessMessage,
+    DocsFailureMessage,
+    DocsStartMessage,
+    DocsSuccessMessage,
+    GeneralFailureMessage,
+    GeneralStartMessage,
+    GeneralSuccessMessage,
+    UnittestsFailureMessage,
+    UnittestsStartMessage,
+    UnittestsSuccessMessage,
+)
+from .settings import Settings
+
+
+@click.group(invoke_without_command=True)
+@click.option(
+    "--version/--no-version",
+    "-v",
+    default=False,
+    help="Print the current version and exit.",
+)
+@click.pass_context
+def cli(ctx, version):
+    """
+    buildbot command line interaface.
+    """
+    ctx.obj["settings"] = Settings()
+    ctx.obj["slack"] = slack.WebClient(token=ctx.obj["settings"].api_token)
+
+    if version:
+        print(ci_buildbot.__version__)
+        sys.exit(0)
+
+
+@cli.command("settings", short_help="Print our application settings.")
+@click.pass_context
+def settings(ctx):
+    """
+    Print our settings to stdout.  This should be the completely evaluated
+    settings including those imported from any environment variable.
+    """
+    pp = pprint.PrettyPrinter(indent=2)
+    pp.pprint(ctx.obj["settings"].dict())
+
+
+@cli.command("channels", short_help="Print our available channels.")
+@click.pass_context
+def channels(ctx):
+    pp = pprint.PrettyPrinter(indent=2)
+    pp.pprint(ctx.obj["slack"].conversations_list(types="private_channel")["channels"])
+
+
+@cli.group("report", short_help="Report about a build step")
+def report():
+    pass
+
+
+@report.command("archive", short_help="Report about an archive-to-code-drop step")
+@click.pass_context
+def archive(ctx):
+    blocks = ArchiveCodeMessage().format()
+    client = ctx.obj["slack"]
+    try:
+        client.chat_postMessage(
+            channel=ctx.obj["settings"].channel, blocks=blocks, as_user=True
+        )
+    except SlackApiError as e:
+        print(f"Got an error: {e.response['error']}")
+
+
+@report.group(
+    "docker",
+    short_help="A group of commands that report about a Docker bmage build step",
+)
+def report_docker():
+    pass
+
+
+@report_docker.command("start", short_help="Report about starting a docker build")
+@click.option(
+    "--changelog/--no-changelog", default=False, help="Include the git changelog."
+)
+@click.argument("image")
+@click.pass_context
+def report_docker_start(ctx, image: str, changelog: bool = False) -> None:
+    blocks = DockerStartMessage().format(image=image, changelog=changelog)
+    client = ctx.obj["slack"]
+    try:
+        client.chat_postMessage(
+            channel=ctx.obj["settings"].channel, blocks=blocks, as_user=True
+        )
+    except SlackApiError as e:
+        print(f"Got an error: {e.response['error']}")
+
+
+@report_docker.command("success", short_help="Report a successful docker build")
+@click.argument("image")
+@click.pass_context
+def report_docker_success(ctx, image):
+    blocks = DockerSuccessMessage().format(image=image)
+    client = ctx.obj["slack"]
+    try:
+        client.chat_postMessage(
+            channel=ctx.obj["settings"].channel, blocks=blocks, as_user=True
+        )
+    except SlackApiError as e:
+        print(f"Got an error: {e.response['error']}")
+
+
+@report_docker.command("failure", short_help="Report a failed docker build")
+@click.argument("image")
+@click.pass_context
+def report_docker_failure(ctx, image):
+    blocks = DockerFailureMessage().format(image=image)
+    client = ctx.obj["slack"]
+    try:
+        client.chat_postMessage(
+            channel=ctx.obj["settings"].channel, blocks=blocks, as_user=True
+        )
+    except SlackApiError as e:
+        print(f"Got an error: {e.response['error']}")
+
+
+@report.group(
+    "unittests",
+    short_help="A group of commands that report about a test runner build step",
+)
+def report_unittests():
+    pass
+
+
+@report_unittests.command(
+    "start", short_help="Report about starting a test runner build"
+)
+@click.pass_context
+def report_unittests_start(ctx):
+    blocks = UnittestsStartMessage().format()
+    client = ctx.obj["slack"]
+    try:
+        client.chat_postMessage(
+            channel=ctx.obj["settings"].channel, blocks=blocks, as_user=True
+        )
+    except SlackApiError as e:
+        print(f"Got an error: {e.response['error']}")
+
+
+@report_unittests.command("success", short_help="Report a successful test runner build")
+@click.argument("report_group")
+@click.pass_context
+def report_unittests_success(ctx, report_group):
+    blocks = UnittestsSuccessMessage().format(report_group=report_group)
+    client = ctx.obj["slack"]
+    try:
+        client.chat_postMessage(
+            channel=ctx.obj["settings"].channel, blocks=blocks, as_user=True
+        )
+    except SlackApiError as e:
+        print(f"Got an error: {e.response['error']}")
+
+
+@report_unittests.command("failure", short_help="Report a failed test runner build")
+@click.argument("report_group")
+@click.pass_context
+def report_unittests_failure(ctx, report_group):
+    blocks = UnittestsFailureMessage().format(report_group=report_group)
+    client = ctx.obj["slack"]
+    try:
+        client.chat_postMessage(
+            channel=ctx.obj["settings"].channel, blocks=blocks, as_user=True
+        )
+    except SlackApiError as e:
+        print(f"Got an error: {e.response['error']}")
+
+
+@report.group(
+    "deployfish",
+    short_help="A group of commands that report about a Deployfish service build step",
+)
+def report_deployfish():
+    pass
+
+
+@report_deployfish.command(
+    "start", short_help="Report about starting a deployfish service deploy"
+)
+@click.argument("service")
+@click.pass_context
+def report_deployfish_start(ctx, service):
+    blocks = DeployfishDeployStartMessage().format(service=service)
+    client = ctx.obj["slack"]
+    try:
+        client.chat_postMessage(
+            channel=ctx.obj["settings"].channel, blocks=blocks, as_user=True
+        )
+    except SlackApiError as e:
+        print(f"Got an error: {e.response['error']}")
+
+
+@report_deployfish.command(
+    "success", short_help="Report a successful deployfish service deploy"
+)
+@click.argument("service")
+@click.pass_context
+def report_deployfish_success(ctx, service):
+    blocks = DeployfishDeploySuccessMessage().format(service=service)
+    client = ctx.obj["slack"]
+    try:
+        client.chat_postMessage(
+            channel=ctx.obj["settings"].channel, blocks=blocks, as_user=True
+        )
+    except SlackApiError as e:
+        print(f"Got an error: {e.response['error']}")
+
+
+@report_deployfish.command(
+    "failure", short_help="Report a failed deployfish service deploy"
+)
+@click.argument("service")
+@click.pass_context
+def report_deployfish_failure(ctx, service):
+    blocks = DeployfishDeployFailureMessage().format(service=service)
+    client = ctx.obj["slack"]
+    try:
+        client.chat_postMessage(
+            channel=ctx.obj["settings"].channel, blocks=blocks, as_user=True
+        )
+    except SlackApiError as e:
+        print(f"Got an error: {e.response['error']}")
+
+
+@report.group(
+    "deployfish-tasks",
+    short_help="A group of commands that report about a Deployfish one-off tasks "
+               "build step",
+)
+def report_deployfish_tasks():
+    pass
+
+
+@report_deployfish_tasks.command(
+    "start", short_help="Report about starting a deployfish one-off tasks deploy"
+)
+@click.argument("tasks", nargs=-1, required=True)
+@click.pass_context
+def report_deployfish_tasks_start(ctx, tasks):
+    blocks = DeployfishTasksDeployStartMessage().format(tasks=tasks)
+    client = ctx.obj["slack"]
+    try:
+        client.chat_postMessage(
+            channel=ctx.obj["settings"].channel, blocks=blocks, as_user=True
+        )
+    except SlackApiError as e:
+        print(f"Got an error: {e.response['error']}")
+
+
+@report_deployfish_tasks.command(
+    "success", short_help="Report a successful deployfish one-off tasks deploy"
+)
+@click.argument("tasks", nargs=-1, required=True)
+@click.pass_context
+def report_deployfish_tasks_success(ctx, tasks):
+    blocks = DeployfishTasksDeploySuccessMessage().format(tasks=tasks)
+    client = ctx.obj["slack"]
+    try:
+        client.chat_postMessage(
+            channel=ctx.obj["settings"].channel, blocks=blocks, as_user=True
+        )
+    except SlackApiError as e:
+        print(f"Got an error: {e.response['error']}")
+
+
+@report_deployfish_tasks.command(
+    "failure", short_help="Report a failed deployfish one-off tasks deploy"
+)
+@click.argument("tasks", nargs=-1, required=True)
+@click.pass_context
+def report_deployfish_tasks_failure(ctx, tasks):
+    blocks = DeployfishTasksDeployFailureMessage().format(tasks=tasks)
+    client = ctx.obj["slack"]
+    try:
+        client.chat_postMessage(
+            channel=ctx.obj["settings"].channel, blocks=blocks, as_user=True
+        )
+    except SlackApiError as e:
+        print(f"Got an error: {e.response['error']}")
+
+
+@report.group(
+    "docs",
+    short_help="A group of commands that report about a Deployfish service build step",
+)
+def report_docs():
+    pass
+
+
+@report_docs.command(
+    "start", short_help="Report about starting a Sphinx docs build and deploy"
+)
+@click.pass_context
+def report_docs_start(ctx):
+    blocks = DocsStartMessage().format()
+    client = ctx.obj["slack"]
+    try:
+        client.chat_postMessage(
+            channel=ctx.obj["settings"].channel, blocks=blocks, as_user=True
+        )
+    except SlackApiError as e:
+        print(f"Got an error: {e.response['error']}")
+
+
+@report_docs.command(
+    "success", short_help="Report a successful Sphinx docs build and deploy"
+)
+@click.pass_context
+def report_docs_success(ctx):
+    blocks = DocsSuccessMessage().format()
+    client = ctx.obj["slack"]
+    try:
+        client.chat_postMessage(
+            channel=ctx.obj["settings"].channel, blocks=blocks, as_user=True
+        )
+    except SlackApiError as e:
+        print(f"Got an error: {e.response['error']}")
+
+
+@report_docs.command(
+    "failure", short_help="Report a failed Sphinx docs build and deploy"
+)
+@click.pass_context
+def report_docs_failure(ctx):
+    blocks = DocsFailureMessage().format()
+    client = ctx.obj["slack"]
+    try:
+        client.chat_postMessage(
+            channel=ctx.obj["settings"].channel, blocks=blocks, as_user=True
+        )
+    except SlackApiError as e:
+        print(f"Got an error: {e.response['error']}")
+
+
+@report.group(
+    "general",
+    short_help="A group of commands that report about a Deployfish service build step",
+)
+def report_general():
+    pass
+
+
+@report_general.command(
+    "start", short_help="Report about starting a general service deploy"
+)
+@click.argument("label")
+@click.pass_context
+def report_general_start(ctx, label):
+    blocks = GeneralStartMessage().format(label=label)
+    client = ctx.obj["slack"]
+    try:
+        client.chat_postMessage(
+            channel=ctx.obj["settings"].channel, blocks=blocks, as_user=True
+        )
+    except SlackApiError as e:
+        print(f"Got an error: {e.response['error']}")
+
+
+@report_general.command(
+    "success", short_help="Report a successful general service deploy"
+)
+@click.argument("label")
+@click.pass_context
+def report_general_success(ctx, label):
+    blocks = GeneralSuccessMessage().format(label=label)
+    client = ctx.obj["slack"]
+    try:
+        client.chat_postMessage(
+            channel=ctx.obj["settings"].channel, blocks=blocks, as_user=True
+        )
+    except SlackApiError as e:
+        print(f"Got an error: {e.response['error']}")
+
+
+@report_general.command("failure", short_help="Report a failed general service deploy")
+@click.argument("label")
+@click.pass_context
+def report_general_failure(ctx, label):
+    blocks = GeneralFailureMessage().format(label=label)
+    client = ctx.obj["slack"]
+    try:
+        client.chat_postMessage(
+            channel=ctx.obj["settings"].channel, blocks=blocks, as_user=True
+        )
+    except SlackApiError as e:
+        print(f"Got an error: {e.response['error']}")
+
+
+def main():
+    cli(obj={})
+
+
+if __name__ == "__main__":
+    main()

ci_buildbot/context_processors/__init__.py

@@ -0,0 +1,8 @@
+from .base import *  # noqa:F403,F401
+from .codebuild import *  # noqa:F403,F401
+from .deployfish import *  # noqa:F403,F401
+from .docker import *  # noqa:F403,F401
+from .generic import *  # noqa:F403,F401
+from .git import *  # noqa:F403,F401
+from .project import *  # noqa:F403,F401
+from .unittest import *  # noqa:F403,F401

ci_buildbot/context_processors/base.py

@@ -0,0 +1,27 @@
+from abc import ABC, abstractmethod
+
+from ..typedefs import MessageContext
+
+
+class AbstractContextProcessor(ABC):
+    """
+    Base class for all context processors.
+    """
+
+    def __init__(self, **kwargs):  # noqa: B027
+        """
+        Args:
+            kwargs: the keyword arguments passed to the context processor
+
+        """
+
+    @abstractmethod
+    def annotate(self, context: MessageContext) -> None:
+        """
+        Add values to the message context ``context``.
+
+        Args:
+            context: the current message context
+
+        """
+        ...

ci_buildbot/context_processors/codebuild.py

@@ -0,0 +1,53 @@
+import os
+import time
+
+from ..typedefs import MessageContext
+from .base import AbstractContextProcessor
+
+
+class CodebuildProcessor(AbstractContextProcessor):
+    """
+    Adds the following keys to the context:
+
+    * ``build_id``: the CodeBuild build id
+    * ``build_project_name``: the CodeBuild project name
+    * ``build_status_url``: the URL to the CodeBuild build status page
+    * ``account_id``: the AWS account id
+    * ``pipeline_url``: the URL to the CodePipeline pipeline status page
+    * ``pipeline``: the CodePipeline pipeline name
+    * ``status``: the CodePipeline pipeline status
+    * ``region``: the AWS region
+    * ``build_time``: the elapsed time for the build in minutes and seconds
+    """
+
+    def get_build_log_url(self, context: MessageContext) -> None:
+        fields = os.environ["CODEBUILD_BUILD_ARN"].split(":")
+        context["account_id"] = fields[4]
+        context["build_project_name"] = fields[5].split("/")[1]
+        context["build_id"] = fields[6]
+        context["build_status_url"] = (
+            f"<https://{context['region']}.console.aws.amazon.com/codesuite/codebuild/"
+            f"{context['account_id']}/projects/{context['build_project_name']}/build/"
+            f"{context['build_project_name']}%3A{context['build_id']}/"
+            "log?region=us-west-2|Click here>"
+        )
+
+    def get_pipeline_url(self, context: MessageContext) -> None:
+        # TODO: detect region from the environment instead of hardcoding it to us-west-2
+        context["pipeline"] = os.environ["CODEBUILD_INITIATOR"].split("/")[1]
+        context["pipeline_url"] = (
+            f"<https://{context['region']}.console.aws.amazon.com/codesuite/codepipeline/pipelines/{context['pipeline']}/view?region=us-west-2|{context['pipeline']}>"
+        )
+
+    def annotate(self, context: MessageContext) -> None:
+        context["status"] = (
+            "Success" if "CODEBUILD_BUILD_SUCCEEDING" in os.environ else "Failed"
+        )
+        context["region"] = os.environ["AWS_DEFAULT_REGION"]
+        context["build_id"] = os.environ.get("CODEBUILD_BUILD_ID", None)
+        build_seconds = time.time() - float(os.environ["CODEBUILD_START_TIME"]) / 1000
+        build_minutes = int(build_seconds // 60)
+        build_seconds = int(build_seconds - build_minutes * 60)
+        context["build_time"] = f"{build_minutes}m {build_seconds}s"
+        self.get_build_log_url(context)
+        self.get_pipeline_url(context)

ci_buildbot/context_processors/deployfish.py

@@ -0,0 +1,32 @@
+from ..typedefs import MessageContext
+from .base import AbstractContextProcessor
+
+
+class DeployfishDeployProcessor(AbstractContextProcessor):
+    """
+    Adds the following keys to the context:
+
+    * ``service``: the name of the ECS service being deployed
+    """
+
+    def __init__(self, **kwargs) -> None:
+        super().__init__(**kwargs)
+        self.service: str = kwargs["service"]
+
+    def annotate(self, context: MessageContext) -> None:
+        context["service"] = self.service
+
+
+class DeployfishTasksDeployProcessor(AbstractContextProcessor):
+    """
+    Adds the following keys to the context:
+
+    * ``tasks``: a list of the names of the ECS tasks being deployed
+    """
+
+    def __init__(self, **kwargs) -> None:
+        super().__init__(**kwargs)
+        self.tasks: list[str] = kwargs["tasks"]
+
+    def annotate(self, context: MessageContext) -> None:
+        context["tasks"] = self.tasks

ci_buildbot/context_processors/docker.py

@@ -0,0 +1,39 @@
+from pathlib import Path
+
+import docker
+
+from ..typedefs import MessageContext
+from .base import AbstractContextProcessor
+
+
+class DockerImageNameProcessor(AbstractContextProcessor):
+    """
+    Adds the key ``short_image`` to the context, which is the basename of
+    the Docker image without the repository name.
+    """
+
+    def __init__(self, **kwargs) -> None:
+        super().__init__(**kwargs)
+        self.image: str = kwargs["image"]
+
+    def annotate(self, context: MessageContext) -> None:
+        context["short_image"] = Path(self.image).name
+
+
+class DockerProcessor(AbstractContextProcessor):
+    """
+    Adds the following keys to the context:
+
+    * ``image_id``: the short id of the Docker image
+    * ``image_size``: the size of the Docker image in MB
+    """
+
+    def __init__(self, **kwargs) -> None:
+        super().__init__(**kwargs)
+        self.image: str = kwargs["image"]
+
+    def annotate(self, context: MessageContext) -> None:
+        client = docker.from_env()
+        image = client.images.get(self.image)
+        context["image_id"] = image.short_id.split(":")[1]
+        context["image_size"] = image.attrs["Size"] / (1024 * 1024)

ci_buildbot/context_processors/generic.py

@@ -0,0 +1,17 @@
+from ..typedefs import MessageContext
+from .base import AbstractContextProcessor
+
+
+class GenericProcessor(AbstractContextProcessor):
+    """
+    Adds the following keys to the context:
+
+    * ``label``: a user supplied label we got from the --label command line option
+    """
+
+    def __init__(self, **kwargs) -> None:
+        super().__init__(**kwargs)
+        self.label: str | None = kwargs["label"]
+
+    def annotate(self, context: MessageContext) -> None:
+        context["label"] = self.label