From 2bd5bccee43a98ccbc7eb1a66f267be638669fd8 Mon Sep 17 00:00:00 2001 From: Igor Hatarist Date: Tue, 13 Dec 2016 21:07:56 +0300 Subject: [PATCH 1/2] Updated build_osx.md, improved formatting --- doc/build.md | 6 +++--- doc/build_osx.md | 11 +++++++---- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/doc/build.md b/doc/build.md index bc0c371b887..0e841e90aa0 100644 --- a/doc/build.md +++ b/doc/build.md @@ -81,8 +81,8 @@ git clone -b stable git@github.com:yandex/ClickHouse.git cd ClickHouse ``` -For development, switch to `master` branch. -For latest release candidate, switch to `testing` branch. +For development, switch to the `master` branch. +For latest release candidate, switch to the `testing` branch. # Build ClickHouse @@ -96,7 +96,7 @@ sudo apt-get install devscripts dupload fakeroot debhelper ### Install recent version of clang. -Clang is embedded into ClickHouse package and used at runtime. Minimal version is 3.8.0. It is optional. +Clang is embedded into ClickHouse package and used at runtime. Minimum version is 3.8.0. It is optional. There are two variants: #### 1. Build clang from sources. diff --git a/doc/build_osx.md b/doc/build_osx.md index efe423a6934..7aae6f4153c 100644 --- a/doc/build_osx.md +++ b/doc/build_osx.md @@ -35,15 +35,18 @@ brew install readline # Checkout ClickHouse sources +To get the latest stable version: + ``` -git clone git@github.com:yandex/ClickHouse.git -# or: git clone https://github.com/yandex/ClickHouse.git +git clone -b stable git@github.com:yandex/ClickHouse.git +# or: git clone -b stable https://github.com/yandex/ClickHouse.git cd ClickHouse ``` -Note that master branch is not stable. -For stable version, switch to some release branch. +For development, switch to the `master` branch. +For the latest release candidate, switch to the `testing` branch. + ## Use GCC 6 for builds From fa851966cb22c8b2de91862f213dd1415b0c6a7f Mon Sep 17 00:00:00 2001 From: Igor Hatarist Date: Tue, 13 Dec 2016 21:17:56 +0300 Subject: [PATCH 2/2] Added developer/tests.md ("How to run tests") (reference: https://github.com/yandex/ClickHouse/pull/225#discussion_r90736460) --- doc/developers/tests.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 doc/developers/tests.md diff --git a/doc/developers/tests.md b/doc/developers/tests.md new file mode 100644 index 00000000000..68dbd5bce18 --- /dev/null +++ b/doc/developers/tests.md @@ -0,0 +1,32 @@ +# How to run tests + +The **clickhouse-test** utility that is used for functional testing is written using Python 2.x. +It also requires you to have some third-party packages: + +``` +$ pip install lxml termcolor +``` + + +## In a nutshell: + +- Put the `clickhouse` program to `/usr/bin` (or `PATH`) +- Create a `clickhouse-client` symlink in `/usr/bin` pointing to `clickhouse` +- Start the `clickhouse` server +- `cd dbms/tests/` +- Run `./clickhouse-test` + + +## Example usage + +Run `./clickhouse-test --help` to see available options. + +To run tests without having to create a symlink or mess with `PATH`: +``` +./clickhouse-test -c "../../build/dbms/src/Server/clickhouse --client" +``` + +To run a single test, i.e. `00395_nullable`: +``` +./clickhouse-test 00395 +```