libzmq/tests/README.md

#   Guidelines for tests

Write your test case as if you were writing clean application code. It should be safe to compile on all platforms.

The only include file you should use is `testutil.hpp`. Do not include files from src. Do not use the internal libzmq API or your test case is fair game to be deleted.

If you must write non-portable code, wrap it in #ifdefs to ensure it will compile and run on all systems.

Note that testutil.hpp includes platform.h. Do not include it yourself as it changes location depending on the build system and OS.

All sources must contain the correct header. Please copy from test_system.cpp if you're not certain.

Please use only ANSI C99 in test cases, no C++. This is to make the code more reusable.

On many slower environments, like embedded systems, VMs or CI systems, test might
fail because it takes time for sockets to settle after a connect. If you need
to add a sleep, please be consistent with all the other tests and use:
  msleep (SETTLE_TIME);

# Building tests in Windows

According to the version of your compiler, you should adapt the path `libzmq.lib` in the file `tests/CMakeLists.txt`.

Install CMAKE
CMD> CMAKE libzmq/tests
CMD> tests.sln
CMD> # build all projects in the solution
Problem: people don't know how to write test cases Solution: document the minimum rules in README.md 2016-02-12 14:49:36 +01:00			`# Guidelines for tests`

			`Write your test case as if you were writing clean application code. It should be safe to compile on all platforms.`

			The only include file you should use is `testutil.hpp`. Do not include files from src. Do not use the internal libzmq API or your test case is fair game to be deleted.

			`If you must write non-portable code, wrap it in #ifdefs to ensure it will compile and run on all systems.`

			`Note that testutil.hpp includes platform.h. Do not include it yourself as it changes location depending on the build system and OS.`

Problem: tests don't build on Windows There were numerous small issues with test cases: - some lacked the right source file header - some were not portable at all - some were using internal libzmq APIs (headers) Solution: fixed and cleaned up. 2016-02-12 15:46:55 +01:00			`All sources must contain the correct header. Please copy from test_system.cpp if you're not certain.`

Problem: tests don't build on Windows There were numerous small issues with test cases: - some lacked the right source file header - some were not portable at all - some were using internal libzmq APIs (headers) Solution: fixed and cleaned up. 2016-02-12 15:46:55 +01:00			`Please use only ANSI C99 in test cases, no C++. This is to make the code more reusable.`
Problem: tests README does not document msleep Solution: suggest to use the common approach of msleep (SETTLE_TIME) after a connect if necessary, rather than reimplementing a different way. 2016-02-13 19:04:25 +01:00
			`On many slower environments, like embedded systems, VMs or CI systems, test might`
			`fail because it takes time for sockets to settle after a connect. If you need`
			`to add a sleep, please be consistent with all the other tests and use:`
Problem: Tests do no build in Windows environment Solution: Modified CMakelist.txt to build correctly for Windows 2016-03-05 18:23:23 +01:00			`msleep (SETTLE_TIME);`

			`# Building tests in Windows`

Fixed issue #2286 by documentation tests/README.md explicitly indicates to check the libzmq.lib path in CMakeLists.txt. 2017-01-01 18:20:03 +01:00			According to the version of your compiler, you should adapt the path `libzmq.lib` in the file `tests/CMakeLists.txt`.

Problem: Tests do no build in Windows environment Solution: Modified CMakelist.txt to build correctly for Windows 2016-03-05 18:23:23 +01:00			`Install CMAKE`
			`CMD> CMAKE libzmq/tests`
			`CMD> tests.sln`
			`CMD> # build all projects in the solution`