Commit 2c2fc6d63a9e70ddeb5da0b79600948ae87e0927

Authored by Stéphane Raimbault
1 parent 7612ce20

Rewrite and rename README as README.md in tests/

tests/Makefile.am
1   -EXTRA_DIST = README unit-tests.sh
  1 +EXTRA_DIST = README.md unit-tests.sh
2 2  
3 3 noinst_PROGRAMS = \
4 4 bandwidth-server-one \
... ...
tests/README deleted
1   -License
2   --------
3   -Test programs of this directory are provided under BSD license (see associated
4   -LICENSE file).
5   -
6   -Compilation
7   ------------
8   -After installation, you can use pkg-config to compile these tests.
9   -For example, to compile random-test-server run:
10   -
11   -gcc random-test-server.c -o random-test-server `pkg-config --libs --cflags libmodbus`
12   -
13   -random-test-server
14   ------------------
15   -It's necessary to launch this server before run random-test-client. By
16   -default, it receives and responses to Modbus query on the localhost
17   -and port 1502.
18   -
19   -random-test-client
20   -------------------
21   -This programm sends many different queries to a large range of
22   -addresses and values to test the communication between the client and
23   -the server.
24   -
25   -unit-test-server
26   -unit-test-client
27   -----------------
28   -By default, this program sends some queries with the values defined in
29   -unit-test.h and checks the responses. These programs are useful to
30   -test the protocol implementation.
31   -
32   -bandwidth-server-one
33   -bandwidth-server-many-up
34   -bandwidth-client
35   ------------------------
36   -It returns some very useful informations about the performance of
37   -transfert rate between the server and the client.
38   -
39   -- bandwidth-server-one: it can handles only one connection with a client.
40   -- bandwidth-server-many-up: it opens a connection each time a new client asks
41   - for, but the number of connection is limited. The same server process handles
42   - all the connections.
tests/README.md 0 → 100644
  1 +# License
  2 +Test programs of this directory are provided under BSD license (see associated
  3 +LICENSE file).
  4 +
  5 +# Compilation
  6 +After installation, you can use pkg-config to compile these tests.
  7 +For example, to compile random-test-server run:
  8 +
  9 +gcc random-test-server.c -o random-test-server `pkg-config --libs --cflags libmodbus`
  10 +
  11 +- `random-test-server` is necessary to launch a server before running
  12 +random-test-client. By default, it receives and replies to Modbus query on the
  13 +localhost and port 1502.
  14 +
  15 +- `random-test-client` sends many different queries to a large range of
  16 +addresses and values to test the communication between the client and the
  17 +server.
  18 +
  19 +- `unit-test-server` and `unit-test-client` run a full unit test suite. These
  20 +programs are essential to test the Modbus protocol implementation and libmodbus
  21 +behavior.
  22 +
  23 +- `bandwidth-server-one`, `bandwidth-server-many-up` and `bandwidth-client`
  24 + return very useful information about the performance of transfert rate between
  25 + the server and the client. `bandwidth-server-one` can only handles one
  26 + connection at once with a client whereas `bandwidth-server-many-up` opens a
  27 + connection for each new clients (with a limit).
... ...