summaryrefslogtreecommitdiff
path: root/google_compute_engine/ip_forwarding/tests/ip_forwarding_utils_test.py
blob: 18774a691d01593e206917f5d2a12d2ede711411 (plain)
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
#!/usr/bin/python
# Copyright 2016 Google Inc. All Rights Reserved.
#
# Licensed 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.

"""Unittest for ip_forwarding_utils.py module."""

from google_compute_engine.ip_forwarding import ip_forwarding_utils
from google_compute_engine.test_compat import builtin
from google_compute_engine.test_compat import mock
from google_compute_engine.test_compat import unittest


def _CreateMockProcess(returncode, stdout, stderr):
  mock_process = mock.Mock()
  mock_process.returncode = returncode
  mock_process.communicate.return_value = (stdout, stderr)
  return mock_process


class IpForwardingUtilsTest(unittest.TestCase):

  def setUp(self):
    self.mock_logger = mock.Mock()
    self.options = {'hello': 'world'}
    with mock.patch(
        'google_compute_engine.ip_forwarding.ip_forwarding_utils'
        '.subprocess') as mock_subprocess:
      mock_subprocess.Popen.return_value = _CreateMockProcess(
          0, b'out', b'')
      self.mock_utils = ip_forwarding_utils.IpForwardingUtils(
          self.mock_logger)
    self.mock_utils.proto_id = 'proto'

  def testCreateRouteOptions(self):
    # Default options.
    expected_options = {
        'proto': 'proto',
        'scope': 'host',
    }
    self.assertEqual(self.mock_utils._CreateRouteOptions(), expected_options)

    # Update dictionary when arguments are specified.
    expected_options = {
        'proto': 'proto',
        'scope': 'host',
        'num': 1,
        'string': 'hello world',
    }
    self.assertEqual(
        self.mock_utils._CreateRouteOptions(num=1, string='hello world'),
        expected_options)

    # Update the default options.
    expected_options = {
        'proto': 'test 1',
        'scope': 'test 2',
    }
    self.assertEqual(
        self.mock_utils._CreateRouteOptions(proto='test 1', scope='test 2'),
        expected_options)

  @mock.patch('google_compute_engine.ip_forwarding.ip_forwarding_utils.subprocess')
  def testRunIpRoute(self, mock_subprocess):
    mock_process = _CreateMockProcess(0, b'out', b'')
    mock_subprocess.Popen.return_value = mock_process
    args = ['foo', 'bar']
    options = {'one': 'two'}

    self.assertEqual(
        self.mock_utils._RunIpRoute(args=args, options=options), 'out')
    command = ['ip', 'route', 'foo', 'bar', 'one', 'two']
    mock_subprocess.Popen.assert_called_once_with(
        command, stdout=mock_subprocess.PIPE, stderr=mock_subprocess.PIPE)
    mock_process.communicate.assert_called_once_with()
    self.mock_logger.warning.assert_not_called()

  @mock.patch('google_compute_engine.ip_forwarding.ip_forwarding_utils.subprocess')
  def testRunIpRouteReturnCode(self, mock_subprocess):
    mock_process = _CreateMockProcess(1, b'out', b'error\n')
    mock_subprocess.Popen.return_value = mock_process

    self.assertEqual(
        self.mock_utils._RunIpRoute(args=['foo', 'bar'], options=self.options),
        '')
    command = ['ip', 'route', 'foo', 'bar', 'hello', 'world']
    self.mock_logger.warning.assert_called_once_with(mock.ANY, command, b'error')

  @mock.patch('google_compute_engine.ip_forwarding.ip_forwarding_utils.subprocess')
  def testRunIpRouteException(self, mock_subprocess):
    mock_subprocess.Popen.side_effect = OSError('Test Error')

    self.assertEqual(
        self.mock_utils._RunIpRoute(args=['foo', 'bar'], options=self.options),
        '')
    command = ['ip', 'route', 'foo', 'bar', 'hello', 'world']
    self.mock_logger.warning.assert_called_once_with(
        mock.ANY, command, 'Test Error')

  def testParseForwardedIps(self):
    self.assertEqual(self.mock_utils.ParseForwardedIps(None), [])
    self.assertEqual(self.mock_utils.ParseForwardedIps([]), [])
    self.assertEqual(self.mock_utils.ParseForwardedIps([None]), [])
    self.assertEqual(self.mock_utils.ParseForwardedIps(['invalid']), [])
    self.assertEqual(self.mock_utils.ParseForwardedIps(['1a1a1a1']), [])
    self.assertEqual(self.mock_utils.ParseForwardedIps(['1.1.1.1.1']), [])
    self.assertEqual(self.mock_utils.ParseForwardedIps(['1111.1.1.1']), [])
    self.assertEqual(self.mock_utils.ParseForwardedIps(['1.1.1.1111']), [])
    expected_calls = [
        mock.call.warning(mock.ANY, None),
        mock.call.warning(mock.ANY, 'invalid'),
        mock.call.warning(mock.ANY, '1a1a1a1'),
        mock.call.warning(mock.ANY, '1.1.1.1.1'),
        mock.call.warning(mock.ANY, '1111.1.1.1'),
        mock.call.warning(mock.ANY, '1.1.1.1111'),
    ]
    self.assertEqual(self.mock_logger.mock_calls, expected_calls)

  def testParseForwardedIpsComplex(self):
    forwarded_ips = {
        '{{}}\n\"hello\"\n!@#$%^&*()\n\n': False,
        '1111.1.1.1': False,
        '1.1.1.1': True,
        'hello': False,
        '123.123.123.123': True,
        '1.1.1.': False,
        '1.1.1.a': False,
        None: False,
        '1.0.0.0': True,
    }
    input_ips = forwarded_ips.keys()
    valid_ips = [ip for ip, valid in forwarded_ips.items() if valid]
    invalid_ips = [ip for ip, valid in forwarded_ips.items() if not valid]

    self.assertEqual(self.mock_utils.ParseForwardedIps(input_ips), valid_ips)
    expected_calls = [mock.call.warning(mock.ANY, ip) for ip in invalid_ips]
    self.assertEqual(self.mock_logger.mock_calls, expected_calls)

  def testGetForwardedIps(self):
    mock_options = mock.Mock()
    mock_options.return_value = self.options
    mock_run = mock.Mock()
    mock_run.return_value = 'a\nb\n'
    mock_parse = mock.Mock()
    mock_parse.return_value = ['Test']
    self.mock_utils._CreateRouteOptions = mock_options
    self.mock_utils._RunIpRoute = mock_run
    self.mock_utils.ParseForwardedIps = mock_parse

    self.assertEqual(self.mock_utils.GetForwardedIps('interface'), ['Test'])
    mock_options.assert_called_once_with(dev='interface')
    mock_run.assert_called_once_with(
        args=['ls', 'table', 'local', 'type', 'local'], options=self.options)
    mock_parse.assert_called_once_with(['a', 'b'])

  def testAddForwardedIp(self):
    mock_options = mock.Mock()
    mock_options.return_value = self.options
    mock_run = mock.Mock()
    self.mock_utils._CreateRouteOptions = mock_options
    self.mock_utils._RunIpRoute = mock_run

    self.mock_utils.AddForwardedIp('1.1.1.1', 'interface')
    mock_options.assert_called_once_with(dev='interface')
    mock_run.assert_called_once_with(
        args=['add', 'to', 'local', '1.1.1.1/32'], options=self.options)

  def testRemoveForwardedIp(self):
    mock_options = mock.Mock()
    mock_options.return_value = self.options
    mock_run = mock.Mock()
    self.mock_utils._CreateRouteOptions = mock_options
    self.mock_utils._RunIpRoute = mock_run

    self.mock_utils.RemoveForwardedIp('1.1.1.1', 'interface')
    mock_options.assert_called_once_with(dev='interface')
    mock_run.assert_called_once_with(
        args=['delete', 'to', 'local', '1.1.1.1/32'], options=self.options)


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