Source code for airflow.providers.google.cloud.links.cloud_build

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
from __future__ import annotations

from typing import TYPE_CHECKING

from airflow.providers.google.cloud.links.base import BaseGoogleLink

if TYPE_CHECKING:
    from airflow.utils.context import Context

[docs]BUILD_BASE_LINK = "/cloud-build"

[docs]BUILD_LINK = BUILD_BASE_LINK + "/builds;region={region}/{build_id}?project={project_id}"

[docs]BUILD_LIST_LINK = BUILD_BASE_LINK + "/builds;region={region}?project={project_id}"

[docs]BUILD_TRIGGERS_LIST_LINK = BUILD_BASE_LINK + "/triggers;region={region}?project={project_id}"

[docs]BUILD_TRIGGER_DETAILS_LINK = (
    BUILD_BASE_LINK + "/triggers;region={region}/edit/{trigger_id}?project={project_id}"
)


[docs]class CloudBuildLink(BaseGoogleLink):
    """Helper class for constructing Cloud Build link."""

[docs]    name = "Cloud Build Details"
[docs]    key = "cloud_build_key"
[docs]    format_str = BUILD_LINK

    @staticmethod
[docs]    def persist(
        context: Context,
        task_instance,
        build_id: str,
        project_id: str,
        region: str,
    ):
        task_instance.xcom_push(
            context=context,
            key=CloudBuildLink.key,
            value={
                "project_id": project_id,
                "region": region,
                "build_id": build_id,
            },
        )


[docs]class CloudBuildListLink(BaseGoogleLink):
    """Helper class for constructing Cloud Build List link."""

[docs]    name = "Cloud Builds List"
[docs]    key = "cloud_build_list_key"
[docs]    format_str = BUILD_LIST_LINK

    @staticmethod
[docs]    def persist(
        context: Context,
        task_instance,
        project_id: str,
        region: str,
    ):
        task_instance.xcom_push(
            context=context,
            key=CloudBuildListLink.key,
            value={
                "project_id": project_id,
                "region": region,
            },
        )


[docs]class CloudBuildTriggersListLink(BaseGoogleLink):
    """Helper class for constructing Cloud Build Triggers List link."""

[docs]    name = "Cloud Build Triggers List"
[docs]    key = "cloud_build_triggers_list_key"
[docs]    format_str = BUILD_TRIGGERS_LIST_LINK

    @staticmethod
[docs]    def persist(
        context: Context,
        task_instance,
        project_id: str,
        region: str,
    ):
        task_instance.xcom_push(
            context=context,
            key=CloudBuildTriggersListLink.key,
            value={
                "project_id": project_id,
                "region": region,
            },
        )


[docs]class CloudBuildTriggerDetailsLink(BaseGoogleLink):
    """Helper class for constructing Cloud Build Trigger Details link."""

[docs]    name = "Cloud Build Triggers Details"
[docs]    key = "cloud_build_triggers_details_key"
[docs]    format_str = BUILD_TRIGGER_DETAILS_LINK

    @staticmethod
[docs]    def persist(
        context: Context,
        task_instance,
        project_id: str,
        region: str,
        trigger_id: str,
    ):
        task_instance.xcom_push(
            context=context,
            key=CloudBuildTriggerDetailsLink.key,
            value={
                "project_id": project_id,
                "region": region,
                "trigger_id": trigger_id,
            },
        )