You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "ieunea1128 (via GitHub)" <gi...@apache.org> on 2023/07/18 03:00:07 UTC
[GitHub] [airflow] ieunea1128 opened a new pull request, #32664: Add endpoint_url in test_connection
ieunea1128 opened a new pull request, #32664:
URL: https://github.com/apache/airflow/pull/32664
<!--
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.
-->
<!--
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 an existing issue, reference it using one of the following:
closes: #ISSUE
related: #32652
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
---
In this pull request, we are resolving an issue related to the failure of the test connection caused by an incorrect STS URL. With this pull request, I've ensure that if the 'test_endpoint_url' parameter is provided, the STS check will be performed using that specific URL. However, if the parameter is not provided, the default URL will be used instead.
related: #32652
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+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 a newsfragment file, named `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [newsfragments](https://github.com/apache/airflow/tree/main/newsfragments).
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] ieunea1128 commented on a diff in pull request #32664: Add endpoint_url in test_connection
Posted by "ieunea1128 (via GitHub)" <gi...@apache.org>.
ieunea1128 commented on code in PR #32664:
URL: https://github.com/apache/airflow/pull/32664#discussion_r1269684728
##########
airflow/providers/amazon/aws/hooks/base_aws.py:
##########
@@ -796,7 +796,11 @@ def test_connection(self):
"""
try:
session = self.get_session()
- conn_info = session.client("sts").get_caller_identity()
+ test_endpoint_url = self.conn_config.extra_config.get("test_endpoint_url")
+ conn_info = session.client(
+ "sts",
+ endpoint_url=test_endpoint_url,
Review Comment:
Oops there's difference in endpoint of sts session. When I've printed endpoint, former returns url of ```test_endpoint_url``` and later returns Global endpoint.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] vincbeck commented on a diff in pull request #32664: Add endpoint_url in test_connection
Posted by "vincbeck (via GitHub)" <gi...@apache.org>.
vincbeck commented on code in PR #32664:
URL: https://github.com/apache/airflow/pull/32664#discussion_r1269706866
##########
airflow/providers/amazon/aws/hooks/base_aws.py:
##########
@@ -796,7 +796,11 @@ def test_connection(self):
"""
try:
session = self.get_session()
- conn_info = session.client("sts").get_caller_identity()
+ test_endpoint_url = self.conn_config.extra_config.get("test_endpoint_url")
+ conn_info = session.client(
+ "sts",
+ endpoint_url=test_endpoint_url,
Review Comment:
In the code you provided, you dont test when `endpoint_url` is `None` but I assume you tested it as you said. LGTM then
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] vincbeck commented on a diff in pull request #32664: Add endpoint_url in test_connection
Posted by "vincbeck (via GitHub)" <gi...@apache.org>.
vincbeck commented on code in PR #32664:
URL: https://github.com/apache/airflow/pull/32664#discussion_r1269600425
##########
airflow/providers/amazon/aws/hooks/base_aws.py:
##########
@@ -796,7 +796,11 @@ def test_connection(self):
"""
try:
session = self.get_session()
- conn_info = session.client("sts").get_caller_identity()
+ test_endpoint_url = self.conn_config.extra_config.get("test_endpoint_url")
+ conn_info = session.client(
+ "sts",
+ endpoint_url=test_endpoint_url,
Review Comment:
Did you tested it when `test_endpoint_url ` is None. My experience with `boto3` is they make a difference between a parameter value being `None` and a parameter not provided to the function
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] ieunea1128 commented on pull request #32664: Add endpoint_url in test_connection
Posted by "ieunea1128 (via GitHub)" <gi...@apache.org>.
ieunea1128 commented on PR #32664:
URL: https://github.com/apache/airflow/pull/32664#issuecomment-1644273768
@vincbeck After making the mentioned change, the test for ```test_hook_connection_test_failed``` in ```test/providers/amazon/aws/hooks/test_base_aws.py``` started asserting an error due to the absence of the ```test_endpoint_url``` in ```mock_sts_client```. To resolve this, I will make the necessary modifications.
By the way, Would it be better to include a unit test specifically for test_endpoint_url to ensure its validity?
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] boring-cyborg[bot] commented on pull request #32664: Add endpoint_url in test_connection
Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #32664:
URL: https://github.com/apache/airflow/pull/32664#issuecomment-1648289477
Awesome work, congrats on your first merged pull request! You are invited to check our [Issue Tracker](https://github.com/apache/airflow/issues) for additional contributions.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] ieunea1128 commented on a diff in pull request #32664: Add endpoint_url in test_connection
Posted by "ieunea1128 (via GitHub)" <gi...@apache.org>.
ieunea1128 commented on code in PR #32664:
URL: https://github.com/apache/airflow/pull/32664#discussion_r1269677374
##########
airflow/providers/amazon/aws/hooks/base_aws.py:
##########
@@ -796,7 +796,11 @@ def test_connection(self):
"""
try:
session = self.get_session()
- conn_info = session.client("sts").get_caller_identity()
+ test_endpoint_url = self.conn_config.extra_config.get("test_endpoint_url")
+ conn_info = session.client(
+ "sts",
+ endpoint_url=test_endpoint_url,
Review Comment:
Both of them returned successful result when I've tested both being None and a parameter not provided to the function.
I've executed code below
```python
conn = Connection(
conn_id="sample_aws_connection",
conn_type="aws",
login="access_key", # Reference to AWS Access Key ID
password="secret_key", # Reference to AWS Secret Access Key
extra={
"test_endpoint_url": "https://sts.us-east-1.amazonaws.com",
"region_name": "us-east-1"
},
)
env_key = f"AIRFLOW_CONN_{conn.conn_id.upper()}"
conn_uri = conn.get_uri()
os.environ[env_key] = conn_uri
conn.test_connection()
```
and I've compared results of two connection. Both of them returned successful result, and there's difference of ```RequestID``` in ```ResponseMetadata``` and ```x-amzn-requestid```, ```date``` in ```HTTPHeaders```
```python
conn_info = session.client(
"sts",
endpoint_url=test_endpoint_url,
).get_caller_identity()
conn_info_without_endpoint_url = session.client(
"sts"
).get_caller_identity()
```
Is there anything more needed to be checked?
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] vincbeck commented on pull request #32664: Add endpoint_url in test_connection
Posted by "vincbeck (via GitHub)" <gi...@apache.org>.
vincbeck commented on PR #32664:
URL: https://github.com/apache/airflow/pull/32664#issuecomment-1644313378
> @vincbeck After making the mentioned change, the test for `test_hook_connection_test_failed` in `test/providers/amazon/aws/hooks/test_base_aws.py` started asserting an error due to the absence of the `test_endpoint_url` in `mock_sts_client`. To resolve this, I will make the necessary modifications. By the way, Would it be better to include a unit test specifically for test_endpoint_url to ensure its validity?
That would be great :)
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] vincbeck merged pull request #32664: Add endpoint_url in test_connection
Posted by "vincbeck (via GitHub)" <gi...@apache.org>.
vincbeck merged PR #32664:
URL: https://github.com/apache/airflow/pull/32664
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] boring-cyborg[bot] commented on pull request #32664: Add endpoint_url in test_connection
Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #32664:
URL: https://github.com/apache/airflow/pull/32664#issuecomment-1639232064
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/main/CONTRIBUTING.rst)
Here are some useful points:
- Pay attention to the quality of your code (ruff, mypy and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/main/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/main/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/main/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/main/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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] vincbeck commented on a diff in pull request #32664: Add endpoint_url in test_connection
Posted by "vincbeck (via GitHub)" <gi...@apache.org>.
vincbeck commented on code in PR #32664:
URL: https://github.com/apache/airflow/pull/32664#discussion_r1266906080
##########
airflow/providers/amazon/aws/hooks/base_aws.py:
##########
@@ -796,7 +796,10 @@ def test_connection(self):
"""
try:
session = self.get_session()
- conn_info = session.client("sts").get_caller_identity()
+ test_endpoint_url = self.conn_config.extra_config.get('test_endpoint_url') or None
+ conn_info = session.client("sts",
Review Comment:
Could you also add a unit test for this new branch
##########
airflow/providers/amazon/aws/hooks/base_aws.py:
##########
@@ -796,7 +796,10 @@ def test_connection(self):
"""
try:
session = self.get_session()
- conn_info = session.client("sts").get_caller_identity()
+ test_endpoint_url = self.conn_config.extra_config.get('test_endpoint_url') or None
Review Comment:
By default, `get` returns None if the key does not exist.
```suggestion
test_endpoint_url = self.conn_config.extra_config.get('test_endpoint_url')
```
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] ieunea1128 commented on pull request #32664: Add endpoint_url in test_connection
Posted by "ieunea1128 (via GitHub)" <gi...@apache.org>.
ieunea1128 commented on PR #32664:
URL: https://github.com/apache/airflow/pull/32664#issuecomment-1646798294
@vincbeck I've added unit test for test_endpoint_url. Would you mind to review my code?
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] ieunea1128 commented on a diff in pull request #32664: Add endpoint_url in test_connection
Posted by "ieunea1128 (via GitHub)" <gi...@apache.org>.
ieunea1128 commented on code in PR #32664:
URL: https://github.com/apache/airflow/pull/32664#discussion_r1269677374
##########
airflow/providers/amazon/aws/hooks/base_aws.py:
##########
@@ -796,7 +796,11 @@ def test_connection(self):
"""
try:
session = self.get_session()
- conn_info = session.client("sts").get_caller_identity()
+ test_endpoint_url = self.conn_config.extra_config.get("test_endpoint_url")
+ conn_info = session.client(
+ "sts",
+ endpoint_url=test_endpoint_url,
Review Comment:
Both of them returned successful result when I've tested both being None and a parameter not provided to the function.
I've executed code below
```python
conn = Connection(
conn_id="sample_aws_connection",
conn_type="aws",
login="access_key", # Reference to AWS Access Key ID
password="secret_key", # Reference to AWS Secret Access Key
extra={
"test_endpoint_url": "https://sts.us-east-1.amazonaws.com",
"region_name": "us-east-1"
},
)
env_key = f"AIRFLOW_CONN_{conn.conn_id.upper()}"
conn_uri = conn.get_uri()
os.environ[env_key] = conn_uri
conn.test_connection()
```
and I've compared results of two connection. Both of them returned successful result, and there's difference of ```RequestID``` in ```ResponseMetadata``` and ```x-amzn-requestid```, ```date``` in ```HTTPHeaders```
```python
conn_info = session.client(
"sts",
endpoint_url=test_endpoint_url,
).get_caller_identity()
conn_info_without_endpoint_url = session.client(
"sts"
).get_caller_identity()
```
Could you let me know if there's anything I've missed?
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] uranusjr commented on pull request #32664: Add endpoint_url in test_connection
Posted by "uranusjr (via GitHub)" <gi...@apache.org>.
uranusjr commented on PR #32664:
URL: https://github.com/apache/airflow/pull/32664#issuecomment-1639479789
Please set up pre-commit (see link in the above comment) and fix static check failures.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org