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

Making TestImplementation available for the whole framework #151

Open
3 tasks
szabo137 opened this issue Jan 21, 2025 · 1 comment · May be fixed by #154
Open
3 tasks

Making TestImplementation available for the whole framework #151

szabo137 opened this issue Jan 21, 2025 · 1 comment · May be fixed by #154

Comments

@szabo137
Copy link
Member

Since the TestImplementations module from #98 could be of use for other packages in the framework, we should make it available.

Requirements

The TestImplementations module should

  • not be a standalone package (too much maintenance overhead for just a test implementation;)
  • should be accessible for all other packages in the framework
  • be placed somewhat near to QEDbase.jl (it is tightly bounded and will probably updated only with QEDbase.jl)

Suggested solution

Maybe we should try to register the TestImplementation as a subdir-package, as discussed here and here.

Other examples, where this is established:

  • BenchmarkPlots in BenchmarkTools.jl
  • InlineTest in ReTest.jl

Final thoughts and open questions

When establishing this, one could also try to include some documentation for TestImplementation into the QEDbase docs.
However, there are still some open questions:

  • Can we use the TagBot?
  • Do we need to think about integration tests?
  • are there any points we need to discuss regarding our current development/test/release workflow?
@szabo137
Copy link
Member Author

As we discussed offline: the proposed way would introduce circular test-dependencies again. Therefore, we should rather add the TestImplementation module directly to QEDbase.jl as a submodule. Then we could just write

using QEDbase.tests

proc = TestProcess(2,3)

After the next release of QEDbase.jl, this would also be available for the other packages in the framework.
Another benefit would be, that the test implementations could also go to the same test pipelines as QEDbase, which is especially nice for integration tests.

@szabo137 szabo137 linked a pull request Jan 29, 2025 that will close this issue
@AntonReinhard AntonReinhard linked a pull request Jan 29, 2025 that will close this issue
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 a pull request may close this issue.

1 participant