You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2021/02/23 22:47:00 UTC
[GitHub] [airflow] ferruzzi opened a new pull request #14402: Implemented S3 Bucket Tagging
ferruzzi opened a new pull request #14402:
URL: https://github.com/apache/airflow/pull/14402
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
closes: #14279
CHANGES:
- Added Put/Get/Delete operators for AWS S3 bucket tagging.
TESTING:
- Unit testing included
- Sample DAG included
- Passes pre-commit
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
In case of fundamental code change, Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in [UPDATING.md](https://github.com/apache/airflow/blob/master/UPDATING.md).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] ferruzzi commented on pull request #14402: Implemented S3 Bucket Tagging
Posted by GitBox <gi...@apache.org>.
ferruzzi commented on pull request #14402:
URL: https://github.com/apache/airflow/pull/14402#issuecomment-784582611
I see it is failing `Validate providers.yaml files` on your side. It says 'skipped' on my side for that one when I run the pre-commit.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] ferruzzi edited a comment on pull request #14402: Implemented S3 Bucket Tagging
Posted by GitBox <gi...@apache.org>.
ferruzzi edited a comment on pull request #14402:
URL: https://github.com/apache/airflow/pull/14402#issuecomment-784582611
I see it is failing `Validate providers.yaml files` on your side. It says 'skipped' on my side for that one when I run the pre-commit. If I do make any changes to that file, the linter says `invalid syntax (<unknown>, line 18) (syntax-error)` which points at the first line after the license.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk merged pull request #14402: Implemented S3 Bucket Tagging
Posted by GitBox <gi...@apache.org>.
potiuk merged pull request #14402:
URL: https://github.com/apache/airflow/pull/14402
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] boring-cyborg[bot] commented on pull request #14402: Implemented S3 Bucket Tagging
Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on pull request #14402:
URL: https://github.com/apache/airflow/pull/14402#issuecomment-784567985
Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst)
Here are some useful points:
- Pay attention to the quality of your code (flake8, pylint and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/master/STATIC_CODE_CHECKS.rst#prerequisites-for-pre-commit-hooks) will help you with that.
- In case of a new feature add useful documentation (in docstrings or in `docs/` directory). Adding a new operator? Check this short [guide](https://github.com/apache/airflow/blob/master/docs/apache-airflow/howto/custom-operator.rst) Consider adding an example DAG that shows how users should use it.
- Consider using [Breeze environment](https://github.com/apache/airflow/blob/master/BREEZE.rst) for testing locally, itโs a heavy docker but it ships with a working Airflow and a lot of integrations.
- Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
- Please follow [ASF Code of Conduct](https://www.apache.org/foundation/policies/conduct) for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
- Be sure to read the [Airflow Coding style]( https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#coding-style-and-best-practices).
Apache Airflow is a community-driven project and together we are making it better ๐.
In case of doubts contact the developers at:
Mailing List: dev@airflow.apache.org
Slack: https://s.apache.org/airflow-slack
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] ashb commented on a change in pull request #14402: Implemented S3 Bucket Tagging
Posted by GitBox <gi...@apache.org>.
ashb commented on a change in pull request #14402:
URL: https://github.com/apache/airflow/pull/14402#discussion_r583506095
##########
File path: airflow/providers/amazon/aws/hooks/s3.py
##########
@@ -848,3 +848,74 @@ def generate_presigned_url(
except ClientError as e:
self.log.error(e.response["Error"]["Message"])
return None
+
+ @provide_bucket_name
+ def get_bucket_tagging(self, bucket_name: Optional[str] = None) -> Optional[List[Dict[str, str]]]:
+ """
+ Gets a List of tags from a bucket.
+
+ :param bucket_name: The name of the bucket.
+ :type bucket_name: str
+ :return: A List containing the key/value pairs for the tags
+ :rtype: Optional[List[Dict[str, str]]]
Review comment:
Why a list of dicts and not just one dict with the "Name" and. "Value" flattened?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] commented on pull request #14402: Implemented S3 Bucket Tagging
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #14402:
URL: https://github.com/apache/airflow/pull/14402#issuecomment-784578447
[The Workflow run](https://github.com/apache/airflow/actions/runs/594171188) is cancelling this PR. It has some failed jobs matching ^Pylint$,^Static checks,^Build docs$,^Spell check docs$,^Backport packages$,^Provider packages,^Checks: Helm tests$,^Test OpenAPI*.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] commented on pull request #14402: Implemented S3 Bucket Tagging
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #14402:
URL: https://github.com/apache/airflow/pull/14402#issuecomment-787520731
The PR is likely OK to be merged with just subset of tests for default Python and Database versions without running the full matrix of tests, because it does not modify the core of Airflow. If the committers decide that the full tests matrix is needed, they will add the label 'full tests needed'. Then you should rebase to the latest master or amend the last commit of the PR, and push it with --force-with-lease.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] ferruzzi commented on a change in pull request #14402: Implemented S3 Bucket Tagging
Posted by GitBox <gi...@apache.org>.
ferruzzi commented on a change in pull request #14402:
URL: https://github.com/apache/airflow/pull/14402#discussion_r583121536
##########
File path: tests/providers/amazon/aws/operators/test_s3_bucket_tagging.py
##########
@@ -0,0 +1,120 @@
+#
+# 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.
+import os
+import unittest
+from unittest import mock
+
+from moto import mock_s3
+
+from airflow.providers.amazon.aws.hooks.s3 import S3Hook
+from airflow.providers.amazon.aws.operators.s3_bucket_tagging import (
+ S3DeleteBucketTaggingOperator,
+ S3GetBucketTaggingOperator,
+ S3PutBucketTaggingOperator,
+)
+
+BUCKET_NAME = os.environ.get("BUCKET_NAME", "test-airflow-bucket")
+TAG_SET = [{'Key': 'Color', 'Value': 'Green'}]
+TASK_ID = os.environ.get("TASK_ID", "test-s3-operator")
+
+
+class TestS3GetBucketTaggingOperator(unittest.TestCase):
+ def setUp(self):
+ self.get_bucket_tagging_operator = S3GetBucketTaggingOperator(
+ task_id=TASK_ID,
+ bucket_name=BUCKET_NAME,
+ )
+
+ @mock_s3
+ @mock.patch.object(S3Hook, "get_bucket_tagging")
+ @mock.patch.object(S3Hook, "check_for_bucket")
+ def test_execute_if_bucket_exist(self, mock_check_for_bucket, get_bucket_tagging):
+ mock_check_for_bucket.return_value = True
+ # execute s3 get bucket tagging operator
+ self.get_bucket_tagging_operator.execute({})
+ mock_check_for_bucket.assert_called_once_with(BUCKET_NAME)
+ get_bucket_tagging.assert_called_once_with(BUCKET_NAME)
+
+ @mock_s3
+ @mock.patch.object(S3Hook, "get_bucket_tagging")
+ @mock.patch.object(S3Hook, "check_for_bucket")
+ def test_execute_if_not_bucket_exist(self, mock_check_for_bucket, get_bucket_tagging):
+ mock_check_for_bucket.return_value = False
+ # execute s3 get bucket tagging operator
+ self.get_bucket_tagging_operator.execute({})
+ mock_check_for_bucket.assert_called_once_with(BUCKET_NAME)
+ get_bucket_tagging.assert_not_called()
+
+
+class TestS3PutBucketTaggingOperator(unittest.TestCase):
+ def setUp(self):
+ self.put_bucket_tagging_operator = S3PutBucketTaggingOperator(
+ task_id=TASK_ID,
+ tag_set=TAG_SET,
+ bucket_name=BUCKET_NAME,
+ )
+
+ @mock_s3
+ @mock.patch.object(S3Hook, "put_bucket_tagging")
+ @mock.patch.object(S3Hook, "check_for_bucket")
+ def test_execute_if_bucket_exist(self, mock_check_for_bucket, put_bucket_tagging):
+ mock_check_for_bucket.return_value = True
+ # execute s3 put bucket tagging operator
+ self.put_bucket_tagging_operator.execute({})
+ mock_check_for_bucket.assert_called_once_with(BUCKET_NAME)
+ put_bucket_tagging.assert_called_once_with(
+ key=None, value=None, tag_set=TAG_SET, bucket_name=BUCKET_NAME
+ )
+
+ @mock_s3
+ @mock.patch.object(S3Hook, "put_bucket_tagging")
+ @mock.patch.object(S3Hook, "check_for_bucket")
+ def test_execute_if_not_bucket_exist(self, mock_check_for_bucket, put_bucket_tagging):
+ mock_check_for_bucket.return_value = False
+ # execute s3 put bucket tagging operator
+ self.put_bucket_tagging_operator.execute({})
+ mock_check_for_bucket.assert_called_once_with(BUCKET_NAME)
+ put_bucket_tagging.assert_not_called()
+
+
+class TestS3DeleteBucketTaggingOperator(unittest.TestCase):
+ def setUp(self):
+ self.delete_bucket_tagging_operator = S3DeleteBucketTaggingOperator(
+ task_id=TASK_ID,
+ bucket_name=BUCKET_NAME,
+ )
+
+ @mock_s3
+ @mock.patch.object(S3Hook, "delete_bucket_tagging")
+ @mock.patch.object(S3Hook, "check_for_bucket")
+ def test_execute_if_bucket_exist(self, mock_check_for_bucket, delete_bucket_tagging):
+ mock_check_for_bucket.return_value = True
+ # execute s3 get bucket tagging operator
Review comment:
Indeed. Corrected, thanks.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] o-nikolas commented on a change in pull request #14402: Implemented S3 Bucket Tagging
Posted by GitBox <gi...@apache.org>.
o-nikolas commented on a change in pull request #14402:
URL: https://github.com/apache/airflow/pull/14402#discussion_r583832338
##########
File path: airflow/providers/amazon/aws/hooks/s3.py
##########
@@ -848,3 +848,74 @@ def generate_presigned_url(
except ClientError as e:
self.log.error(e.response["Error"]["Message"])
return None
+
+ @provide_bucket_name
+ def get_bucket_tagging(self, bucket_name: Optional[str] = None) -> Optional[List[Dict[str, str]]]:
+ """
+ Gets a List of tags from a bucket.
+
+ :param bucket_name: The name of the bucket.
+ :type bucket_name: str
+ :return: A List containing the key/value pairs for the tags
+ :rtype: Optional[List[Dict[str, str]]]
Review comment:
I'd prefer that we keep the standard S3 Boto API behaviour. Diverging from the API will lead to confusion, especially for folks that are moving standalone Python code over to Airflow and it's operators.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] ferruzzi commented on pull request #14402: Implemented S3 Bucket Tagging
Posted by GitBox <gi...@apache.org>.
ferruzzi commented on pull request #14402:
URL: https://github.com/apache/airflow/pull/14402#issuecomment-786915379
@potiuk The howto should be showing up momentarily
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] ferruzzi commented on a change in pull request #14402: Implemented S3 Bucket Tagging
Posted by GitBox <gi...@apache.org>.
ferruzzi commented on a change in pull request #14402:
URL: https://github.com/apache/airflow/pull/14402#discussion_r583775797
##########
File path: airflow/providers/amazon/aws/hooks/s3.py
##########
@@ -848,3 +848,74 @@ def generate_presigned_url(
except ClientError as e:
self.log.error(e.response["Error"]["Message"])
return None
+
+ @provide_bucket_name
+ def get_bucket_tagging(self, bucket_name: Optional[str] = None) -> Optional[List[Dict[str, str]]]:
+ """
+ Gets a List of tags from a bucket.
+
+ :param bucket_name: The name of the bucket.
+ :type bucket_name: str
+ :return: A List containing the key/value pairs for the tags
+ :rtype: Optional[List[Dict[str, str]]]
Review comment:
This mirrors how the API behaves. I'm not positive why the API is returning it that way, but didn't presume to change it and possibly break someone's implementation. It's an easy enough change if we would prefer to unwrap it. What do you think?
Reference: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3.html#S3.Client.get_bucket_tagging
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] o-nikolas commented on a change in pull request #14402: Implemented S3 Bucket Tagging
Posted by GitBox <gi...@apache.org>.
o-nikolas commented on a change in pull request #14402:
URL: https://github.com/apache/airflow/pull/14402#discussion_r583046506
##########
File path: tests/providers/amazon/aws/operators/test_s3_bucket_tagging.py
##########
@@ -0,0 +1,120 @@
+#
+# 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.
+import os
+import unittest
+from unittest import mock
+
+from moto import mock_s3
+
+from airflow.providers.amazon.aws.hooks.s3 import S3Hook
+from airflow.providers.amazon.aws.operators.s3_bucket_tagging import (
+ S3DeleteBucketTaggingOperator,
+ S3GetBucketTaggingOperator,
+ S3PutBucketTaggingOperator,
+)
+
+BUCKET_NAME = os.environ.get("BUCKET_NAME", "test-airflow-bucket")
+TAG_SET = [{'Key': 'Color', 'Value': 'Green'}]
+TASK_ID = os.environ.get("TASK_ID", "test-s3-operator")
+
+
+class TestS3GetBucketTaggingOperator(unittest.TestCase):
+ def setUp(self):
+ self.get_bucket_tagging_operator = S3GetBucketTaggingOperator(
+ task_id=TASK_ID,
+ bucket_name=BUCKET_NAME,
+ )
+
+ @mock_s3
+ @mock.patch.object(S3Hook, "get_bucket_tagging")
+ @mock.patch.object(S3Hook, "check_for_bucket")
+ def test_execute_if_bucket_exist(self, mock_check_for_bucket, get_bucket_tagging):
+ mock_check_for_bucket.return_value = True
+ # execute s3 get bucket tagging operator
+ self.get_bucket_tagging_operator.execute({})
+ mock_check_for_bucket.assert_called_once_with(BUCKET_NAME)
+ get_bucket_tagging.assert_called_once_with(BUCKET_NAME)
+
+ @mock_s3
+ @mock.patch.object(S3Hook, "get_bucket_tagging")
+ @mock.patch.object(S3Hook, "check_for_bucket")
+ def test_execute_if_not_bucket_exist(self, mock_check_for_bucket, get_bucket_tagging):
+ mock_check_for_bucket.return_value = False
+ # execute s3 get bucket tagging operator
+ self.get_bucket_tagging_operator.execute({})
+ mock_check_for_bucket.assert_called_once_with(BUCKET_NAME)
+ get_bucket_tagging.assert_not_called()
+
+
+class TestS3PutBucketTaggingOperator(unittest.TestCase):
+ def setUp(self):
+ self.put_bucket_tagging_operator = S3PutBucketTaggingOperator(
+ task_id=TASK_ID,
+ tag_set=TAG_SET,
+ bucket_name=BUCKET_NAME,
+ )
+
+ @mock_s3
+ @mock.patch.object(S3Hook, "put_bucket_tagging")
+ @mock.patch.object(S3Hook, "check_for_bucket")
+ def test_execute_if_bucket_exist(self, mock_check_for_bucket, put_bucket_tagging):
+ mock_check_for_bucket.return_value = True
+ # execute s3 put bucket tagging operator
+ self.put_bucket_tagging_operator.execute({})
+ mock_check_for_bucket.assert_called_once_with(BUCKET_NAME)
+ put_bucket_tagging.assert_called_once_with(
+ key=None, value=None, tag_set=TAG_SET, bucket_name=BUCKET_NAME
+ )
+
+ @mock_s3
+ @mock.patch.object(S3Hook, "put_bucket_tagging")
+ @mock.patch.object(S3Hook, "check_for_bucket")
+ def test_execute_if_not_bucket_exist(self, mock_check_for_bucket, put_bucket_tagging):
+ mock_check_for_bucket.return_value = False
+ # execute s3 put bucket tagging operator
+ self.put_bucket_tagging_operator.execute({})
+ mock_check_for_bucket.assert_called_once_with(BUCKET_NAME)
+ put_bucket_tagging.assert_not_called()
+
+
+class TestS3DeleteBucketTaggingOperator(unittest.TestCase):
+ def setUp(self):
+ self.delete_bucket_tagging_operator = S3DeleteBucketTaggingOperator(
+ task_id=TASK_ID,
+ bucket_name=BUCKET_NAME,
+ )
+
+ @mock_s3
+ @mock.patch.object(S3Hook, "delete_bucket_tagging")
+ @mock.patch.object(S3Hook, "check_for_bucket")
+ def test_execute_if_bucket_exist(self, mock_check_for_bucket, delete_bucket_tagging):
+ mock_check_for_bucket.return_value = True
+ # execute s3 get bucket tagging operator
Review comment:
nit: Looks like this comment was copy/pasted from the Get test class, s/get/delete/g
Same in the method below.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on a change in pull request #14402: Implemented S3 Bucket Tagging
Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #14402:
URL: https://github.com/apache/airflow/pull/14402#discussion_r584358322
##########
File path: airflow/providers/amazon/aws/hooks/s3.py
##########
@@ -848,3 +848,74 @@ def generate_presigned_url(
except ClientError as e:
self.log.error(e.response["Error"]["Message"])
return None
+
+ @provide_bucket_name
+ def get_bucket_tagging(self, bucket_name: Optional[str] = None) -> Optional[List[Dict[str, str]]]:
+ """
+ Gets a List of tags from a bucket.
+
+ :param bucket_name: The name of the bucket.
+ :type bucket_name: str
+ :return: A List containing the key/value pairs for the tags
+ :rtype: Optional[List[Dict[str, str]]]
Review comment:
Yep. This is what we usually prefer for the integrations/providers - to transparently move what the API we integrate with rather than fix it - this is usually more future-proof.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] boring-cyborg[bot] commented on pull request #14402: Implemented S3 Bucket Tagging
Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on pull request #14402:
URL: https://github.com/apache/airflow/pull/14402#issuecomment-787520698
Awesome work, congrats on your first merged pull request!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org