unit tests should be enforced by the CI

OneDeadKey / kalamine

Keyboard Layout Maker

MIT License

105 stars 29 forks source link

unit tests should be enforced by the CI #52

Closed fabi1cazenave closed 7 months ago

fabi1cazenave commented 8 months ago

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 #15
[x] 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 commented 8 months ago

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 commented 7 months ago

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

etienne-monier commented 7 months ago

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 commented 7 months ago

Here is a first PR https://github.com/fabi1cazenave/kalamine/pull/73

fabi1cazenave commented 7 months ago

Fixed by #73, thanks !