.. Licensed to the Apache Software Foundation (ASF) under one
.. or more contributor license agreements.  See the NOTICE file
.. distributed with this work for additional information
.. regarding copyright ownership.  The ASF licenses this file
.. to you under the Apache License, Version 2.0 (the
.. "License"); you may not use this file except in compliance
.. with the License.  You may obtain a copy of the License at
..
..     http://www.apache.org/licenses/LICENSE-2.0
..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.

.. highlight:: none
..  _testing:

Testing
*******

Creating tests is one of the most important and also most difficult parts of developing Cassandra. There are different ways to test your code depending on what you're working on.


Unit Testing
============

The most simple way to test code in Cassandra is probably by writing a unit test. Cassandra uses JUnit as a testing framework and test cases can be found in the ``test/unit`` directory. Ideally you’d be able to create a unit test for your implementation that would exclusively cover the class you created (the unit under test). Unfortunately this is not always possible and Cassandra doesn’t have a very mock friendly code base. Often you’ll find yourself in a situation where you have to make use of an embedded Cassandra instance that you’ll be able to interact with in your test. If you want to make use of CQL in your test, you can simply extend CQLTester and use some of the convenient helper methods such as in the following example.

.. code-block:: java

  @Test
  public void testBatchAndList() throws Throwable
  {
     createTable("CREATE TABLE %s (k int PRIMARY KEY, l list<int>)");
     execute("BEGIN BATCH " +
             "UPDATE %1$s SET l = l +[ 1 ] WHERE k = 0; " +
             "UPDATE %1$s SET l = l + [ 2 ] WHERE k = 0; " +
             "UPDATE %1$s SET l = l + [ 3 ] WHERE k = 0; " +
             "APPLY BATCH");

     assertRows(execute("SELECT l FROM %s WHERE k = 0"),
                row(list(1, 2, 3)));
  }

Unit tests can be run from the command line using the ``ant test`` command, ``ant test -Dtest.name=<simple_classname>`` to execute a test suite or ``ant testsome -Dtest.name=<FQCN> -Dtest.methods=<testmethod1>[,testmethod2]`` for individual tests.  For example, to run all test methods in the ``org.apache.cassandra.cql3.SimpleQueryTest`` class, you would run::

    ant test -Dtest.name=SimpleQueryTest

To run only the ``testTableWithOneClustering()`` test method from that class, you would run::

    ant testsome -Dtest.name=org.apache.cassandra.cql3.SimpleQueryTest -Dtest.methods=testTableWithOneClustering

If you see an error like this::

    Throws: cassandra-trunk/build.xml:1134: taskdef A class needed by class org.krummas.junit.JStackJUnitTask cannot be found:
    org/apache/tools/ant/taskdefs/optional/junit/JUnitTask  using the classloader
    AntClassLoader[/.../cassandra-trunk/lib/jstackjunit-0.0.1.jar]

You will need to install the ant-optional package since it contains the ``JUnitTask`` class.

Long running tests
------------------

Test that consume a significant amount of time during execution can be found in the ``test/long`` directory and executed as a regular JUnit test or standalone program. Except for the execution time, there’s nothing really special about them. However, ant will execute tests under ``test/long`` only when using the ``ant long-test`` target.

Flaky tests
-----------

If a test failure is difficult to reproduce you can always use a shell loop, circle repeat strategy and similar solutions. At the JUnit level ``RepeatableRunner`` will let you run a JUnit class N times for convenience. On tests that are fast this is a much faster way to iterate than doing it at the shell level. Beware of tests that modify singleton state or similar as they won't work.

DTests
======

One way of doing integration or system testing at larger scale is by using `dtest <https://github.com/apache/cassandra-dtest>`_, which stands for “Cassandra Distributed Tests”. The idea is to automatically setup Cassandra clusters using various configurations and simulate certain use cases you want to test. This is done using Python scripts and ``ccmlib`` from the `ccm <https://github.com/pcmanus/ccm>`_ project. Dtests will setup clusters using this library just as you do running ad-hoc ``ccm`` commands on your local machine. Afterwards dtests will use the `Python driver <http://datastax.github.io/python-driver/installation.html>`_ to interact with the nodes, manipulate the file system, analyze logs or mess with individual nodes.

Using dtests helps us to prevent regression bugs by continually executing tests on the `CI server <https://builds.apache.org/>`_ against new patches. Committers will be able to set up build branches there and your reviewer may use the CI environment to run tests for your patch.

The best way to learn how to write dtests is probably by reading the introduction "`How to Write a Dtest <http://www.datastax.com/dev/blog/how-to-write-a-dtest>`_" and by looking at existing, recently updated tests in the project. New tests must follow certain `style conventions <https://github.com/apache/cassandra-dtest/blob/trunk/CONTRIBUTING.md>`_ that are being checked before accepting contributions. In contrast to Cassandra, dtest issues and pull-requests are managed on github, therefor you should make sure to link any created dtests in your Cassandra ticket and also refer to the ticket number in your dtest PR.

Creating a good dtest can be tough, but it should not prevent you from submitting patches! Please ask in the corresponding JIRA ticket how to write a good dtest for the patch. In most cases a reviewer or committer will able to support you, and in some cases they may offer to write a dtest for you.

Performance Testing
===================

Performance tests for Cassandra are a special breed of tests that are not part of the usual patch contribution process. In fact you can contribute tons of patches to Cassandra without ever running performance tests. They are important however when working on performance improvements, as such improvements must be measurable.

Cassandra Stress Tool
---------------------

See :ref:`cassandra_stress`

cstar_perf
----------

Another tool available on github is `cstar_perf <https://github.com/datastax/cstar_perf>`_ that can be used for intensive performance testing in large clusters or locally. Please refer to the project page on how to set it up and how to use it.

CircleCI
========

Cassandra ships with a default `CircleCI <https://circleci.com>`_ configuration, to enable running tests on your branches, you need to go the CircleCI website, click "Login" and log in with your github account. Then you need to give CircleCI permission to watch your repositories. Once you have done that, you can optionally configure CircleCI to run tests in parallel - click "Projects", then your github account and then click the settings for the project. If you leave the parallelism at 1 for Cassandra, only ``ant eclipse-warnings`` and ``ant test`` will be run. If you up the parallelism to 4, it also runs ``ant long-test``, ``ant test-compression`` and ``ant stress-test``.

The configuration for CircleCI is in the ``.circleci/config.yml`` file. This configuration file is meant to use low resources, you can find equivalent configuration files using more resources in the same ``.circleci`` directory. Please read the ``readme.md`` file in that directory for further information. Note that the higher resources are not available in the free tier of CircleCI.

The optional ``repeated_utest``/``repeated_dtest`` CircleCI jobs run a specific JUnit/Python test repeatedly. In an analogous way, upgrade tests can be run repeatedly with the jobs ``repeated_upgrade_dtest``/``repeated_jvm_upgrade_dtest``. This is useful to verify that a certain test is stable. It's usually a good idea to run these jobs when adding or modifying a test. To specify what test should be run and the number of repetitions you should edit the related evironment variables in the CircleCI configuration file:

+----------------------------------------------+---------------------------------------------------------------+
| Variable                                     | Description                                                   |
+==============================================+===============================================================+
|``REPEATED_UTEST_TARGET``                     | The Ant test target to run, for example:                      |
|                                              |                                                               |
|                                              | * ``testsome``                                                |
|                                              | * ``test-jvm-dtest-some``                                     |
|                                              | * ``test-cdc``                                                |
|                                              | * ``test-compression``                                        |
|                                              | * ``test-system-keyspace-directory``                          |
+----------------------------------------------+---------------------------------------------------------------+
|``REPEATED_UTEST_CLASS``                      | The name of the Java test class to be run multiple times, for |
|                                              | example:                                                      |
|                                              |                                                               |
|                                              | * ``org.apache.cassandra.cql3.ViewTest``                      |
|                                              | * ``org.apache.cassandra.distributed.test.PagingTest``        |
+----------------------------------------------+---------------------------------------------------------------+
|``REPEATED_UTEST_METHODS``                    | The optional specific methods within ``REPEATED_UTEST_CLASS`` |
|                                              | to be run, for example:                                       |
|                                              |                                                               |
|                                              | * ``testCompoundPartitionKey``                                |
|                                              | * ``testCompoundPartitionKey,testStaticTable``                |
+----------------------------------------------+---------------------------------------------------------------+
|``REPEATED_UTEST_COUNT``                      | The number of times that the repeated Java test should be run |
+----------------------------------------------+---------------------------------------------------------------+
|``REPEATED_UTEST_STOP_ON_FAILURE``            | Whether the utest iteration should stop on the first failure  |
+----------------------------------------------+---------------------------------------------------------------+
|``REPEATED_DTEST_NAME``                       | The Python dtest to be run multiple times, for example:       |
|                                              |                                                               |
|                                              | * ``cqlsh_tests/test_cqlsh.py``                               |
|                                              | * ``cqlsh_tests/test_cqlsh.py::TestCqlshSmoke``               |
+----------------------------------------------+---------------------------------------------------------------+
|``REPEATED_DTEST_VNODES``                     | Whether the repeated Python dtest should use vnodes           |
+----------------------------------------------+---------------------------------------------------------------+
|``REPEATED_DTEST_COUNT``                      | The number of times that the repeated Python dtest should be  |
|                                              | run                                                           |
+----------------------------------------------+---------------------------------------------------------------+
|``REPEATED_DTEST_STOP_ON_FAILURE``            | Whether the dtest iteration should stop on the first failure  |
+----------------------------------------------+---------------------------------------------------------------+
|``REPEATED_UPGRADE_DTEST_NAME``               | A Python upgrade dtest to be run multiple times, for example: |
|                                              |                                                               |
|                                              | * ``upgrade_tests/cql_tests.py``                              |
|                                              | * ``upgrade_tests/repair_test.py``                            |
+----------------------------------------------+---------------------------------------------------------------+
|``REPEATED_UPGRADE_DTEST_COUNT``              | The number of times that the repeated Python upgrade dtest    |
|                                              | should be run                                                 |
+----------------------------------------------+---------------------------------------------------------------+
|``REPEATED_UPGRADE_DTEST_STOP_ON_             | Whether the Python upgrade dtest iteration should stop on the |
|FAILURE``                                     | first failure                                                 |
+----------------------------------------------+---------------------------------------------------------------+
|``REPEATED_JVM_UPGRADE_DTEST_CLASS``          | The name of JVM upgrade dtest class to be run multiple times, |
|                                              | for example:                                                  |
|                                              |                                                               |
|                                              | * | ``org.apache.cassandra.distributed.upgrade.``             |
|                                              |   | ``MixedModeAvailabilityV30Test``                          |
|                                              | * | ``org.apache.cassandra.distributed.upgrade.``             |
|                                              |   | ``MixedModeConsistencyV3XTest``                           |
+----------------------------------------------+---------------------------------------------------------------+
|``REPEATED_JVM_UPGRADE_DTEST_METHODS``        | The optional specific methods within                          |
|                                              | ``REPEATED_JVM_UPGRADE_DTEST_CLASS`` to be run, for example:  |
|                                              |                                                               |
|                                              | * ``testAvailabilityV30ToV4``                                 |
|                                              | * ``testAvailabilityV30ToV3X,testAvailabilityV30ToV4``        |
+----------------------------------------------+---------------------------------------------------------------+
|``REPEATED_JVM_UPGRADE_DTEST_COUNT``          | The number of times that the repeated JVM upgrade dtest       |
|                                              | should be run                                                 |
+----------------------------------------------+---------------------------------------------------------------+
|``REPEATED_JVM_UPGRADE_DTEST_STOP_ON_FAILURE``| Whether the JVM upgrade dtest iteration should stop on the    |
|                                              | first failure                                                 |
+----------------------------------------------+---------------------------------------------------------------+