- tor-commits - lists.torproject.org

[stem/master] Making integ test ps query just match 'tor'
by atagar＠torproject.org 03 Jan '12

03 Jan '12

commit 4cd8ac450fd0f3c80a74c4f7835bee1fd2644ef5 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Jan 2 20:39:50 2012 -0800 Making integ test ps query just match 'tor' The fix in c421b54 checked for endings of 'tor' rather than ' tor', causing things like 'monitor' to be picked up. --- test/integ/util/system.py | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/test/integ/util/system.py b/test/integ/util/system.py index b255c4a..dc06351 100644 --- a/test/integ/util/system.py +++ b/test/integ/util/system.py @@ -30,7 +30,7 @@ class TestSystem(unittest.TestCase): self.is_extra_tor_running = len(pgrep_results) > 1 else: ps_results = stem.util.system.call(stem.util.system.GET_PID_BY_NAME_PS_BSD) - results = [r for r in ps_results if r.endswith("tor")] + results = [r for r in ps_results if r.endswith(" tor")] self.is_extra_tor_running = len(results) > 1 def tearDown(self):

1 0

[stem/master] Replace pgrep with ps in the BSD systems
by atagar＠torproject.org 03 Jan '12

03 Jan '12

commit 8c8ad75bd1e3dc5541273336b03d6300f689b66e Author: Sathyanarayanan Gunasekaran <gsathya.ceg(a)gmail.com> Date: Mon Dec 19 22:23:41 2011 +0530 Replace pgrep with ps in the BSD systems Now, the integ test checks if the os is a BSD system with a call to stem.util.system.is_bsd(). If it is BSD, then it uses ps to check if an extra Tor instance is running, instead of using pgrep which does not exist on BSD. --- test/integ/util/system.py | 9 ++++++--- 1 files changed, 6 insertions(+), 3 deletions(-) diff --git a/test/integ/util/system.py b/test/integ/util/system.py index d1e9f88..7f4c68c 100644 --- a/test/integ/util/system.py +++ b/test/integ/util/system.py @@ -25,9 +25,12 @@ class TestSystem(unittest.TestCase): # legitemately fail. if self.is_extra_tor_running == None: - pgrep_results = stem.util.system.call("pgrep -x tor") - self.is_extra_tor_running = len(pgrep_results) > 1 - + if not stem.util.system.is_bsd(): + pgrep_results = stem.util.system.call("pgrep -x tor") + self.is_extra_tor_running = len(pgrep_results) > 1 + else: + pgrep_results = stem.util.system.call("ps -axo pid,command,args | grep -i tor | awk '{ print $1}'") + self.is_extra_tor_running = len(pgrep_results) > 1 def tearDown(self): # resets call mocking back to being disabled stem.util.system.CALL_MOCKING = None

1 0

[stem/master] Dropping get_system_tor_version() usage from tests
by atagar＠torproject.org 03 Jan '12

03 Jan '12

commit 29652d978ce7465f288575061c819e77a7e67013 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Jan 2 16:42:14 2012 -0800 Dropping get_system_tor_version() usage from tests At one point our integ tests was using the get_system_tor_version() function to determine our test instance's version. This is fine for now since we run against whatever tor binary is first in our path, but in the future tor devs will want to be able to select the binary so that won't work. Adding a test runner method for querying our version from tor instead. --- test/integ/socket/control_message.py | 13 ++++--------- test/runner.py | 26 +++++++++++++++++++++++++- 2 files changed, 29 insertions(+), 10 deletions(-) diff --git a/test/integ/socket/control_message.py b/test/integ/socket/control_message.py index b939c87..90ac623 100644 --- a/test/integ/socket/control_message.py +++ b/test/integ/socket/control_message.py @@ -120,16 +120,12 @@ class TestControlMessage(unittest.TestCase): Parses the 'GETINFO config-text' response. """ + runner = test.runner.get_runner() req_version = stem.version.Requirement.GETINFO_CONFIG_TEXT + our_version = runner.get_tor_version() - try: - if stem.version.get_system_tor_version() < req_version: - self.skipTest("(requires %s)" % req_version) - except IOError: - # This is a best-effot lookup to avoid showing a valid failure. If the - # version lookup fails then running the test. - - pass + if our_version and our_version < req_version: + self.skipTest("(requires %s)" % req_version) # We can't be certain of the order, and there may be extra config-text # entries as per... @@ -137,7 +133,6 @@ class TestControlMessage(unittest.TestCase): # # so we'll just check that the response is a superset of our config - runner = test.runner.get_runner() torrc_contents = [] for line in runner.get_torrc_contents().split("\n"): diff --git a/test/runner.py b/test/runner.py index ed92126..581f95a 100644 --- a/test/runner.py +++ b/test/runner.py @@ -15,7 +15,8 @@ Runner - Runtime context for our integration tests. |- get_torrc_contents - contents of our tor instance's torrc |- get_connection_type - method by which controllers can connect to tor |- get_pid - process id of our tor process - +- get_tor_socket - provides a socket to the tor instance + |- get_tor_socket - provides a socket to the tor instance + +- get_tor_version - provides the version of tor we're running against """ import os @@ -30,6 +31,7 @@ import threading import stem.socket import stem.process +import stem.version import stem.util.conf import stem.util.enum import stem.util.term as term @@ -365,6 +367,28 @@ class Runner: return control_socket + def get_tor_version(self): + """ + Queries our test instance for tor's version. + + Returns: + stem.version.Version for our test instance, None if we're unable to + connect to it + """ + + # TODO: replace with higher level functions when we've completed a basic + # controller class + + control_socket = self.get_tor_socket() + if not control_socket: return None + + control_socket.send("GETINFO version") + version_response = control_socket.recv() + control_socket.close() + + tor_version = list(version_response)[0][8:] + return stem.version.Version(tor_version) + def _get(self, attr): """ Fetches one of our attributes in a thread safe manner, raising if we aren't

1 0

[stem/master] Integ tests for stem.version
by atagar＠torproject.org 03 Jan '12

03 Jan '12

commit a08c09a21743225181569a9ba08b3b15a7c584e2 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Jan 2 16:27:48 2012 -0800 Integ tests for stem.version I didn't have any integ tests for versions? Seriously? *sigh* Adding some basic verification tests that we can handle the version of our system and test instances. Earlier boerni was running into a bug where another integ tests inadvertantly failed due to an uncaught exception from get_system_tor_version(). It was inappropriate for that test to fail (it wasn't testing versions) but we should have some test for the function so this is it. --- run_tests.py | 31 ++++++++++------- test/integ/connection/protocolinfo.py | 1 + test/integ/version.py | 59 +++++++++++++++++++++++++++++++++ 3 files changed, 79 insertions(+), 12 deletions(-) diff --git a/run_tests.py b/run_tests.py index 9bd0735..280b05e 100755 --- a/run_tests.py +++ b/run_tests.py @@ -14,19 +14,20 @@ import StringIO import test.output import test.runner -import test.unit.version -import test.unit.socket.control_message -import test.unit.socket.control_line import test.unit.connection.authentication import test.unit.connection.protocolinfo +import test.unit.socket.control_line +import test.unit.socket.control_message import test.unit.util.enum import test.unit.util.system -import test.integ.socket.control_message -import test.integ.util.conf -import test.integ.util.system +import test.unit.version import test.integ.connection.authentication import test.integ.connection.connect import test.integ.connection.protocolinfo +import test.integ.socket.control_message +import test.integ.util.conf +import test.integ.util.system +import test.integ.version import stem.util.enum import stem.util.log as log @@ -36,23 +37,29 @@ OPT = "uic:t:l:h" OPT_EXPANDED = ["unit", "integ", "config=", "targets=", "log=", "help"] DIVIDER = "=" * 70 +# Tests are ordered by the dependencies so the lowest level tests come first. +# This is because a problem in say, controller message parsing, will cause all +# higher level tests to fail too. Hence we want the test that most narrowly +# exhibits problems to come first. + UNIT_TESTS = ( + test.unit.util.enum.TestEnum, + test.unit.util.system.TestSystem, + test.unit.version.TestVersion, test.unit.socket.control_message.TestControlMessage, test.unit.socket.control_line.TestControlLine, - test.unit.version.TestVersion, test.unit.connection.authentication.TestAuthenticate, test.unit.connection.protocolinfo.TestProtocolInfoResponse, - test.unit.util.enum.TestEnum, - test.unit.util.system.TestSystem, ) INTEG_TESTS = ( + test.integ.util.conf.TestConf, + test.integ.util.system.TestSystem, + test.integ.version.TestVersion, test.integ.socket.control_message.TestControlMessage, + test.integ.connection.protocolinfo.TestProtocolInfo, test.integ.connection.authentication.TestAuthenticate, test.integ.connection.connect.TestConnect, - test.integ.connection.protocolinfo.TestProtocolInfo, - test.integ.util.conf.TestConf, - test.integ.util.system.TestSystem, ) # Integration tests above the basic suite. diff --git a/test/integ/connection/protocolinfo.py b/test/integ/connection/protocolinfo.py index e37f63b..6f036c8 100644 --- a/test/integ/connection/protocolinfo.py +++ b/test/integ/connection/protocolinfo.py @@ -37,6 +37,7 @@ class TestProtocolInfo(unittest.TestCase): control_socket.send("PROTOCOLINFO 1") protocolinfo_response = control_socket.recv() stem.connection.ProtocolInfoResponse.convert(protocolinfo_response) + control_socket.close() # according to the control spec the following _could_ differ or be # undefined but if that actually happens then it's gonna make people sad diff --git a/test/integ/version.py b/test/integ/version.py new file mode 100644 index 0000000..9bd7ee7 --- /dev/null +++ b/test/integ/version.py @@ -0,0 +1,59 @@ +""" +Integration tests for tor version parsing. +""" + +import unittest + +import test.runner +import stem.version + +class TestVersion(unittest.TestCase): + """ + Tests that the stem.version functions can handle the tor instance we're + running with. + """ + + def test_get_system_tor_version(self): + """ + Basic verification checks for the get_system_tor_version() function. + """ + + if not stem.util.system.is_available("tor"): + self.skipTest("(tor isn't in our path)") + + # Since tor is in our path we should expect to be able to get the version + # that way, though this might not belong to our test instance (if we're + # running against a specific tor binary). + + stem.version.get_system_tor_version() + + # try running against a command that exists, but isn't tor + self.assertRaises(IOError, stem.version.get_system_tor_version, "ls") + + # try running against a command that doesn't exist + self.assertRaises(IOError, stem.version.get_system_tor_version, "blarg") + + def test_getinfo_version_parsing(self): + """ + Issues a 'GETINFO version' query to our test instance and makes sure that + we can parse it. + """ + + runner = test.runner.get_runner() + connection_type = runner.get_connection_type() + + if connection_type == test.runner.TorConnection.NONE: + self.skipTest("(no connection)") + + control_socket = runner.get_tor_socket() + control_socket.send("GETINFO version") + version_response = control_socket.recv() + control_socket.close() + + # the getinfo response looks like... + # 250-version=0.2.1.30 + # 250 OK + + tor_version = list(version_response)[0][8:] + stem.version.Version(tor_version) +

1 0

[translation/tsum] Update translations for tsum
by translation＠torproject.org 03 Jan '12

03 Jan '12

commit 1e25528bd6c8242492f20337581bd4a05b8582e6 Author: Translation commit bot <translation(a)torproject.org> Date: Tue Jan 3 00:15:03 2012 +0000 Update translations for tsum --- pt/tsum.po | 9 +++++---- 1 files changed, 5 insertions(+), 4 deletions(-) diff --git a/pt/tsum.po b/pt/tsum.po index ec48207..32177f7 100644 --- a/pt/tsum.po +++ b/pt/tsum.po @@ -11,7 +11,7 @@ msgstr "" "Project-Id-Version: The Tor Project\n" "Report-Msgid-Bugs-To: https://trac.torproject.org/projects/tor\n" "POT-Creation-Date: 2011-11-05 17:16+0000\n" -"PO-Revision-Date: 2012-01-02 23:32+0000\n" +"PO-Revision-Date: 2012-01-02 23:59+0000\n" "Last-Translator: flavioamieiro <flavioamieiro(a)gmail.com>\n" "Language-Team: LANGUAGE <LL(a)li.org>\n" "MIME-Version: 1.0\n" @@ -408,9 +408,8 @@ msgid "" msgstr "" "Se sua conexão normal com a internet está funcionando, mas o Tor ainda não " "consegue conectar à rede, tente o seguinte: abra o painel de controle do " -"Vidalia, clique em *Message Log* e selecione a aba *Advanced*. Pode ser que " -"o Tor não consiga conectar porque:og* e selecione a aba *Advanced*. Pode ser" -" que o Tor não consiga conectar porque:" +"Vidalia, clique em *Registro de mensagens* e selecione a aba *Avançado*. " +"Pode ser que o Tor não consiga conectar porque:" #. type: Plain text #: en/tsum.text:178 @@ -433,6 +432,8 @@ msgid "" "*Network*, and tick the box that says *My firewall only lets me connect\n" "to certain ports*. \n" msgstr "" +"**Você está atrás de um firewall restritivo**: Para que o Tor tente usar apenas as portas 80 e 443, abra o painel de controle do Vidalia, clique em *Configurações*, depois em\n" +"*Rede*, e marque a caixa que diz *A minha firewall apenas permite a conexão a certas portas*.\n" #. type: Plain text #: en/tsum.text:187

1 0

[translation/tsum] Update translations for tsum
by translation＠torproject.org 03 Jan '12

03 Jan '12

commit 1d7db6cada29e25fa6e44de296d9c84a7a3f8079 Author: Translation commit bot <translation(a)torproject.org> Date: Mon Jan 2 23:45:03 2012 +0000 Update translations for tsum --- pt/tsum.po | 13 +++++++++++-- 1 files changed, 11 insertions(+), 2 deletions(-) diff --git a/pt/tsum.po b/pt/tsum.po index 50931aa..ec48207 100644 --- a/pt/tsum.po +++ b/pt/tsum.po @@ -5,13 +5,14 @@ # Translators: # <caiocajazeiras12(a)gmail.com>, 2011. # <e.nertt(a)gmail.com>, 2011. +# <flavioamieiro(a)gmail.com>, 2012. msgid "" msgstr "" "Project-Id-Version: The Tor Project\n" "Report-Msgid-Bugs-To: https://trac.torproject.org/projects/tor\n" "POT-Creation-Date: 2011-11-05 17:16+0000\n" -"PO-Revision-Date: 2011-11-07 12:18+0000\n" -"Last-Translator: nert_t <e.nertt(a)gmail.com>\n" +"PO-Revision-Date: 2012-01-02 23:32+0000\n" +"Last-Translator: flavioamieiro <flavioamieiro(a)gmail.com>\n" "Language-Team: LANGUAGE <LL(a)li.org>\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" @@ -405,6 +406,11 @@ msgid "" "*Message Log* and select the *Advanced* tab. It may be that Tor won't " "connect because:" msgstr "" +"Se sua conexão normal com a internet está funcionando, mas o Tor ainda não " +"consegue conectar à rede, tente o seguinte: abra o painel de controle do " +"Vidalia, clique em *Message Log* e selecione a aba *Advanced*. Pode ser que " +"o Tor não consiga conectar porque:og* e selecione a aba *Advanced*. Pode ser" +" que o Tor não consiga conectar porque:" #. type: Plain text #: en/tsum.text:178 @@ -414,6 +420,9 @@ msgid "" "system is correct, and restart Tor. You may need to synchronize your\n" "system clock with an Internet time server. \n" msgstr "" +"**O relógio do seu sistema está errado**: garanta que a data e horário do " +"seu sistema estão corretos, e reinicie o Tor. Pode ser necessário que você " +"sincronize o relógio do sistema com um servidor de horário na internet.\n" #. type: Plain text #: en/tsum.text:183

1 0

[stem/master] Integ for cookie auth failed due to missing cookie
by atagar＠torproject.org 03 Jan '12

03 Jan '12

commit b4f86854437d0e81cc1adb18de66ca46c49dabb4 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Jan 2 14:49:12 2012 -0800 Integ for cookie auth failed due to missing cookie If we're running the integ tests for the first time then it would fail because it attempts cookie auth but the cookie file doesn't exist yet. This went uncaught for quite a while because after the first test run we leave the data directory (to speed up future test runs). Caught thanks to boerni. --- test/integ/connection/authentication.py | 10 +++++++++- 1 files changed, 9 insertions(+), 1 deletions(-) diff --git a/test/integ/connection/authentication.py b/test/integ/connection/authentication.py index 7ac745b..612e058 100644 --- a/test/integ/connection/authentication.py +++ b/test/integ/connection/authentication.py @@ -172,7 +172,15 @@ class TestAuthenticate(unittest.TestCase): auth_type = stem.connection.AuthMethod.COOKIE auth_value = test.runner.get_runner().get_auth_cookie_path() - if self._can_authenticate(auth_type): + if not os.path.exists(auth_value): + # If the authentication cookie doesn't exist then we'll be getting an + # error for that rather than rejection. This will even fail if + # _can_authenticate is true because we *can* authenticate with cookie + # auth but the function will short circuit with failure due to the + # missing file. + + self.assertRaises(stem.connection.UnreadableCookieFile, self._check_auth, auth_type, auth_value) + elif self._can_authenticate(auth_type): self._check_auth(auth_type, auth_value) else: self.assertRaises(stem.connection.CookieAuthRejected, self._check_auth, auth_type, auth_value)

1 0

[stem/master] Reducing socket/proctol error logging to INFO
by atagar＠torproject.org 03 Jan '12

03 Jan '12

commit ad77d82535a5d86cb9b059d2365ff70cfa260c53 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Jan 1 10:12:18 2012 -0800 Reducing socket/proctol error logging to INFO The base socket and protocol errors are too low level to be of interest to users. They're interested in the symptoms and what it means for them not that, say, a control message was malformed. Also escaping the logged message content - much easier to make sense of that way. --- stem/socket.py | 14 +++++++------- stem/util/log.py | 17 +++++++++++++++++ 2 files changed, 24 insertions(+), 7 deletions(-) diff --git a/stem/socket.py b/stem/socket.py index 961fece..b2bde2b 100644 --- a/stem/socket.py +++ b/stem/socket.py @@ -697,13 +697,13 @@ def recv_message(control_file): # if the control_file has been closed then we will receive: # AttributeError: 'NoneType' object has no attribute 'recv' - log.warn("SocketClosed: socket file has been closed") + log.info("SocketClosed: socket file has been closed") raise SocketClosed("socket file has been closed") except socket.error, exc: # when disconnected we get... # socket.error: [Errno 107] Transport endpoint is not connected - log.warn("SocketClosed: received an exception (%s)" % exc) + log.info("SocketClosed: received an exception (%s)" % exc) raise SocketClosed(exc) raw_content += line @@ -715,16 +715,16 @@ def recv_message(control_file): # if the socket is disconnected then the readline() method will provide # empty content - log.warn("SocketClosed: empty socket content") + log.info("SocketClosed: empty socket content") raise SocketClosed("Received empty socket content.") elif len(line) < 4: - log.warn("ProtocolError: line too short (%s)" % line) + log.info("ProtocolError: line too short (%s)" % log.escape(line)) raise ProtocolError("Badly formatted reply line: too short") elif not re.match(r'^[a-zA-Z0-9]{3}[-+ ]', line): - log.warn("ProtocolError: malformed status code/divider (%s)" % line) + log.info("ProtocolError: malformed status code/divider (%s)" % log.escape(line)) raise ProtocolError("Badly formatted reply line: beginning is malformed") elif not line.endswith("\r\n"): - log.warn("ProtocolError: no CRLF linebreak (%s)" % line) + log.info("ProtocolError: no CRLF linebreak (%s)" % log.escape(line)) raise ProtocolError("All lines should end with CRLF") line = line[:-2] # strips off the CRLF @@ -754,7 +754,7 @@ def recv_message(control_file): raw_content += line if not line.endswith("\r\n"): - log.warn("ProtocolError: no CRLF linebreak for data entry (%s)" % line) + log.info("ProtocolError: no CRLF linebreak for data entry (%s)" % log.escape(line)) raise ProtocolError("All lines should end with CRLF") elif line == ".\r\n": break # data block termination diff --git a/stem/util/log.py b/stem/util/log.py index 76ebb2c..f9efa09 100644 --- a/stem/util/log.py +++ b/stem/util/log.py @@ -89,3 +89,20 @@ def notice(message): log(Runlevel.NOTICE, message) def warn(message): log(Runlevel.WARN, message) def error(message): log(Runlevel.ERROR, message) +def escape(message): + """ + Escapes specific sequences for logging (newlines, tabs, carrage returns). + + Arguments: + message (str) - string to be escaped + + Returns: + str that is escaped + """ + + for pattern, replacement in (("\n", "\\n"), ("\r", "\\r"), ("\t", "\\t")): + message = message.replace(pattern, replacement) + + return message + +

1 0

[stem/master] Downgrading protocolinfo version mismatch to INFO
by atagar＠torproject.org 03 Jan '12

03 Jan '12

commit 5a988db9a78161240a9f3146936a57dfc0a6734e Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Jan 1 09:56:26 2012 -0800 Downgrading protocolinfo version mismatch to INFO The response for PROTOCOLINFO queries do not necessarily need to be what we requested. We make a best effort to parse any response as a v1 response, and warned if the response was for something besides v1. Downgrading the warning from WARN to INFO since this is a valid tor response and, if we're still able to parse it, the user doesn't really need to be alerted. If the version mismatch can't be handled like a v1 response then that most likely *will* cause warnings or errors that we'll alert the user of. --- stem/connection.py | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/stem/connection.py b/stem/connection.py index 7cb76be..6bd50fd 100644 --- a/stem/connection.py +++ b/stem/connection.py @@ -772,7 +772,7 @@ class ProtocolInfoResponse(stem.socket.ControlMessage): # an effort to parse like a v1 response. if self.protocol_version != 1: - log.warn("We made a PROTOCOLINFO v1 query but got a version %i response instead. We'll still try to use it, but this may cause problems." % self.protocol_version) + log.info("We made a PROTOCOLINFO version 1 query but got a version %i response instead. We'll still try to use it, but this may cause problems." % self.protocol_version) elif line_type == "AUTH": # Line format: # AuthLine = "250-AUTH" SP "METHODS=" AuthMethod *("," AuthMethod)

1 0

[stem/master] Deduplicating unknown auth type messages
by atagar＠torproject.org 03 Jan '12

03 Jan '12

commit 4a5586afb64d50c627652c1ead9314596cb0b36c Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Jan 1 10:24:38 2012 -0800 Deduplicating unknown auth type messages There's quite a few log messages that really don't make sense to repeatedly log. Adding optinal logging deduplication and applying it to the INFO level message about getting an auth method we don't recognize. --- stem/connection.py | 3 ++- stem/util/log.py | 25 +++++++++++++++++++++++++ 2 files changed, 27 insertions(+), 1 deletions(-) diff --git a/stem/connection.py b/stem/connection.py index 6bd50fd..37578cf 100644 --- a/stem/connection.py +++ b/stem/connection.py @@ -794,7 +794,8 @@ class ProtocolInfoResponse(stem.socket.ControlMessage): auth_methods.append(AuthMethod.COOKIE) else: unknown_auth_methods.append(method) - log.info("PROTOCOLINFO response had an unrecognized authentication method: %s" % method) + message_id = "stem.connection.unknown_auth_%s" % method + log.log_once(message_id, log.INFO, "PROTOCOLINFO response had an unrecognized authentication method: %s" % method) # our auth_methods should have a single AuthMethod.UNKNOWN entry if # any unknown authentication methods exist diff --git a/stem/util/log.py b/stem/util/log.py index f9efa09..de84ead 100644 --- a/stem/util/log.py +++ b/stem/util/log.py @@ -37,6 +37,10 @@ LOG_VALUES = { LOGGER = logging.getLogger("stem") +# There's some messages that we don't want to log more than once. This set has +# the messages IDs that we've logged which fall into this category. +DEDUPLICATION_MESSAGE_IDS = set() + # Adds a default nullhandler for the stem logger, suppressing the 'No handlers # could be found for logger "stem"' warning as per... # http://docs.python.org/release/3.1.3/library/logging.html#configuring-loggi… @@ -81,6 +85,27 @@ def log(runlevel, message): if runlevel: LOGGER.log(LOG_VALUES[runlevel], message) +def log_once(message_id, runlevel, message): + """ + Logs a message at the given runlevel. If a message with this ID has already + been logged then this is a no-op. + + Arguments: + message_id (str) - unique message identifier to deduplicate on + runlevel (Runlevel) - runlevel to log the message at, logging is skipped if + None + message (str) - message to be logged + + Returns: + True if we log the message, False otherwise + """ + + if not runlevel or message_id in DEDUPLICATION_MESSAGE_IDS: + return False + else: + DEDUPLICATION_MESSAGE_IDS.add(message_id) + log(runlevel, message) + # shorter aliases for logging at a runlevel def trace(message): log(Runlevel.TRACE, message) def debug(message): log(Runlevel.DEBUG, message)

1 0