starred/certbot-certbot-2
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-08-01 08:08:00 +02:00
Code Issues Packages Projects Releases Wiki Activity

Satisfy pylint on various points

Browse Source
This commit is contained in:
Seth Schoen
2015-02-08 11:06:04 -08:00
parent 304ffab112
commit 76fb3b54e2
2 changed files with 47 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
letsencrypt/client/standalone_authenticator.py
+11 -10
View File
@@ -53,7 +53,8 @@ def pack_3bytes(value):
# Exclude this function from coverage testing because it is currently # Exclude this function from coverage testing because it is currently
# not used. # not used.
def tls_parse_client_hello(tls_record): # pragma: no cover def tls_parse_client_hello(tls_record): # pragma: no cover
# pylint: disable=too-many-return-statements # pylint: disable=too-many-return-statements,too-many-locals,bad-builtin
# pylint: disable=too-many-branches
"""If possible, parse the specified TLS record as a ClientHello and """If possible, parse the specified TLS record as a ClientHello and
return the first host_name indicated in a Server Name Indication return the first host_name indicated in a Server Name Indication
extension within that ClientHello. If the TLS record could not extension within that ClientHello. If the TLS record could not
@@ -228,6 +229,7 @@ def tls_generate_server_hello_done():
class StandaloneAuthenticator(object): class StandaloneAuthenticator(object):
# pylint: disable=too-many-instance-attributes
"""The StandaloneAuthenticator class itself, which can be invoked """The StandaloneAuthenticator class itself, which can be invoked
by the Let's Encrypt client according to the IAuthenticator API by the Let's Encrypt client according to the IAuthenticator API
interface.""" interface."""
@@ -236,9 +238,7 @@ class StandaloneAuthenticator(object):
def __init__(self): def __init__(self):
self.child_pid = None self.child_pid = None
self.parent_pid = os.getpid() self.parent_pid = os.getpid()
self.subproc_ready = False self.subproc_state = None
self.subproc_inuse = False
self.subproc_cantbind = False
self.tasks = {} self.tasks = {}
self.sock = None self.sock = None
self.connection = None self.connection = None
@@ -254,11 +254,11 @@ class StandaloneAuthenticator(object):
# subprocess → client INUSE : SIGUSR1 # subprocess → client INUSE : SIGUSR1
# subprocess → client CANTBIND: SIGUSR2 # subprocess → client CANTBIND: SIGUSR2
if sig == signal.SIGIO: if sig == signal.SIGIO:
self.subproc_ready = True self.subproc_state = "ready"
elif sig == signal.SIGUSR1: elif sig == signal.SIGUSR1:
self.subproc_inuse = True self.subproc_state = "inuse"
elif sig == signal.SIGUSR2: elif sig == signal.SIGUSR2:
self.subproc_cantbind = True self.subproc_state = "cantbind"
else: else:
# NOTREACHED # NOTREACHED
assert False assert False
@@ -323,15 +323,15 @@ class StandaloneAuthenticator(object):
display = zope.component.getUtility(interfaces.IDisplay) display = zope.component.getUtility(interfaces.IDisplay)
start_time = time.time() start_time = time.time()
while time.time() < start_time + delay_amount: while time.time() < start_time + delay_amount:
if self.subproc_ready: if self.subproc_state == "ready":
return True return True
if self.subproc_inuse: if self.subproc_state == "inuse":
display.generic_notification( display.generic_notification(
"Could not bind TCP port {} because it is already in " "Could not bind TCP port {} because it is already in "
"use it is already in use by another process on this " "use it is already in use by another process on this "
"system (such as a web server).".format(port)) "system (such as a web server).".format(port))
return False return False
if self.subproc_cantbind: if self.subproc_state == "cantbind":
display.generic_notification( display.generic_notification(
"Could not bind TCP port {} because you don't have " "Could not bind TCP port {} because you don't have "
"the appropriate permissions (for example, you " "the appropriate permissions (for example, you "
@@ -437,6 +437,7 @@ class StandaloneAuthenticator(object):
# IAuthenticator method implementations follow # IAuthenticator method implementations follow
def get_chall_pref(self, unused_domain): def get_chall_pref(self, unused_domain):
# pylint: disable=no-self-use
"""IAuthenticator interface method: Return a list of challenge """IAuthenticator interface method: Return a list of challenge
types that this authenticator can perform for this domain. In types that this authenticator can perform for this domain. In
the case of the StandaloneAuthenticator, the only challenge the case of the StandaloneAuthenticator, the only challenge
letsencrypt/client/tests/standalone_authenticator_test.py
+36 -24
View File
@@ -13,6 +13,7 @@ from letsencrypt.client.challenge_util import DvsniChall
# http://igorsobreira.com/2013/03/17/testing-infinite-loops.html # http://igorsobreira.com/2013/03/17/testing-infinite-loops.html
class SocketAcceptOnlyNTimes(object): class SocketAcceptOnlyNTimes(object):
# pylint: disable=too-few-public-methods
""" """
Callable that will raise `CallableExhausted` Callable that will raise `CallableExhausted`
exception after `limit` calls, modified to also return exception after `limit` calls, modified to also return
@@ -31,6 +32,7 @@ class SocketAcceptOnlyNTimes(object):
return (mock.MagicMock(), "ignored") return (mock.MagicMock(), "ignored")
class CallableExhausted(Exception): class CallableExhausted(Exception):
# pylint: disable=too-few-public-methods
"""Exception raised when a method is called more than the """Exception raised when a method is called more than the
specified number of times.""" specified number of times."""
pass pass
@@ -70,6 +72,7 @@ class PackAndUnpackTests(unittest.TestCase):
class TLSParseClientHelloTest(unittest.TestCase): class TLSParseClientHelloTest(unittest.TestCase):
# pylint: disable=too-few-public-methods
"""Test for tls_parse_client_hello() function.""" """Test for tls_parse_client_hello() function."""
def test_tls_parse_client_hello(self): def test_tls_parse_client_hello(self):
from letsencrypt.client.standalone_authenticator import \ from letsencrypt.client.standalone_authenticator import \
@@ -92,6 +95,7 @@ class TLSParseClientHelloTest(unittest.TestCase):
class TLSGenerateServerHelloTest(unittest.TestCase): class TLSGenerateServerHelloTest(unittest.TestCase):
# pylint: disable=too-few-public-methods
"""Tests for tls_generate_server_hello() function.""" """Tests for tls_generate_server_hello() function."""
def test_tls_generate_server_hello(self): def test_tls_generate_server_hello(self):
from letsencrypt.client.standalone_authenticator import \ from letsencrypt.client.standalone_authenticator import \
@@ -103,6 +107,7 @@ class TLSGenerateServerHelloTest(unittest.TestCase):
class TLSGenerateCertMsgTest(unittest.TestCase): class TLSGenerateCertMsgTest(unittest.TestCase):
# pylint: disable=too-few-public-methods
"""Tests for tls_generate_cert_msg() function.""" """Tests for tls_generate_cert_msg() function."""
def test_tls_generate_cert_msg(self): def test_tls_generate_cert_msg(self):
from letsencrypt.client.standalone_authenticator import \ from letsencrypt.client.standalone_authenticator import \
@@ -134,6 +139,7 @@ class TLSGenerateCertMsgTest(unittest.TestCase):
class TLSServerHelloDoneTest(unittest.TestCase): class TLSServerHelloDoneTest(unittest.TestCase):
# pylint: disable=too-few-public-methods
"""Tests for tls_generate_server_hello_done() function.""" """Tests for tls_generate_server_hello_done() function."""
def test_tls_generate_server_hello_done(self): def test_tls_generate_server_hello_done(self):
from letsencrypt.client.standalone_authenticator import \ from letsencrypt.client.standalone_authenticator import \
@@ -164,11 +170,10 @@ class SNICallbackTest(unittest.TestCase):
import OpenSSL.crypto import OpenSSL.crypto
from OpenSSL.crypto import FILETYPE_PEM from OpenSSL.crypto import FILETYPE_PEM
self.authenticator = StandaloneAuthenticator() self.authenticator = StandaloneAuthenticator()
r = "x" * 32 name, r_b64 = "example.com", le_util.jose_b64encode("x" * 32)
name, r_b64 = "example.com", le_util.jose_b64encode(r) test_key = pkg_resources.resource_string(__name__,
RSA256_KEY = pkg_resources.resource_string(__name__, 'testdata/rsa256_key.pem')
'testdata/rsa256_key.pem') nonce, key = "abcdef", le_util.Key("foo", test_key)
nonce, key = "abcdef", le_util.Key("foo", RSA256_KEY)
self.cert = dvsni_gen_cert(name, r_b64, nonce, key)[0] self.cert = dvsni_gen_cert(name, r_b64, nonce, key)[0]
private_key = OpenSSL.crypto.load_privatekey(FILETYPE_PEM, key.pem) private_key = OpenSSL.crypto.load_privatekey(FILETYPE_PEM, key.pem)
self.authenticator.private_key = private_key self.authenticator.private_key = private_key
@@ -294,9 +299,9 @@ class PerformTest(unittest.TestCase):
def test_can_perform(self): def test_can_perform(self):
"""What happens if start_listener() returns True.""" """What happens if start_listener() returns True."""
from letsencrypt.client import le_util from letsencrypt.client import le_util
RSA256_KEY = pkg_resources.resource_string(__name__, test_key = pkg_resources.resource_string(__name__,
'testdata/rsa256_key.pem') 'testdata/rsa256_key.pem')
key = le_util.Key("something", RSA256_KEY) key = le_util.Key("something", test_key)
chall1 = DvsniChall("foo.example.com", "whee", "foononce", key) chall1 = DvsniChall("foo.example.com", "whee", "foononce", key)
chall2 = DvsniChall("bar.example.com", "whee", "barnonce", key) chall2 = DvsniChall("bar.example.com", "whee", "barnonce", key)
bad_chall = ("This", "Represents", "A Non-DVSNI", "Challenge") bad_chall = ("This", "Represents", "A Non-DVSNI", "Challenge")
@@ -320,9 +325,9 @@ class PerformTest(unittest.TestCase):
def test_cannot_perform(self): def test_cannot_perform(self):
"""What happens if start_listener() returns False.""" """What happens if start_listener() returns False."""
from letsencrypt.client import le_util from letsencrypt.client import le_util
RSA256_KEY = pkg_resources.resource_string(__name__, test_key = pkg_resources.resource_string(__name__,
'testdata/rsa256_key.pem') 'testdata/rsa256_key.pem')
key = le_util.Key("something", RSA256_KEY) key = le_util.Key("something", test_key)
chall1 = DvsniChall("foo.example.com", "whee", "foononce", key) chall1 = DvsniChall("foo.example.com", "whee", "foononce", key)
chall2 = DvsniChall("bar.example.com", "whee", "barnonce", key) chall2 = DvsniChall("bar.example.com", "whee", "barnonce", key)
bad_chall = ("This", "Represents", "A Non-DVSNI", "Challenge") bad_chall = ("This", "Represents", "A Non-DVSNI", "Challenge")
@@ -365,7 +370,8 @@ class StartListenerTest(unittest.TestCase):
StandaloneAuthenticator StandaloneAuthenticator
self.authenticator = StandaloneAuthenticator() self.authenticator = StandaloneAuthenticator()
@mock.patch("letsencrypt.client.standalone_authenticator.Crypto.Random.atfork") @mock.patch("letsencrypt.client.standalone_authenticator."
"Crypto.Random.atfork")
@mock.patch("letsencrypt.client.standalone_authenticator.os.fork") @mock.patch("letsencrypt.client.standalone_authenticator.os.fork")
def test_start_listener_fork_parent(self, mock_fork, mock_atfork): def test_start_listener_fork_parent(self, mock_fork, mock_atfork):
self.authenticator.do_parent_process = mock.Mock() self.authenticator.do_parent_process = mock.Mock()
@@ -375,7 +381,8 @@ class StartListenerTest(unittest.TestCase):
self.authenticator.do_parent_process.assert_called_once_with(1717) self.authenticator.do_parent_process.assert_called_once_with(1717)
mock_atfork.assert_called_once_with() mock_atfork.assert_called_once_with()
@mock.patch("letsencrypt.client.standalone_authenticator.Crypto.Random.atfork") @mock.patch("letsencrypt.client.standalone_authenticator."
"Crypto.Random.atfork")
@mock.patch("letsencrypt.client.standalone_authenticator.os.fork") @mock.patch("letsencrypt.client.standalone_authenticator.os.fork")
def test_start_listener_fork_child(self, mock_fork, mock_atfork): def test_start_listener_fork_child(self, mock_fork, mock_atfork):
import os import os
@@ -396,7 +403,8 @@ class DoParentProcessTest(unittest.TestCase):
self.authenticator = StandaloneAuthenticator() self.authenticator = StandaloneAuthenticator()
@mock.patch("letsencrypt.client.standalone_authenticator.signal.signal") @mock.patch("letsencrypt.client.standalone_authenticator.signal.signal")
@mock.patch("letsencrypt.client.standalone_authenticator.zope.component.getUtility") @mock.patch("letsencrypt.client.standalone_authenticator."
"zope.component.getUtility")
def test_do_parent_process_ok(self, mock_get_utility, mock_signal): def test_do_parent_process_ok(self, mock_get_utility, mock_signal):
self.authenticator.subproc_ready = True self.authenticator.subproc_ready = True
result = self.authenticator.do_parent_process(1717) result = self.authenticator.do_parent_process(1717)
@@ -405,7 +413,8 @@ class DoParentProcessTest(unittest.TestCase):
self.assertEqual(mock_signal.call_count, 3) self.assertEqual(mock_signal.call_count, 3)
@mock.patch("letsencrypt.client.standalone_authenticator.signal.signal") @mock.patch("letsencrypt.client.standalone_authenticator.signal.signal")
@mock.patch("letsencrypt.client.standalone_authenticator.zope.component.getUtility") @mock.patch("letsencrypt.client.standalone_authenticator."
"zope.component.getUtility")
def test_do_parent_process_inuse(self, mock_get_utility, mock_signal): def test_do_parent_process_inuse(self, mock_get_utility, mock_signal):
self.authenticator.subproc_inuse = True self.authenticator.subproc_inuse = True
result = self.authenticator.do_parent_process(1717) result = self.authenticator.do_parent_process(1717)
@@ -414,7 +423,8 @@ class DoParentProcessTest(unittest.TestCase):
self.assertEqual(mock_signal.call_count, 3) self.assertEqual(mock_signal.call_count, 3)
@mock.patch("letsencrypt.client.standalone_authenticator.signal.signal") @mock.patch("letsencrypt.client.standalone_authenticator.signal.signal")
@mock.patch("letsencrypt.client.standalone_authenticator.zope.component.getUtility") @mock.patch("letsencrypt.client.standalone_authenticator."
"zope.component.getUtility")
def test_do_parent_process_cantbind(self, mock_get_utility, mock_signal): def test_do_parent_process_cantbind(self, mock_get_utility, mock_signal):
self.authenticator.subproc_cantbind = True self.authenticator.subproc_cantbind = True
result = self.authenticator.do_parent_process(1717) result = self.authenticator.do_parent_process(1717)
@@ -423,7 +433,8 @@ class DoParentProcessTest(unittest.TestCase):
self.assertEqual(mock_signal.call_count, 3) self.assertEqual(mock_signal.call_count, 3)
@mock.patch("letsencrypt.client.standalone_authenticator.signal.signal") @mock.patch("letsencrypt.client.standalone_authenticator.signal.signal")
@mock.patch("letsencrypt.client.standalone_authenticator.zope.component.getUtility") @mock.patch("letsencrypt.client.standalone_authenticator."
"zope.component.getUtility")
def test_do_parent_process_timeout(self, mock_get_utility, mock_signal): def test_do_parent_process_timeout(self, mock_get_utility, mock_signal):
# Normally times out in 5 seconds and returns False. We can # Normally times out in 5 seconds and returns False. We can
# now set delay_amount to a lower value so that it times out # now set delay_amount to a lower value so that it times out
@@ -444,11 +455,10 @@ class DoChildProcessTest(unittest.TestCase):
import OpenSSL.crypto import OpenSSL.crypto
from OpenSSL.crypto import FILETYPE_PEM from OpenSSL.crypto import FILETYPE_PEM
self.authenticator = StandaloneAuthenticator() self.authenticator = StandaloneAuthenticator()
r = "x" * 32 name, r_b64 = "example.com", le_util.jose_b64encode("x" * 32)
name, r_b64 = "example.com", le_util.jose_b64encode(r) test_key = pkg_resources.resource_string(__name__,
RSA256_KEY = pkg_resources.resource_string(__name__, 'testdata/rsa256_key.pem')
'testdata/rsa256_key.pem') nonce, key = "abcdef", le_util.Key("foo", test_key)
nonce, key = "abcdef", le_util.Key("foo", RSA256_KEY)
self.key = key self.key = key
self.cert = dvsni_gen_cert(name, r_b64, nonce, key)[0] self.cert = dvsni_gen_cert(name, r_b64, nonce, key)[0]
private_key = OpenSSL.crypto.load_privatekey(FILETYPE_PEM, key.pem) private_key = OpenSSL.crypto.load_privatekey(FILETYPE_PEM, key.pem)
@@ -508,10 +518,12 @@ class DoChildProcessTest(unittest.TestCase):
with self.assertRaises(socket.error): with self.assertRaises(socket.error):
self.authenticator.do_child_process(1717, self.key) self.authenticator.do_child_process(1717, self.key)
@mock.patch("letsencrypt.client.standalone_authenticator.OpenSSL.SSL.Connection") @mock.patch("letsencrypt.client.standalone_authenticator."
"OpenSSL.SSL.Connection")
@mock.patch("letsencrypt.client.standalone_authenticator.socket.socket") @mock.patch("letsencrypt.client.standalone_authenticator.socket.socket")
@mock.patch("letsencrypt.client.standalone_authenticator.os.kill") @mock.patch("letsencrypt.client.standalone_authenticator.os.kill")
def test_do_child_process_success(self, mock_kill, mock_socket, mock_connection): def test_do_child_process_success(self, mock_kill, mock_socket,
mock_connection):
import signal import signal
sample_socket = mock.MagicMock() sample_socket = mock.MagicMock()
sample_socket.accept.side_effect = SocketAcceptOnlyNTimes(2) sample_socket.accept.side_effect = SocketAcceptOnlyNTimes(2)