Disallow calling #[test] functions from non-#[test] code
#3261
Labels
compiler: frontend
Everything to do with type checking, control flow analysis, and everything between parsing and IRgen
compiler
General compiler. Should eventually become more specific as the issue is triaged
forc-test
Everything related to the `forc-test` lib and `forc test` command.
Comments
mitchmindtree
added
compiler
8 tasks
mitchmindtree
added a commit
that referenced
this issue
Nov 4, 2022
OK, this should be good to go! ## Highlights - Adds support for multiple entry points to IR. Adds a tests for serializing entry functions to/from IR. - Enables ASM generation for libraries (to support test function entry points). - Track entry points through ASM generation so we can return entry point metadata as a part of the compilation result. This doesn't affect ASM generation, but allows tools using `sway-core` as a library to work with different entry points. - Updated E2E test harness with a new test category "UnitTestsPass". - Added E2E tests with multiple unit tests for each type of Sway program (library, script, predicate, contract). - Gets `forc test` working with pretty output! Here's the output from the new `lib_multi_test`:  ## Test running implementation Currently, it seems like there's no publicly accessible approach to execute a script directly from a custom entry point. As a result, for each test, we patch the bytecode with a `JI` instruction that jumps from after the data section setup to the test's entry point. This is a bit hairy, but works for now! As a follow-up, we may want to consider adding support upstream in `fuel-vm` for executing scripts directly from a given entry point. Even if this was only exposed from the interpreter API, this would make the `forc-test` implementation quite a bit cleaner and avoid the need to patch the bytecode. Alternatively, when building projects we could return more metadata along with the compiled output (whether in memory or bytecode header) to indicate how to work with different entry points in a more reliable manner (rather than the magic const offset currently used in `forc-test`). # TODO - [x] Add `include_tests` flag to `BuildConfig`, allowing `forc` to trigger compilation of test functions. - [x] Include `#[test]` fns as entry points within dead code analysis. - [x] IR and ASM generation for test entry points. - [x] Add `forc build --tests`. - [x] Add `forc test`. - [x] Always include test fns in `TyProgram` (for DCA), but omit from IR if not building tests. - [x] Work out how to iterate over different entry points during `forc test`. - [x] Only generate tests for top-level "members" (not all dependencies). ### Follow-up: - #3260 - #3261 - #3262 - #3263 - #3264 - #3265 - #3266 - #3267 - #3268 Closes #1832.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Calling
#[test]functions from non-test code shouldn't be particularly harmful, but is just a bit confusing and would make supportingdev-dependenciesmore complicated (or at least produce confusing results).We should check function calls to ensure
#[test]functions are never called from non-test code.The text was updated successfully, but these errors were encountered: