1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
DTail Testing Guide
===================
Currently, there are 3 different ways of how DTail can be tested.
1. Unit tests (automatic)
2. Integration tests (automatic)
3. Semi-manual tests with DTail server instances running in Docker.
## Quality control
Also, not actually testing, DTail is being linted and vetted before each release. For this run `make lint` and `make vet` at the top level source directory. Furthermore, to improve the quality of the software even more, the code is being scanned by SonarQube and Black Duck periodically. DTail is also audited and pen-tested by Mimecast staff. And, of course, new features are peer reviewed as well...
## Unit tests
To run all the unit tests simply run the following make command at the top level source directory:
```shell
% make test
```
It will run unit tests for each source directory one after another and abort immediately when an error occurs.
## Integration tests
Other than the unit tests, which only test the internal code, the integration tests will run a set of DTail commands externally and thus simulating common end user scenarios.
This means, that you will need to compile all DTail binaries prior to running these tests:
```shell
# Not mandatory, but pest practise to delete all previously compiled binaries
% make clean
# Now compile all the binaries (dtail, dcat, dmap, dserver...)
% make build
```
The integration tests can be enabled setting the following environment variable:
```
% export DTAIL_INTEGRATION_TEST_RUN_MODE=yes
```
To run the integration test together with all the unit tests, simply run `make test` in the top level source tree. In case you only want to run the integration tests without the normal unit tests, then just do:
```shell
% go clean -testcache
% go test -race -v ./integrationtests
```
## Semi-manual tests with DTail server instances running in Docker
### Requirements
This assumes, that you have Docker up and running on your system. The following has been tested only on Fedora Linux 35. For other versions of Fedora (or Linux) you might need to change the Docker base image used (see Dockerfile) as otherwise you might run into issues with a different `GLIBC` major version used.
This also assumes, that you have compiled all the DTail binaries already (with `make` in the top level source directory).
### Building DTail server Docker image
To build the `dserver` Docker image run:
```
% make -C docker
make: Entering directory '/home/paul/git/dtail/docker'
cp ../integrationtests/mapr_testdata.log .
cp ../dserver .
docker build . -t dserver:develop
Sending build context to Docker daemon 13.84MB
Step 1/11 : FROM fedora:34
---> dce66322d647
Step 2/11 : RUN mkdir -p /etc/dserver /var/run/dserver/ /var/log/dserver
.
.
.
Successfully built b44e92f7c066
Successfully tagged dserver:develop
rm ./dserver
rm ./mapr_testdata.log
make: Leaving directory '/home/paul/git/dtail/docker'
```
### Starting a DTail server farm
To spin up 10 instances of the `dserver` Docker image, run:
```shell
% make -C docker spinup
make: Entering directory '/home/paul/git/dtail/docker'
./spinup.sh 10
Creating dserver-serv0
b34e05f33deb62df628dc00b4ea4e7f1da0be73fdba7895d182fff6dd5b48b2f
Creating dserver-serv1
bb303acfb47a620e3f58f7c0539102db1d286ed2104d091eefe52710c2bba86e
Creating dserver-serv2
.
.
.
```
Now, have a look at the containers:
```shell
% docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
3873f7e69620 dserver:develop "/usr/local/bin/dser…" 3 minutes ago Up 3 minutes 0.0.0.0:2232->2222/tcp, :::2232->2222/tcp dserver-serv9
412f79d0f716 dserver:develop "/usr/local/bin/dser…" 3 minutes ago Up 3 minutes 0.0.0.0:2231->2222/tcp, :::2231->2222/tcp dserver-serv8
1ff2a52ae614 dserver:develop "/usr/local/bin/dser…" 3 minutes ago Up 3 minutes 0.0.0.0:2230->2222/tcp, :::2230->2222/tcp dserver-serv7
6d1c78eceedd dserver:develop "/usr/local/bin/dser…" 3 minutes ago Up 3 minutes 0.0.0.0:2229->2222/tcp, :::2229->2222/tcp dserver-serv6
073fe345235f dserver:develop "/usr/local/bin/dser…" 3 minutes ago Up 3 minutes 0.0.0.0:2228->2222/tcp, :::2228->2222/tcp dserver-serv5
63fd7f2393f1 dserver:develop "/usr/local/bin/dser…" 3 minutes ago Up 3 minutes 0.0.0.0:2227->2222/tcp, :::2227->2222/tcp dserver-serv4
32c9f940312c dserver:develop "/usr/local/bin/dser…" 3 minutes ago Up 3 minutes 0.0.0.0:2226->2222/tcp, :::2226->2222/tcp dserver-serv3
91b137c2dd19 dserver:develop "/usr/local/bin/dser…" 3 minutes ago Up 3 minutes 0.0.0.0:2225->2222/tcp, :::2225->2222/tcp dserver-serv2
bb303acfb47a dserver:develop "/usr/local/bin/dser…" 3 minutes ago Up 3 minutes 0.0.0.0:2224->2222/tcp, :::2224->2222/tcp dserver-serv1
b34e05f33deb dserver:develop "/usr/local/bin/dser…" 3 minutes ago Up 3 minutes 0.0.0.0:2223->2222/tcp, :::2223->2222/tcp dserver-serv0
```
### Connecting to all 10 DTail servers
Have a look at `docker/Makefile` for some pre-defined commands. But one example would be:
```shell
make -C docker dtail
```
This will launch `dtail` and follow the `dserver` log files of all 10 containers.
### Stopping all Docker containers again
Just run this:
```shell
make -C docker spindown
```
|
