[jira] [Commented] (AIRFLOW-2913) Check bucket_key and bucket_name combination in S3KeySensor()

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/AIRFLOW-2913?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16584010#comment-16584010 ] 

ASF GitHub Bot commented on AIRFLOW-2913:
-----------------------------------------

XD-DENG opened a new pull request #3762: [AIRFLOW-2913] Check bucket_key/bucket_name combination
URL: https://github.com/apache/incubator-airflow/pull/3762
 
 
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [x] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
     - https://issues.apache.org/jira/browse/AIRFLOW-2913
     - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
   
   ### Description
   
   - [x] Here are some details about my PR, including screenshots of any UI changes:
   
   1. When `bucket_name` is provided, and `bucket_key` is also provided as a full S3:// url, the `full_url` obtained eventually will be wrong. It will be like "`s3://bucket_name/s3://bucket_name/object_key`". This should be avoided by adding checking and raise exception in such case.
   
   2. Given the documentation is not clear enough, this issue may happen to new users of S3KeySensor(). I have improved the Documentation as well.
   
   3. Unit tests are added for the `bucket_key` and `bucket_name` combination checking as well.
   
   ### Tests
   
   - [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
   
   ### Commits
   
   - [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)":
     1. Subject is separated from body by a blank line
     1. Subject is limited to 50 characters (not including Jira issue reference)
     1. Subject does not end with a period
     1. Subject uses the imperative mood ("add", not "adding")
     1. Body wraps at 72 characters
     1. Body explains "what" and "why", not "how"
   
   ### Documentation
   
   - [ ] In case of new functionality, my PR adds documentation that describes how to use it.
     - When adding new operators/hooks/sensors, the autoclass documentation generation needs to be added.
   
   ### Code Quality
   
   - [x] Passes `git diff upstream/master -u -- "*.py" | flake8 --diff`
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on 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


> Check bucket_key and bucket_name combination in S3KeySensor()
> -------------------------------------------------------------
>
>                 Key: AIRFLOW-2913
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-2913
>             Project: Apache Airflow
>          Issue Type: Improvement
>          Components: operators
>            Reporter: Xiaodong DENG
>            Assignee: Xiaodong DENG
>            Priority: Critical
>
> 1. When *bucket_name* is provided, and *bucket_key* is also provided as a full S3:// url, the full_url obtained eventually will be wrong. It will be like "_s3://bucket_name/s3://bucket_name/object_key_". This should be avoided by adding checking and raise exception in such case.
> 2. Given the documentation is not clear enough, this may happen to new users of S3KeySensor() (like myself). I have improved the Documentation as well.
> 3. Unit tests are added for the bucket_key and bucket_name combination checking as well.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)