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

unit tests should be enforced by the CI #52

Closed
1 of 3 tasks
fabi1cazenave opened this issue Dec 29, 2023 · 5 comments
Closed
1 of 3 tasks

unit tests should be enforced by the CI #52

fabi1cazenave opened this issue Dec 29, 2023 · 5 comments
Labels
bug Something isn't working good first issue Good for newcomers help wanted Extra attention is needed

Comments

@fabi1cazenave
Copy link
Collaborator

fabi1cazenave commented Dec 29, 2023

pytest stopped working, and I realize our unit tests are broken in many ways:

  • they assume all sample layouts have already been built, which is wrong — see Serve latest compiled layouts after each commit #15
  • they don’t event test each conversion output, only the macOS one at the moment
  • there should be an automated way to ensure tests are run, at least before publishing !!

Some of these tasks are “good first issues” for developers with basic Python / github CI culture — and I’m afraid I’m not reaching the “basic” level right now for these.

@fabi1cazenave fabi1cazenave added bug Something isn't working help wanted Extra attention is needed good first issue Good for newcomers labels Dec 29, 2023
@fabi1cazenave
Copy link
Collaborator Author

After a quick regression fix, pytest now works again. The Makefile ensures I won’t publish to PyPi without passing unit tests any more, but we have to do better than that.

@fabi1cazenave fabi1cazenave changed the title broken unit tests unit tests should be enforced by the CI Jan 1, 2024
@fabi1cazenave
Copy link
Collaborator Author

@etienne-monier you might want to use your magic on this one ;-)

@etienne-monier
Copy link
Contributor

I'll have a look at this.

But I think that a CI workflow should be considered, such as:

  • any commit: run tests
  • any release: tests + deploy to pypi

The latter leads to release creations. I saw the package had two tags. Making releases should be preferred. Via CI, it requires an API token. Trying on test pypi could be nice.

I hesitate concerning the "any commit" rule. Maybe pull request is enough, but I'll consider this.

I'm more familiar with gitlab CI but as I've a website to update, I'll make come CI to deploy to github pages :)

@etienne-monier
Copy link
Contributor

Here is a first PR
#73

@fabi1cazenave
Copy link
Collaborator Author

Fixed by #73, thanks !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants