Skip to content

Latest commit

 

History

History
108 lines (83 loc) · 3.67 KB

README.md

File metadata and controls

108 lines (83 loc) · 3.67 KB

Pytest flags

Flag Description
-s Stream to stdio -- without this pytest will absorb all stdio output and is diffucult to debug
--skip-provisioning Skips provisioning -- will only empty buckets and restart Sync Gateways
--mode Channel cache mode ('cc') or using sg_accel in distributed index ('di') mode. Determines which CLUSTER_CONFIG values are used during provisioning
-k Run a specific test rather than the entire sweet. Supports substrings / regex?
--sync-gateway-version Sync Gateway version or commit hash
--race If a Sync Gateway commit hash is provided and this flag is set, Sync Gateway will be built with -races
--server-version Couchbase Server version
--collect-logs Collect logs regardless of pass or fail state of test. Default is to collect logs only on failure
--sg-ce Installs community version of Sync Gateway

Executing sync_gateway functional tests

You can run any of the sync_gateway tests in the 'test/' directory in channel cache mode ('cc') or using sg_accel in distributed index ('di') mode.

These commands must be run from the root directory of the repo.

Run all the tests in distributed index mode

pytest  -s \
        --mode=di \
        --server-version=4.5.0 \
        --sync-gateway-version=1.3.1-16 \
        testsuites/syncgateway/functional/tests/

Run all the tests in channel cache mode

pytest  -s \
        --mode=cc \
        --server-version=4.5.0 \
        --sync-gateway-version=1.3.1-16 \
        testsuites/syncgateway/functional/tests/

Run all the tests in channel cache mode with a source build

pytest  -s \
        --mode=cc \
        --server-version=4.5.0 \
        --sync-gateway-version=5bb66efa523a2440642729ba5faebfef96fd2696 \
        testsuites/syncgateway/functional/tests/

Run all the tests in channel cache mode with a source build with -race

pytest  -s \
        --mode=cc \
        --server-version=4.5.0 \
        --sync-gateway-version=5bb66efa523a2440642729ba5faebfef96fd2696 \
        --race \
        testsuites/syncgateway/functional/tests/

Run a the test in channel cache mode matching a -k pattern

pytest  -s \
        --mode=cc \
        --server-version=4.5.0 \
        --sync-gateway-version=1.3.1-16 \
        -k "test_online_to_offline_check_503" \
        testsuites/syncgateway/functional/tests/

Run all the tests in a module (ex. test_db_online_offline.py)

pytest  -s \
        --mode=di \
        --server-version=4.5.0 \
        --sync-gateway-version=1.4.0-20 \
        testsuites/syncgateway/functional/tests/test_db_online_offline.py

Run a the test in channel cache mode matching a -k pattern and skipping the cluster provisioning.

WARNING! Only provide --skip-provisioning if you know what you are doing. You could end up running a test in an unexpected state.

pytest  -s \
        --mode=cc \
        --skip-provisioning \
        --server-version=4.5.0 \
        --sync-gateway-version=1.3.1-16 \
        -k "test_online_to_offline_check_503" \
        testsuites/syncgateway/functional/tests/

Locally redeploy Linux binaries

To speed up local development, you can build Sync Gateway + Accel locally on your OSX machine and cross-compile for Linux, and then deploy the binaries to your Vagrant / AWS / Data Center VM machines using a script.

Steps:

  1. GOOS=linux GOARCH=amd64 ./build.sh
  2. export CLUSTER_CONFIG=path/to/your/cluster_config
  3. ./redeploy_local_sg_build.sh -b path/to/your/sync_gw/linux/binaries

An example path to your Sync Gateway linux binaries is ~/code/sync_gateway/godeps/bin/linux_amd64/