Fix a slew of new CI pipeline / test suite problems that appear after new years #2537
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We haven't supported Python 2 for quite a while now.
ciscoconfparse is a dependency of NAV's direct dependency napalm. However, the latest few versions of ciscoconfparse have been packaged with dependencies that are only relevant for developers, not for production use. These dependencies conflict with our test environment dependencies. Until we upgrade to Napalm 4 (which ditches ciscoconfparse), we lock it to an older, stable version during test runs.
This should get rid of all the intermittent access errors from coverage. These are mainly due to the fact that certain subprocesses during test setup (such as database initialization inside test container) will run as root or other users that do not have write access to the source root directory. This points coverage to use a coverage database file in the reports directory, and ensures this is world-writeable (!) so all subprocesses can access it.
Apparently, pip<21.3 behaves differently on Python 3.7 and 3.9. The package `crispy-forms-foundation` does not get its package data installed (i.e. its Django templates directory) under Python 3.7, but it does under Python 3.9. Since the latest pip appears to work fine for NAV now, we can safely update.
Tox 4 was released last month, and has since released 23 patch releases. All of them break compatibility with our tox.ini in two important regards: `passenv` is no longer a space separated glob list, it seem it needs to be a comma-separated one. More importantly, tox no longer interprets quotes in commands - it interprets them literally and feeds them as verbatim arguments to the called commands, causing every command in our tox.ini file that uses quotes to fail.
It seems the upstream `ubuntu-latest` action runner was updated by GitHub 4 days ago. The latest ubuntu is now 22.04, which features libsnmp40 rather than libsnmp35.
|
Kudos, SonarCloud Quality Gate passed!
|
hmpf
reviewed
Jan 3, 2023
Comment on lines
+51
to
+52
| mkdir -p {toxinidir}/reports/coverage | ||
| chmod 777 {toxinidir}/reports/coverage |
There was a problem hiding this comment.
Were these automatically created before or have they been manually moved?
There was a problem hiding this comment.
No, only the {toxinidir}/reports part is typically created as part of a test run from before. This adds the extra subdirectory coverage, and tells coverage to put its coverage database files (primarily an SQLite3 file called .coverage) there, while making sure all subprocesses can write to it.
hmpf
reviewed
Jan 3, 2023
Codecov Report
@@ Coverage Diff @@
## 5.5.x #2537 +/- ##
=======================================
Coverage 53.15% 53.15%
=======================================
Files 554 554
Lines 40309 40309
=======================================
Hits 21426 21426
Misses 18883 18883 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
johannaengland
approved these changes
Jan 4, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Several changes in upstream dependencies caused our test suite to break down over X-mas vacation, making the first workday of 2023 a pain.
This resolves multiple of these issues and cleans up a few things along the way.
Since these problems will also affect the current stable branch, this PR is against the stable branch, which should be merged to master as soon as the PR is approved.
Tox
Tox 4 breaks compatibility with several bits of our tox.ini (and they must have had a lot of problems with this release, they've had 23 new releases in the month that has passed since the release of 4.0.0): https://pypi.org/project/tox/#history
Primarily, this bites us hard, in a non-compatible way: tox-dev/tox#2635
Also, the
passenvoption seems to require comma-separated arguments now, rather than the space-separated ones required in version 3.