cassandra_cleaner 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d447cc067301e38bd4fd54d0d9be23806e069428
+  data.tar.gz: 7570639ddb01f7288681410f7663e2b9812a29a0
+SHA512:
+  metadata.gz: 4df431d18048cbf39bcfe6b8db6188bf3732710aa8739c43069bf22ff850ddf20b3c919865d6f62a8db48d3fed409dcee82d30c516ea4b6cbc834b4f2601f661
+  data.tar.gz: 751b95f3efc685be6f524c606265bf8b7d18c3c0d18b5e0c011d19c7f652da0a3e1aa8092932f7c4fcfda1f04ca93270c697a0c1eed00bcfc65d922d51bde0d6

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+-f d
+--colour

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cassandra_cleaner.gemspec
+gemspec
+
+gem 'cql-rb', '~> 2.0.0'
+
+group :test do
+  gem 'rspec', '>= 3.0'
+end
+
+group :development do
+  gem "guard-rspec", "~> 4.4.2", require: false
+end
+
+group :development, :test do
+  gem "guard", "~> 2.11"
+end

data/Guardfile

@@ -0,0 +1,83 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec feature)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), the you will want to move the Guardfile
+## to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "ostruct"
+
+  # Generic Ruby apps
+  rspec = OpenStruct.new
+  rspec.spec = ->(m) { "spec/#{m}_spec.rb" }
+  rspec.spec_dir = "spec"
+  rspec.spec_helper = "spec/spec_helper.rb"
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| rspec.spec.("lib/#{m[1]}") }
+  watch(rspec.spec_helper)      { rspec.spec_dir }
+
+  # Rails example
+  rails = OpenStruct.new
+  rails.app = %r{^app/(.+)\.rb$}
+  rails.views_n_layouts = %r{^app/(.*)(\.erb|\.haml|\.slim)$}
+  rails.controllers = %r{^app/controllers/(.+)_controller\.rb$}
+  rails.routes = "config/routes.rb"
+  rails.app_controller = "app/controllers/application_controller.rb"
+  rails.spec_helper = "spec/rails_helper.rb"
+  rails.spec_support = %r{^spec/support/(.+)\.rb$}
+  rails.views = %r{^app/views/(.+)/.*\.(erb|haml|slim)$}
+
+  watch(rails.app) { |m| rspec.spec.(m[1]) }
+  watch(rails.views_n_layouts) { |m| rspec.spec.("#{m[1]}#{m[2]}") }
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  watch(rails.spec_support)    { rspec.spec_dir }
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "spec/routing" }
+  watch(rails.app_controller)  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(rails.views)     { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 artemk
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# CassandraCleaner
+
+it is like database_cleaner but for cql-rb (cassandra)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cassandra_cleaner'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cassandra_cleaner
+
+## Usage
+
+Add config in rspec_helper.rb
+
+```ruby
+require 'cassandra_cleaner'
+CassandraCleaner.configure do |config|
+  config.cleaner_tag = :cassandra_clean
+  config.debug = false
+  config.client = CQL_CLIENT #aimed that CQL_CLIENT is some constanst set before, i.e. CQL_CLIENT = Cql::Client.connect(hosts: ['cassandra.example.com'])
+  config.enable
+end
+```
+
+And mark some test with a tag you set in config section
+
+```ruby
+it "should test something", :cassandra_clean do
+  #test me
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/cassandra_cleaner/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+#TODO
+1. add warning if update or insert not in CassandraCleaner.configured_column_families
+2. more specs

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/cassandra_cleaner.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cassandra_cleaner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cassandra_cleaner"
+  spec.version       = CassandraCleaner::VERSION
+  spec.authors       = ["artemk"]
+  spec.email         = ["me@artemk.name"]
+  spec.summary       = %q{it is like database_cleaner but for cql-rb (cassandra)}
+  spec.description   = %q{it is like database_cleaner but for cql-rb (cassandra)}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/cassandra_cleaner/configuration.rb

@@ -0,0 +1,17 @@
+module CassandraCleaner
+  class Configuration
+    attr_accessor :cleaner_tag, :debug, :client
+
+    def initialize
+      @cleaner_tag = :clean_cassandra
+      @debug = false
+      @client = nil
+    end
+
+    def enable
+      RSpec.configure do |config|
+        config.include CassandraCleaner::RspecHelper
+      end
+    end
+  end
+end

data/lib/cassandra_cleaner/cql.rb

@@ -0,0 +1,25 @@
+# monkey patching cql-rb classes
+# todo: add batch
+module Cql
+  module Client
+    class SynchronousClient
+      include CassandraCleaner::CqlRspecNotifications::Client
+      include CassandraCleaner::CqlRspecNotifications::Base
+    end
+
+    class AsynchronousClient
+      include CassandraCleaner::CqlRspecNotifications::Client
+      include CassandraCleaner::CqlRspecNotifications::Base
+    end
+
+    class AsynchronousPreparedStatement
+      include CassandraCleaner::CqlRspecNotifications::PreparedStatement
+      include CassandraCleaner::CqlRspecNotifications::Base
+    end
+
+    class SynchronousPreparedStatement
+      include CassandraCleaner::CqlRspecNotifications::PreparedStatement
+      include CassandraCleaner::CqlRspecNotifications::Base
+    end
+  end
+end

data/lib/cassandra_cleaner/cql_rspec_notifications.rb

@@ -0,0 +1,44 @@
+require 'cql/client/client'
+
+module CassandraCleaner  
+  module CqlRspecNotifications
+
+    module Base
+      def self.included(host)
+        host.class_eval do
+          alias_method :execute_without_notify, :execute
+          alias_method :execute, :execute_with_notify
+        end
+
+      end
+
+      def notify_observers(table_name)
+        notifiers = CassandraCleaner.rspec_notifiers
+        notifiers.each{|n| n.receive(table_name)} if notifiers && table_name
+      end
+    end
+
+    module Client
+      def execute_with_notify(*args)
+        res = execute_without_notify(*args)
+        table_name = grap_table_name(args)
+        notify_observers(table_name)
+        res
+      end
+
+      def grap_table_name(args)
+        $1.split('.').last if args && args.first.match(/(?:INSERT INTO|UPDATE)\s([\w\.]*)\s.*/)        
+      end 
+    end
+
+    module PreparedStatement
+      def execute_with_notify(*args)
+        res = execute_without_notify(*args)
+        table_name = self.metadata.instance_variable_get(:@metadata).try(:first).try(:last).try(:table)
+        notify_observers(table_name)
+        res
+      end
+    end
+
+  end
+end

data/lib/cassandra_cleaner/rspec_helper.rb

@@ -0,0 +1,28 @@
+require 'rspec'
+
+module CassandraCleaner
+  module RspecHelper
+    def self.included(rspec_config)
+      rspec_config.before(:each, CassandraCleaner.configuration.cleaner_tag => true) do
+        CassandraCleaner.add_rspec_notifier(CassandraCleaner::RspecNotifier.new)
+      end
+
+      rspec_config.after(:each, CassandraCleaner.configuration.cleaner_tag => true) do
+        begin
+          CassandraCleaner.rspec_notifiers.each do |n| 
+            n.show_info if CassandraCleaner.configuration.debug
+            
+            table_for_truncation = n.tables & CassandraCleaner.configured_column_families
+            unless table_for_truncation.empty?
+              table_for_truncation.each do |column_family|
+                CassandraCleaner.configuration.client.execute("TRUNCATE #{column_family}")
+              end
+            end
+          end
+        ensure
+          CassandraCleaner.unregister_notifiers
+        end
+      end
+    end
+  end
+end

data/lib/cassandra_cleaner/rspec_notifier.rb

@@ -0,0 +1,20 @@
+module CassandraCleaner
+  class RspecNotifier
+    def initialize
+      @column_families = []
+    end
+
+    def receive(table_name)
+      @column_families << table_name    
+    end
+
+    def show_info
+      puts "\nColumn Families used in tests"
+      pp @column_families.uniq
+    end
+
+    def tables
+      @column_families.uniq
+    end
+  end
+end

data/lib/cassandra_cleaner/version.rb

@@ -0,0 +1,3 @@
+module CassandraCleaner
+  VERSION = "0.0.1"
+end

data/lib/cassandra_cleaner.rb

@@ -0,0 +1,40 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require "cql"
+
+require_relative "cassandra_cleaner/version"
+require_relative 'cassandra_cleaner/configuration'
+
+module CassandraCleaner
+  class << self
+    def configure(&block)
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configured_column_families
+      configuration.client.execute("select columnfamily_name from system.schema_columnfamilies where keyspace_name = '#{configuration.client.keyspace}'").to_a.map(&:values).flatten
+    end
+
+    def add_rspec_notifier(rspec_notifier)
+      @@rspec_notifiers ||= []
+      @@rspec_notifiers << rspec_notifier
+    end
+
+    def unregister_notifiers
+      @@rspec_notifiers = []
+    end
+
+    def rspec_notifiers
+      @@rspec_notifiers ||= []
+    end
+  end
+end
+
+require_relative 'cassandra_cleaner/rspec_helper'
+require_relative 'cassandra_cleaner/rspec_notifier'
+require_relative 'cassandra_cleaner/cql_rspec_notifications'
+require_relative 'cassandra_cleaner/cql'

data/spec/cassandra_cleaner_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe CassandraCleaner do
+  let(:cql_client) { CQL_CLIENT }
+  let(:keyspace) { ENV['CASSANDRA_CLEANER_KEYSPACE'] }
+
+  before(:all) do 
+    CQL_CLIENT.execute("CREATE TABLE #{ENV['CASSANDRA_CLEANER_KEYSPACE']}.users (id INT, name TEXT, PRIMARY KEY (id))")
+    CQL_CLIENT.execute("CREATE TABLE #{ENV['CASSANDRA_CLEANER_KEYSPACE']}.posts (id INT, title TEXT, PRIMARY KEY (id))")
+  end
+
+  after(:all) do
+    CQL_CLIENT.execute("DROP TABLE #{ENV['CASSANDRA_CLEANER_KEYSPACE']}.users")
+    CQL_CLIENT.execute("DROP TABLE #{ENV['CASSANDRA_CLEANER_KEYSPACE']}.posts")
+  end
+
+  describe "truncation" do
+    it "should not truncate anything after this spec" do
+      cql_client.execute("INSERT INTO #{keyspace}.users (id, name) VALUES (1, 'Artem K')")
+      expect(CassandraCleaner.rspec_notifiers.map(&:tables)).to eq([])
+    end
+
+    it "should truncate users after this spec", :cassandra_clean do
+      cql_client.execute("INSERT INTO #{keyspace}.users (id, name) VALUES (1, 'Artem K')")
+      expect(CassandraCleaner.rspec_notifiers.map(&:tables)).to eq([["users"]])
+    end
+  end
+
+  describe ".configured_column_families" do
+    it "should return column families that are part of keyspace" do
+      expect(CassandraCleaner.configured_column_families).to eq(["posts", "users"])
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+ENV['CASSANDRA_HOST'] ||= 'localhost'
+ENV['CASSANDRA_CLEANER_KEYSPACE'] ||= 'cassandra_cleaner_test'
+
+require "bundler"
+Bundler.setup
+
+require 'cassandra_cleaner'
+CQL_CLIENT = Cql::Client.connect(hosts: [ENV['CASSANDRA_HOST']])
+
+Dir['./spec/support/**/*.rb'].sort.each { |f| require f }

data/spec/support/1_cql_client.rb

@@ -0,0 +1,28 @@
+RSpec.configure do |config|
+  config.before(:suite) do
+
+    #create test keyspace
+    keyspace_definition = <<-KSDEF
+  CREATE KEYSPACE #{ENV['CASSANDRA_CLEANER_KEYSPACE']}
+  WITH replication = {
+    'class': 'SimpleStrategy',
+    'replication_factor': 1
+  }
+KSDEF
+    CQL_CLIENT.execute("DROP KEYSPACE #{ENV['CASSANDRA_CLEANER_KEYSPACE']}") rescue nil
+    CQL_CLIENT.execute(keyspace_definition)
+    CQL_CLIENT.use(ENV['CASSANDRA_CLEANER_KEYSPACE'])
+  end
+
+  config.after(:suite) do
+    
+    #drop keyspace
+    CQL_CLIENT.execute("DROP KEYSPACE #{ENV['CASSANDRA_CLEANER_KEYSPACE']}") rescue nil
+
+    #close test connection
+    CQL_CLIENT.close
+  end
+end
+
+
+

data/spec/support/2_config.rb

@@ -0,0 +1,6 @@
+CassandraCleaner.configure do |config|
+  config.cleaner_tag = :cassandra_clean
+  config.debug = false
+  config.client = CQL_CLIENT
+  config.enable
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: cassandra_cleaner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- artemk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: it is like database_cleaner but for cql-rb (cassandra)
+email:
+- me@artemk.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cassandra_cleaner.gemspec
+- lib/cassandra_cleaner.rb
+- lib/cassandra_cleaner/configuration.rb
+- lib/cassandra_cleaner/cql.rb
+- lib/cassandra_cleaner/cql_rspec_notifications.rb
+- lib/cassandra_cleaner/rspec_helper.rb
+- lib/cassandra_cleaner/rspec_notifier.rb
+- lib/cassandra_cleaner/version.rb
+- spec/cassandra_cleaner_spec.rb
+- spec/spec_helper.rb
+- spec/support/1_cql_client.rb
+- spec/support/2_config.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: it is like database_cleaner but for cql-rb (cassandra)
+test_files:
+- spec/cassandra_cleaner_spec.rb
+- spec/spec_helper.rb
+- spec/support/1_cql_client.rb
+- spec/support/2_config.rb