Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing docker test_exceptions.py #35674

Merged
merged 3 commits into from
Nov 22, 2023
Merged

Conversation

rpkay
Copy link
Contributor

@rpkay rpkay commented Nov 16, 2023

This PR adds a simple test for docker exceptions (DockerContainerFailedException, DockerContainerFailedSkipException)

Part of #35442


^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
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.

Copy link

boring-cyborg bot commented Nov 16, 2023

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 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 Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment 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 for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: [email protected]
    Slack: https://s.apache.org/airflow-slack

@rpkay rpkay marked this pull request as draft November 16, 2023 08:47
@rpkay rpkay marked this pull request as ready for review November 16, 2023 08:48
Copy link
Member

@Lee-W Lee-W left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure these tests really check much. I might suggest adding tests to this block

if result["StatusCode"] in self.skip_on_exit_code:
raise DockerContainerFailedSkipException(
f"Docker container returned exit code {self.skip_on_exit_code}. Skipping.", logs=log_lines
)
elif result["StatusCode"] != 0:
raise DockerContainerFailedException(f"Docker container failed: {result!r}", logs=log_lines)

@rpkay
Copy link
Contributor Author

rpkay commented Nov 16, 2023

I'm not sure these tests really check much. I might suggest adding tests to this block

if result["StatusCode"] in self.skip_on_exit_code:
raise DockerContainerFailedSkipException(
f"Docker container returned exit code {self.skip_on_exit_code}. Skipping.", logs=log_lines
)
elif result["StatusCode"] != 0:
raise DockerContainerFailedException(f"Docker container failed: {result!r}", logs=log_lines)

I am not sure if I understood your comment, can you please give some detail if possible ?

@Lee-W
Copy link
Member

Lee-W commented Nov 17, 2023

I'm not sure these tests really check much. I might suggest adding tests to this block

if result["StatusCode"] in self.skip_on_exit_code:
raise DockerContainerFailedSkipException(
f"Docker container returned exit code {self.skip_on_exit_code}. Skipping.", logs=log_lines
)
elif result["StatusCode"] != 0:
raise DockerContainerFailedException(f"Docker container failed: {result!r}", logs=log_lines)

I am not sure if I understood your comment, can you please give some detail if possible ?

It seems to me that the test we're having in this PR might not actually test meaningful things. So, if we're to add tests to cover the exception, maybe the code block I pasted could be a choice

@rpkay
Copy link
Contributor Author

rpkay commented Nov 17, 2023

I'm not sure these tests really check much. I might suggest adding tests to this block

if result["StatusCode"] in self.skip_on_exit_code:
raise DockerContainerFailedSkipException(
f"Docker container returned exit code {self.skip_on_exit_code}. Skipping.", logs=log_lines
)
elif result["StatusCode"] != 0:
raise DockerContainerFailedException(f"Docker container failed: {result!r}", logs=log_lines)

I am not sure if I understood your comment, can you please give some detail if possible ?

It seems to me that the test we're having in this PR might not actually test meaningful things. So, if we're to add tests to cover the exception, maybe the code block I pasted could be a choice

Thank you for the clarification, I will work on the change.

@rpkay rpkay force-pushed the docker-test-exception branch from 373d283 to 65bbc16 Compare November 17, 2023 15:41
@rpkay rpkay force-pushed the docker-test-exception branch from 353cfda to 95a5cb2 Compare November 21, 2023 13:00
@rpkay rpkay requested a review from Lee-W November 21, 2023 13:01
@potiuk
Copy link
Member

potiuk commented Nov 21, 2023

@Lee-W ? Are you happy ?

@Lee-W
Copy link
Member

Lee-W commented Nov 21, 2023

Hi all, sorry for the late review. Wasn't feeling well lately. let me review it now

Copy link
Member

@Lee-W Lee-W left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks awesome! @rpkay Thanks for your great work!

@potiuk potiuk merged commit f4e5571 into apache:main Nov 22, 2023
47 checks passed
Copy link

boring-cyborg bot commented Nov 22, 2023

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

@rpkay
Copy link
Contributor Author

rpkay commented Nov 22, 2023

Thank you @Lee-W for your guidance.

Special thanks to @Taragolis for code reference.

@rpkay rpkay deleted the docker-test-exception branch November 22, 2023 04:59
ephraimbuddy pushed a commit that referenced this pull request Nov 23, 2023
* test case for docker exceptions

* removed docker test exception

* re-wrote test case based on feedback
ephraimbuddy pushed a commit that referenced this pull request Nov 26, 2023
* test case for docker exceptions

* removed docker test exception

* re-wrote test case based on feedback
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants