Skip to content

Commit 36aa9f5

Browse files
committed
Describe unit test automation
1 parent a61e067 commit 36aa9f5

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

CI/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Automated unit test execution and error reporting
2+
3+
This directory contains code used by continuous integration [pipelines] to
4+
non-interactively execute LibPQ unit tests and to report detected test failures.
5+
6+
## Usage
7+
8+
To execute tests manually run `make verify` in this directory.
9+
10+
## Dependencies
11+
12+
The following tools are required to execute LibPQ unit tests
13+
non-interactively:
14+
15+
- [PowerQueryNet]: the most important tool behind LibPQ test automation. It
16+
allows us to execute Power Query outside of Excel/PowerBI and provides
17+
commandline entrypoint for non-interactive use
18+
- [GNU Make]: provides nice interface to orchestrate other CLI tools and to
19+
manage dependencies between automation steps
20+
- [Python 3]: powers a [simple script][verify.py] that verifies test results
21+
and reports errors
22+
- [envsubst] from gettext utils: a simple templating engine for configuration
23+
files used by other tools. This utility is usually automatically installed
24+
along with Unix-like userland (MSYS, Cygwin, WSL)
25+
26+
[GNU Make]: https://www.gnu.org/software/make/
27+
[PowerQueryNet]: https://github.com/gsimardnet/PowerQueryNet
28+
[Python 3]: https://www.python.org/
29+
[envsubst]: https://www.gnu.org/software/gettext/manual/html_node/envsubst-Invocation.html
30+
[pipelines]: https://github.com/sio/LibPQ/actions
31+
[verify.py]: verify.py

0 commit comments

Comments
 (0)