testing.cassandra3 1.3.0
automatically setups a cassandra instance in a temporary directory, and destroys it after testing
License: Apache License 2.0

``testing.cassandra3`` automatically setups a cassandra instance in a temporary directory, and destroys it after testing

.. image:: https://travis-ci.org/criteo-forks/testing.cassandra.svg?branch=master
   :target: https://travis-ci.org/criteo-forks/testing.cassandra

.. image:: https://coveralls.io/repos/criteo-forks/testing.cassandra/badge.png?branch=master
   :target: https://coveralls.io/r/criteo-forks/testing.cassandra?branch=master

.. image:: https://codeclimate.com/github/criteo-forks/testing.cassandra/badges/gpa.svg
   :target: https://codeclimate.com/github/criteo-forks/testing.cassandra

This is a fork of https://github.com/tk0miya/testing.cassandra.

Install
=======
Use easy_install (or pip)::

   $ easy_install testing.cassandra3

And ``testing.cassandra3`` requires Cassandra server.


Usage
=====
Create Cassandra instance using ``testing.cassandra3.Cassandra``::

  import cassandra
  import testing.cassandra3

  # Launch new Cassandra server
  with testing.cassandra3.Cassandra as cassandra:
      conn = cassandra.cluster.Cluster(**cassandra.connection_params())
      #
      # do any tests using Cassandra...
      #

  # Cassandra server is terminated here


``testing.cassandra3`` automatically searchs for cassandra files in ``/usr/local/``.
If you install cassandra to other directory, set ``cassandra_home`` keyword::

  # uses a copy of specified data directory of Cassandra.
  cassandra = testing.cassandra3.Cassandra(copy_data_from='/path/to/your/database')


``testing.cassandra3.Cassandra`` executes ``cassandra`` on instantiation.
On deleting Cassandra object, it terminates Cassandra instance and removes temporary directory.

If you want a database including column families and any fixtures for your apps,
use ``copy_data_from`` keyword::

  # uses a copy of specified data directory of Cassandra.
  cassandra = testing.cassandra3.Cassandra(copy_data_from='/path/to/your/database')


You can specify parameters for Cassandra with ``cassandra_yaml`` keyword::

  # boot Cassandra server listens on 12345 port
  cassandra = testing.cassandra3.Cassandra(cassandra_yaml={'rpc_port': 12345})


For example, you can setup new Cassandra server for each testcases on setUp() method::

  import unittest
  import testing.cassandra3

  class MyTestCase(unittest.TestCase):
      def setUp(self):
          self.cassandra = testing.cassandra3.Cassandra()

      def tearDown(self):
          self.cassandra.stop()


Requirements
============
* Cassandra 3.11.1
* Python 2.7, 3.5, 3.6
* cassandra-driver
* PyYAML


License
=======
Apache License 2.0


History
=======

1.3.0 (2017-12-10)
------------------
* Fork testing.cassandra
* Drop support for Cassandra 2.x and Python 2.6
* Add support for Cassandra 3.x and Python 3

1.2.0 (2016-02-03)
-------------------
* Add timeout to server invoker
* Support Homebrew
* Support Cassandra 2.x
* Refer $CASSANDRA_HOME for search cassandra home directory
* Depend on ``testing.common.database`` package

1.1.4 (2015-04-06)
-------------------
* Fix bugs:

  - Do not call os.getpid() on destructor (if not needed)
  - Use absolute path for which command

1.1.3 (2014-06-19)
-------------------
* Add timeout on terminating cassandra
* Fix bugs

1.1.2 (2014-06-11)
-------------------
* Fix ImportError if caught SIGINT on py3

1.1.1 (2013-12-06)
-------------------
* Suport Cassandra 2.0.x
* Fix Cassandra#stop() causes OSError (at destructing object)

1.1.0 (2013-12-06)
-------------------
* Support Cassandra 1.2.x
* Support python 2.6
* Add cassandra.skipIfNotInstalled decorator
* Change behavior: Cassandra#stop() cleans workdir
* Fix workdir does not removed if cassandra does not started

1.0.0 (2013-10-17)
-------------------
* First release