Changeset: 741ecdf8656d for MonetDB
URL: https://dev.monetdb.org/hg/MonetDB?cmd=changeset;node=741ecdf8656d
Added Files:
documentation/source/developers_handbook.rst
Modified Files:
documentation/index.rst
Branch: default
Log Message:
Start a developer's handbook
Add a section about adding a new test.
diffs (55 lines):
diff --git a/documentation/index.rst b/documentation/index.rst
--- a/documentation/index.rst
+++ b/documentation/index.rst
@@ -28,6 +28,7 @@ Welcome to MonetDB's documentation!
source/manual_pages
source/cmake
source/release
+ source/developers_handbook
Indices and tables
==================
diff --git a/documentation/source/developers_handbook.rst
b/documentation/source/developers_handbook.rst
new file mode 100644
--- /dev/null
+++ b/documentation/source/developers_handbook.rst
@@ -0,0 +1,39 @@
+.. This Source Code Form is subject to the terms of the Mozilla Public
+.. License, v. 2.0. If a copy of the MPL was not distributed with this
+.. file, You can obtain one at http://mozilla.org/MPL/2.0/.
+..
+.. Copyright 1997 - July 2008 CWI, August 2008 - 2020 MonetDB B.V.
+
+********************
+Developer's Handbook
+********************
+
+Testing
+=======
+
+MonetDB uses a custom program ``Mtest.py`` to run tests. Each test is an SQL,
+Python or MAL program along with its standard output and standard error
streams.
+``Mtest.py`` runs each of these programs, captures the standard output and the
+standard error, and compares them to the *stable* streams. If any differences
are
+encountered then the test has failed.
+
+Tests in the codebase
+---------------------
+
+Tests are usually ``.sql``, ``.py`` or ``.malC`` files and the stable streams
+are stored in ``.stable.out`` and ``.stable.err`` files with the same name in
+the same directory. For example in the directory ``sql/test/json/Tests`` we
find
+the files:
+
+* ``jsonkeyarray.sql``
+* ``jsonkeyarray.stable.out``
+* ``jsonkeyarray.stable.err``
+
+Running tests
+-------------
+
+Adding a new test
+-----------------
+
+Python tests API
+----------------
_______________________________________________
checkin-list mailing list
[email protected]
https://www.monetdb.org/mailman/listinfo/checkin-list
