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

Documentation testing broken since flake8 upgrade #1140

Closed
bonjourmauko opened this issue Jul 31, 2022 · 1 comment · Fixed by #1145
Closed

Documentation testing broken since flake8 upgrade #1140

bonjourmauko opened this issue Jul 31, 2022 · 1 comment · Fixed by #1145
Labels
kind:fix Bugs are defects and failure demand.

Comments

@bonjourmauko
Copy link
Member

Hi there!

I really enjoy OpenFisca, but I recently encountered an issue.

Here is what I did:

I created a PR #1138

Here is what I expected to happen:

All tests to pass.

Here is what actually happened:

Doc tests are failing since the merging of #1137 .

Here is data (or links to it) that can help you reproduce this issue:

It sems to me that #1137 did not create the problem, but solved it partially.

Context

I identify more as a:

  • Developer (I create tools that use the existing OpenFisca code).
@bonjourmauko bonjourmauko added the kind:fix Bugs are defects and failure demand. label Jul 31, 2022
@MattiSG MattiSG changed the title Doc tests broken since fkale8 upgrade Doc tests broken since flake8 upgrade Aug 1, 2022
@MattiSG
Copy link
Member

MattiSG commented Aug 1, 2022

Thank you for reporting this issue!

To be more precise, it is the install step of the doc tests that fails. This explains why the tests passed in #1137 and failed afterwards.

Indeed, the test-doc-install task executes:

	@pip install --requirement doc/requirements.txt 1> /dev/null
	@pip install --editable .[dev] --upgrade 1> /dev/null

And doc/requirements.txt contains:

--editable git+https://github.com/openfisca/openfisca-core.git@master#egg=OpenFisca-Core[dev]

There is thus an inconsistency where the Core is installed both from the local version and the production version, leading to the clear error:

ERROR: Cannot install -r doc/requirements.txt (line 6), OpenFisca-Core and flake8==4.0.1 because these package versions have conflicting dependencies.

Thus, the fix proposed in #1141 cannot be tested properly as the setup will always be inconsistent between testing on master and testing on a feature branch, as dependencies will be pulled from master.

I cannot reproduce the issue in #1136 anymore, nor can reproduce failing tests locally with make test-doc.

Could you please attach to this issue a description of how to reproduce the failure?

@bonjourmauko bonjourmauko changed the title Doc tests broken since flake8 upgrade Documentation testing broken since flake8 upgrade Aug 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:fix Bugs are defects and failure demand.
Projects
None yet
2 participants