Files
Nim/tests
quantimnot d30c6419a0 Refactor and doc package handling, module name mangling (#19821)
* Refactor and doc package handling, module name mangling

* Consolidate, de-duplicate and extend package handling
* Alter how duplicate module names of a package are handled
* Alter how module names are mangled
* Fix crash when another package is named 'stdlib' (test case added)
* Doc what defines a package in the manual

Modules with duplicate names within a package used to be given 'fake'
packages to resolve conflicts. That prevented the ability to discern if
a module belonged to the current project package or a foreign package.
They now have the proper package owner and the names are mangled in a
consistent manner to prevent codegen clashes.

All module names are now mangled the same. Stdlib was treated special
before, but now it is same as any other package. This fixes a crash
when a foreign package is named 'stdlib'.

Module mangling is altered for both file paths and symbols used by the
backends.

Removed an unused module name to package mapping that may have been
intended for IC. The mapping was removed because it wasn't being used
and was complicating the issue of package modules with duplicate names
not having the proper package owner assigned.

* Fix some tests

* Refactor `packagehandling`

* Remove `packagehandling.withPackageName` and its uses
* Move module path mangling from `packagehandling` to `modulepaths`
* Move `options.toRodFile` to `ic` to break import cycle

* Changed import style to match preferred style

Co-authored-by: quantimnot <quantimnot@users.noreply.github.com>
2022-05-30 18:52:19 +02:00
..
2017-07-25 09:28:23 +02:00
2021-02-08 09:46:07 +01:00
2021-08-21 08:22:00 +02:00
2019-05-25 07:33:33 +02:00
2021-01-21 17:31:47 +01:00
2022-02-02 17:10:11 +01:00
2022-04-07 20:57:50 +02:00
2020-12-28 14:13:21 +01:00
2018-12-11 21:23:22 +01:00
2021-04-06 16:20:01 +02:00
2021-09-04 17:49:27 +02:00
2019-09-16 12:12:44 +02:00
2021-03-28 00:57:22 -07:00
2021-06-03 17:12:45 +02:00
2020-11-07 08:00:41 +00:00
2021-04-24 18:33:29 +01:00
2021-11-03 06:46:34 +01:00
2022-05-30 12:09:18 +02:00
2020-11-18 00:14:14 +00:00
2022-03-10 17:01:27 +01:00
2020-07-14 19:50:42 +02:00
2020-07-14 16:44:56 +02:00
2021-04-06 16:20:01 +02:00
2020-12-28 14:13:21 +01:00
2022-02-03 11:15:46 +08:00

This directory contains the test cases.

Each test must have a filename of the form: t*.nim

Note: Testament is only aware of tests under a directory (eg tests/foo/) and will ignore top-level tests like tests/tbar.nim.

Specs

Each test can contain a spec in a discard """ ... """ block.

Check out the parseSpec procedure in the specs module for a full and reliable reference

action

Specifies what action this test should take.

Default: run

Options:

  • compile - compiles the module and fails the test if compilations fails.
  • run - compiles and runs the module, fails the test if compilation or execution of test code fails.
  • reject - compiles the module and fails the test if compilation succeeds.

There are certain spec keys that imply run, including output and outputsub.

cmd

Specifies the Nim command to use for compiling the test.

There are a number of variables that are replaced in this spec option:

  • $target - the compilation target, e.g. c.
  • $options - the options for the compiler.
  • $file - the filename of the test.
  • $filedir - the directory of the test file.

Example:

discard """
  cmd: "nim $target --nimblePath:./nimbleDir/simplePkgs $options $file"
"""

Categories

Each folder under this directory represents a test category, which can be tested by running koch tests pcat <category> (or cat to avoid parallel testing, which is slower).

The folder dll contains simple DLL tests.

The folder realtimeGC contains a test for validating that the realtime GC can run properly without linking against the nimrtl.dll/so.