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

adding a test suite and continuous integration #16

Closed
grlee77 opened this issue Sep 5, 2019 · 5 comments
Closed

adding a test suite and continuous integration #16

grlee77 opened this issue Sep 5, 2019 · 5 comments
Assignees
Labels
enhancement New feature or request

Comments

@grlee77
Copy link

grlee77 commented Sep 5, 2019

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 grlee77 changed the title adding additional tests adding a test suite and continuous integration Sep 5, 2019
@sravan953 sravan953 self-assigned this Sep 6, 2019
@sravan953
Copy link
Collaborator

@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
Copy link
Collaborator

@grlee77 Can this issue be closed?

@grlee77
Copy link
Author

grlee77 commented Sep 23, 2019

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.

@sravan953
Copy link
Collaborator

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

@sravan953 sravan953 added enhancement New feature or request and removed review comment JOSS reviewer's comments labels Sep 23, 2019
@schuenke
Copy link
Collaborator

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants