You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
194 lines
7.5 KiB
194 lines
7.5 KiB
# |
|
# 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. |
|
"""This module contains SFTP to Google Cloud Storage operator.""" |
|
import os |
|
from tempfile import NamedTemporaryFile |
|
from typing import Optional, Sequence, Union |
|
|
|
from airflow.exceptions import AirflowException |
|
from airflow.models import BaseOperator |
|
from airflow.providers.google.cloud.hooks.gcs import GCSHook |
|
from airflow.providers.sftp.hooks.sftp import SFTPHook |
|
from airflow.utils.decorators import apply_defaults |
|
|
|
WILDCARD = "*" |
|
|
|
|
|
class SFTPToGCSOperator(BaseOperator): |
|
""" |
|
Transfer files to Google Cloud Storage from SFTP server. |
|
|
|
.. seealso:: |
|
For more information on how to use this operator, take a look at the guide: |
|
:ref:`howto/operator:SFTPToGCSOperator` |
|
|
|
:param source_path: The sftp remote path. This is the specified file path |
|
for downloading the single file or multiple files from the SFTP server. |
|
You can use only one wildcard within your path. The wildcard can appear |
|
inside the path or at the end of the path. |
|
:type source_path: str |
|
:param destination_bucket: The bucket to upload to. |
|
:type destination_bucket: str |
|
:param destination_path: The destination name of the object in the |
|
destination Google Cloud Storage bucket. |
|
If destination_path is not provided file/files will be placed in the |
|
main bucket path. |
|
If a wildcard is supplied in the destination_path argument, this is the |
|
prefix that will be prepended to the final destination objects' paths. |
|
:type destination_path: str |
|
:param gcp_conn_id: (Optional) The connection ID used to connect to Google Cloud. |
|
:type gcp_conn_id: str |
|
:param sftp_conn_id: The sftp connection id. The name or identifier for |
|
establishing a connection to the SFTP server. |
|
:type sftp_conn_id: str |
|
:param delegate_to: The account to impersonate using domain-wide delegation of authority, |
|
if any. For this to work, the service account making the request must have |
|
domain-wide delegation enabled. |
|
:type delegate_to: str |
|
:param mime_type: The mime-type string |
|
:type mime_type: str |
|
:param gzip: Allows for file to be compressed and uploaded as gzip |
|
:type gzip: bool |
|
:param move_object: When move object is True, the object is moved instead |
|
of copied to the new location. This is the equivalent of a mv command |
|
as opposed to a cp command. |
|
:type move_object: bool |
|
:param impersonation_chain: Optional service account to impersonate using short-term |
|
credentials, or chained list of accounts required to get the access_token |
|
of the last account in the list, which will be impersonated in the request. |
|
If set as a string, the account must grant the originating account |
|
the Service Account Token Creator IAM role. |
|
If set as a sequence, the identities from the list must grant |
|
Service Account Token Creator IAM role to the directly preceding identity, with first |
|
account from the list granting this role to the originating account (templated). |
|
:type impersonation_chain: Union[str, Sequence[str]] |
|
""" |
|
|
|
template_fields = ( |
|
"source_path", |
|
"destination_path", |
|
"destination_bucket", |
|
"impersonation_chain", |
|
) |
|
|
|
@apply_defaults |
|
def __init__( |
|
self, |
|
*, |
|
source_path: str, |
|
destination_bucket: str, |
|
destination_path: Optional[str] = None, |
|
gcp_conn_id: str = "google_cloud_default", |
|
sftp_conn_id: str = "ssh_default", |
|
delegate_to: Optional[str] = None, |
|
mime_type: str = "application/octet-stream", |
|
gzip: bool = False, |
|
move_object: bool = False, |
|
impersonation_chain: Optional[Union[str, Sequence[str]]] = None, |
|
**kwargs, |
|
) -> None: |
|
super().__init__(**kwargs) |
|
|
|
self.source_path = source_path |
|
self.destination_path = self._set_destination_path(destination_path) |
|
self.destination_bucket = self._set_bucket_name(destination_bucket) |
|
self.gcp_conn_id = gcp_conn_id |
|
self.mime_type = mime_type |
|
self.delegate_to = delegate_to |
|
self.gzip = gzip |
|
self.sftp_conn_id = sftp_conn_id |
|
self.move_object = move_object |
|
self.impersonation_chain = impersonation_chain |
|
|
|
def execute(self, context): |
|
gcs_hook = GCSHook( |
|
gcp_conn_id=self.gcp_conn_id, |
|
delegate_to=self.delegate_to, |
|
impersonation_chain=self.impersonation_chain, |
|
) |
|
|
|
sftp_hook = SFTPHook(self.sftp_conn_id) |
|
|
|
if WILDCARD in self.source_path: |
|
total_wildcards = self.source_path.count(WILDCARD) |
|
if total_wildcards > 1: |
|
raise AirflowException( |
|
"Only one wildcard '*' is allowed in source_path parameter. " |
|
"Found {} in {}.".format(total_wildcards, self.source_path) |
|
) |
|
|
|
prefix, delimiter = self.source_path.split(WILDCARD, 1) |
|
base_path = os.path.dirname(prefix) |
|
|
|
files, _, _ = sftp_hook.get_tree_map( |
|
base_path, prefix=prefix, delimiter=delimiter |
|
) |
|
|
|
for file in files: |
|
destination_path = file.replace(base_path, self.destination_path, 1) |
|
self._copy_single_object(gcs_hook, sftp_hook, file, destination_path) |
|
|
|
else: |
|
destination_object = ( |
|
self.destination_path |
|
if self.destination_path |
|
else self.source_path.rsplit("/", 1)[1] |
|
) |
|
self._copy_single_object( |
|
gcs_hook, sftp_hook, self.source_path, destination_object |
|
) |
|
|
|
def _copy_single_object( |
|
self, |
|
gcs_hook: GCSHook, |
|
sftp_hook: SFTPHook, |
|
source_path: str, |
|
destination_object: str, |
|
) -> None: |
|
"""Helper function to copy single object.""" |
|
self.log.info( |
|
"Executing copy of %s to gs://%s/%s", |
|
source_path, |
|
self.destination_bucket, |
|
destination_object, |
|
) |
|
|
|
with NamedTemporaryFile("w") as tmp: |
|
sftp_hook.retrieve_file(source_path, tmp.name) |
|
|
|
gcs_hook.upload( |
|
bucket_name=self.destination_bucket, |
|
object_name=destination_object, |
|
filename=tmp.name, |
|
mime_type=self.mime_type, |
|
) |
|
|
|
if self.move_object: |
|
self.log.info("Executing delete of %s", source_path) |
|
sftp_hook.delete_file(source_path) |
|
|
|
@staticmethod |
|
def _set_destination_path(path: Union[str, None]) -> str: |
|
if path is not None: |
|
return path.lstrip("/") if path.startswith("/") else path |
|
return "" |
|
|
|
@staticmethod |
|
def _set_bucket_name(name: str) -> str: |
|
bucket = name if not name.startswith("gs://") else name[5:] |
|
return bucket.strip("/")
|
|
|