Source code for tests.system.providers.google.cloud.data_loss_prevention.example_dlp_info_types

#
# 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.

"""
Example Airflow DAG that creates and manage Data Loss Prevention info types.
"""

from __future__ import annotations

import os
from datetime import datetime
from pathlib import Path

from google.cloud.dlp_v2 import StoredInfoTypeConfig
from google.cloud.dlp_v2.types import ContentItem, InspectConfig, InspectTemplate

from airflow.models.dag import DAG
from airflow.providers.google.cloud.operators.dlp import (
    CloudDLPCreateStoredInfoTypeOperator,
    CloudDLPDeleteStoredInfoTypeOperator,
    CloudDLPGetStoredInfoTypeOperator,
    CloudDLPListInfoTypesOperator,
    CloudDLPListStoredInfoTypesOperator,
    CloudDLPUpdateStoredInfoTypeOperator,
)
from airflow.providers.google.cloud.operators.gcs import GCSCreateBucketOperator, GCSDeleteBucketOperator
from airflow.providers.google.cloud.transfers.local_to_gcs import LocalFilesystemToGCSOperator
from airflow.utils.trigger_rule import TriggerRule


[docs]DAG_ID = "dlp_info_types"


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


[docs]PROJECT_ID = os.environ.get("SYSTEM_TESTS_GCP_PROJECT")



[docs]TEMPLATE_ID = f"dlp-inspect-info-{ENV_ID}"


[docs]ITEM = ContentItem(
    table={
        "headers": [{"name": "column1"}],
        "rows": [{"values": [{"string_value": "My phone number is (206) 555-0123"}]}],
    }
)


[docs]INSPECT_CONFIG = InspectConfig(info_types=[{"name": "PHONE_NUMBER"}, {"name": "US_TOLLFREE_PHONE_NUMBER"}])


[docs]INSPECT_TEMPLATE = InspectTemplate(inspect_config=INSPECT_CONFIG)


[docs]BUCKET_NAME = f"bucket_{DAG_ID}_{ENV_ID}"



[docs]FILE_NAME = "dictionary.txt"


[docs]UPLOAD_FILE_PATH = str(Path(__file__).parent / "resources" / FILE_NAME)


[docs]FILE_SET = "tmp/"


[docs]DICTIONARY_PATH = FILE_SET + FILE_NAME


[docs]OBJECT_GCS_URI = f"gs://{BUCKET_NAME}/{FILE_SET}"


[docs]OBJECT_GCS_OUTPUT_URI = OBJECT_GCS_URI + FILE_NAME



[docs]CUSTOM_INFO_TYPE_ID = "custom_info_type"


[docs]CUSTOM_INFO_TYPES = StoredInfoTypeConfig(
    {
        "large_custom_dictionary": {
            "output_path": {"path": OBJECT_GCS_OUTPUT_URI},
            "cloud_storage_file_set": {"url": f"{OBJECT_GCS_URI}*"},
        }
    }
)


[docs]UPDATE_CUSTOM_INFO_TYPE = {
    "large_custom_dictionary": {
        "output_path": {"path": OBJECT_GCS_OUTPUT_URI},
        "cloud_storage_file_set": {"url": f"{OBJECT_GCS_URI}*"},
    }
}


with DAG(
    DAG_ID,
    schedule="@once",
    start_date=datetime(2021, 1, 1),
    catchup=False,
    tags=["dlp", "example"],
) as dag:

[docs]    create_bucket = GCSCreateBucketOperator(
        task_id="create_bucket",
        bucket_name=BUCKET_NAME,
        project_id=PROJECT_ID,
    )

    upload_file = LocalFilesystemToGCSOperator(
        task_id="upload_file",
        src=UPLOAD_FILE_PATH,
        dst=DICTIONARY_PATH,
        bucket=BUCKET_NAME,
    )

    list_possible_info_types = CloudDLPListInfoTypesOperator(task_id="list_info_types")

    # [START howto_operator_dlp_create_info_type]
    create_info_type = CloudDLPCreateStoredInfoTypeOperator(
        project_id=PROJECT_ID,
        config=CUSTOM_INFO_TYPES,
        stored_info_type_id=CUSTOM_INFO_TYPE_ID,
        task_id="create_info_type",
    )
    # [END howto_operator_dlp_create_info_type]

    list_stored_info_types = CloudDLPListStoredInfoTypesOperator(
        task_id="list_stored_info_types", project_id=PROJECT_ID
    )

    get_stored_info_type = CloudDLPGetStoredInfoTypeOperator(
        task_id="get_stored_info_type", project_id=PROJECT_ID, stored_info_type_id=CUSTOM_INFO_TYPE_ID
    )

    # [START howto_operator_dlp_update_info_type]
    update_info_type = CloudDLPUpdateStoredInfoTypeOperator(
        project_id=PROJECT_ID,
        stored_info_type_id=CUSTOM_INFO_TYPE_ID,
        config=UPDATE_CUSTOM_INFO_TYPE,
        task_id="update_info_type",
    )
    # [END howto_operator_dlp_update_info_type]

    # [START howto_operator_dlp_delete_info_type]
    delete_info_type = CloudDLPDeleteStoredInfoTypeOperator(
        project_id=PROJECT_ID,
        stored_info_type_id=CUSTOM_INFO_TYPE_ID,
        task_id="delete_info_type",
    )
    # [END howto_operator_dlp_delete_info_type]
    delete_info_type.trigger_rule = TriggerRule.ALL_DONE

    delete_bucket = GCSDeleteBucketOperator(
        task_id="delete_bucket", bucket_name=BUCKET_NAME, trigger_rule=TriggerRule.ALL_DONE
    )

    (
        create_bucket
        >> upload_file
        >> list_possible_info_types
        >> create_info_type
        >> list_stored_info_types
        >> get_stored_info_type
        >> update_info_type
        >> delete_info_type
        >> delete_bucket
    )

    from tests.system.utils.watcher import watcher

    # This test needs watcher in order to properly mark success/failure
    # when "teardown" task with trigger rule is part of the DAG
    list(dag.tasks) >> watcher()


from tests.system.utils 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)

Was this entry helpful?