pseudo_cleaner 0.0.38 → 0.0.39

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTk2NTg5N2FhYmRiYjJmYzkyMzA5NGE1YjhmZTNlYTE4MjhlODk1OQ==
+    YTgyNWUyNmQ2ZGE1MDI3YmVhNDNiYmEzNjRhYThlOGY5ZTdiODIxMQ==
   data.tar.gz: !binary |-
-    ZjgwZDExYmRhNWE5YjE5OTAyZTY3OGIzNjdkZjEwMTFkOGVlYTNlNA==
+    YmY3MzcyYWE5MDczNDdjMjYyNDljYTMxYmQ4N2FhZTZjZDI2ZDcwYQ==
 SHA512:
   metadata.gz: !binary |-
-    NWUwMDhlY2FjYzVjOWNiYjc4ZWEwMGY3NmU2YjA4MjRhMjg5MDkwNTkwNzFl
-    NWUyZjA2MjdhMTg1NDJhYjgwNGY0MDAxZGYwMDg1OWJjN2RmNDdkYmMyNTVl
-    OThiODEwYWZmZmFiM2MxZjBiY2RjYTQxYTAyMTVhZTVkMTczNjk=
+    OWQ4YmU1YjQ4MGRhMjZlOGJhMTZkMDUyZTczYjAyZWNhNDUxMjJkMTFmMDNi
+    NDBkZDFiNWEzMTUzYjJkMDY4NGY2MDUwNzFkMDk2M2Q5N2U5N2ZkYzNkZmI5
+    ODBkMmE4ZGNmNDZjNThlYWJjYjJiOWE1NmIzM2RiMTdlNTM3ZWM=
   data.tar.gz: !binary |-
-    ZjhjNjI1MmVmOTRjYWE1MTY1OTg2Y2EwZDg4Zjk5ZDRhZTk1ZDg2NWU4MDU2
-    NDhjZWFmY2JmNGRjZGQxN2Q5MTljYmVhMGRjYTNkNGFjZDI0MTAyMmMwMDZh
-    YjdlNGQ0NmI2NGFiNzQ1MDZlNTg5YWZhNjA2YjQxNTllNmQxODk=
+    ZTRlOThkNmQ0MTk0OWY4ZDVkZGJhYzdlYmY4NDc4NzYyYzJlNmY1OTAxY2Zi
+    YmUzMTViYTE2YTEyNjIyZWQwNmMzYWNkMGQzMjQxNDljMTYyOGUxZGY0ZWEz
+    YzMzMTBhYTE4ZWYyYTA5NDhiZTE0NTQ5NzBkMWY2NzQyMTI2MTg=

data/README.md

@@ -145,10 +145,102 @@ Cleaners must also include one or more of the following funcitons:
 
 A Cleaner can adjust when it is called in relation to other cleaners by overriding the instance method `<=>`
 
+### Redis Cleaner
+
+The RedisCleaner is a base class for a Custom Cleaner you must create yourself.  The RedisCleaner is designed to work
+by replacing your existing redis class with a tracking redis class.  It will track your updates as you make calls and
+then clean them up when you are done.
+
+An example implementation where the default redis used by the system is `$redis`.  (In other cases, you may want to 
+use mocking to swap out the redis instance...)
+
+This in the file:  db\cleaners\redis_cleaner.rb in the project...
+
+    class RedisCleaner < PseudoCleaner::RedisCleaner
+      attr_reader :test_ignore_regex
+      attr_reader :current_ignore_regex
+
+      BASE_IGNORE =
+          [
+              /rc-analytics::exports:actions:partner_last_run_dates/,
+              /rack\|whitelist_cache\|hash_data/,
+              /SequelModelCache/,
+              /active_sessions/,
+          ]
+
+      def ignore_regexes
+        current_ignore_regex
+      end
+
+      def ignore_durring_test(additional_ignore_regexes, &block)
+        orig_test_ignore_regex = test_ignore_regex
+        begin
+          @test_ignore_regex    = [*additional_ignore_regexes, *test_ignore_regex]
+          @current_ignore_regex = [*RedisCleaner::BASE_IGNORE, *test_ignore_regex]
+
+          block.yield
+        ensure
+          @test_ignore_regex    = orig_test_ignore_regex
+          @current_ignore_regex = [*RedisCleaner::BASE_IGNORE, *test_ignore_regex]
+        end
+      end
+
+      def initialize(*args)
+        super(*args)
+
+        @current_ignore_regex = RedisCleaner::BASE_IGNORE
+        @test_ignore_regex    = []
+        @redis                = $redis
+        $redis                = self
+
+        Redis.current        = $redis
+        Ohm.redis            = $redis
+        Redis::Objects.redis = $redis
+      end
+    end
+
+The main point here is that I set the value of @redis to the redis instance I want to use, and then "replace" that 
+redis instance in the code with the RedisCleaner class.
+
+## Configurations
+
+As the system evolves, I keep adding new and different options.  Here is a summary of what some of them do at least:
+
+* **output_diagnostics**
+  Output diagnostic information at various points in the process.  This would include the level set starting point of
+  a table, what rows were deleted, etc.
+* **clean_database_before_tests**
+  Delete all data in all tables can call SortedSeeer to re-seed the database before any tests are run.  This is 
+  defaulted to false because this can be time-consuming and many automated testing systems already do this for you.
+* **reset_auto_increment**
+  Defaulted to true, this will set the auto-increment value for a table to the highest id + 1 when the system starts.
+* **post_transaction_analysis**
+  An early version of the peek-data function.  This will output information about every table at the end of the test.
+  The data output will match the initial state data if `output_diagnostics` is true.
+* **peek_data_on_error**
+  Defaulted to true, this will output a dump of all of the new values in the database if an error occured in the test.
+* **peek_data_not_on_error**
+  If set to true, this will output a dump of all of the new values in the database at the end of every test.  This 
+  functionality can also be achieved by tagging your test with `:full_data_dump` (RSpec) or `@full_data_dump` 
+  (Cucumber and Spinach).
+* **enable_full_data_dump_tag**
+  Defaulted to true, this allows the `full_data_dump` tag to work.  If set to false, the tag will be ignored.
+* **disable_cornucopia_output**
+  If set to false, this will force all output to be done through the registered logger which defaults to simply 
+  outputing data to stdout.
+
+## Cornucopia integration
+
+I have another gem that I use a lot called `cornucopia`.  I like it because it gives me really useful reports on what
+happened in my tests.
+
+I have updated this gem to use Cornucopia to output most of the information to be output by the gem.  You can disable
+this feature by setting `disable_cornucopia_output` to true.
+
 ## Contributing
 
 1. Fork it
 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 new Pull Request
+5. Create new Pull Request

data/lib/pseudo_cleaner/configuration.rb

@@ -33,6 +33,7 @@ module PseudoCleaner
       @peek_data_on_error          = true
       @peek_data_not_on_error      = false
       @enable_full_data_dump_tag   = true
+      @disable_cornucopia_output   = false
     end
 
     # Backwards comaptibility...

data/lib/pseudo_cleaner/master_cleaner.rb

@@ -350,7 +350,8 @@ module PseudoCleaner
 
         if Object.const_defined?("Cornucopia", false) &&
             Cornucopia.const_defined?("Util", false) &&
-            Cornucopia::Util.const_defined?("ReportBuilder", false)
+            Cornucopia::Util.const_defined?("ReportBuilder", false) &&
+            !PseudoCleaner::Configuration.current_instance.disable_cornucopia_output
           Cornucopia::Util::ReportBuilder.current_report.within_section(options[:description]) do |report|
             report.within_hidden_table do |outer_report_table|
               Cornucopia::Util::ReportTable.new(

data/lib/pseudo_cleaner/redis_cleaner.rb

@@ -110,6 +110,7 @@ module PseudoCleaner
             "sunionstore",
             "zincrby",
             "zinterstore",
+            "[]=",
         ]
     READ_COMMANDS  =
         [
@@ -159,6 +160,7 @@ module PseudoCleaner
             "zscan",
             "zscan_each",
             "zscore",
+            "[]",
         ]
 
     attr_reader :initial_keys
@@ -242,11 +244,24 @@ module PseudoCleaner
         elsif ["exec", "pipelined"].include?(args[0])
           begin
             if (!response && @multi_commands.length > 0) || (response && response.length != @multi_commands.length)
-              raise "exec response does not match sent commands.\n  response: #{response}\n commands: #{@multi_commands}"
+              puts "exec response does not match sent commands.\n  response: #{response}\n  commands: #{@multi_commands}"
+
+              # make the response length match the commands length.
+              # so far the only time this has happened was when a multi returned nil which SHOULD indicate a failure
+              #
+              # I am assuming that the multi failed in this case, but even if so, it is safest for tracking purposes
+              # to assume that redis DID change and record it as such.  Even if I am wrong, for the cleaner, it
+              # doesn't matter, and there is no harm.
+              response ||= []
+              @multi_commands.each_with_index do |command, index|
+                if response.length < index
+                  response << true
+                end
+              end
             end
 
-            response.each_with_index do |command_response, index|
-              process_command(command_response, *(@multi_commands[index]))
+            @multi_commands.each_with_index do |command, index|
+              process_command(response[index], *command)
             end
           ensure
             @in_multi       = false
@@ -258,7 +273,14 @@ module PseudoCleaner
         elsif WRITE_COMMANDS.include?(args[0])
           updated_keys.merge(extract_keys(*args))
         elsif SET_COMMANDS.include?(args[0])
-          if [true, false].include?(response) ? response : (response > 0)
+          update_key = true
+          if [true, false].include?(response)
+            update_key = response
+          else
+            update_key = response > 0 rescue true
+          end
+
+          if update_key
             updated_keys.merge(extract_keys(*args))
           end
         end

data/lib/pseudo_cleaner/version.rb

@@ -1,3 +1,3 @@
 module PseudoCleaner
-  VERSION = "0.0.38"
+  VERSION = "0.0.39"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pseudo_cleaner
 version: !ruby/object:Gem::Version
-  version: 0.0.38
+  version: 0.0.39
 platform: ruby
 authors:
 - RealNobody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-26 00:00:00.000000000 Z
+date: 2015-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize