File: lock_test.rb

package info (click to toggle)
ruby-with-advisory-lock 5.3.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 244 kB
  • sloc: ruby: 818; makefile: 14
file content (111 lines) | stat: -rw-r--r-- 3,202 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# frozen_string_literal: true

require 'test_helper'

class LockTest < GemTestCase
  setup do
    @lock_name = 'test lock'
    @return_val = 1900
  end

  test 'returns nil outside an advisory lock request' do
    assert_nil(Tag.current_advisory_lock)
  end

  test 'returns the name of the last lock acquired' do
    Tag.with_advisory_lock(@lock_name) do
      assert_match(/#{@lock_name}/, Tag.current_advisory_lock)
    end
  end

  test 'can obtain a lock with a name that attempts to disrupt a SQL comment' do
    dangerous_lock_name = 'test */ lock /*'
    Tag.with_advisory_lock(dangerous_lock_name) do
      assert_match(/#{Regexp.escape(dangerous_lock_name)}/, Tag.current_advisory_lock)
    end
  end

  test 'returns false for an unacquired lock' do
    refute(Tag.advisory_lock_exists?(@lock_name))
  end

  test 'returns true for an acquired lock' do
    Tag.with_advisory_lock(@lock_name) do
      assert(Tag.advisory_lock_exists?(@lock_name))
    end
  end

  test 'returns block return value if lock successful' do
    assert_equal(@return_val, Tag.with_advisory_lock!(@lock_name) { @return_val })
  end

  test 'returns false on lock acquisition failure' do
    thread_with_lock = Thread.new do
      Tag.with_advisory_lock(@lock_name, timeout_seconds: 0) do
        @locked_elsewhere = true
        loop { sleep 0.01 }
      end
    end

    sleep 0.01 until @locked_elsewhere
    assert_not(Tag.with_advisory_lock(@lock_name, timeout_seconds: 0) { @return_val })

    thread_with_lock.kill
  end

  test 'raises an error on lock acquisition failure' do
    thread_with_lock = Thread.new do
      Tag.with_advisory_lock(@lock_name, timeout_seconds: 0) do
        @locked_elsewhere = true
        loop { sleep 0.01 }
      end
    end

    sleep 0.01 until @locked_elsewhere
    assert_raises(WithAdvisoryLock::FailedToAcquireLock) do
      Tag.with_advisory_lock!(@lock_name, timeout_seconds: 0) { @return_val }
    end

    thread_with_lock.kill
  end

  test 'attempts the lock exactly once with no timeout' do
    expected = SecureRandom.base64
    actual = Tag.with_advisory_lock(@lock_name, 0) do
      expected
    end

    assert_equal(expected, actual)
  end

  test 'current_advisory_locks returns empty array outside an advisory lock request' do
    assert_equal([], Tag.current_advisory_locks)
  end

  test 'current_advisory_locks returns an array with names of the acquired locks' do
    Tag.with_advisory_lock(@lock_name) do
      locks = Tag.current_advisory_locks
      assert_equal(1, locks.size)
      assert_match(/#{@lock_name}/, locks.first)
    end
  end

  test 'current_advisory_locks returns array of all nested lock names' do
    first_lock = 'outer lock'
    second_lock = 'inner lock'

    Tag.with_advisory_lock(first_lock) do
      Tag.with_advisory_lock(second_lock) do
        locks = Tag.current_advisory_locks
        assert_equal(2, locks.size)
        assert_match(/#{first_lock}/, locks.first)
        assert_match(/#{second_lock}/, locks.last)
      end

      locks = Tag.current_advisory_locks
      assert_equal(1, locks.size)
      assert_match(/#{first_lock}/, locks.first)
    end
    assert_equal([], Tag.current_advisory_locks)
  end
end