boltless 1.0.0

data/spec/boltless/extensions/operations_spec.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Boltless::Extensions::Operations do
+  let(:described_class) { Boltless }
+
+  before { clean_neo4j! }
+
+  describe '.clear_database!' do
+    let(:action) { described_class.clear_database! }
+    let(:logger) { Logger.new(log_dev) }
+    let(:log_dev) { StringIO.new }
+    let(:log) { log_dev.string }
+
+    before do
+      described_class.configuration.logger = logger
+      described_class.add_index(name: 'user_id', for: '(n:User)', on: 'n.id')
+      described_class.add_constraint(name: 'uniq_user_email', for: '(n:User)',
+                                     require: 'n.email IS UNIQUE')
+      described_class.one_shot! do |tx|
+        tx.add('CREATE (n:User { name: $name })', name: 'Klaus')
+        tx.add('CREATE (n:User { name: $name })', name: 'Bernd')
+        tx.add('MATCH (a:User { name: $a_name }) ' \
+               'MATCH (b:User { name: $b_name }) ' \
+               'CREATE (a)-[:FRIEND_OF { since: $since }]->(b)',
+               a_name: 'Klaus', b_name: 'Bernd', since: Date.today.to_s)
+      end
+    end
+
+    it 'removes all indexes' do
+      expect { action }.to \
+        change { described_class.index_names.count }.from(1).to(0)
+    end
+
+    it 'removes all constraints' do
+      expect { action }.to \
+        change { described_class.constraint_names.count }.from(1).to(0)
+    end
+
+    it 'removes all nodes' do
+      expect { action }.to \
+        change { described_class.query!('MATCH (n) RETURN count(n)').value }
+        .from(2).to(0)
+    end
+
+    it 'removes all relationships' do
+      check = proc do
+        described_class.query!('MATCH (a)-[r]->(b) RETURN type(r) AS type')
+                       .count
+      end
+      expect { action }.to change(&check).from(1).to(0)
+    end
+
+    it 'logs the removed indexes' do
+      action
+      expect(log).to include('Drop neo4j index user_id')
+    end
+
+    it 'logs the removed constraints' do
+      action
+      expect(log).to include('Drop neo4j constraint uniq_user_email')
+    end
+
+    it 'logs the removed nodes count' do
+      action
+      expect(log).to include('Nodes deleted: 2')
+    end
+
+    it 'logs the removed relationships count' do
+      action
+      expect(log).to include('Relationships deleted: 1')
+    end
+  end
+
+  describe '.component_name_present?' do
+    before do
+      described_class.add_index(name: 'user_id', for: '(n:User)', on: 'n.id')
+      described_class.add_constraint(name: 'uniq_user_email', for: '(n:User)',
+                                     require: 'n.email IS UNIQUE')
+    end
+
+    context 'with an known index' do
+      it 'returns true' do
+        expect(described_class.component_name_present?('user_id')).to \
+          be_eql(true)
+      end
+    end
+
+    context 'with an known constraint' do
+      it 'returns true' do
+        expect(described_class.component_name_present?('uniq_user_email')).to \
+          be_eql(true)
+      end
+    end
+
+    context 'with an unknown name' do
+      it 'returns false' do
+        expect(described_class.component_name_present?('unknown')).to \
+          be_eql(false)
+      end
+    end
+  end
+
+  describe '.index_names' do
+    before do
+      described_class.add_index(name: 'user_id', for: '(n:User)', on: 'n.id')
+      described_class.add_index(name: 'session_id', for: '(n:Session)',
+                                on: 'n.id')
+    end
+
+    it 'returns the known index names' do
+      expect(described_class.index_names).to \
+        match_array(%w[user_id session_id])
+    end
+  end
+
+  describe '.constraint_names' do
+    before do
+      described_class.add_constraint(name: 'uniq_user_email',
+                                     for: '(n:User)',
+                                     require: 'n.email IS UNIQUE')
+      described_class.add_constraint(name: 'uniq_user_session',
+                                     for: '(n:Session)',
+                                     require: 'n.user_id IS UNIQUE')
+    end
+
+    it 'returns the known constraint names' do
+      expect(described_class.constraint_names).to \
+        match_array(%w[uniq_user_email uniq_user_session])
+    end
+  end
+
+  describe '.add_index' do
+    it 'allows to create a new index' do
+      described_class.add_index(name: 'user_id', for: '(n:User)', on: 'n.id')
+      expect(described_class.index_names).to match_array(['user_id'])
+    end
+  end
+
+  describe '.drop_index' do
+    before do
+      described_class.add_index(name: 'user_id', for: '(n:User)', on: 'n.id')
+    end
+
+    context 'with an existing index' do
+      it 'allows to drop an index' do
+        described_class.drop_index('user_id')
+        expect(described_class.index_names).to match_array([])
+      end
+    end
+
+    context 'without an existing index' do
+      it 'does not raise errors' do
+        expect { described_class.drop_index('unknown') }.not_to raise_error
+      end
+    end
+  end
+
+  describe '.add_constraint' do
+    it 'allows to create a new constraint' do
+      described_class.add_constraint(name: 'uniq_user_email', for: '(n:User)',
+                                     require: 'n.email IS UNIQUE')
+      expect(described_class.constraint_names).to \
+        match_array(['uniq_user_email'])
+    end
+  end
+
+  describe '.drop_constraint' do
+    before do
+      described_class.add_constraint(name: 'uniq_user_email', for: '(n:User)',
+                                     require: 'n.email IS UNIQUE')
+    end
+
+    context 'with an existing constraint' do
+      it 'allows to drop an constraint' do
+        described_class.drop_constraint('uniq_user_email')
+        expect(described_class.constraint_names).to match_array([])
+      end
+    end
+
+    context 'without an existing constraint' do
+      it 'does not raise errors' do
+        expect { described_class.drop_constraint('unknown') }.not_to \
+          raise_error
+      end
+    end
+  end
+end

data/spec/boltless/extensions/transactions_spec.rb

@@ -0,0 +1,418 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Boltless::Extensions::Transactions do
+  let(:described_class) { Boltless }
+  let(:access_mode) { :write }
+  let(:statement_payload) do
+    cypher, params = statement
+    [cypher, (params || {}).merge(opts)]
+  end
+  let(:statement_payloads) do
+    statements.map do |(cypher, params)|
+      [cypher, (params || {}).merge(opts)]
+    end
+  end
+  let(:opts) { {} }
+  let(:create_users) do
+    Boltless.one_shot! do |tx|
+      %w[Bernd Klaus Uwe Monika].each do |name|
+        tx.add('CREATE (n:User { name: $name })', name: name)
+      end
+    end
+  end
+  let(:create_user_statement) do
+    ['CREATE (n:User { name: $name })', { name: 'Silke' }]
+  end
+  let(:fetch_users_statement) do
+    ['MATCH (n:User) RETURN n.name AS name', {}]
+  end
+  let(:count_users_statement) do
+    ['MATCH (n:User) RETURN count(n) AS count', {}]
+  end
+  let(:statement_with_syntax_errors) do
+    ['SOME THING!', {}]
+  end
+  let(:fetch_date_statement) do
+    ['RETURN date() AS date', {}]
+  end
+  let(:fetch_static_number_statement) do
+    ['RETURN 9867 AS number', {}]
+  end
+
+  before { clean_neo4j! }
+
+  describe '.execute!' do
+    let(:action) do
+      cypher, args = statement_payload
+      described_class.execute!(cypher, **args)
+    end
+
+    context 'with Cypher syntax errors' do
+      let(:statement) { statement_with_syntax_errors }
+
+      it 'raises an Boltless::Errors::TransactionRollbackError' do
+        expect { action }.to \
+          raise_error(Boltless::Errors::TransactionRollbackError,
+                      /invalid input/i)
+      end
+    end
+
+    context 'with multiple rows' do
+      let(:statement) { fetch_users_statement }
+
+      before { create_users }
+
+      it 'returns the user names' do
+        expect(action.pluck(:name)).to \
+          match_array(%w[Bernd Klaus Uwe Monika])
+      end
+
+      it 'returns a Boltless::Result' do
+        expect(action).to be_a(Boltless::Result)
+      end
+    end
+
+    context 'with write operations on a read-only transaction' do
+      let(:statement) { create_user_statement }
+      let(:opts) { { access_mode: :read } }
+
+      it 'raises an Boltless::Errors::TransactionRollbackError' do
+        expect { action }.to \
+          raise_error(Boltless::Errors::TransactionRollbackError,
+                      /Neo.ClientError.Request.Invalid/i)
+      end
+    end
+  end
+
+  describe '.execute' do
+    let(:action) do
+      cypher, args = statement_payload
+      described_class.execute(cypher, **args)
+    end
+
+    context 'with Cypher syntax errors' do
+      let(:statement) { statement_with_syntax_errors }
+
+      it 'returns nil' do
+        expect(action).to be(nil)
+      end
+    end
+
+    context 'with multiple rows' do
+      let(:statement) { fetch_users_statement }
+
+      before { create_users }
+
+      it 'returns the user names' do
+        expect(action.pluck(:name)).to \
+          match_array(%w[Bernd Klaus Uwe Monika])
+      end
+
+      it 'returns a Boltless::Result' do
+        expect(action).to be_a(Boltless::Result)
+      end
+    end
+
+    context 'with write operations on a read-only transaction' do
+      let(:statement) { create_user_statement }
+      let(:opts) { { access_mode: :read } }
+
+      it 'returns nil' do
+        expect(action).to be(nil)
+      end
+    end
+  end
+
+  describe '.one_shot!' do
+    let(:action) do
+      described_class.one_shot!(access_mode) do |tx|
+        statement_payloads.each { |cypher, args| tx.add(cypher, **args) }
+      end
+    end
+
+    context 'with an error in between' do
+      let(:statements) do
+        [
+          create_user_statement,
+          statement_with_syntax_errors,
+          create_user_statement,
+          fetch_users_statement
+        ]
+      end
+
+      it 'raises an Boltless::Errors::TransactionRollbackError' do
+        expect { action }.to \
+          raise_error(Boltless::Errors::TransactionRollbackError,
+                      /Neo.ClientError.Statement.SyntaxError/i)
+      end
+
+      it 'rolls back the transaction (no data is written)' do
+        suppress(StandardError) { action }
+        cypher, args = count_users_statement
+        expect(described_class.execute!(cypher, **args).value).to be_eql(0)
+      end
+    end
+
+    context 'with multiple statements' do
+      let(:statements) do
+        [
+          create_user_statement,
+          create_user_statement,
+          create_user_statement,
+          count_users_statement
+        ]
+      end
+
+      it 'returns 4 results (one for each statement)' do
+        expect(action.count).to be_eql(4)
+      end
+
+      it 'returns the correct created user count' do
+        expect(action.last.value).to be_eql(3)
+      end
+    end
+  end
+
+  describe '.one_shot' do
+    let(:action) do
+      described_class.one_shot(access_mode) do |tx|
+        statement_payloads.each { |cypher, args| tx.add(cypher, **args) }
+      end
+    end
+
+    context 'with an error in between' do
+      let(:statements) do
+        [
+          create_user_statement,
+          statement_with_syntax_errors,
+          create_user_statement,
+          fetch_users_statement
+        ]
+      end
+
+      it 'returns nil' do
+        expect(action).to be(nil)
+      end
+
+      it 'rolls back the transaction (no data is written)' do
+        suppress(StandardError) { action }
+        cypher, args = count_users_statement
+        expect(described_class.execute!(cypher, **args).value).to be_eql(0)
+      end
+    end
+
+    context 'with multiple statements' do
+      let(:statements) do
+        [
+          create_user_statement,
+          create_user_statement,
+          create_user_statement,
+          count_users_statement
+        ]
+      end
+
+      it 'returns 4 results (one for each statement)' do
+        expect(action.count).to be_eql(4)
+      end
+
+      it 'returns the correct created user count' do
+        expect(action.last.value).to be_eql(3)
+      end
+    end
+  end
+
+  describe '.transaction!' do
+    let(:action) { described_class.transaction!(access_mode, &user_block) }
+
+    context 'with an error in between' do
+      let(:user_block) do
+        proc do |tx|
+          cypher, args = create_user_statement
+          tx.run!(cypher, **args)
+
+          cypher, args = statement_with_syntax_errors
+          tx.run!(cypher, **args)
+        end
+      end
+
+      it 'raises an Boltless::Errors::TransactionRollbackError' do
+        expect { action }.to \
+          raise_error(Boltless::Errors::TransactionRollbackError,
+                      /Neo.ClientError.Statement.SyntaxError/i)
+      end
+
+      it 'rolls back the transaction (no data is written)' do
+        suppress(StandardError) { action }
+        cypher, args = count_users_statement
+        expect(described_class.execute!(cypher, **args).value).to \
+          be_eql(0)
+      end
+    end
+
+    context 'with manual rollback (without raised errors)' do
+      let(:user_block) do
+        proc do |tx|
+          cypher, args = create_user_statement
+          tx.run!(cypher, **args)
+          tx.rollback!
+        end
+      end
+
+      it 'returns true' do
+        expect(action).to be_eql(true)
+      end
+
+      it 'rolls back the transaction (no data is written)' do
+        suppress(StandardError) { action }
+        cypher, args = count_users_statement
+        expect(described_class.execute!(cypher, **args).value).to be_eql(0)
+      end
+    end
+
+    context 'with manual commit (without raised errors)' do
+      let(:user_block) do
+        proc do |tx|
+          cypher, args = create_user_statement
+          tx.run!(cypher, **args)
+          tx.commit!
+        end
+      end
+
+      it 'returns an empty array (due to no finalization statements given)' do
+        expect(action).to match_array([])
+      end
+
+      it 'completed the transaction (data is written)' do
+        suppress(StandardError) { action }
+        cypher, args = count_users_statement
+        expect(described_class.execute!(cypher, **args).value).to be_eql(1)
+      end
+    end
+
+    context 'with intermediate results' do
+      # rubocop:disable RSpec/MultipleExpectations because of the
+      #   in-block testing
+      # rubocop:disable RSpec/ExampleLength dito
+      it 'allows direct access to each result' do
+        Boltless.transaction! do |tx|
+          cypher, args = fetch_date_statement
+          expect(tx.run!(cypher, **args).value).to be_eql(Date.today.to_s)
+
+          cypher, args = fetch_static_number_statement
+          expect(tx.run!(cypher, **args).value).to be_eql(9867)
+        end
+      end
+      # rubocop:enable RSpec/MultipleExpectations
+      # rubocop:enable RSpec/ExampleLength
+    end
+  end
+
+  describe '.transaction' do
+    let(:action) { described_class.transaction(access_mode, &user_block) }
+
+    context 'with an error in between (not raised)' do
+      let(:user_block) do
+        proc do |tx|
+          cypher, args = create_user_statement
+          tx.run(cypher, **args)
+
+          cypher, args = statement_with_syntax_errors
+          tx.run(cypher, **args)
+        end
+      end
+
+      it 'returns nil' do
+        expect(action).to be(nil)
+      end
+
+      it 'rolls back the transaction (no data is written)' do
+        suppress(StandardError) { action }
+        cypher, args = count_users_statement
+        expect(described_class.execute!(cypher, **args).value).to be_eql(0)
+      end
+    end
+
+    context 'with an error in between (raised)' do
+      let(:user_block) do
+        proc do |tx|
+          cypher, args = create_user_statement
+          tx.run(cypher, **args)
+
+          cypher, args = statement_with_syntax_errors
+          tx.run!(cypher, **args)
+        end
+      end
+
+      it 'raises an Boltless::Errors::TransactionRollbackError' do
+        expect { action }.to \
+          raise_error(Boltless::Errors::TransactionRollbackError,
+                      /Neo.ClientError.Statement.SyntaxError/i)
+      end
+
+      it 'rolls back the transaction (no data is written)' do
+        suppress(StandardError) { action }
+        cypher, args = count_users_statement
+        expect(described_class.execute!(cypher, **args).value).to be_eql(0)
+      end
+    end
+
+    context 'with manual rollback (without raised errors)' do
+      let(:user_block) do
+        proc do |tx|
+          cypher, args = create_user_statement
+          tx.run(cypher, **args)
+          tx.rollback
+        end
+      end
+
+      it 'returns true' do
+        expect(action).to be_eql(true)
+      end
+
+      it 'rolls back the transaction (no data is written)' do
+        suppress(StandardError) { action }
+        cypher, args = count_users_statement
+        expect(described_class.execute!(cypher, **args).value).to be_eql(0)
+      end
+    end
+
+    context 'with manual commit (without raised errors)' do
+      let(:user_block) do
+        proc do |tx|
+          cypher, args = create_user_statement
+          tx.run(cypher, **args)
+          tx.commit
+        end
+      end
+
+      it 'returns an empty array (due to no finalization statements given)' do
+        expect(action).to match_array([])
+      end
+
+      it 'completed the transaction (data is written)' do
+        suppress(StandardError) { action }
+        cypher, args = count_users_statement
+        expect(described_class.execute!(cypher, **args).value).to be_eql(1)
+      end
+    end
+
+    context 'with intermediate results' do
+      # rubocop:disable RSpec/MultipleExpectations because of the
+      #   in-block testing
+      # rubocop:disable RSpec/ExampleLength dito
+      it 'allows direct access to each result' do
+        Boltless.transaction do |tx|
+          cypher, args = fetch_date_statement
+          expect(tx.run(cypher, **args).value).to be_eql(Date.today.to_s)
+
+          cypher, args = fetch_static_number_statement
+          expect(tx.run(cypher, **args).value).to be_eql(9867)
+        end
+      end
+      # rubocop:enable RSpec/MultipleExpectations
+      # rubocop:enable RSpec/ExampleLength
+    end
+  end
+end