pypulseq icon indicating copy to clipboard operation
pypulseq copied to clipboard

adding a test suite and continuous integration

Open grlee77 opened this issue 6 years ago • 4 comments

Is your feature request related to a problem? Please describe. In considering the JOSS review criteria, I think the lack of a test suite or any type of continuous integration to verify correct operation across platforms / software versions is the biggest weakness.

There are fortunately a number of demos that the user can run to verify the basic operation of the package, but I did see any automated way to run tests.

Describe the solution you'd like

Ideally some automated unit tests would be created. The pytest package is a popular choice for this.

Once unit tests have been defined, services like Travis-CI, Circle-CI, Appveyor and/or Azure can be used to set up automated cross-platform testing on each pull request, etc. This may be overkill at the moment for a project of this size, but something to keep in mind.

Describe alternatives you've considered

Additional context

grlee77 avatar Sep 05 '19 23:09 grlee77

@grlee77 Thank you for your comments regarding automated testing/CI. We have been discussing this internally and plan to incorporate the same in our next major release (2.0.0) as a part of ISMRM 2021 efforts.

sravan953 avatar Sep 16 '19 15:09 sravan953

@grlee77 Can this issue be closed?

sravan953 avatar Sep 20 '19 19:09 sravan953

It does not hurt to keep the issue open as a reminder to add this in the future. You could remove the "review comment" label and add a label like "task" to indicate that the issue is task-related and not a bug. Ultimately, it is up to you whether you find it useful to keep this open or not, though.

grlee77 avatar Sep 23 '19 16:09 grlee77

Completely on board about the benefits of CI - will incorporate it in the future, thank you for your inputs.

sravan953 avatar Sep 23 '19 16:09 sravan953

Was added in #144 , #173 , #207 , ... so I close this. Feel free to re-open it if needed.

schuenke avatar Nov 29 '24 16:11 schuenke