Source code for tests.system.slack.example_slack

# 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

import os
from datetime import datetime

from airflow.models.dag import DAG
from airflow.providers.slack.operators.slack import SlackAPIFileOperator, SlackAPIPostOperator


[docs]
ENV_ID = os.environ.get("SYSTEM_TESTS_ENV_ID")


[docs]
DAG_ID = "slack_api_example_dag"


[docs]
SLACK_API_CONN_ID = os.environ.get("SLACK_API_CONN_ID", "slack_conn_id")


[docs]
SLACK_CHANNEL = os.environ.get("SLACK_CHANNEL", "#general")


[docs]
IMAGE_URL = (
    "https://raw.githubusercontent.com/apache/airflow/main/airflow-core/src/airflow/ui/public/pin_100.png"
)


with DAG(
    dag_id=DAG_ID,
    schedule=None,
    start_date=datetime(2021, 1, 1),
    default_args={"slack_conn_id": SLACK_API_CONN_ID, "initial_comment": "Hello World!"},
    max_active_runs=1,
    tags=["example"],
) as dag:
    # [START slack_api_post_operator_text_howto_guide]

[docs]
    slack_operator_post_text = SlackAPIPostOperator(
        task_id="slack_post_text",
        channel=SLACK_CHANNEL,
        text=(
            "Apache Airflow® is an open-source platform for developing, "
            "scheduling, and monitoring batch-oriented workflows."
        ),
    )

    # [END slack_api_post_operator_text_howto_guide]

    # [START slack_api_post_operator_blocks_howto_guide]
    slack_operator_post_blocks = SlackAPIPostOperator(
        task_id="slack_post_blocks",
        channel=SLACK_CHANNEL,
        blocks=[
            {
                "type": "section",
                "text": {
                    "type": "mrkdwn",
                    "text": (
                        "*<https://github.com/apache/airflow|Apache Airflow®>* "
                        "is an open-source platform for developing, scheduling, "
                        "and monitoring batch-oriented workflows."
                    ),
                },
                "accessory": {"type": "image", "image_url": IMAGE_URL, "alt_text": "Pinwheel"},
            }
        ],
        text="Fallback message",
    )
    # [END slack_api_post_operator_blocks_howto_guide]

    # [START slack_api_file_operator_howto_guide]
    slack_operator_file = SlackAPIFileOperator(
        task_id="slack_file_upload_1",
        channels=SLACK_CHANNEL,
        filename="/files/dags/test.txt",
    )
    # [END slack_api_file_operator_howto_guide]

    # [START slack_api_file_operator_content_howto_guide]
    slack_operator_file_content = SlackAPIFileOperator(
        task_id="slack_file_upload_2",
        channels=SLACK_CHANNEL,
        content="file content in txt",
    )
    # [END slack_api_file_operator_content_howto_guide]

    (
        slack_operator_post_text
        >> slack_operator_post_blocks
        >> slack_operator_file
        >> slack_operator_file_content
    )


from tests_common.test_utils.system_tests import get_test_run  # noqa: E402

# Needed to run the example DAG with pytest (see: tests/system/README.md#run_via_pytest)

[docs]
test_run = get_test_run(dag)