Remove Uses of tox-battery #191

feanil · 2023-04-14T12:46:40Z

Context

The tox-battery python package provides only one feature to the tox tool. It detects changes to the requirements files that are the deps of a tox environment and optionally re-builds the environments if there are changes to the requirements. The tox-battery package can't run with tox 4.0.0 because of incompatibilites. So make upgrade won't upgrade us to the latest version of tox in a bunch of repos. However tox>=4.0.0 has the requirements monitoring feature built-in and if we drop the tox-battery dependency, we'll get the latest tox with the right featureset.

References

support tracking changes in requirements.txt without full rebuild tox-dev/tox#296
Rebuild tox environment after change requirements openshift-eng/elliott#149
https://github.com/signalpillar/tox-battery/blob/master/setup.py#L20 - tox-battery constrains itself correctly now.

Task

Update common constraints to not require tox<4.0.0
In any repo that depends on tox-battery, drop the tox-battery dependency and upgrade to tox>=4.0.0.

Task List

The text was updated successfully, but these errors were encountered:

Agrendalath · 2023-06-22T08:44:25Z

@feanil, before removing tox-battery from any of these repositories, we should remove tox<4.0.0 from the common constraints. Otherwise, we won't be able to upgrade it to tox>=4.0.0.

feanil · 2023-06-22T14:36:24Z

Good point, and that should be safe to do since tox-battery now explicitly declares it's requirment on tox<4.0.0

I'll update the ticket description.

bpostow · 2023-10-12T18:26:32Z

I'm new here so I want to make sure I understand what I'm doing. tox-battery only appears in requirements files, right? so we just need to remove that line? or is there something more complicated that I'm missing?

feanil · 2023-10-12T19:53:02Z

@bpostow This upgrade is a little tricky because of how we're using common constraints. The best way to do this upgrade incrementally right now is to:

Update any repo that uses tox to locally constrain tox<4.0.0
Remove the global common constraint.
Incrementally remove the local constraint, as well as the depedency on tox-battery if it exists in that repo, and then run make upgrade and fix any tox issues that arise from the upgrade. Some notes related to that here: https://tox.wiki/en/latest/upgrading.html

Agrendalath · 2023-10-13T14:09:52Z

@feanil,

Update any repo that uses tox to locally constrain tox<4.0.0

This step should only be needed for repos that use tox without tox-battery. For them, we risk that running make upgrade will bump tox to 4.x and break some tests.
If a repo uses tox-battery, running make upgrade will not bump the tox version to 4.x because it is incompatible with tox-battery, as you already mentioned above.

cc: @bpostow

bpostow · 2023-10-13T14:45:16Z

My question is mostly, WHERE is tox-battery being used? I only see it in requirements. So, if we just remove the requirement for something that isn't actually being used, shouldn't that be safe?

or are there constraints somewhere else that I'm not looking?

If this is a more subtle thing that a newbie shouldn't be touching, I fully understand that and will look for other better intro tickets.

Agrendalath · 2023-10-13T15:25:01Z

@bpostow, you don't need to explicitly use the tox-battery package - it plugs into the tox with this entrypoint. As mentioned in the description of this issue, this plugin is responsible for tracking the requirement changes.
If you simply remove it (without updating tox to 4.x), it will cause some confusion in the dev environments.
On the other hand, removing tox-battery and automatically upgrading tox in all repositories can break some tests (e.g., because of edx/edx-arch-experiments#130). Therefore, we should do this repo-by-repo.

or are there constraints somewhere else that I'm not looking?

Do you mean this constraint (described in #203)? The process described in this comment (with this clarification) sums up everything we should do to move this forward.
Edit: it looks like there is already a PR (openedx/edx-lint#354) for step 2 ("Remove the global common constraint.").

bpostow · 2023-10-13T17:23:23Z

ah, ok, I was unclear on how tox works, I thought that this was a code library that would be referenced in the code somewhere.

Younggregs · 2023-12-19T19:40:27Z

Hello @feanil are these issues still open? I'll like to take some

feanil · 2023-12-19T19:44:51Z

@Younggregs this was just completed by someone else. It looks like tox-battery has been removed everywhere.

Younggregs · 2023-12-19T19:47:19Z

Thank you @feanil for the feedback.
I'll really appreciate if you can point me to any available open issue please, I haven't been able to find one.

feanil · 2023-12-19T19:54:02Z

There are a lot in the "Help Wanted" section of public-engineering: https://github.com/openedx/public-engineering/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22

Younggregs · 2023-12-19T19:56:15Z

Thank you @feanil !

feanil added help wanted Ready to be picked up by anyone in the community maintenance Routine upkeep necessary for the health of the platform labels Apr 14, 2023

feanil closed this as completed Dec 19, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove Uses of tox-battery #191

Remove Uses of tox-battery #191

feanil commented Apr 14, 2023 •

edited

Loading

Agrendalath commented Jun 22, 2023

feanil commented Jun 22, 2023

bpostow commented Oct 12, 2023

feanil commented Oct 12, 2023

Agrendalath commented Oct 13, 2023 •

edited

Loading

bpostow commented Oct 13, 2023

Agrendalath commented Oct 13, 2023 •

edited

Loading

bpostow commented Oct 13, 2023

Younggregs commented Dec 19, 2023

feanil commented Dec 19, 2023

Younggregs commented Dec 19, 2023

feanil commented Dec 19, 2023

Younggregs commented Dec 19, 2023

Remove Uses of tox-battery #191

Remove Uses of tox-battery #191

Comments

feanil commented Apr 14, 2023 • edited Loading

Context

References

Task

Task List

Agrendalath commented Jun 22, 2023

feanil commented Jun 22, 2023

bpostow commented Oct 12, 2023

feanil commented Oct 12, 2023

Agrendalath commented Oct 13, 2023 • edited Loading

bpostow commented Oct 13, 2023

Agrendalath commented Oct 13, 2023 • edited Loading

bpostow commented Oct 13, 2023

Younggregs commented Dec 19, 2023

feanil commented Dec 19, 2023

Younggregs commented Dec 19, 2023

feanil commented Dec 19, 2023

Younggregs commented Dec 19, 2023

feanil commented Apr 14, 2023 •

edited

Loading

Agrendalath commented Oct 13, 2023 •

edited

Loading

Agrendalath commented Oct 13, 2023 •

edited

Loading