beam/sdks/python/apache_beam/io/components/rate_limiter_test.py at 5f1ae53fd392de55b8efd0511c04e69770e44add · tarun-google/beam · GitHub

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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

import unittest
from datetime import timedelta
from unittest import mock

import grpc
from envoy_data_plane.envoy.service.ratelimit.v3 import RateLimitResponse
from envoy_data_plane.envoy.service.ratelimit.v3 import RateLimitResponseCode
from envoy_data_plane.envoy.service.ratelimit.v3 import RateLimitResponseDescriptorStatus

from apache_beam.io.components import rate_limiter


class EnvoyRateLimiterTest(unittest.TestCase):
  def setUp(self):
    self.service_address = 'localhost:8081'
    self.domain = 'test_domain'
    self.descriptors = [{'key': 'value'}]
    self.limiter = rate_limiter.EnvoyRateLimiter(
        self.service_address,
        self.domain,
        self.descriptors,
        timeout=0.1,  # Fast timeout for tests
        block_until_allowed=False,
        retries=2,
        namespace='test_namespace')

  @mock.patch('grpc.insecure_channel')
  def test_allow_success(self, mock_channel):
    # Mock successful OK response
    mock_stub = mock.Mock()
    mock_response = RateLimitResponse(overall_code=RateLimitResponseCode.OK)
    mock_stub.ShouldRateLimit.return_value = mock_response

    # Inject mock stub
    self.limiter._stub = mock_stub

    allowed = self.limiter.allow()

    self.assertTrue(allowed)
    mock_stub.ShouldRateLimit.assert_called_once()

  @mock.patch('grpc.insecure_channel')
  def test_allow_over_limit_retries_exceeded(self, mock_channel):
    # Mock OVER_LIMIT response
    mock_stub = mock.Mock()
    mock_response = RateLimitResponse(
        overall_code=RateLimitResponseCode.OVER_LIMIT)
    mock_stub.ShouldRateLimit.return_value = mock_response

    self.limiter._stub = mock_stub
    # block_until_allowed is False, so it should eventually return False

    # We mock time.sleep to run fast
    with mock.patch('time.sleep'):
      allowed = self.limiter.allow()

    self.assertFalse(allowed)
    # Should be called 1 (initial) + 2 (retries) + 1 (last check > retries
    # logic depends on loop)
    # Logic: attempt starts at 0.
    # Loop 1: attempt 0. status OVER_LIMIT. sleep. attempt becomes 1.
    # Loop 2: attempt 1. status OVER_LIMIT. sleep. attempt becomes 2.
    # Loop 3: attempt 2. status OVER_LIMIT. sleep. attempt becomes 3.
    # Loop 4: attempt 3 > retries(2). Break.
    # Total calls: 3
    self.assertEqual(mock_stub.ShouldRateLimit.call_count, 3)

  @mock.patch('grpc.insecure_channel')
  def test_allow_rpc_error_retry(self, mock_channel):
    # Mock RpcError then Success
    mock_stub = mock.Mock()
    mock_response = RateLimitResponse(overall_code=RateLimitResponseCode.OK)

    # Side effect: Error, Error, Success
    error = grpc.RpcError()
    mock_stub.ShouldRateLimit.side_effect = [error, error, mock_response]

    self.limiter._stub = mock_stub

    with mock.patch('time.sleep'):
      allowed = self.limiter.allow()

    self.assertTrue(allowed)
    self.assertEqual(mock_stub.ShouldRateLimit.call_count, 3)

  @mock.patch('grpc.insecure_channel')
  def test_allow_rpc_error_fail(self, mock_channel):
    # Mock Persistent RpcError
    mock_stub = mock.Mock()
    error = grpc.RpcError()
    mock_stub.ShouldRateLimit.side_effect = error

    self.limiter._stub = mock_stub

    with mock.patch('time.sleep'):
      with self.assertRaises(grpc.RpcError):
        self.limiter.allow()

    # The inner loop tries 5 times for connection errors
    self.assertEqual(mock_stub.ShouldRateLimit.call_count, 5)

  @mock.patch('grpc.insecure_channel')
  @mock.patch('random.uniform', return_value=0.0)
  def test_extract_duration_from_response(self, mock_random, mock_channel):
    # Mock OVER_LIMIT with specific duration
    mock_stub = mock.Mock()

    # Valid until 5 seconds
    status = RateLimitResponseDescriptorStatus(
        code=RateLimitResponseCode.OVER_LIMIT,
        duration_until_reset=timedelta(seconds=5))
    mock_response = RateLimitResponse(
        overall_code=RateLimitResponseCode.OVER_LIMIT, statuses=[status])

    mock_stub.ShouldRateLimit.return_value = mock_response
    self.limiter._stub = mock_stub
    self.limiter.retries = 0  # Single attempt

    with mock.patch('time.sleep') as mock_sleep:
      self.limiter.allow()
      # Should sleep for 5 seconds (jitter is 0.0)
      mock_sleep.assert_called_with(5.0)


if __name__ == '__main__':
  unittest.main()