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 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
|
"""Test the helper objects in certbot_nginx._internal.obj."""
import itertools
import sys
import unittest
import pytest
class AddrTest(unittest.TestCase):
"""Test the Addr class."""
def setUp(self):
from certbot_nginx._internal.obj import Addr
self.addr1 = Addr.fromstring("192.168.1.1")
self.addr2 = Addr.fromstring("192.168.1.1:* ssl")
self.addr3 = Addr.fromstring("192.168.1.1:80")
self.addr4 = Addr.fromstring("*:80 default_server ssl")
self.addr5 = Addr.fromstring("myhost")
self.addr6 = Addr.fromstring("80 default_server spdy")
self.addr7 = Addr.fromstring("*:80 default ssl")
def test_fromstring(self):
assert self.addr1.get_addr() == "192.168.1.1"
assert self.addr1.get_port() == ""
assert self.addr1.ssl is False
assert self.addr1.default is False
assert self.addr2.get_addr() == "192.168.1.1"
assert self.addr2.get_port() == "*"
assert self.addr2.ssl is True
assert self.addr2.default is False
assert self.addr3.get_addr() == "192.168.1.1"
assert self.addr3.get_port() == "80"
assert self.addr3.ssl is False
assert self.addr3.default is False
assert self.addr4.get_addr() == "*"
assert self.addr4.get_port() == "80"
assert self.addr4.ssl is True
assert self.addr4.default is True
assert self.addr5.get_addr() == "myhost"
assert self.addr5.get_port() == ""
assert self.addr5.ssl is False
assert self.addr5.default is False
assert self.addr6.get_addr() == ""
assert self.addr6.get_port() == "80"
assert self.addr6.ssl is False
assert self.addr6.default is True
assert self.addr7.default is True
def test_fromstring_socket(self):
from certbot_nginx._internal.obj import Addr, SocketAddrError
socket_string = r"unix:/var/run/nginx.sock"
with pytest.raises(SocketAddrError, match=socket_string):
Addr.fromstring(socket_string)
def test_str(self):
assert str(self.addr1) == "192.168.1.1"
assert str(self.addr2) == "192.168.1.1:* ssl"
assert str(self.addr3) == "192.168.1.1:80"
assert str(self.addr4) == "*:80 default_server ssl"
assert str(self.addr5) == "myhost"
assert str(self.addr6) == "80 default_server"
assert str(self.addr7) == "*:80 default_server ssl"
def test_to_string(self):
assert self.addr1.to_string() == "192.168.1.1"
assert self.addr2.to_string() == "192.168.1.1:* ssl"
assert self.addr3.to_string() == "192.168.1.1:80"
assert self.addr4.to_string() == "*:80 default_server ssl"
assert self.addr4.to_string(include_default=False) == "*:80 ssl"
assert self.addr5.to_string() == "myhost"
assert self.addr6.to_string() == "80 default_server"
assert self.addr6.to_string(include_default=False) == "80"
def test_eq(self):
from certbot_nginx._internal.obj import Addr
new_addr1 = Addr.fromstring("192.168.1.1 spdy")
assert self.addr1 == new_addr1
assert self.addr1 != self.addr2
assert self.addr1 != 3333
def test_equivalent_any_addresses(self):
from certbot_nginx._internal.obj import Addr
any_addresses = ("0.0.0.0:80 default_server ssl",
"80 default_server ssl",
"*:80 default_server ssl",
"80 default ssl")
for first, second in itertools.combinations(any_addresses, 2):
assert Addr.fromstring(first) == Addr.fromstring(second)
# Also, make sure ports are checked.
assert Addr.fromstring(any_addresses[0]) != \
Addr.fromstring("0.0.0.0:443 default_server ssl")
# And they aren't equivalent to a specified address.
for any_address in any_addresses:
assert Addr.fromstring("192.168.1.2:80 default_server ssl") != \
Addr.fromstring(any_address)
def test_set_inclusion(self):
from certbot_nginx._internal.obj import Addr
set_a = {self.addr1, self.addr2}
addr1b = Addr.fromstring("192.168.1.1")
addr2b = Addr.fromstring("192.168.1.1:* ssl")
set_b = {addr1b, addr2b}
assert set_a == set_b
class VirtualHostTest(unittest.TestCase):
"""Test the VirtualHost class."""
def setUp(self):
from certbot_nginx._internal.obj import Addr
from certbot_nginx._internal.obj import VirtualHost
raw1 = [
['listen', '69.50.225.155:9000'],
[['if', '($scheme', '!=', '"https") '],
[['return', '301', 'https://$host$request_uri']]
],
['#', ' managed by Certbot']
]
self.vhost1 = VirtualHost(
"filep",
{Addr.fromstring("localhost")}, False, False,
{'localhost'}, raw1, [])
raw2 = [
['listen', '69.50.225.155:9000'],
[['if', '($scheme', '!=', '"https") '],
[['return', '301', 'https://$host$request_uri']]
]
]
self.vhost2 = VirtualHost(
"filep",
{Addr.fromstring("localhost")}, False, False,
{'localhost'}, raw2, [])
raw3 = [
['listen', '69.50.225.155:9000'],
['rewrite', '^(.*)$', '$scheme://www.domain.com$1', 'permanent']
]
self.vhost3 = VirtualHost(
"filep",
{Addr.fromstring("localhost")}, False, False,
{'localhost'}, raw3, [])
raw4 = [
['listen', '69.50.225.155:9000'],
['server_name', 'return.com']
]
self.vhost4 = VirtualHost(
"filp",
{Addr.fromstring("localhost")}, False, False,
{'localhost'}, raw4, [])
raw_has_hsts = [
['listen', '69.50.225.155:9000'],
['server_name', 'return.com'],
['add_header', 'always', 'set', 'Strict-Transport-Security', '\"max-age=31536000\"'],
]
self.vhost_has_hsts = VirtualHost(
"filep",
{Addr.fromstring("localhost")}, False, False,
{'localhost'}, raw_has_hsts, [])
def test_eq(self):
from certbot_nginx._internal.obj import Addr
from certbot_nginx._internal.obj import VirtualHost
vhost1b = VirtualHost(
"filep",
{Addr.fromstring("localhost blah")}, False, False,
{'localhost'}, [], [])
assert vhost1b == self.vhost1
assert str(vhost1b) == str(self.vhost1)
assert vhost1b != 1234
def test_str(self):
stringified = '\n'.join(['file: filep', 'addrs: localhost',
"names: ['localhost']", 'ssl: False',
'enabled: False'])
assert stringified == str(self.vhost1)
def test_has_header(self):
assert self.vhost_has_hsts.has_header('Strict-Transport-Security') is True
assert self.vhost_has_hsts.has_header('Bogus-Header') is False
assert self.vhost1.has_header('Strict-Transport-Security') is False
assert self.vhost1.has_header('Bogus-Header') is False
def test_contains_list(self):
from certbot_nginx._internal.configurator import _test_block_from_block
from certbot_nginx._internal.obj import Addr
from certbot_nginx._internal.obj import VirtualHost
test_block = [
['\n ', 'return', ' ', '301', ' ', 'https://$host$request_uri'],
['\n']
]
test_needle = _test_block_from_block(test_block)
test_haystack = [['listen', '80'], ['root', '/var/www/html'],
['index', 'index.html index.htm index.nginx-debian.html'],
['server_name', 'two.functorkitten.xyz'], ['listen', '443 ssl'],
['#', ' managed by Certbot'],
['ssl_certificate', '/etc/letsencrypt/live/two.functorkitten.xyz/fullchain.pem'],
['#', ' managed by Certbot'],
['ssl_certificate_key', '/etc/letsencrypt/live/two.functorkitten.xyz/privkey.pem'],
['#', ' managed by Certbot'],
['return', '301', 'https://$host$request_uri'],
['#', ' managed by Certbot'], []]
vhost_haystack = VirtualHost(
"filp",
{Addr.fromstring("localhost")}, False, False,
{'localhost'}, test_haystack, [])
test_bad_haystack = [['listen', '80'], ['root', '/var/www/html'],
['index', 'index.html index.htm index.nginx-debian.html'],
['server_name', 'two.functorkitten.xyz'], ['listen', '443 ssl'],
['#', ' managed by Certbot'],
['ssl_certificate', '/etc/letsencrypt/live/two.functorkitten.xyz/fullchain.pem'],
['#', ' managed by Certbot'],
['ssl_certificate_key', '/etc/letsencrypt/live/two.functorkitten.xyz/privkey.pem'],
['#', ' managed by Certbot'],
[['if', '($scheme', '!=', '"https")'],
[['return', '302', 'https://$host$request_uri']]
],
['#', ' managed by Certbot'], []]
vhost_bad_haystack = VirtualHost(
"filp",
{Addr.fromstring("localhost")}, False, False,
{'localhost'}, test_bad_haystack, [])
assert vhost_haystack.contains_list(test_needle)
assert not vhost_bad_haystack.contains_list(test_needle)
if __name__ == "__main__":
sys.exit(pytest.main(sys.argv[1:] + [__file__])) # pragma: no cover
|