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

Make CI testing compatible with large image and girder 5 #1728

Merged
merged 12 commits into from
Dec 12, 2024

Conversation

naglepuff
Copy link
Collaborator

@naglepuff naglepuff commented Nov 22, 2024

Changes

1. Changes to tox config and environments

Since the girder build command is being removed from Girder 5, that command has been removed from the tox.ini configuration. Since client tests are being migrated to playright, the existing python files that invoke client tests have been removed.

Additionally, a new requirements file, requirements-girder5.txt has been created and uses --pre to ensure that all of the Girder-adjacent requirements are installed using the correct (development/prerelease) versions.

2. Changes to Circle CI config

A new step has been added under allservices which will build the client code. This was necessary since the register plugin code relies on certain files (geojs.js) being available in the dist/ folder.

Node v16 is used for all of the tests. Version 16 was chosen because it matches the version used in the testing environment for Girder's v4-integration branch. During discussion about these changes, it was decided to use Node 20.

3. Linting and formatting

For client-side linting, everything in dist/ will be ignored by the linter. Also, the girder global has been added to the eslintconfig. Client side files were also formatted using tox -e formatclient.

The python linting config has been updated to ignore error codes G002 and G004 (using f-strings in log statements and using '%' in log statements). I'm willing to re-enable those error codes and fix the 30ish places in the code where they occur if that is worth the added effort here.

4. Miscellaneous changes

  1. Import statements for the girder worker plugin had to be updated due to the relocation of that code to the main Girder repository.
  2. Some log statements were still using the old method of importing the logger from girder. These have been fixed.
  3. zarr is now pinned to zarr<3 due to some refactoring of stores (see the link in sources/zarr/setup.py).

TODO before review/merge

  • Clean up git commit history
  • Clean up comments in code
  • Add formatting-only commits to .git-blame-ignore-revs

@naglepuff naglepuff changed the title Fix tox config for Girder 5 Make CI testing compatible with large image and girder 5 Dec 11, 2024
Also use node 16, since that is what is used by the current girder_test
image.
Ensure that it works with the `girder` global and ignores the `dist/` directory.
Adding this primarily as a stopgap. It might be worthwhile to go back and clean this issues up before merging the Girder 5 branch.
@naglepuff naglepuff marked this pull request as ready for review December 12, 2024 17:40
@naglepuff naglepuff merged commit 197b853 into girder-5 Dec 12, 2024
18 checks passed
@naglepuff naglepuff deleted the girder-5-tox branch December 12, 2024 17:46
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.

1 participant