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

fix compile_pip_requirements on windows #595

Merged

Conversation

jheaff1
Copy link
Contributor

@jheaff1 jheaff1 commented Jan 5, 2022

PR Checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature (please, look at the "Scope of the project" section in the README.md file)
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

PR #529 updated click to a version which depends on colorama on Windows. This broke the generation of a requirements.txt lock file using the compile_pip_requirements rule on windows.
Issue Number: #529

What is the new behavior?

The generation of a requirements.txt lock file using the compile_pip_requirements rule on windows now works

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

PR bazelbuild#529 updated `click` to a version which depends on `colorama` on
Windows. This broke `compile_pip_requirements` on windows. This commit
resolves the issue by adding colorama as a dependency.
@jheaff1 jheaff1 marked this pull request as ready for review January 5, 2022 12:53
@UebelAndre
Copy link
Contributor

UebelAndre commented Jan 5, 2022

Now that rules_python runs tests on Windows runners in CI (#585), I'm surprised this wasn't caught then. I thought compile_pip_requirements was run as part of the @rules_python//examples:pip_install_example integration test:
https://github.com/bazelbuild/rules_python/blob/0.6.0/examples/pip_install/BUILD#L69-L73

Do you know why this might not be caught by that test and if something can be done to improve the test coverage for the rule?

@jheaff1
Copy link
Contributor Author

jheaff1 commented Jan 6, 2022

Now that rules_python runs tests on Windows runners in CI (#585), I'm surprised this wasn't caught then. I thought compile_pip_requirements was run as part of the @rules_python//examples:pip_install_example integration test: https://github.com/bazelbuild/rules_python/blob/0.6.0/examples/pip_install/BUILD#L69-L73

Do you know why this might not be caught by that test and if something can be done to improve the test coverage for the rule?

It seems that test_runner.py did not detect failing tests. Please see #597

Copy link
Contributor

@UebelAndre UebelAndre left a comment

Choose a reason for hiding this comment

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

It seems that test_runner.py did not detect failing tests. Please see #597

Most unfortunate. Though, having tested these changes on both macos and windows, I think they're good. Both platforms work and I think it'd be good to have this change while the test runner issues are fixed separately.

Though, I'm not a maintainer so my opinion has little value here 😅

Copy link
Collaborator

@alexeagle alexeagle left a comment

Choose a reason for hiding this comment

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

thanks!

@alexeagle alexeagle merged commit f99ea2a into bazelbuild:main Jan 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants