db_obfuscation 0.0.1

data/spec/db_obfuscation/truncation_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'db_obfuscation/truncation'
+
+module DbObfuscation
+  describe Truncation do
+    describe '.truncate' do
+    around(:each) do |example|
+      DB.transaction(rollback: :always) do
+        example.run
+      end
+    end
+
+    it 'truncates tables that match the user specified truncation patterns' do
+      expect(DB[:truncation_table_1].all.count).to be > 0
+      expect(DB[:audit_truncation_table].all.count).to be > 0
+      described_class.truncate
+
+      expect(DB[:truncation_table_1].all.count).to eq 0
+      expect(DB[:audit_truncation_table].all.count).to eq 0
+    end
+
+    end
+
+    describe '.tables' do
+      it 'returns the list of truncation tables' do
+        expect(described_class.tables).to match_array [:truncation_table_1,
+                                                       :audit_truncation_table]
+      end
+    end
+  end
+end

data/spec/db_obfuscation/util/trigger_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+require 'db_obfuscation/util/trigger'
+
+def create_trigger_function
+  DbObfuscation::DB.run <<-sql
+    create or replace function fake_function() returns trigger
+    as $$ begin end $$ language plpgsql;
+  sql
+end
+
+def drop_trigger_function
+  DbObfuscation::DB.run <<-sql
+    drop function fake_function()
+  sql
+end
+
+def create_trigger(table_name)
+  create_trigger_function
+
+  <<-sql
+    CREATE TRIGGER audit_#{table_name}
+    AFTER UPDATE ON #{table_name}
+    FOR EACH ROW
+    EXECUTE PROCEDURE fake_function();
+  sql
+end
+
+def drop_trigger(table_name)
+  DbObfuscation::DB.run <<-sql
+   DROP TRIGGER audit_#{table_name}
+   ON #{table_name}
+  sql
+
+  drop_trigger_function
+end
+
+def trigger_status
+  <<-sql
+   SELECT triggers.tgenabled as status,
+   tables.relname as table_name
+   FROM pg_trigger triggers, pg_class tables
+   WHERE triggers.tgrelid = tables.oid
+   AND tables.relname !~ '^pg_'
+   AND triggers.tgname LIKE 'audit_%'
+  sql
+end
+
+module DbObfuscation::Util
+  describe Trigger do
+    around(:each) do |example|
+      DbObfuscation::DB.run(create_trigger('table_1')) rescue nil
+      DbObfuscation::DB.run(create_trigger('table_2')) rescue nil
+
+      example.run
+
+      DbObfuscation::DB.run(drop_trigger('table_1')) rescue nil
+      DbObfuscation::DB.run(drop_trigger('table_2')) rescue nil
+    end
+
+    it 'returns tables with triggers' do
+      tables_with_triggers = ['table_1', 'table_2']
+      expect(described_class.tables).to match_array(
+        tables_with_triggers
+      )
+    end
+
+    it 'drops all the triggers in the database' do
+      described_class.drop(:all)
+      expect(described_class.tables).to eq([])
+    end
+
+    it 'drops triggers for given table' do
+      described_class.drop('table_1')
+      expect(described_class.tables).to eq(['table_2'])
+    end
+
+    it 'disable trigger for given table' do
+      status = [
+        { status: 'D', table_name: 'table_1' },
+        { status: 'O', table_name: 'table_2' },
+      ]
+      described_class.disable('table_1')
+      expect(DbObfuscation::DB[trigger_status].all).to match_array(status)
+    end
+
+    it 'disables triggers for all the tables' do
+      status = [
+        { status: 'D', table_name: 'table_1' },
+        { status: 'D', table_name: 'table_2' },
+      ]
+      described_class.disable(:all)
+      expect(DbObfuscation::DB[trigger_status].all).to match_array(status)
+    end
+
+    it 'enables trigger for given table' do
+      status = [
+        { status: 'O', table_name: 'table_1' },
+        { status: 'D', table_name: 'table_2' },
+      ]
+      described_class.disable(:all)
+      described_class.enable('table_1')
+      expect(DbObfuscation::DB[trigger_status].all).to match_array(status)
+    end
+
+    it 'enables all the triggers' do
+      status = [
+        { status: 'O', table_name: 'table_1' },
+        { status: 'O', table_name: 'table_2' },
+      ]
+      described_class.disable(:all)
+      described_class.enable(:all)
+      expect(DbObfuscation::DB[trigger_status].all).to match_array(status)
+    end
+
+    describe '.trigger?' do
+      it 'returns true if table has a trigger' do
+        expect(described_class.exists?('table_1')).to eq true
+      end
+
+      it 'returns false if table does not have a trigger' do
+        expect(described_class.exists?('whitelisted_table_1')).
+          to eq false
+      end
+    end
+  end
+end

data/spec/integration/obfuscation_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'db_obfuscation'
+require 'db_obfuscation/truncation'
+
+describe 'DbObfuscation' do
+  around(:each) do |example|
+    DbObfuscation::DB.transaction(rollback: :always) do
+      example.run
+    end
+  end
+
+  it 'replaces existing data columns with fake data' do
+    record = DbObfuscation::DB[:table_1].first
+    original_value = record[:field_1]
+    expect(original_value).to eq 'original_field_1_1'
+
+    DbObfuscation.obfuscate(100)
+
+    record = DbObfuscation::DB[:table_1].where(id: record[:id]).first
+    obfuscated_value = record[:field_1]
+    expect(obfuscated_value).to_not eq 'original_field_1_1'
+  end
+
+  it 'obfuscates date field when included in the config file' do
+    record = DbObfuscation::DB[:table_1].first
+    original_date = record[:date_field]
+    expect(original_date.to_s).to eq '2001-01-01'
+
+    DbObfuscation.obfuscate(100)
+
+    record = DbObfuscation::DB[:table_1].where(id: record[:id]).first
+    obfuscated_date = record[:date_field]
+    expect(obfuscated_date.to_s).to_not eq '2001-01-01'
+  end
+
+  it 'does not obfuscate whitelisted column for a table' do
+    record = DbObfuscation::DB[:table_2].first
+    original_value = record[:field_2]
+    expect(original_value).to eq 'original_field_2_1'
+
+    DbObfuscation.obfuscate(100)
+
+    record = DbObfuscation::DB[:table_2].where(id: record[:id]).first
+    obfuscated_value = record[:field_2]
+    expect(obfuscated_value).to eq 'original_field_2_1'
+  end
+
+  it 'does not obfuscate the whitelisted tables' do
+    record = DbObfuscation::DB[:whitelisted_table_1].first
+    original_value = record[:field_1]
+    expect(original_value).to eq 'whitelisted_field_1_1'
+
+    DbObfuscation.obfuscate(100)
+
+    record = DbObfuscation::DB[:whitelisted_table_1].where(id: record[:id]).first
+    obfuscated_value = record[:field_1]
+    expect(obfuscated_value).to eq 'whitelisted_field_1_1'
+  end
+
+  it 'truncates the truncation table list' do
+    original_data_count = DbObfuscation::DB[:truncation_table_1].count
+    expect(original_data_count).to be > 0
+
+    DbObfuscation::Truncation.truncate
+
+    new_data_count = DbObfuscation::DB[:truncation_table_1].count
+    expect(new_data_count).to eq 0
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'db_obfuscation/environment'
+DbObfuscation.config_dir = DbObfuscation::ROOT.join('spec/config')
+DbObfuscation.logging = Logger.new('test_logs')

data/spec/test_db_setup/migrations/1_add_table_1.rb

@@ -0,0 +1,18 @@
+Sequel.migration do
+  up do
+    create_table(:table_1) do
+      primary_key :id, type: Bignum
+      String :field_1
+      String :field_2
+      Date :date_field
+      DateTime :created_at
+      DateTime :updated_at
+      TrueClass :boolean_field
+      Bignum :integer_field
+    end
+  end
+
+  down do
+    drop_table(:table_1)
+  end
+end

data/spec/test_db_setup/migrations/2_add_table_2.rb

@@ -0,0 +1,19 @@
+Sequel.migration do
+  up do
+    create_table(:table_2) do
+      primary_key :id, type: Bignum
+      String :field_1
+      String :field_2
+      Date :date_field
+      DateTime :created_at
+      DateTime :updated_at
+      TrueClass :boolean_field
+      Bignum :integer_field
+      foreign_key :table_1_id, :table_1, type: Bignum, key: :id
+    end
+  end
+
+  down do
+    drop_table(:table_2)
+  end
+end

data/spec/test_db_setup/migrations/3_add_truncation_table_1.rb

@@ -0,0 +1,14 @@
+Sequel.migration do
+  up do
+    create_table(:truncation_table_1) do
+      primary_key :id, type: Bignum
+      String :field_1
+      String :field_2
+      foreign_key :table_1_id, :table_1, type: Bignum, key: :id
+    end
+  end
+
+  down do
+    drop_table(:truncation_table_1)
+  end
+end

data/spec/test_db_setup/migrations/4_add_whitelisted_table_1.rb

@@ -0,0 +1,14 @@
+Sequel.migration do
+  up do
+    create_table(:whitelisted_table_1) do
+      primary_key :id, type: Bignum
+      String :field_1
+      String :field_2
+      foreign_key :table_1_id, :table_1, type: Bignum, key: :id
+    end
+  end
+
+  down do
+    drop_table(:whitelisted_table_1)
+  end
+end

data/spec/test_db_setup/migrations/5_add_table_without_any_user_defined_obfuscation_strategies.rb

@@ -0,0 +1,18 @@
+Sequel.migration do
+  up do
+    create_table(:table_without_any_user_defined_obfuscation_strategies) do
+      primary_key :id, type: Bignum
+      String :field_1
+      String :field_2
+      Date :date_field
+      DateTime :created_at
+      DateTime :updated_at
+      TrueClass :boolean_field
+      Bignum :integer_field
+    end
+  end
+
+  down do
+    drop_table(:table_without_any_user_defined_obfuscation_strategies)
+  end
+end

data/spec/test_db_setup/migrations/6_add_table_without_any_obfuscatable_columns.rb

@@ -0,0 +1,15 @@
+Sequel.migration do
+  up do
+    create_table(:table_without_any_obfuscatable_columns) do
+      primary_key :id, type: Bignum
+      DateTime :created_at
+      DateTime :updated_at
+      TrueClass :boolean_field
+      Bignum :integer_field
+    end
+  end
+
+  down do
+    drop_table(:table_without_any_obfuscatable_columns)
+  end
+end

data/spec/test_db_setup/migrations/7_add_audit_truncation_table.rb

@@ -0,0 +1,13 @@
+Sequel.migration do
+  up do
+    create_table(:audit_truncation_table) do
+      primary_key :id, type: Bignum
+      String :field_1
+      String :field_2
+    end
+  end
+
+  down do
+    drop_table(:audit_truncation_table)
+  end
+end

data/spec/test_db_setup/seeds/audit_truncation_table.yml

@@ -0,0 +1,7 @@
+row1:
+  field_1: 'truncation_field_1_1'
+  field_2: 'truncation_field_2_1'
+
+row2:
+  field_1: 'truncation_field_1_2'
+  field_2: 'truncation_field_2_2'

data/spec/test_db_setup/seeds/table_1.yml

@@ -0,0 +1,13 @@
+row1:
+  field_1: 'original_field_1_1'
+  field_2: 'original_field_2_1'
+  date_field: '1/1/2001'
+  boolean_field: true
+  integer_field: 21
+
+row2:
+  field_1: 'original_field_1_2'
+  field_2: 'original_field_2_2'
+  date_field: '1/2/2001'
+  boolean_field: false
+  integer_field: 22

data/spec/test_db_setup/seeds/table_2.yml

@@ -0,0 +1,15 @@
+row1:
+  field_1: 'original_field_1_1'
+  field_2: 'original_field_2_1'
+  date_field: '1/1/2001'
+  boolean_field: true
+  integer_field: 21
+  table_1_id: 1
+
+row2:
+  field_1: 'original_field_1_2'
+  field_2: 'original_field_2_2'
+  date_field: '1/2/2001'
+  boolean_field: false
+  integer_field: 22
+  table_1_id: 2

data/spec/test_db_setup/seeds/table_without_any_obfuscatable_columns.yml

@@ -0,0 +1,7 @@
+row1:
+  boolean_field: true
+  integer_field: 21
+
+row2:
+  boolean_field: false
+  integer_field: 22

data/spec/test_db_setup/seeds/table_without_any_user_defined_obfuscation_strategies.yml

@@ -0,0 +1,13 @@
+row1:
+  field_1: 'original_field_1_1'
+  field_2: 'original_field_2_1'
+  date_field: '1/1/2001'
+  boolean_field: true
+  integer_field: 21
+
+row2:
+  field_1: 'original_field_1_2'
+  field_2: 'original_field_2_2'
+  date_field: '1/2/2001'
+  boolean_field: false
+  integer_field: 22

data/spec/test_db_setup/seeds/truncation_table_1.yml

@@ -0,0 +1,9 @@
+row1:
+  field_1: 'truncation_field_1_1'
+  field_2: 'truncation_field_2_1'
+  table_1_id: 1
+
+row2:
+  field_1: 'truncation_field_1_2'
+  field_2: 'truncation_field_2_2'
+  table_1_id: 2

data/spec/test_db_setup/seeds/whitelisted_table_1.yml

@@ -0,0 +1,9 @@
+row1:
+  field_1: 'whitelisted_field_1_1'
+  field_2: 'whitelisted_field_2_1'
+  table_1_id: 1
+
+row2:
+  field_1: 'whitelisted_field_1_2'
+  field_2: 'whitelisted_field_2_2'
+  table_1_id: 2

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: db_obfuscation
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Case Commons, LLC
+- Rajat Agrawal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-21 00:00:00.000000000 Z
+dependencies: []
+description: |2
+   db_obfuscation is a gem that helps to prepare a production size obfuscated database. This obfuscated database can be used for internal testing purposes like user acceptance testing, QA/Regression testing. db_obfuscation takes a production database and updates data in every row in each table with fake data. db_obfuscation ensures that associations between different tables are still maintained.
+email:
+- casebook-dev@googlegroups.com
+- agrawal.rajat.89@gmail.com
+executables:
+- db_obfuscation
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- TODO
+- bin/console
+- bin/db_obfuscation
+- bin/obfuscation_test
+- cli/db_dump.rb
+- cli/migrator.rb
+- cli/seeder.rb
+- db_obfuscation.gemspec
+- features/bin/dump.feature
+- features/bin/obfuscation.feature
+- features/bin/test_database_tasks.feature
+- features/support.rb
+- lib/db_obfuscation.rb
+- lib/db_obfuscation/batch_formulator.rb
+- lib/db_obfuscation/config.rb
+- lib/db_obfuscation/database.rb
+- lib/db_obfuscation/environment.rb
+- lib/db_obfuscation/filtering.rb
+- lib/db_obfuscation/filtering/column.rb
+- lib/db_obfuscation/filtering/truncation.rb
+- lib/db_obfuscation/obfuscation_strategy.rb
+- lib/db_obfuscation/obfuscator.rb
+- lib/db_obfuscation/query_builder.rb
+- lib/db_obfuscation/truncation.rb
+- lib/db_obfuscation/util/trigger.rb
+- lib/db_obfuscation/version.rb
+- spec/cli/db_dump_spec.rb
+- spec/cli/migrator_spec.rb
+- spec/cli/seeder_spec.rb
+- spec/config/database.yml
+- spec/config/table_strategies/table_1.yml
+- spec/config/table_strategies/table_2.yml
+- spec/config/table_strategies/truncation_table_1.yml
+- spec/config/table_strategies/whitelisted_table_1.yml
+- spec/config/truncation_patterns.yml
+- spec/config/whitelisted_tables.yml
+- spec/db_obfuscation/batch_formulator_spec.rb
+- spec/db_obfuscation/config_spec.rb
+- spec/db_obfuscation/database_spec.rb
+- spec/db_obfuscation/filtering/column_spec.rb
+- spec/db_obfuscation/filtering/truncation_spec.rb
+- spec/db_obfuscation/filtering_spec.rb
+- spec/db_obfuscation/obfuscation_strategy_spec.rb
+- spec/db_obfuscation/obfuscator_spec.rb
+- spec/db_obfuscation/query_builder_spec.rb
+- spec/db_obfuscation/truncation_spec.rb
+- spec/db_obfuscation/util/trigger_spec.rb
+- spec/integration/obfuscation_spec.rb
+- spec/spec_helper.rb
+- spec/test_db_setup/migrations/1_add_table_1.rb
+- spec/test_db_setup/migrations/2_add_table_2.rb
+- spec/test_db_setup/migrations/3_add_truncation_table_1.rb
+- spec/test_db_setup/migrations/4_add_whitelisted_table_1.rb
+- spec/test_db_setup/migrations/5_add_table_without_any_user_defined_obfuscation_strategies.rb
+- spec/test_db_setup/migrations/6_add_table_without_any_obfuscatable_columns.rb
+- spec/test_db_setup/migrations/7_add_audit_truncation_table.rb
+- spec/test_db_setup/seeds/audit_truncation_table.yml
+- spec/test_db_setup/seeds/table_1.yml
+- spec/test_db_setup/seeds/table_2.yml
+- spec/test_db_setup/seeds/table_without_any_obfuscatable_columns.yml
+- spec/test_db_setup/seeds/table_without_any_user_defined_obfuscation_strategies.yml
+- spec/test_db_setup/seeds/truncation_table_1.yml
+- spec/test_db_setup/seeds/whitelisted_table_1.yml
+homepage: https://github.com/CaseCommonsDevOps/db_obfuscation
+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.4.2
+signing_key: 
+specification_version: 4
+summary: A gem to obfuscate a production database with fake values for testing with
+  a production size database
+test_files:
+- features/bin/dump.feature
+- features/bin/obfuscation.feature
+- features/bin/test_database_tasks.feature
+- features/support.rb
+- spec/cli/db_dump_spec.rb
+- spec/cli/migrator_spec.rb
+- spec/cli/seeder_spec.rb
+- spec/config/database.yml
+- spec/config/table_strategies/table_1.yml
+- spec/config/table_strategies/table_2.yml
+- spec/config/table_strategies/truncation_table_1.yml
+- spec/config/table_strategies/whitelisted_table_1.yml
+- spec/config/truncation_patterns.yml
+- spec/config/whitelisted_tables.yml
+- spec/db_obfuscation/batch_formulator_spec.rb
+- spec/db_obfuscation/config_spec.rb
+- spec/db_obfuscation/database_spec.rb
+- spec/db_obfuscation/filtering/column_spec.rb
+- spec/db_obfuscation/filtering/truncation_spec.rb
+- spec/db_obfuscation/filtering_spec.rb
+- spec/db_obfuscation/obfuscation_strategy_spec.rb
+- spec/db_obfuscation/obfuscator_spec.rb
+- spec/db_obfuscation/query_builder_spec.rb
+- spec/db_obfuscation/truncation_spec.rb
+- spec/db_obfuscation/util/trigger_spec.rb
+- spec/integration/obfuscation_spec.rb
+- spec/spec_helper.rb
+- spec/test_db_setup/migrations/1_add_table_1.rb
+- spec/test_db_setup/migrations/2_add_table_2.rb
+- spec/test_db_setup/migrations/3_add_truncation_table_1.rb
+- spec/test_db_setup/migrations/4_add_whitelisted_table_1.rb
+- spec/test_db_setup/migrations/5_add_table_without_any_user_defined_obfuscation_strategies.rb
+- spec/test_db_setup/migrations/6_add_table_without_any_obfuscatable_columns.rb
+- spec/test_db_setup/migrations/7_add_audit_truncation_table.rb
+- spec/test_db_setup/seeds/audit_truncation_table.yml
+- spec/test_db_setup/seeds/table_1.yml
+- spec/test_db_setup/seeds/table_2.yml
+- spec/test_db_setup/seeds/table_without_any_obfuscatable_columns.yml
+- spec/test_db_setup/seeds/table_without_any_user_defined_obfuscation_strategies.yml
+- spec/test_db_setup/seeds/truncation_table_1.yml
+- spec/test_db_setup/seeds/whitelisted_table_1.yml
+has_rdoc: