2018-03-01 19:28:18 +00:00
|
|
|
"""
|
|
|
|
This module contains classes and functions to implement and manage
|
|
|
|
a node for Tahoe-LAFS.
|
2020-10-30 15:21:14 +00:00
|
|
|
|
|
|
|
Ported to Python 3.
|
2018-03-01 19:28:18 +00:00
|
|
|
"""
|
2020-10-29 18:09:18 +00:00
|
|
|
from __future__ import absolute_import
|
|
|
|
from __future__ import division
|
|
|
|
from __future__ import print_function
|
|
|
|
from __future__ import unicode_literals
|
|
|
|
|
|
|
|
from future.utils import PY2
|
|
|
|
if PY2:
|
|
|
|
from future.builtins import filter, map, zip, ascii, chr, hex, input, next, oct, open, pow, round, super, bytes, dict, list, object, range, str, max, min # noqa: F401
|
2020-10-30 15:23:30 +00:00
|
|
|
from six import ensure_str, ensure_text
|
2020-08-27 19:19:49 +00:00
|
|
|
|
2018-02-07 10:05:21 +00:00
|
|
|
import datetime
|
|
|
|
import os.path
|
|
|
|
import re
|
|
|
|
import types
|
2018-08-24 21:50:55 +00:00
|
|
|
import errno
|
2018-02-07 10:05:21 +00:00
|
|
|
import tempfile
|
2007-08-12 17:29:38 +00:00
|
|
|
from base64 import b32decode, b32encode
|
2020-11-14 14:12:14 +00:00
|
|
|
from errno import ENOENT, EPERM
|
|
|
|
from warnings import warn
|
2007-05-22 21:01:40 +00:00
|
|
|
|
2020-10-26 15:30:12 +00:00
|
|
|
# On Python 2 this will be the backported package.
|
|
|
|
import configparser
|
feat(py3): Fix config from string compatibility
I did an audit of the code base and AFAICT the `node.config_from_string(...)` is only
used internally. Much of that usage is in tests where most of the usages feed in
non-specific, simple `"..."` string literals (IOW, bytes under py2, unicode under py3) while one
test module used `b"..."` byte string literals. Given all that it seems to me that the
best goal would be to use simple string literals throughout the usage of
`node.config_from_string(...)` and have only one special case in that function to handle
the difference between versions.
I just discovered that running the test with `TEST_SUITE=allmydata` doesn't run the
tests in `allmydata.test.test_node` but running them with
`TEST_SUITE=allmydata.test.test_node` does run them. I'm trying to figure out why that
is, but in the meantime here are the differences in the Python 3 test output when
running just the `allmydata.test.test_node` tests. This changes converts 11 tests from
errros to success, changes the specific errors for others and improves coverage a bit:
```diff
--- ../../.tox/make-test-py3-all-old.log 2020-10-01 11:56:15.428609940 -0700
+++ ../../.tox/make-test-py3-all-new.log 2020-10-01 11:56:55.052792565 -0700
@@ -95,9 +95,9 @@
tor_provider,
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/introducer/server.py", line 87, in __init__
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 739, in __init__
self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 831, in setup_logging
newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
@@ -158,53 +158,29 @@
(#.### secs)
allmydata.test.test_node.TestCase.test_config_required ... [OK]
(#.### secs)
-allmydata.test.test_node.TestCase.test_location1 ... Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 112, in test_location1
- tub_location="192.0.2.0:1234")
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 99, in _test_location
- tub = testing_tub(config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 53, in testing_tub
- config = config_from_string(basedir, 'DEFAULT_PORTNUMFILE_BLANK', config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-[ERROR]
+allmydata.test.test_node.TestCase.test_location1 ... [OK]
(#.### secs)
allmydata.test.test_node.TestCase.test_location2 ... Traceback (most recent call last):
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 117, in test_location2
tub_location="192.0.2.0:1234,example.org:8091")
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 99, in _test_location
tub = testing_tub(config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 53, in testing_tub
- config = config_from_string(basedir, 'DEFAULT_PORTNUMFILE_BLANK', config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 65, in testing_tub
+ cert_filename='DEFAULT_CERTFILE_BLANK'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 669, in create_main_tub
+ portlocation = _tub_portlocation(config)
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 596, in _tub_portlocation
+ tubport = _convert_tub_port(file_tubport)
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 552, in _convert_tub_port
+ if re.search(r'^\d+$', s):
+ File "/usr/lib/python3.6/re.py", line 182, in search
+ return _compile(pattern, flags).search(string)
+builtins.TypeError: cannot use a string pattern on a bytes-like object
[ERROR]
(#.### secs)
-allmydata.test.test_node.TestCase.test_location_auto_and_explicit ... Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 142, in test_location_auto_and_explicit
- local_addresses=["127.0.0.1", "192.0.2.0", "example.com:4321"],
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 99, in _test_location
- tub = testing_tub(config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 53, in testing_tub
- config = config_from_string(basedir, 'DEFAULT_PORTNUMFILE_BLANK', config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-[ERROR]
+allmydata.test.test_node.TestCase.test_location_auto_and_explicit ... [OK]
(#.### secs)
-allmydata.test.test_node.TestCase.test_location_not_set ... Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 128, in test_location_not_set
- local_addresses=["127.0.0.1", "192.0.2.0"],
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 99, in _test_location
- tub = testing_tub(config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 53, in testing_tub
- config = config_from_string(basedir, 'DEFAULT_PORTNUMFILE_BLANK', config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-[ERROR]
+allmydata.test.test_node.TestCase.test_location_not_set ... [OK]
(#.### secs)
allmydata.test.test_node.TestCase.test_logdir_is_str ... Traceback (most recent call last):
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 340, in test_logdir_is_str
@@ -215,27 +191,31 @@
storage_broker,
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/client.py", line 676, in __init__
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 739, in __init__
self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 831, in setup_logging
newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
[ERROR]
(#.### secs)
allmydata.test.test_node.TestCase.test_private_config ... Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 259, in test_private_config
- config = config_from_string(basedir, "", "")
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-[ERROR]
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 261, in test_private_config
+ self.assertEqual(config.get_private_config("already"), "secret")
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/.tox/py36-coverage/lib/python3.6/site-packages/twisted/trial/_synctest.py", line 434, in assertEqual
+ super(_Assertions, self).assertEqual(first, second, msg)
+ File "/usr/lib/python3.6/unittest/case.py", line 829, in assertEqual
+ assertion_func(first, second, msg=msg)
+ File "/usr/lib/python3.6/unittest/case.py", line 822, in _baseAssertEqual
+ raise self.failureException(msg)
+twisted.trial.unittest.FailTest: b'secret' != 'secret'
+[FAILURE]
(#.### secs)
allmydata.test.test_node.TestCase.test_private_config_missing ... [OK]
(#.### secs)
allmydata.test.test_node.TestCase.test_private_config_unreadable ... Traceback (most recent call last):
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 213, in test_private_config_unreadable
config.get_or_create_private_config("foo", "contents")
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 369, in get_or_create_private_config
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 374, in get_or_create_private_config
fileutil.write(privname, value)
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/util/fileutil.py", line 275, in write
f.write(data)
@@ -258,77 +238,33 @@
(#.### secs)
allmydata.test.test_node.TestCase.test_timestamp ... [OK]
(#.### secs)
-allmydata.test.test_node.TestCase.test_write_config_unwritable_file ... Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 288, in test_write_config_unwritable_file
- config = config_from_string(basedir, "", "")
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-[ERROR]
+allmydata.test.test_node.TestCase.test_write_config_unwritable_file ... [OK]
(#.### secs)
-allmydata.test.test_node.TestMissingPorts.test_disabled_port_not_tub ... Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 488, in test_disabled_port_not_tub
- config = config_from_string(self.basedir, "portnum", config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-[ERROR]
+allmydata.test.test_node.TestMissingPorts.test_disabled_port_not_tub ... [OK]
(#.### secs)
-allmydata.test.test_node.TestMissingPorts.test_disabled_tub_not_port ... Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 506, in test_disabled_tub_not_port
- config = config_from_string(self.basedir, "portnum", config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-[ERROR]
+allmydata.test.test_node.TestMissingPorts.test_disabled_tub_not_port ... [OK]
(#.### secs)
-allmydata.test.test_node.TestMissingPorts.test_empty_tub_location ... Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 470, in test_empty_tub_location
- config = config_from_string(self.basedir, "portnum", config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-[ERROR]
+allmydata.test.test_node.TestMissingPorts.test_empty_tub_location ... [OK]
(#.### secs)
-allmydata.test.test_node.TestMissingPorts.test_empty_tub_port ... Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 453, in test_empty_tub_port
- config = config_from_string(self.basedir, "portnum", config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-[ERROR]
+allmydata.test.test_node.TestMissingPorts.test_empty_tub_port ... [OK]
(#.### secs)
-allmydata.test.test_node.TestMissingPorts.test_parsing_all_disabled ... Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 439, in test_parsing_all_disabled
- config = config_from_string(self.basedir, "portnum", config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-[ERROR]
+allmydata.test.test_node.TestMissingPorts.test_parsing_all_disabled ... [OK]
(#.### secs)
-allmydata.test.test_node.TestMissingPorts.test_parsing_defaults ... Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 392, in test_parsing_defaults
- config = config_from_string(self.basedir, "portnum", config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-[ERROR]
+allmydata.test.test_node.TestMissingPorts.test_parsing_defaults ... [OK]
(#.### secs)
allmydata.test.test_node.TestMissingPorts.test_parsing_location_complex ... Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 415, in test_parsing_location_complex
- config = config_from_string(self.basedir, "portnum", config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 418, in test_parsing_location_complex
+ tubport, tublocation = _tub_portlocation(config)
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 596, in _tub_portlocation
+ tubport = _convert_tub_port(file_tubport)
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 552, in _convert_tub_port
+ if re.search(r'^\d+$', s):
+ File "/usr/lib/python3.6/re.py", line 182, in search
+ return _compile(pattern, flags).search(string)
+builtins.TypeError: cannot use a string pattern on a bytes-like object
[ERROR]
(#.### secs)
-allmydata.test.test_node.TestMissingPorts.test_parsing_tcp ... Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 370, in test_parsing_tcp
- config = config_from_string(self.basedir, "portnum", config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-[ERROR]
+allmydata.test.test_node.TestMissingPorts.test_parsing_tcp ... [OK]
(#.### secs)
===============================================================================
@@ -415,9 +351,9 @@
tor_provider,
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/introducer/server.py", line 87, in __init__
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 739, in __init__
self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 831, in setup_logging
newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
@@ -449,6 +385,20 @@
allmydata.test.test_node.TestCase.test_config_items
===============================================================================
+[FAIL]
+Traceback (most recent call last):
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 261, in test_private_config
+ self.assertEqual(config.get_private_config("already"), "secret")
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/.tox/py36-coverage/lib/python3.6/site-packages/twisted/trial/_synctest.py", line 434, in assertEqual
+ super(_Assertions, self).assertEqual(first, second, msg)
+ File "/usr/lib/python3.6/unittest/case.py", line 829, in assertEqual
+ assertion_func(first, second, msg=msg)
+ File "/usr/lib/python3.6/unittest/case.py", line 822, in _baseAssertEqual
+ raise self.failureException(msg)
+twisted.trial.unittest.FailTest: b'secret' != 'secret'
+
+allmydata.test.test_node.TestCase.test_private_config
+===============================================================================
[ERROR]
Traceback (most recent call last):
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 657, in test_disabled
@@ -503,62 +453,26 @@
===============================================================================
[ERROR]
Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 112, in test_location1
- tub_location="192.0.2.0:1234")
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 99, in _test_location
- tub = testing_tub(config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 53, in testing_tub
- config = config_from_string(basedir, 'DEFAULT_PORTNUMFILE_BLANK', config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-
-allmydata.test.test_node.TestCase.test_location1
-===============================================================================
-[ERROR]
-Traceback (most recent call last):
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 117, in test_location2
tub_location="192.0.2.0:1234,example.org:8091")
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 99, in _test_location
tub = testing_tub(config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 53, in testing_tub
- config = config_from_string(basedir, 'DEFAULT_PORTNUMFILE_BLANK', config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 65, in testing_tub
+ cert_filename='DEFAULT_CERTFILE_BLANK'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 669, in create_main_tub
+ portlocation = _tub_portlocation(config)
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 596, in _tub_portlocation
+ tubport = _convert_tub_port(file_tubport)
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 552, in _convert_tub_port
+ if re.search(r'^\d+$', s):
+ File "/usr/lib/python3.6/re.py", line 182, in search
+ return _compile(pattern, flags).search(string)
+builtins.TypeError: cannot use a string pattern on a bytes-like object
allmydata.test.test_node.TestCase.test_location2
===============================================================================
[ERROR]
Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 142, in test_location_auto_and_explicit
- local_addresses=["127.0.0.1", "192.0.2.0", "example.com:4321"],
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 99, in _test_location
- tub = testing_tub(config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 53, in testing_tub
- config = config_from_string(basedir, 'DEFAULT_PORTNUMFILE_BLANK', config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-
-allmydata.test.test_node.TestCase.test_location_auto_and_explicit
-===============================================================================
-[ERROR]
-Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 128, in test_location_not_set
- local_addresses=["127.0.0.1", "192.0.2.0"],
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 99, in _test_location
- tub = testing_tub(config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 53, in testing_tub
- config = config_from_string(basedir, 'DEFAULT_PORTNUMFILE_BLANK', config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-
-allmydata.test.test_node.TestCase.test_location_not_set
-===============================================================================
-[ERROR]
-Traceback (most recent call last):
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 340, in test_logdir_is_str
yield client.create_client(basedir)
File "/home/rpatterson/src/work/sfu/tahoe-lafs/.tox/py36-coverage/lib/python3.6/site-packages/twisted/internet/defer.py", line 1418, in _inlineCallbacks
@@ -567,9 +481,9 @@
storage_broker,
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/client.py", line 676, in __init__
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 739, in __init__
self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 831, in setup_logging
newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
@@ -577,19 +491,9 @@
===============================================================================
[ERROR]
Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 259, in test_private_config
- config = config_from_string(basedir, "", "")
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-
-allmydata.test.test_node.TestCase.test_private_config
-===============================================================================
-[ERROR]
-Traceback (most recent call last):
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 213, in test_private_config_unreadable
config.get_or_create_private_config("foo", "contents")
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 369, in get_or_create_private_config
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 374, in get_or_create_private_config
fileutil.write(privname, value)
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/util/fileutil.py", line 275, in write
f.write(data)
@@ -607,97 +511,21 @@
===============================================================================
[ERROR]
Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 288, in test_write_config_unwritable_file
- config = config_from_string(basedir, "", "")
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-
-allmydata.test.test_node.TestCase.test_write_config_unwritable_file
-===============================================================================
-[ERROR]
-Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 488, in test_disabled_port_not_tub
- config = config_from_string(self.basedir, "portnum", config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-
-allmydata.test.test_node.TestMissingPorts.test_disabled_port_not_tub
-===============================================================================
-[ERROR]
-Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 506, in test_disabled_tub_not_port
- config = config_from_string(self.basedir, "portnum", config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-
-allmydata.test.test_node.TestMissingPorts.test_disabled_tub_not_port
-===============================================================================
-[ERROR]
-Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 470, in test_empty_tub_location
- config = config_from_string(self.basedir, "portnum", config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-
-allmydata.test.test_node.TestMissingPorts.test_empty_tub_location
-===============================================================================
-[ERROR]
-Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 453, in test_empty_tub_port
- config = config_from_string(self.basedir, "portnum", config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-
-allmydata.test.test_node.TestMissingPorts.test_empty_tub_port
-===============================================================================
-[ERROR]
-Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 439, in test_parsing_all_disabled
- config = config_from_string(self.basedir, "portnum", config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-
-allmydata.test.test_node.TestMissingPorts.test_parsing_all_disabled
-===============================================================================
-[ERROR]
-Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 392, in test_parsing_defaults
- config = config_from_string(self.basedir, "portnum", config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-
-allmydata.test.test_node.TestMissingPorts.test_parsing_defaults
-===============================================================================
-[ERROR]
-Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 415, in test_parsing_location_complex
- config = config_from_string(self.basedir, "portnum", config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 418, in test_parsing_location_complex
+ tubport, tublocation = _tub_portlocation(config)
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 596, in _tub_portlocation
+ tubport = _convert_tub_port(file_tubport)
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 552, in _convert_tub_port
+ if re.search(r'^\d+$', s):
+ File "/usr/lib/python3.6/re.py", line 182, in search
+ return _compile(pattern, flags).search(string)
+builtins.TypeError: cannot use a string pattern on a bytes-like object
allmydata.test.test_node.TestMissingPorts.test_parsing_location_complex
-===============================================================================
-[ERROR]
-Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 370, in test_parsing_tcp
- config = config_from_string(self.basedir, "portnum", config_data)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
- parser.readfp(BytesIO(config_str))
-builtins.TypeError: a bytes-like object is required, not 'str'
-
-allmydata.test.test_node.TestMissingPorts.test_parsing_tcp
-------------------------------------------------------------------------------
-Ran 34 tests in 2.788s
+Ran 34 tests in 2.516s
-FAILED (failures=4, errors=21, successes=9)
+FAILED (failures=5, errors=9, successes=20)
Name Stmts Miss Branch BrPart Cover Missing
------------------------------------------------------------------------------------------------
src/allmydata/__init__.py 16 4 0 0 75% 18-22, 28-32
@@ -751,7 +579,7 @@
src/allmydata/mutable/repairer.py 57 37 18 0 29% 13, 15, 17, 19, 29-34, 65-71, 74-126, 129-131
src/allmydata/mutable/retrieve.py 489 411 120 0 13% 29-43, 46, 48, 50, 52, 54, 56, 58, 60, 62, 64, 67-69, 71, 73, 75, 77, 79, 81, 83, 85, 87, 89-90, 105-160, 164, 167-171, 174-175, 186-193, 201-208, 211-212, 223-227, 230-232, 236-254, 257-275, 278-283, 286-332, 344-354, 362-454, 485-516, 529-540, 564-578, 586-597, 607-633, 643-663, 671-699, 712-729, 738-798, 806-829, 839-889, 897-905, 909-910, 919-941, 950-971, 981-994, 999-1005
src/allmydata/mutable/servermap.py 623 524 198 0 12% 26-38, 41-42, 45, 47, 49, 51, 53, 55, 57, 59, 61, 63, 65, 67, 70, 72, 74, 76, 78, 80, 82, 116-124, 130-139, 142, 145, 148, 159-161, 165, 170-172, 175, 177, 180-181, 183, 186-199, 202, 206, 213, 217-220, 225-228, 231, 234-238, 243-252, 255-259, 263-265, 269-275, 280-290, 295-305, 311-315, 320-322, 328-350, 358-363, 370-372, 379, 390-450, 454, 457-461, 466-545, 549-557, 560-575, 578-593, 596-613, 623-638, 642-779, 787, 791-799, 803-804, 816-880, 883-904, 910-914, 919-920, 928-944, 960-974, 981-998, 1002-1012, 1020-1183, 1186-1205, 1209-1225, 1228-1229
-src/allmydata/node.py 388 106 146 39 69% 120, 132, 190, 211-213, 241, 243-245, 278, 284, 291-295, 303-306, 315, 320, 339, 341, 361, 368, 370, 377-379, 393-396, 422, 424, 449, 453, 490, 493, 500, 511-512, 547-549, 566, 574, 581, 583, 590-591, 597, 601, 612, 622-634, 679, 681, 736-750, 756, 764, 792-805, 808-809, 814-815, 827-846, 189->190, 204->208, 240->241, 242->243, 277->278, 314->315, 319->320, 338->339, 340->341, 360->361, 365->368, 391->393, 421->422, 423->424, 448->449, 451->453, 489->490, 492->493, 499->500, 510->511, 565->566, 567->570, 573->574, 575->578, 580->581, 582->583, 585->597, 589->590, 600->601, 603->606, 610->616, 611->612, 618->622, 673->679, 680->681, 763->764, 766->768, 821->830, 823->821
+src/allmydata/node.py 391 87 148 30 75% 20, 125, 137, 195, 246, 248-250, 283, 289, 308-311, 320, 325, 344, 346, 366, 373, 375, 382-384, 398-401, 427, 429, 454, 458, 495, 498, 505, 516-517, 606, 617, 634-638, 684, 686, 741-755, 761, 769, 797-810, 813-814, 819-820, 832-851, 19->20, 194->195, 209->213, 245->246, 247->248, 282->283, 319->320, 324->325, 343->344, 345->346, 365->366, 370->373, 396->398, 426->427, 428->429, 453->454, 456->458, 494->495, 497->498, 504->505, 515->516, 605->606, 616->617, 627->634, 678->684, 685->686, 768->769, 771->773, 826->835, 828->826
src/allmydata/nodemaker.py 97 71 38 0 21% 23-33, 36, 38, 41, 44-47, 49, 53-95, 98-115, 118-125, 129-138, 141-150
src/allmydata/scripts/admin.py 51 31 2 0 38% 9-14, 17-21, 25, 28, 31-37, 40-46, 56-57, 59, 61-66, 74-78
src/allmydata/scripts/backupdb.py 146 146 14 0 0% 1-341
@@ -810,7 +638,7 @@
src/allmydata/util/dictutil.py 38 22 12 1 34% 16, 21-24, 27-31, 34-38, 55-56, 59-60, 63-64, 71, 77-78, 12->16
src/allmydata/util/eliotutil.py 115 68 24 0 35% 82-85, 91-94, 104, 117-122, 129-139, 151, 155-159, 163-167, 179-186, 198-199, 202-210, 222-226, 231-247, 250, 266-294, 308-312
src/allmydata/util/encodingutil.py 217 123 80 12 36% 18, 37-38, 41, 43, 52-53, 69, 75-78, 102, 108, 114-122, 130-134, 145-155, 164, 173-175, 178-181, 187, 196-213, 217-231, 237-243, 279-282, 291-296, 314, 320-322, 327, 334-340, 343-355, 358-363, 366-367, 370-373, 379, 395-405, 412-420, 423, 429, 16->18, 36->37, 40->41, 42->43, 66->69, 72->74, 74->75, 278->279, 285->295, 288->291, 299->310, 319->320
-src/allmydata/util/fileutil.py 343 244 120 13 25% 15, 23-25, 47-55, 71-85, 96-97, 100, 103, 106, 109, 115-116, 119-125, 128, 131, 134, 137-138, 142-145, 151-153, 158, 166-176, 179-184, 201-203, 214-237, 241-244, 247-254, 262, 279, 282-290, 293-304, 326, 328, 336-342, 348, 351, 358, 366-376, 382-400, 405, 410-426, 434-462, 486-529, 548-554, 566-568, 573-604, 608-612, 615-627, 633, 636-659, 13->15, 22->23, 200->201, 259->262, 325->326, 327->328, 332->336, 345->351, 347->348, 357->358, 380->382, 404->405, 571->573
+src/allmydata/util/fileutil.py 343 243 120 13 25% 15, 23-25, 47-55, 71-85, 96-97, 100, 103, 106, 109, 115-116, 119-125, 128, 131, 134, 137-138, 142-145, 151-153, 158, 166-176, 179-184, 201-203, 214-237, 241-244, 247-254, 262, 282-290, 293-304, 326, 328, 336-342, 348, 351, 358, 366-376, 382-400, 405, 410-426, 434-462, 486-529, 548-554, 566-568, 573-604, 608-612, 615-627, 633, 636-659, 13->15, 22->23, 200->201, 259->262, 325->326, 327->328, 332->336, 345->351, 347->348, 357->358, 380->382, 404->405, 571->573
src/allmydata/util/gcutil.py 23 3 8 3 81% 20, 51-57, 19->20, 50->51, 64->exit
src/allmydata/util/happinessutil.py 77 62 42 1 13% 15, 25-54, 64-69, 82-92, 142-183, 207-223, 235-249, 13->15
src/allmydata/util/hashutil.py 157 76 8 1 50% 14, 40-42, 45-46, 49-56, 60-62, 66-68, 72-76, 118, 122, 126, 130, 134, 138, 142, 146, 150, 154, 158, 162, 166, 174-176, 180-183, 187, 191, 195, 199, 204, 209-210, 214-215, 219, 223-228, 232, 236, 240, 244, 248-250, 254, 258, 262, 266, 270-271, 278, 282, 12->14
@@ -818,7 +646,7 @@
src/allmydata/util/i2p_provider.py 121 73 36 5 35% 44-67, 72-81, 85-135, 151-161, 168, 176-180, 183-184, 187, 193-216, 219, 226, 167->168, 175->176, 182->183, 186->187, 192->193
src/allmydata/util/idlib.py 5 2 0 0 60% 6, 9
src/allmydata/util/iputil.py 172 74 56 12 52% 14, 63-102, 123-140, 151-184, 209, 216, 229, 237-238, 242, 246, 254-257, 271-277, 328-329, 353-354, 13->14, 215->216, 220->242, 226->229, 234->220, 239->234, 245->246, 249->259, 265->261, 291->329, 295->328, 360->exit
-src/allmydata/util/log.py 52 27 16 1 38% 13, 38-41, 46-48, 51-61, 67-75, 78, 12->13
+src/allmydata/util/log.py 52 23 16 2 46% 13, 46-48, 51-61, 67-75, 78, 12->13, 39->41
src/allmydata/util/mathutil.py 12 3 2 1 71% 16, 25-26, 15->16
src/allmydata/util/netstring.py 35 24 12 1 26% 13, 31-54, 12->13
src/allmydata/util/observer.py 91 56 20 1 32% 14, 29-32, 36-38, 41, 44, 47, 50-54, 57-60, 63-66, 69-70, 79, 82, 93-97, 103, 106, 109, 112-113, 119-121, 134, 137-139, 142-145, 148-151, 154-157, 13->14
@@ -854,7 +682,7 @@
src/allmydata/windows/fixups.py 133 133 54 0 0% 1-237
src/allmydata/windows/registry.py 42 42 12 0 0% 1-77
------------------------------------------------------------------------------------------------
-TOTAL 27467 22018 8248 184 17%
+TOTAL 27470 21994 8250 176 17%
12 files skipped due to complete coverage.
make[#]: Leaving directory '/home/rpatterson/src/work/sfu/tahoe-lafs'
```
2020-10-01 18:23:52 +00:00
|
|
|
|
2020-11-14 14:12:14 +00:00
|
|
|
from twisted.python.filepath import FilePath
|
2008-09-20 17:35:45 +00:00
|
|
|
from twisted.python import log as twlog
|
2007-03-08 22:10:36 +00:00
|
|
|
from twisted.application import service
|
2018-08-24 21:50:55 +00:00
|
|
|
from twisted.python.failure import Failure
|
2016-04-27 04:54:45 +00:00
|
|
|
from foolscap.api import Tub, app_versions
|
2008-07-07 06:49:08 +00:00
|
|
|
import foolscap.logging.log
|
2019-08-13 19:11:01 +00:00
|
|
|
from allmydata.version_checks import get_package_versions, get_package_versions_string
|
2008-07-03 00:40:29 +00:00
|
|
|
from allmydata.util import log
|
2016-04-27 04:54:45 +00:00
|
|
|
from allmydata.util import fileutil, iputil
|
|
|
|
from allmydata.util.assertutil import _assert
|
2010-07-22 00:14:18 +00:00
|
|
|
from allmydata.util.fileutil import abspath_expanduser_unicode
|
2011-08-03 16:38:48 +00:00
|
|
|
from allmydata.util.encodingutil import get_filesystem_encoding, quote_output
|
2015-12-21 21:59:15 +00:00
|
|
|
from allmydata.util import configutil
|
2020-11-14 14:12:14 +00:00
|
|
|
from allmydata.util.yamlutil import (
|
|
|
|
safe_load,
|
|
|
|
)
|
2016-08-31 08:50:13 +00:00
|
|
|
|
2019-06-17 20:44:17 +00:00
|
|
|
def _common_valid_config():
|
|
|
|
return configutil.ValidConfiguration({
|
2016-09-05 22:34:17 +00:00
|
|
|
"connections": (
|
|
|
|
"tcp",
|
|
|
|
),
|
|
|
|
"node": (
|
|
|
|
"log_gatherer.furl",
|
|
|
|
"nickname",
|
|
|
|
"reveal-ip-address",
|
|
|
|
"tempdir",
|
|
|
|
"timeout.disconnect",
|
|
|
|
"timeout.keepalive",
|
|
|
|
"tub.location",
|
|
|
|
"tub.port",
|
|
|
|
"web.port",
|
|
|
|
"web.static",
|
|
|
|
),
|
|
|
|
"i2p": (
|
|
|
|
"enabled",
|
|
|
|
"i2p.configdir",
|
|
|
|
"i2p.executable",
|
|
|
|
"launch",
|
|
|
|
"sam.port",
|
2016-10-22 19:26:36 +00:00
|
|
|
"dest",
|
|
|
|
"dest.port",
|
|
|
|
"dest.private_key_file",
|
2016-09-05 22:34:17 +00:00
|
|
|
),
|
|
|
|
"tor": (
|
|
|
|
"control.port",
|
|
|
|
"enabled",
|
|
|
|
"launch",
|
|
|
|
"socks.port",
|
|
|
|
"tor.executable",
|
2016-10-09 05:02:11 +00:00
|
|
|
"onion",
|
|
|
|
"onion.local_port",
|
|
|
|
"onion.external_port",
|
|
|
|
"onion.private_key_file",
|
2016-09-05 22:34:17 +00:00
|
|
|
),
|
2019-06-17 20:44:17 +00:00
|
|
|
})
|
2016-09-05 22:34:17 +00:00
|
|
|
|
2007-12-21 21:42:38 +00:00
|
|
|
# Add our application versions to the data that Foolscap's LogPublisher
|
2008-09-23 00:03:51 +00:00
|
|
|
# reports.
|
2020-10-29 18:09:18 +00:00
|
|
|
for thing, things_version in list(get_package_versions().items()):
|
2020-09-30 16:56:43 +00:00
|
|
|
app_versions.add_version(thing, things_version)
|
2007-05-21 20:42:51 +00:00
|
|
|
|
2007-05-22 21:01:40 +00:00
|
|
|
# group 1 will be addr (dotted quad string), group 3 if any will be portnum (string)
|
2018-03-01 19:31:30 +00:00
|
|
|
ADDR_RE = re.compile("^([1-9][0-9]*\.[1-9][0-9]*\.[1-9][0-9]*\.[1-9][0-9]*)(:([1-9][0-9]*))?$")
|
2007-05-22 21:01:40 +00:00
|
|
|
|
2018-01-28 06:13:50 +00:00
|
|
|
# this is put into README in new node-directories (for client and introducers)
|
|
|
|
PRIV_README = """
|
|
|
|
This directory contains files which contain private data for the Tahoe node,
|
|
|
|
such as private keys. On Unix-like systems, the permissions on this directory
|
|
|
|
are set to disallow users other than its owner from reading the contents of
|
|
|
|
the files. See the 'configuration.rst' documentation file for details.
|
|
|
|
"""
|
|
|
|
|
2007-10-12 00:30:07 +00:00
|
|
|
|
2007-10-15 03:43:11 +00:00
|
|
|
def formatTimeTahoeStyle(self, when):
|
2018-03-01 19:28:18 +00:00
|
|
|
"""
|
|
|
|
Format the given (UTC) timestamp in the way Tahoe-LAFS expects it,
|
|
|
|
for example: 2007-10-12 00:26:28.566Z
|
|
|
|
|
|
|
|
:param when: UTC POSIX timestamp
|
|
|
|
:type when: float
|
|
|
|
:returns: datetime.datetime
|
|
|
|
"""
|
2007-10-15 03:46:51 +00:00
|
|
|
d = datetime.datetime.utcfromtimestamp(when)
|
|
|
|
if d.microsecond:
|
2020-10-30 17:59:57 +00:00
|
|
|
return d.isoformat(ensure_str(" "))[:-3]+"Z"
|
|
|
|
return d.isoformat(ensure_str(" ")) + ".000Z"
|
2007-10-12 00:30:07 +00:00
|
|
|
|
2018-03-01 19:31:30 +00:00
|
|
|
PRIV_README = """
|
2007-12-17 23:39:54 +00:00
|
|
|
This directory contains files which contain private data for the Tahoe node,
|
|
|
|
such as private keys. On Unix-like systems, the permissions on this directory
|
|
|
|
are set to disallow users other than its owner from reading the contents of
|
2010-11-28 17:34:44 +00:00
|
|
|
the files. See the 'configuration.rst' documentation file for details."""
|
2007-12-17 23:39:54 +00:00
|
|
|
|
2018-08-24 21:41:31 +00:00
|
|
|
class _None(object):
|
2018-03-01 19:56:59 +00:00
|
|
|
"""
|
|
|
|
This class is to be used as a marker in get_config()
|
|
|
|
"""
|
2008-09-30 23:21:49 +00:00
|
|
|
pass
|
|
|
|
|
|
|
|
class MissingConfigEntry(Exception):
|
2011-08-01 23:24:23 +00:00
|
|
|
""" A required config entry was not found. """
|
|
|
|
|
|
|
|
class OldConfigError(Exception):
|
|
|
|
""" An obsolete config file was found. See
|
|
|
|
docs/historical/configuration.rst. """
|
2011-08-03 17:45:46 +00:00
|
|
|
def __str__(self):
|
|
|
|
return ("Found pre-Tahoe-LAFS-v1.3 configuration file(s):\n"
|
|
|
|
"%s\n"
|
|
|
|
"See docs/historical/configuration.rst."
|
|
|
|
% "\n".join([quote_output(fname) for fname in self.args[0]]))
|
|
|
|
|
2011-11-20 23:24:26 +00:00
|
|
|
class OldConfigOptionError(Exception):
|
2018-03-01 19:28:18 +00:00
|
|
|
"""Indicate that outdated configuration options are being used."""
|
2011-11-20 23:24:26 +00:00
|
|
|
pass
|
|
|
|
|
2014-05-05 21:55:50 +00:00
|
|
|
class UnescapedHashError(Exception):
|
2018-03-01 19:28:18 +00:00
|
|
|
"""Indicate that a configuration entry contains an unescaped '#' character."""
|
2014-05-05 21:55:50 +00:00
|
|
|
def __str__(self):
|
|
|
|
return ("The configuration entry %s contained an unescaped '#' character."
|
2014-05-05 22:14:48 +00:00
|
|
|
% quote_output("[%s]%s = %s" % self.args))
|
2014-05-05 21:55:50 +00:00
|
|
|
|
2016-08-31 09:44:27 +00:00
|
|
|
class PrivacyError(Exception):
|
|
|
|
"""reveal-IP-address = false, but the node is configured in such a way
|
|
|
|
that the IP address could be revealed"""
|
2008-09-30 23:21:49 +00:00
|
|
|
|
2017-09-06 01:08:35 +00:00
|
|
|
|
2018-02-27 22:00:31 +00:00
|
|
|
def create_node_dir(basedir, readme_text):
|
|
|
|
"""
|
|
|
|
Create new new 'node directory' at 'basedir'. This includes a
|
|
|
|
'private' subdirectory. If basedir (and privdir) already exists,
|
|
|
|
nothing is done.
|
|
|
|
|
|
|
|
:param readme_text: text to put in <basedir>/private/README
|
|
|
|
"""
|
|
|
|
if not os.path.exists(basedir):
|
|
|
|
fileutil.make_dirs(basedir)
|
|
|
|
privdir = os.path.join(basedir, "private")
|
|
|
|
if not os.path.exists(privdir):
|
2018-08-24 21:42:00 +00:00
|
|
|
fileutil.make_dirs(privdir, 0o700)
|
2020-10-30 17:59:57 +00:00
|
|
|
readme_text = ensure_text(readme_text)
|
2018-02-27 22:00:31 +00:00
|
|
|
with open(os.path.join(privdir, 'README'), 'w') as f:
|
|
|
|
f.write(readme_text)
|
|
|
|
|
|
|
|
|
2019-06-17 20:44:17 +00:00
|
|
|
def read_config(basedir, portnumfile, generated_files=[], _valid_config=None):
|
2018-08-24 21:41:31 +00:00
|
|
|
"""
|
|
|
|
Read and validate configuration.
|
|
|
|
|
|
|
|
:param unicode basedir: directory where configuration data begins
|
|
|
|
|
|
|
|
:param unicode portnumfile: filename fragment for "port number" files
|
|
|
|
|
|
|
|
:param list generated_files: a list of automatically-generated
|
|
|
|
configuration files.
|
|
|
|
|
2019-06-17 20:44:17 +00:00
|
|
|
:param ValidConfiguration _valid_config: (internal use, optional) a
|
|
|
|
structure defining valid configuration sections and keys
|
2018-08-24 21:41:31 +00:00
|
|
|
|
|
|
|
:returns: :class:`allmydata.node._Config` instance
|
|
|
|
"""
|
2020-10-30 15:23:30 +00:00
|
|
|
basedir = abspath_expanduser_unicode(ensure_text(basedir))
|
2019-06-17 20:44:17 +00:00
|
|
|
if _valid_config is None:
|
|
|
|
_valid_config = _common_valid_config()
|
2017-09-06 01:08:35 +00:00
|
|
|
|
|
|
|
# complain if there's bad stuff in the config dir
|
|
|
|
_error_about_old_config_files(basedir, generated_files)
|
|
|
|
|
|
|
|
# canonicalize the portnum file
|
|
|
|
portnumfile = os.path.join(basedir, portnumfile)
|
|
|
|
|
|
|
|
# (try to) read the main config file
|
|
|
|
config_fname = os.path.join(basedir, "tahoe.cfg")
|
|
|
|
try:
|
|
|
|
parser = configutil.get_config(config_fname)
|
2018-08-24 21:50:55 +00:00
|
|
|
except EnvironmentError as e:
|
|
|
|
if e.errno != errno.ENOENT:
|
2017-09-06 01:08:35 +00:00
|
|
|
raise
|
2020-10-27 15:48:25 +00:00
|
|
|
# The file is missing, just create empty ConfigParser.
|
2020-10-27 17:59:45 +00:00
|
|
|
parser = configutil.get_config_from_string(u"")
|
2018-01-31 18:30:46 +00:00
|
|
|
|
2019-06-17 20:44:17 +00:00
|
|
|
configutil.validate_config(config_fname, parser, _valid_config)
|
2018-01-31 18:30:46 +00:00
|
|
|
|
|
|
|
# make sure we have a private configuration area
|
|
|
|
fileutil.make_dirs(os.path.join(basedir, "private"), 0o700)
|
2018-01-29 01:59:56 +00:00
|
|
|
|
2018-01-31 18:30:46 +00:00
|
|
|
return _Config(parser, portnumfile, basedir, config_fname)
|
2017-09-06 01:08:35 +00:00
|
|
|
|
|
|
|
|
2019-06-19 14:47:23 +00:00
|
|
|
def config_from_string(basedir, portnumfile, config_str, _valid_config=None):
|
2018-08-25 08:23:58 +00:00
|
|
|
"""
|
2019-06-19 14:47:23 +00:00
|
|
|
load and validate configuration from in-memory string
|
2018-08-25 08:23:58 +00:00
|
|
|
"""
|
2019-06-19 14:47:23 +00:00
|
|
|
if _valid_config is None:
|
|
|
|
_valid_config = _common_valid_config()
|
|
|
|
|
2020-10-27 12:54:28 +00:00
|
|
|
if isinstance(config_str, bytes):
|
|
|
|
config_str = config_str.decode("utf-8")
|
2020-10-27 17:59:45 +00:00
|
|
|
|
2018-03-13 23:11:30 +00:00
|
|
|
# load configuration from in-memory string
|
2020-10-27 17:59:45 +00:00
|
|
|
parser = configutil.get_config_from_string(config_str)
|
2019-06-19 14:47:23 +00:00
|
|
|
|
|
|
|
fname = "<in-memory>"
|
|
|
|
configutil.validate_config(fname, parser, _valid_config)
|
|
|
|
return _Config(parser, portnumfile, basedir, fname)
|
2017-09-06 01:08:35 +00:00
|
|
|
|
|
|
|
|
2018-02-14 01:57:49 +00:00
|
|
|
def get_app_versions():
|
2018-08-24 21:44:17 +00:00
|
|
|
"""
|
|
|
|
:returns: dict of versions important to Foolscap
|
|
|
|
"""
|
2018-02-14 01:57:49 +00:00
|
|
|
return dict(app_versions.versions)
|
|
|
|
|
|
|
|
|
2017-09-06 01:08:35 +00:00
|
|
|
def _error_about_old_config_files(basedir, generated_files):
|
|
|
|
"""
|
|
|
|
If any old configuration files are detected, raise
|
|
|
|
OldConfigError.
|
|
|
|
"""
|
|
|
|
oldfnames = set()
|
|
|
|
old_names = [
|
|
|
|
'nickname', 'webport', 'keepalive_timeout', 'log_gatherer.furl',
|
|
|
|
'disconnect_timeout', 'advertised_ip_addresses', 'introducer.furl',
|
|
|
|
'helper.furl', 'key_generator.furl', 'stats_gatherer.furl',
|
|
|
|
'no_storage', 'readonly_storage', 'sizelimit',
|
|
|
|
'debug_discard_storage', 'run_helper'
|
|
|
|
]
|
|
|
|
for fn in generated_files:
|
|
|
|
old_names.remove(fn)
|
|
|
|
for name in old_names:
|
|
|
|
fullfname = os.path.join(basedir, name)
|
|
|
|
if os.path.exists(fullfname):
|
|
|
|
oldfnames.add(fullfname)
|
|
|
|
if oldfnames:
|
|
|
|
e = OldConfigError(oldfnames)
|
|
|
|
twlog.msg(e)
|
|
|
|
raise e
|
|
|
|
|
|
|
|
|
|
|
|
class _Config(object):
|
|
|
|
"""
|
2018-02-22 21:39:35 +00:00
|
|
|
Manages configuration of a Tahoe 'node directory'.
|
2017-09-06 01:08:35 +00:00
|
|
|
|
2018-02-22 21:39:35 +00:00
|
|
|
Note: all this code and functionality was formerly in the Node
|
|
|
|
class; names and funtionality have been kept the same while moving
|
|
|
|
the code. It probably makes sense for several of these APIs to
|
|
|
|
have better names.
|
2017-09-06 01:08:35 +00:00
|
|
|
"""
|
|
|
|
|
2018-01-31 18:30:46 +00:00
|
|
|
def __init__(self, configparser, portnum_fname, basedir, config_fname):
|
2018-02-22 21:39:35 +00:00
|
|
|
"""
|
|
|
|
:param configparser: a ConfigParser instance
|
|
|
|
|
|
|
|
:param portnum_fname: filename to use for the port-number file
|
|
|
|
(a relative path inside basedir)
|
|
|
|
|
|
|
|
:param basedir: path to our "node directory", inside which all
|
|
|
|
configuration is managed
|
|
|
|
|
|
|
|
:param config_fname: the pathname actually used to create the
|
|
|
|
configparser (might be 'fake' if using in-memory data)
|
|
|
|
"""
|
2017-09-06 01:08:35 +00:00
|
|
|
self.portnum_fname = portnum_fname
|
2020-10-30 15:23:30 +00:00
|
|
|
self._basedir = abspath_expanduser_unicode(ensure_text(basedir))
|
2018-02-22 21:39:35 +00:00
|
|
|
self._config_fname = config_fname
|
2017-09-06 01:08:35 +00:00
|
|
|
self.config = configparser
|
2020-10-29 14:20:06 +00:00
|
|
|
self.nickname = self.get_config("node", "nickname", u"<unspecified>")
|
2020-10-29 18:09:18 +00:00
|
|
|
assert isinstance(self.nickname, str)
|
2017-09-06 01:08:35 +00:00
|
|
|
|
|
|
|
def validate(self, valid_config_sections):
|
|
|
|
configutil.validate_config(self._config_fname, self.config, valid_config_sections)
|
|
|
|
|
2018-01-31 18:30:46 +00:00
|
|
|
def write_config_file(self, name, value, mode="w"):
|
|
|
|
"""
|
|
|
|
writes the given 'value' into a file called 'name' in the config
|
|
|
|
directory
|
|
|
|
"""
|
|
|
|
fn = os.path.join(self._basedir, name)
|
|
|
|
try:
|
|
|
|
fileutil.write(fn, value, mode)
|
2018-01-31 22:28:47 +00:00
|
|
|
except EnvironmentError:
|
|
|
|
log.err(
|
|
|
|
Failure(),
|
|
|
|
"Unable to write config file '{}'".format(fn),
|
|
|
|
)
|
2018-01-31 18:30:46 +00:00
|
|
|
|
2019-08-19 15:21:03 +00:00
|
|
|
def items(self, section, default=_None):
|
|
|
|
try:
|
|
|
|
return self.config.items(section)
|
2020-08-21 20:27:21 +00:00
|
|
|
except configparser.NoSectionError:
|
2019-08-19 15:21:03 +00:00
|
|
|
if default is _None:
|
|
|
|
raise
|
|
|
|
return default
|
2019-06-27 19:07:45 +00:00
|
|
|
|
2017-09-06 01:08:35 +00:00
|
|
|
def get_config(self, section, option, default=_None, boolean=False):
|
|
|
|
try:
|
|
|
|
if boolean:
|
|
|
|
return self.config.getboolean(section, option)
|
|
|
|
|
|
|
|
item = self.config.get(section, option)
|
2020-10-29 17:51:29 +00:00
|
|
|
if option.endswith(".furl") and '#' in item:
|
2017-09-06 01:08:35 +00:00
|
|
|
raise UnescapedHashError(section, option, item)
|
|
|
|
|
|
|
|
return item
|
2020-08-21 20:27:21 +00:00
|
|
|
except (configparser.NoOptionError, configparser.NoSectionError):
|
2017-09-06 01:08:35 +00:00
|
|
|
if default is _None:
|
|
|
|
raise MissingConfigEntry(
|
|
|
|
"{} is missing the [{}]{} entry".format(
|
|
|
|
quote_output(self._config_fname),
|
|
|
|
section,
|
|
|
|
option,
|
|
|
|
)
|
|
|
|
)
|
|
|
|
return default
|
|
|
|
|
2018-01-31 18:30:46 +00:00
|
|
|
def get_config_from_file(self, name, required=False):
|
|
|
|
"""Get the (string) contents of a config file, or None if the file
|
|
|
|
did not exist. If required=True, raise an exception rather than
|
|
|
|
returning None. Any leading or trailing whitespace will be stripped
|
|
|
|
from the data."""
|
|
|
|
fn = os.path.join(self._basedir, name)
|
|
|
|
try:
|
|
|
|
return fileutil.read(fn).strip()
|
2018-08-24 21:50:55 +00:00
|
|
|
except EnvironmentError as e:
|
|
|
|
if e.errno != errno.ENOENT:
|
|
|
|
raise # we only care about "file doesn't exist"
|
2018-01-31 18:30:46 +00:00
|
|
|
if not required:
|
|
|
|
return None
|
|
|
|
raise
|
|
|
|
|
|
|
|
def get_or_create_private_config(self, name, default=_None):
|
|
|
|
"""Try to get the (string) contents of a private config file (which
|
|
|
|
is a config file that resides within the subdirectory named
|
|
|
|
'private'), and return it. Any leading or trailing whitespace will be
|
|
|
|
stripped from the data.
|
|
|
|
|
|
|
|
If the file does not exist, and default is not given, report an error.
|
|
|
|
If the file does not exist and a default is specified, try to create
|
|
|
|
it using that default, and then return the value that was written.
|
|
|
|
If 'default' is a string, use it as a default value. If not, treat it
|
|
|
|
as a zero-argument callable that is expected to return a string.
|
|
|
|
"""
|
|
|
|
privname = os.path.join(self._basedir, "private", name)
|
|
|
|
try:
|
2020-10-16 15:13:11 +00:00
|
|
|
value = fileutil.read(privname, mode="r")
|
2018-08-24 21:50:55 +00:00
|
|
|
except EnvironmentError as e:
|
|
|
|
if e.errno != errno.ENOENT:
|
|
|
|
raise # we only care about "file doesn't exist"
|
2018-01-31 18:30:46 +00:00
|
|
|
if default is _None:
|
|
|
|
raise MissingConfigEntry("The required configuration file %s is missing."
|
|
|
|
% (quote_output(privname),))
|
2020-10-16 15:13:11 +00:00
|
|
|
if isinstance(default, bytes):
|
2020-10-29 18:09:18 +00:00
|
|
|
default = str(default, "utf-8")
|
|
|
|
if isinstance(default, str):
|
2018-01-31 18:30:46 +00:00
|
|
|
value = default
|
|
|
|
else:
|
|
|
|
value = default()
|
|
|
|
fileutil.write(privname, value)
|
|
|
|
return value.strip()
|
|
|
|
|
|
|
|
def write_private_config(self, name, value):
|
|
|
|
"""Write the (string) contents of a private config file (which is a
|
|
|
|
config file that resides within the subdirectory named 'private'), and
|
|
|
|
return it.
|
|
|
|
"""
|
2020-10-29 18:09:18 +00:00
|
|
|
if isinstance(value, str):
|
2020-10-16 15:13:11 +00:00
|
|
|
value = value.encode("utf-8")
|
2018-01-31 18:30:46 +00:00
|
|
|
privname = os.path.join(self._basedir, "private", name)
|
2020-09-16 15:13:23 +00:00
|
|
|
with open(privname, "wb") as f:
|
2018-01-31 18:30:46 +00:00
|
|
|
f.write(value)
|
|
|
|
|
|
|
|
def get_private_config(self, name, default=_None):
|
2020-10-16 15:13:11 +00:00
|
|
|
"""Read the (native string) contents of a private config file (a
|
2018-01-31 18:30:46 +00:00
|
|
|
config file that resides within the subdirectory named 'private'),
|
|
|
|
and return it. Return a default, or raise an error if one was not
|
|
|
|
given.
|
|
|
|
"""
|
|
|
|
privname = os.path.join(self._basedir, "private", name)
|
|
|
|
try:
|
2020-10-16 15:13:11 +00:00
|
|
|
return fileutil.read(privname, mode="r").strip()
|
2018-08-24 21:50:55 +00:00
|
|
|
except EnvironmentError as e:
|
|
|
|
if e.errno != errno.ENOENT:
|
|
|
|
raise # we only care about "file doesn't exist"
|
2018-01-31 18:30:46 +00:00
|
|
|
if default is _None:
|
|
|
|
raise MissingConfigEntry("The required configuration file %s is missing."
|
|
|
|
% (quote_output(privname),))
|
|
|
|
return default
|
|
|
|
|
|
|
|
def get_private_path(self, *args):
|
|
|
|
"""
|
|
|
|
returns an absolute path inside the 'private' directory with any
|
|
|
|
extra args join()-ed
|
|
|
|
"""
|
|
|
|
return os.path.join(self._basedir, "private", *args)
|
|
|
|
|
|
|
|
def get_config_path(self, *args):
|
|
|
|
"""
|
|
|
|
returns an absolute path inside the config directory with any
|
|
|
|
extra args join()-ed
|
|
|
|
"""
|
2018-02-22 22:32:00 +00:00
|
|
|
# note: we re-expand here (_basedir already went through this
|
|
|
|
# expanduser function) in case the path we're being asked for
|
|
|
|
# has embedded ".."'s in it
|
|
|
|
return abspath_expanduser_unicode(
|
|
|
|
os.path.join(self._basedir, *args)
|
|
|
|
)
|
2018-01-31 18:30:46 +00:00
|
|
|
|
2020-11-14 14:12:14 +00:00
|
|
|
def get_introducer_configuration(self):
|
|
|
|
"""
|
|
|
|
Get configuration for introducers.
|
|
|
|
|
2020-11-14 14:26:07 +00:00
|
|
|
:return {unicode: (unicode, FilePath)}: A mapping from introducer
|
|
|
|
petname to a tuple of the introducer's fURL and local cache path.
|
2020-11-14 14:12:14 +00:00
|
|
|
"""
|
|
|
|
introducers_yaml_filename = self.get_private_path("introducers.yaml")
|
|
|
|
introducers_filepath = FilePath(introducers_yaml_filename)
|
|
|
|
|
2020-11-14 14:26:07 +00:00
|
|
|
def get_cache_filepath(petname):
|
|
|
|
return FilePath(
|
|
|
|
self.get_private_path("introducer_{}_cache.yaml".format(petname)),
|
|
|
|
)
|
|
|
|
|
2020-11-14 14:12:14 +00:00
|
|
|
try:
|
|
|
|
with introducers_filepath.open() as f:
|
|
|
|
introducers_yaml = safe_load(f)
|
|
|
|
if introducers_yaml is None:
|
|
|
|
raise EnvironmentError(
|
|
|
|
EPERM,
|
|
|
|
"Can't read '{}'".format(introducers_yaml_filename),
|
|
|
|
introducers_yaml_filename,
|
|
|
|
)
|
|
|
|
introducers = {
|
|
|
|
petname: config["furl"]
|
|
|
|
for petname, config
|
|
|
|
in introducers_yaml.get("introducers", {}).items()
|
|
|
|
}
|
2020-11-14 21:51:36 +00:00
|
|
|
assert all(isinstance(k, str) for k in introducers.keys())
|
2020-11-14 21:57:45 +00:00
|
|
|
assert all(isinstance(v, str) for v in introducers.values()), introducers.values()
|
2020-11-14 14:12:14 +00:00
|
|
|
log.msg(
|
|
|
|
"found {} introducers in private/introducers.yaml".format(
|
|
|
|
len(introducers),
|
|
|
|
)
|
|
|
|
)
|
|
|
|
except EnvironmentError as e:
|
|
|
|
if e.errno != ENOENT:
|
|
|
|
raise
|
|
|
|
introducers = {}
|
|
|
|
|
2020-11-16 20:02:13 +00:00
|
|
|
# supported the deprecated [client]introducer.furl item in tahoe.cfg
|
2020-11-14 14:12:14 +00:00
|
|
|
tahoe_cfg_introducer_furl = self.get_config("client", "introducer.furl", None)
|
|
|
|
if tahoe_cfg_introducer_furl == "None":
|
|
|
|
raise ValueError(
|
|
|
|
"tahoe.cfg has invalid 'introducer.furl = None':"
|
|
|
|
" to disable it, use 'introducer.furl ='"
|
|
|
|
" or omit the key entirely"
|
|
|
|
)
|
|
|
|
if tahoe_cfg_introducer_furl:
|
|
|
|
warn(
|
|
|
|
"tahoe.cfg [client]introducer.furl is deprecated; "
|
|
|
|
"use private/introducers.yaml instead.",
|
|
|
|
category=DeprecationWarning,
|
|
|
|
stacklevel=-1,
|
|
|
|
)
|
2020-11-14 15:23:28 +00:00
|
|
|
if "default" in introducers:
|
|
|
|
raise ValueError(
|
|
|
|
"'default' introducer furl cannot be specified in tahoe.cfg and introducers.yaml;"
|
|
|
|
" please fix impossible configuration."
|
|
|
|
)
|
2020-11-14 14:12:14 +00:00
|
|
|
introducers['default'] = tahoe_cfg_introducer_furl
|
|
|
|
|
2020-11-14 14:26:07 +00:00
|
|
|
return {
|
|
|
|
petname: (furl, get_cache_filepath(petname))
|
|
|
|
for (petname, furl)
|
|
|
|
in introducers.items()
|
|
|
|
}
|
2020-11-14 14:12:14 +00:00
|
|
|
|
2017-09-06 01:08:35 +00:00
|
|
|
|
2018-01-28 01:05:16 +00:00
|
|
|
def create_tub_options(config):
|
2018-08-29 22:44:12 +00:00
|
|
|
"""
|
|
|
|
:param config: a _Config instance
|
|
|
|
|
|
|
|
:returns: dict containing all Foolscap Tub-related options,
|
|
|
|
overriding defaults with appropriate config from `config`
|
|
|
|
instance.
|
|
|
|
"""
|
2018-09-04 20:56:50 +00:00
|
|
|
# We can't unify the camelCase vs. dashed-name divide here,
|
|
|
|
# because these are options for Foolscap
|
2018-01-28 01:05:16 +00:00
|
|
|
tub_options = {
|
|
|
|
"logLocalFailures": True,
|
|
|
|
"logRemoteFailures": True,
|
|
|
|
"expose-remote-exception-types": False,
|
|
|
|
"accept-gifts": False,
|
|
|
|
}
|
|
|
|
|
|
|
|
# see #521 for a discussion of how to pick these timeout values.
|
|
|
|
keepalive_timeout_s = config.get_config("node", "timeout.keepalive", "")
|
|
|
|
if keepalive_timeout_s:
|
|
|
|
tub_options["keepaliveTimeout"] = int(keepalive_timeout_s)
|
|
|
|
disconnect_timeout_s = config.get_config("node", "timeout.disconnect", "")
|
|
|
|
if disconnect_timeout_s:
|
|
|
|
# N.B.: this is in seconds, so use "1800" to get 30min
|
|
|
|
tub_options["disconnectTimeout"] = int(disconnect_timeout_s)
|
|
|
|
return tub_options
|
|
|
|
|
|
|
|
|
|
|
|
def _make_tcp_handler():
|
2018-08-29 22:44:12 +00:00
|
|
|
"""
|
|
|
|
:returns: a Foolscap default TCP handler
|
|
|
|
"""
|
2018-01-28 01:05:16 +00:00
|
|
|
# this is always available
|
|
|
|
from foolscap.connections.tcp import default
|
|
|
|
return default()
|
|
|
|
|
|
|
|
|
2018-01-28 08:27:25 +00:00
|
|
|
def create_connection_handlers(reactor, config, i2p_provider, tor_provider):
|
2018-01-28 01:05:16 +00:00
|
|
|
"""
|
|
|
|
:returns: 2-tuple of default_connection_handlers, foolscap_connection_handlers
|
|
|
|
"""
|
|
|
|
reveal_ip = config.get_config("node", "reveal-IP-address", True, boolean=True)
|
|
|
|
|
|
|
|
# We store handlers for everything. None means we were unable to
|
|
|
|
# create that handler, so hints which want it will be ignored.
|
|
|
|
handlers = foolscap_connection_handlers = {
|
|
|
|
"tcp": _make_tcp_handler(),
|
2018-01-29 05:41:19 +00:00
|
|
|
"tor": tor_provider.get_tor_handler(),
|
|
|
|
"i2p": i2p_provider.get_i2p_handler(),
|
2018-01-28 01:05:16 +00:00
|
|
|
}
|
|
|
|
log.msg(
|
|
|
|
format="built Foolscap connection handlers for: %(known_handlers)s",
|
|
|
|
known_handlers=sorted([k for k,v in handlers.items() if v]),
|
|
|
|
facility="tahoe.node",
|
|
|
|
umid="PuLh8g",
|
|
|
|
)
|
|
|
|
|
|
|
|
# then we remember the default mappings from tahoe.cfg
|
|
|
|
default_connection_handlers = {"tor": "tor", "i2p": "i2p"}
|
|
|
|
tcp_handler_name = config.get_config("connections", "tcp", "tcp").lower()
|
|
|
|
if tcp_handler_name == "disabled":
|
|
|
|
default_connection_handlers["tcp"] = None
|
|
|
|
else:
|
|
|
|
if tcp_handler_name not in handlers:
|
|
|
|
raise ValueError(
|
|
|
|
"'tahoe.cfg [connections] tcp=' uses "
|
|
|
|
"unknown handler type '{}'".format(
|
|
|
|
tcp_handler_name
|
|
|
|
)
|
|
|
|
)
|
|
|
|
if not handlers[tcp_handler_name]:
|
|
|
|
raise ValueError(
|
|
|
|
"'tahoe.cfg [connections] tcp=' uses "
|
|
|
|
"unavailable/unimportable handler type '{}'. "
|
|
|
|
"Please pip install tahoe-lafs[{}] to fix.".format(
|
|
|
|
tcp_handler_name,
|
|
|
|
tcp_handler_name,
|
|
|
|
)
|
|
|
|
)
|
|
|
|
default_connection_handlers["tcp"] = tcp_handler_name
|
|
|
|
|
|
|
|
if not reveal_ip:
|
|
|
|
if default_connection_handlers.get("tcp") == "tcp":
|
|
|
|
raise PrivacyError("tcp = tcp, must be set to 'tor' or 'disabled'")
|
|
|
|
return default_connection_handlers, foolscap_connection_handlers
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def create_tub(tub_options, default_connection_handlers, foolscap_connection_handlers,
|
|
|
|
handler_overrides={}, **kwargs):
|
2018-08-29 22:44:12 +00:00
|
|
|
"""
|
|
|
|
Create a Tub with the right options and handlers. It will be
|
|
|
|
ephemeral unless the caller provides certFile= in kwargs
|
|
|
|
|
|
|
|
:param handler_overrides: anything in this will override anything
|
|
|
|
in `default_connection_handlers` for just this call.
|
|
|
|
|
|
|
|
:param dict tub_options: every key-value pair in here will be set in
|
|
|
|
the new Tub via `Tub.setOption`
|
|
|
|
"""
|
2018-01-28 01:05:16 +00:00
|
|
|
tub = Tub(**kwargs)
|
2020-10-29 18:09:18 +00:00
|
|
|
for (name, value) in list(tub_options.items()):
|
2018-01-28 01:05:16 +00:00
|
|
|
tub.setOption(name, value)
|
|
|
|
handlers = default_connection_handlers.copy()
|
|
|
|
handlers.update(handler_overrides)
|
|
|
|
tub.removeAllConnectionHintHandlers()
|
2020-10-29 18:09:18 +00:00
|
|
|
for hint_type, handler_name in list(handlers.items()):
|
2018-01-28 01:05:16 +00:00
|
|
|
handler = foolscap_connection_handlers.get(handler_name)
|
|
|
|
if handler:
|
|
|
|
tub.addConnectionHintHandler(hint_type, handler)
|
|
|
|
return tub
|
|
|
|
|
|
|
|
|
|
|
|
def _convert_tub_port(s):
|
2018-08-29 22:44:12 +00:00
|
|
|
"""
|
|
|
|
:returns: a proper Twisted endpoint string like (`tcp:X`) is `s`
|
|
|
|
is a bare number, or returns `s` as-is
|
|
|
|
"""
|
2020-10-16 14:55:33 +00:00
|
|
|
us = s
|
|
|
|
if isinstance(s, bytes):
|
|
|
|
us = s.decode("utf-8")
|
|
|
|
if re.search(r'^\d+$', us):
|
|
|
|
return "tcp:{}".format(int(us))
|
|
|
|
return us
|
2018-01-28 01:05:16 +00:00
|
|
|
|
|
|
|
|
2018-03-05 04:30:52 +00:00
|
|
|
def _tub_portlocation(config):
|
|
|
|
"""
|
|
|
|
:returns: None or tuple of (port, location) for the main tub based
|
|
|
|
on the given configuration. May raise ValueError or PrivacyError
|
|
|
|
if there are problems with the config
|
|
|
|
"""
|
|
|
|
cfg_tubport = config.get_config("node", "tub.port", None)
|
|
|
|
cfg_location = config.get_config("node", "tub.location", None)
|
2018-01-28 04:40:43 +00:00
|
|
|
reveal_ip = config.get_config("node", "reveal-IP-address", True, boolean=True)
|
2018-03-05 04:30:52 +00:00
|
|
|
tubport_disabled = False
|
2018-01-28 04:40:43 +00:00
|
|
|
|
2018-01-28 01:05:16 +00:00
|
|
|
if cfg_tubport is not None:
|
|
|
|
cfg_tubport = cfg_tubport.strip()
|
|
|
|
if cfg_tubport == "":
|
|
|
|
raise ValueError("tub.port must not be empty")
|
|
|
|
if cfg_tubport == "disabled":
|
|
|
|
tubport_disabled = True
|
|
|
|
|
|
|
|
location_disabled = False
|
|
|
|
if cfg_location is not None:
|
|
|
|
cfg_location = cfg_location.strip()
|
|
|
|
if cfg_location == "":
|
|
|
|
raise ValueError("tub.location must not be empty")
|
|
|
|
if cfg_location == "disabled":
|
|
|
|
location_disabled = True
|
|
|
|
|
|
|
|
if tubport_disabled and location_disabled:
|
|
|
|
return None
|
|
|
|
if tubport_disabled and not location_disabled:
|
|
|
|
raise ValueError("tub.port is disabled, but not tub.location")
|
|
|
|
if location_disabled and not tubport_disabled:
|
|
|
|
raise ValueError("tub.location is disabled, but not tub.port")
|
|
|
|
|
|
|
|
if cfg_tubport is None:
|
|
|
|
# For 'tub.port', tahoe.cfg overrides the individual file on
|
2018-09-06 17:42:16 +00:00
|
|
|
# disk. So only read config.portnum_fname if tahoe.cfg doesn't
|
2018-01-28 01:05:16 +00:00
|
|
|
# provide a value.
|
|
|
|
if os.path.exists(config.portnum_fname):
|
|
|
|
file_tubport = fileutil.read(config.portnum_fname).strip()
|
|
|
|
tubport = _convert_tub_port(file_tubport)
|
|
|
|
else:
|
|
|
|
tubport = "tcp:%d" % iputil.allocate_tcp_port()
|
|
|
|
fileutil.write_atomically(config.portnum_fname, tubport + "\n",
|
|
|
|
mode="")
|
|
|
|
else:
|
|
|
|
tubport = _convert_tub_port(cfg_tubport)
|
|
|
|
|
2018-03-05 04:52:45 +00:00
|
|
|
for port in tubport.split(","):
|
|
|
|
if port in ("0", "tcp:0"):
|
|
|
|
raise ValueError("tub.port cannot be 0: you must choose")
|
|
|
|
|
2018-01-28 01:05:16 +00:00
|
|
|
if cfg_location is None:
|
|
|
|
cfg_location = "AUTO"
|
|
|
|
|
|
|
|
local_portnum = None # needed to hush lgtm.com static analyzer
|
|
|
|
# Replace the location "AUTO", if present, with the detected local
|
|
|
|
# addresses. Don't probe for local addresses unless necessary.
|
|
|
|
split_location = cfg_location.split(",")
|
|
|
|
if "AUTO" in split_location:
|
|
|
|
if not reveal_ip:
|
|
|
|
raise PrivacyError("tub.location uses AUTO")
|
|
|
|
local_addresses = iputil.get_local_addresses_sync()
|
|
|
|
# tubport must be like "tcp:12345" or "tcp:12345:morestuff"
|
|
|
|
local_portnum = int(tubport.split(":")[1])
|
|
|
|
new_locations = []
|
|
|
|
for loc in split_location:
|
|
|
|
if loc == "AUTO":
|
|
|
|
new_locations.extend(["tcp:%s:%d" % (ip, local_portnum)
|
|
|
|
for ip in local_addresses])
|
|
|
|
else:
|
|
|
|
if not reveal_ip:
|
|
|
|
# Legacy hints are "host:port". We use Foolscap's utility
|
|
|
|
# function to convert all hints into the modern format
|
|
|
|
# ("tcp:host:port") because that's what the receiving
|
|
|
|
# client will probably do. We test the converted hint for
|
|
|
|
# TCP-ness, but publish the original hint because that
|
|
|
|
# was the user's intent.
|
|
|
|
from foolscap.connections.tcp import convert_legacy_hint
|
|
|
|
converted_hint = convert_legacy_hint(loc)
|
|
|
|
hint_type = converted_hint.split(":")[0]
|
|
|
|
if hint_type == "tcp":
|
|
|
|
raise PrivacyError("tub.location includes tcp: hint")
|
|
|
|
new_locations.append(loc)
|
|
|
|
location = ",".join(new_locations)
|
|
|
|
|
2020-10-27 15:43:27 +00:00
|
|
|
# Lacking this, Python 2 blows up in Foolscap when it is confused by a
|
|
|
|
# Unicode FURL.
|
2020-10-26 20:37:00 +00:00
|
|
|
location = location.encode("utf-8")
|
|
|
|
|
2018-01-28 01:05:16 +00:00
|
|
|
return tubport, location
|
|
|
|
|
|
|
|
|
2018-01-31 18:30:46 +00:00
|
|
|
def create_main_tub(config, tub_options,
|
2018-01-28 08:27:25 +00:00
|
|
|
default_connection_handlers, foolscap_connection_handlers,
|
|
|
|
i2p_provider, tor_provider,
|
|
|
|
handler_overrides={}, cert_filename="node.pem"):
|
2018-08-29 22:44:12 +00:00
|
|
|
"""
|
|
|
|
Creates a 'main' Foolscap Tub, typically for use as the top-level
|
|
|
|
access point for a running Node.
|
|
|
|
|
|
|
|
:param Config: a `_Config` instance
|
|
|
|
|
|
|
|
:param dict tub_options: any options to change in the tub
|
|
|
|
|
|
|
|
:param default_connection_handlers: default Foolscap connection
|
|
|
|
handlers
|
|
|
|
|
|
|
|
:param foolscap_connection_handlers: Foolscap connection
|
|
|
|
handlers for this tub
|
|
|
|
|
|
|
|
:param i2p_provider: None, or a _Provider instance if I2P is
|
|
|
|
installed.
|
|
|
|
|
|
|
|
:param tor_provider: None, or a _Provider instance if txtorcon +
|
|
|
|
Tor are installed.
|
|
|
|
"""
|
2018-03-05 04:30:52 +00:00
|
|
|
portlocation = _tub_portlocation(config)
|
2018-01-28 04:40:43 +00:00
|
|
|
|
2018-01-31 18:30:46 +00:00
|
|
|
certfile = config.get_private_path("node.pem") # FIXME? "node.pem" was the CERTFILE option/thing
|
2018-01-28 01:05:16 +00:00
|
|
|
tub = create_tub(tub_options, default_connection_handlers, foolscap_connection_handlers,
|
|
|
|
handler_overrides=handler_overrides, certFile=certfile)
|
|
|
|
|
|
|
|
if portlocation:
|
|
|
|
tubport, location = portlocation
|
|
|
|
for port in tubport.split(","):
|
|
|
|
if port == "listen:i2p":
|
|
|
|
# the I2P provider will read its section of tahoe.cfg and
|
|
|
|
# return either a fully-formed Endpoint, or a descriptor
|
|
|
|
# that will create one, so we don't have to stuff all the
|
|
|
|
# options into the tub.port string (which would need a lot
|
|
|
|
# of escaping)
|
2018-01-28 08:27:25 +00:00
|
|
|
port_or_endpoint = i2p_provider.get_listener()
|
2018-01-28 01:05:16 +00:00
|
|
|
elif port == "listen:tor":
|
2018-01-28 08:27:25 +00:00
|
|
|
port_or_endpoint = tor_provider.get_listener()
|
2018-01-28 01:05:16 +00:00
|
|
|
else:
|
|
|
|
port_or_endpoint = port
|
2020-10-26 20:37:00 +00:00
|
|
|
# Foolscap requires native strings:
|
2020-10-29 18:09:18 +00:00
|
|
|
if isinstance(port_or_endpoint, (bytes, str)):
|
2020-10-26 20:37:00 +00:00
|
|
|
port_or_endpoint = ensure_str(port_or_endpoint)
|
2018-01-28 01:05:16 +00:00
|
|
|
tub.listenOn(port_or_endpoint)
|
|
|
|
tub.setLocation(location)
|
|
|
|
log.msg("Tub location set to %s" % (location,))
|
|
|
|
# the Tub is now ready for tub.registerReference()
|
|
|
|
else:
|
|
|
|
log.msg("Tub is not listening")
|
|
|
|
|
2018-03-06 23:29:24 +00:00
|
|
|
return tub
|
2018-01-28 01:05:16 +00:00
|
|
|
|
|
|
|
|
|
|
|
def create_control_tub():
|
2018-08-29 22:44:12 +00:00
|
|
|
"""
|
|
|
|
Creates a Foolscap Tub for use by the control port. This is a
|
|
|
|
localhost-only ephemeral Tub, with no control over the listening
|
|
|
|
port or location
|
|
|
|
"""
|
2018-01-28 01:05:16 +00:00
|
|
|
control_tub = Tub()
|
2019-04-16 15:26:42 +00:00
|
|
|
portnum = iputil.listenOnUnused(control_tub)
|
|
|
|
log.msg("Control Tub location set to 127.0.0.1:%s" % (portnum,))
|
2018-01-28 01:05:16 +00:00
|
|
|
return control_tub
|
|
|
|
|
|
|
|
|
2006-12-03 01:27:18 +00:00
|
|
|
class Node(service.MultiService):
|
2018-03-01 19:28:18 +00:00
|
|
|
"""
|
|
|
|
This class implements common functionality of both Client nodes and Introducer nodes.
|
|
|
|
"""
|
2006-12-03 01:27:18 +00:00
|
|
|
NODETYPE = "unknown NODETYPE"
|
2007-05-23 19:48:52 +00:00
|
|
|
CERTFILE = "node.pem"
|
2011-08-03 01:32:12 +00:00
|
|
|
GENERATED_FILES = []
|
2006-12-03 01:27:18 +00:00
|
|
|
|
2018-03-06 23:29:24 +00:00
|
|
|
def __init__(self, config, main_tub, control_tub, i2p_provider, tor_provider):
|
2018-03-01 19:28:18 +00:00
|
|
|
"""
|
2018-01-31 18:30:46 +00:00
|
|
|
Initialize the node with the given configuration. Its base directory
|
2018-03-01 19:28:18 +00:00
|
|
|
is the current directory by default.
|
|
|
|
"""
|
2006-12-03 01:27:18 +00:00
|
|
|
service.MultiService.__init__(self)
|
2008-09-30 23:21:49 +00:00
|
|
|
|
2017-09-06 01:08:35 +00:00
|
|
|
self.config = config
|
|
|
|
self.get_config = config.get_config # XXX stopgap
|
|
|
|
self.nickname = config.nickname # XXX stopgap
|
2008-09-30 23:21:49 +00:00
|
|
|
|
2018-01-29 01:01:10 +00:00
|
|
|
# this can go away once Client.init_client_storage_broker is moved into create_client()
|
2018-01-31 01:04:08 +00:00
|
|
|
# (tests sometimes have None here)
|
2018-01-29 01:01:10 +00:00
|
|
|
self._i2p_provider = i2p_provider
|
|
|
|
self._tor_provider = tor_provider
|
|
|
|
|
2009-01-15 03:00:15 +00:00
|
|
|
self.init_tempdir()
|
2016-09-30 05:51:23 +00:00
|
|
|
|
|
|
|
self.create_log_tub()
|
2018-03-01 19:31:30 +00:00
|
|
|
self.logSource = "Node"
|
2016-09-30 05:51:23 +00:00
|
|
|
self.setup_logging()
|
|
|
|
|
2018-01-28 01:05:16 +00:00
|
|
|
self.tub = main_tub
|
|
|
|
if self.tub is not None:
|
2018-09-06 17:48:06 +00:00
|
|
|
self.nodeid = b32decode(self.tub.tubID.upper()) # binary format
|
|
|
|
self.short_nodeid = b32encode(self.nodeid).lower()[:8] # for printing
|
2020-10-16 14:47:49 +00:00
|
|
|
self.config.write_config_file("my_nodeid", b32encode(self.nodeid).lower() + b"\n", mode="wb")
|
2018-09-06 17:48:06 +00:00
|
|
|
self.tub.setServiceParent(self)
|
2018-01-28 01:05:16 +00:00
|
|
|
else:
|
|
|
|
self.nodeid = self.short_nodeid = None
|
|
|
|
|
|
|
|
self.control_tub = control_tub
|
|
|
|
if self.control_tub is not None:
|
2018-09-06 17:48:06 +00:00
|
|
|
self.control_tub.setServiceParent(self)
|
2008-09-30 23:21:49 +00:00
|
|
|
|
|
|
|
self.log("Node constructed. " + get_package_versions_string())
|
|
|
|
iputil.increase_rlimits()
|
|
|
|
|
2018-03-06 23:29:24 +00:00
|
|
|
def _is_tub_listening(self):
|
|
|
|
"""
|
|
|
|
:returns: True if the main tub is listening
|
|
|
|
"""
|
|
|
|
return len(self.tub.getListeners()) > 0
|
|
|
|
|
2009-01-15 03:00:15 +00:00
|
|
|
def init_tempdir(self):
|
2018-03-01 19:28:18 +00:00
|
|
|
"""
|
|
|
|
Initialize/create a directory for temporary files.
|
|
|
|
"""
|
2020-09-16 15:13:23 +00:00
|
|
|
tempdir_config = self.config.get_config("node", "tempdir", "tmp")
|
|
|
|
if isinstance(tempdir_config, bytes):
|
|
|
|
tempdir_config = tempdir_config.decode('utf-8')
|
2018-01-31 18:30:46 +00:00
|
|
|
tempdir = self.config.get_config_path(tempdir_config)
|
2009-01-15 03:00:15 +00:00
|
|
|
if not os.path.exists(tempdir):
|
|
|
|
fileutil.make_dirs(tempdir)
|
2015-01-30 00:50:18 +00:00
|
|
|
tempfile.tempdir = tempdir
|
2009-01-15 03:00:15 +00:00
|
|
|
# this should cause twisted.web.http (which uses
|
|
|
|
# tempfile.TemporaryFile) to put large request bodies in the given
|
|
|
|
# directory. Without this, the default temp dir is usually /tmp/,
|
|
|
|
# which is frequently too small.
|
2018-01-28 19:05:53 +00:00
|
|
|
temp_fd, test_name = tempfile.mkstemp()
|
2009-01-15 03:00:15 +00:00
|
|
|
_assert(os.path.dirname(test_name) == tempdir, test_name, tempdir)
|
2018-03-01 19:56:59 +00:00
|
|
|
os.close(temp_fd) # avoid leak of unneeded fd
|
2009-01-15 03:00:15 +00:00
|
|
|
|
2018-09-06 17:56:29 +00:00
|
|
|
# pull this outside of Node's __init__ too, see:
|
|
|
|
# https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2948
|
2016-07-07 02:47:00 +00:00
|
|
|
def create_log_tub(self):
|
|
|
|
# The logport uses a localhost-only ephemeral Tub, with no control
|
|
|
|
# over the listening port or location. This might change if we
|
|
|
|
# discover a compelling reason for it in the future (e.g. being able
|
|
|
|
# to use "flogtool tail" against a remote server), but for now I
|
|
|
|
# think we can live without it.
|
|
|
|
self.log_tub = Tub()
|
2019-04-16 15:30:18 +00:00
|
|
|
portnum = iputil.listenOnUnused(self.log_tub)
|
|
|
|
self.log("Log Tub location set to 127.0.0.1:%s" % (portnum,))
|
2016-07-07 02:47:00 +00:00
|
|
|
self.log_tub.setServiceParent(self)
|
|
|
|
|
2007-05-24 00:54:48 +00:00
|
|
|
def startService(self):
|
2007-10-22 23:55:20 +00:00
|
|
|
# Note: this class can be started and stopped at most once.
|
2007-05-31 20:44:22 +00:00
|
|
|
self.log("Node.startService")
|
2009-07-15 07:29:29 +00:00
|
|
|
# Record the process id in the twisted log, after startService()
|
|
|
|
# (__init__ is called before fork(), but startService is called
|
|
|
|
# after). Note that Foolscap logs handle pid-logging by itself, no
|
|
|
|
# need to send a pid to the foolscap log here.
|
|
|
|
twlog.msg("My pid: %s" % os.getpid())
|
2008-03-27 01:37:54 +00:00
|
|
|
try:
|
2019-03-28 13:02:56 +00:00
|
|
|
os.chmod("twistd.pid", 0o644)
|
2008-03-27 01:37:54 +00:00
|
|
|
except EnvironmentError:
|
|
|
|
pass
|
2007-03-08 22:10:36 +00:00
|
|
|
|
|
|
|
service.MultiService.startService(self)
|
2016-04-27 01:21:36 +00:00
|
|
|
self.log("%s running" % self.NODETYPE)
|
2016-08-22 23:36:56 +00:00
|
|
|
twlog.msg("%s running" % self.NODETYPE)
|
2008-03-06 20:53:21 +00:00
|
|
|
|
2007-05-23 22:08:03 +00:00
|
|
|
def stopService(self):
|
2007-05-31 20:44:22 +00:00
|
|
|
self.log("Node.stopService")
|
2016-04-27 04:54:45 +00:00
|
|
|
return service.MultiService.stopService(self)
|
2007-05-31 20:44:22 +00:00
|
|
|
|
2007-03-08 22:10:36 +00:00
|
|
|
def shutdown(self):
|
|
|
|
"""Shut down the node. Returns a Deferred that fires (with None) when
|
|
|
|
it finally stops kicking."""
|
2007-05-31 20:44:22 +00:00
|
|
|
self.log("Node.shutdown")
|
2007-03-08 22:10:36 +00:00
|
|
|
return self.stopService()
|
|
|
|
|
2007-10-12 00:30:07 +00:00
|
|
|
def setup_logging(self):
|
2011-08-01 23:24:23 +00:00
|
|
|
# we replace the formatTime() method of the log observer that
|
|
|
|
# twistd set up for us, with a method that uses our preferred
|
|
|
|
# timestamp format.
|
2008-09-20 17:35:45 +00:00
|
|
|
for o in twlog.theLogPublisher.observers:
|
2007-10-12 00:30:07 +00:00
|
|
|
# o might be a FileLogObserver's .emit method
|
|
|
|
if type(o) is type(self.setup_logging): # bound method
|
feat(py3): Update Python internal data model refs
As of Python 2.7, some of [the `func_*` and `im_*` attributes also can be accessed
through their corresponding `__*__` attributes for Python 3
compatibility](https://docs.python.org/2/reference/datamodel.html?highlight=__self__#the-standard-type-hierarchy).
I searched for all such occurrences and this is all that needed changing AFAICT.
Converts 9 test errors to errors with new exceptions and improves Python 3 test coverage
a smidge:
```diff
--- ../../.tox/make-test-py3-all-old.log 2020-10-04 15:16:34.054975263 -0700
+++ ../../.tox/make-test-py3-all-new.log 2020-10-04 15:59:59.355692613 -0700
@@ -2273,9 +2273,9 @@
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 824, in setup_logging
- ob = o.im_self
-builtins.AttributeError: 'function' object has no attribute 'im_self'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
+ newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
+builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
allmydata.test.test_node.IntroducerNotListening.test_port_none_introducer
@@ -5935,9 +5935,9 @@
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 824, in setup_logging
- ob = o.im_self
-builtins.AttributeError: 'function' object has no attribute 'im_self'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
+ newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
+builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
allmydata.test.test_client.Basic.test_web_apiauthtoken
===============================================================================
@@ -7146,9 +7146,9 @@
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 824, in setup_logging
- ob = o.im_self
-AttributeError: 'function' object has no attribute 'im_self'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
+ newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
+AttributeError: module 'types' has no attribute 'UnboundMethodType'
allmydata.test.test_introducer.Node.test_create
@@ -7171,9 +7171,9 @@
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 824, in setup_logging
- ob = o.im_self
-AttributeError: 'function' object has no attribute 'im_self'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
+ newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
+AttributeError: module 'types' has no attribute 'UnboundMethodType'
allmydata.test.test_introducer.Node.test_furl
@@ -7550,9 +7550,9 @@
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 824, in setup_logging
- ob = o.im_self
-builtins.AttributeError: 'function' object has no attribute 'im_self'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
+ newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
+builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
allmydata.test.test_node.TestCase.test_logdir_is_str
===============================================================================
@@ -8448,9 +8448,9 @@
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 824, in setup_logging
- ob = o.im_self
-builtins.AttributeError: 'function' object has no attribute 'im_self'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
+ newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
+builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
allmydata.test.test_system.Connections.test_rref
allmydata.test.test_system.SystemTest.test_filesystem
@@ -8567,9 +8567,9 @@
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 824, in setup_logging
- ob = o.im_self
-builtins.AttributeError: 'function' object has no attribute 'im_self'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
+ newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
+builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
allmydata.test.web.test_introducer.IntroducerWeb.test_basic_information
===============================================================================
@@ -8589,9 +8589,9 @@
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 824, in setup_logging
- ob = o.im_self
-builtins.AttributeError: 'function' object has no attribute 'im_self'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
+ newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
+builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
allmydata.test.web.test_introducer.IntroducerWeb.test_json_front_page
===============================================================================
@@ -8611,9 +8611,9 @@
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 824, in setup_logging
- ob = o.im_self
-builtins.AttributeError: 'function' object has no attribute 'im_self'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
+ newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
+builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
allmydata.test.web.test_introducer.IntroducerWeb.test_tahoe_css
===============================================================================
@@ -8633,9 +8633,9 @@
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 824, in setup_logging
- ob = o.im_self
-builtins.AttributeError: 'function' object has no attribute 'im_self'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
+ newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
+builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
allmydata.test.web.test_introducer.IntroducerWeb.test_welcome
===============================================================================
@@ -8742,9 +8742,9 @@
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 824, in setup_logging
- ob = o.im_self
-builtins.AttributeError: 'function' object has no attribute 'im_self'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
+ newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
+builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
+ test_exit=1
+ ./.tox/py36-coverage/bin/coverage combine
+ ./.tox/py36-coverage/bin/coverage html
@@ -8802,7 +8802,7 @@
src/allmydata/mutable/repairer.py 57 37 18 0 29% 13, 15, 17, 19, 29-34, 65-71, 74-126, 129-131
src/allmydata/mutable/retrieve.py 489 123 120 33 71% 46, 48, 50, 52, 56, 58, 60, 62, 64, 89-90, 133, 186-193, 204-208, 211-212, 224-226, 231, 240, 251, 312, 318, 344-354, 377, 385-386, 399-400, 425-434, 490, 501, 515-516, 529-540, 564-578, 591-592, 629-630, 653-654, 674-675, 681-682, 698, 712-729, 758-760, 765, 772-774, 790-792, 871, 883, 909-910, 919-941, 965-966, 981-994, 999-1005, 129->133, 167->169, 169->171, 201->204, 223->224, 230->231, 237->239, 239->240, 243->247, 249->251, 309->312, 317->318, 376->377, 381->385, 391->394, 396->399, 424->425, 489->490, 499->501, 514->515, 590->591, 628->629, 652->653, 673->674, 677->687, 680->681, 687->694, 694->698, 755->764, 764->765, 868->871, 880->883, 964->965
src/allmydata/mutable/servermap.py 612 240 186 26 56% 45, 47, 49, 51, 53, 55, 57, 59, 61, 63, 65, 67, 74, 130-139, 142, 148, 159-161, 175, 177, 183, 186-199, 206, 213, 217-220, 231, 234-238, 243-252, 255-259, 315, 328-350, 358-363, 370-372, 379, 429, 433, 443-447, 495, 498, 506-508, 514-516, 569-570, 603-611, 623-638, 718-721, 732-741, 792, 796, 803-804, 850-851, 872-874, 911-915, 929-945, 961-975, 982-999, 1003-1013, 1043-1045, 1050-1052, 1060-1064, 1069-1070, 1093-1100, 1106-1186, 1214-1215, 1232-1233, 313->315, 427->429, 432->433, 439->443, 459->461, 493->495, 497->498, 504->506, 509->514, 566->569, 597->603, 687->exit, 702->exit, 710->exit, 717->718, 727->732, 759->exit, 791->792, 795->796, 869->872, 1039->1043, 1047->1050, 1059->1060, 1066->1069, 1092->1093, 1213->1214
-src/allmydata/node.py 388 84 146 33 75% 120, 132, 190, 241, 243-245, 278, 284, 294-295, 303-306, 315, 320, 339, 341, 361, 393-396, 422, 449, 453, 490, 493, 500, 511-512, 548, 566, 574, 581, 583, 590-591, 601, 612, 629-633, 679, 681, 738-741, 747, 756, 764, 792-805, 808-809, 814-815, 825-846, 189->190, 240->241, 242->243, 277->278, 314->315, 319->320, 338->339, 340->341, 360->361, 391->393, 421->422, 448->449, 451->453, 489->490, 492->493, 499->500, 510->511, 547->548, 565->566, 573->574, 580->581, 582->583, 589->590, 600->601, 611->612, 622->629, 673->679, 680->681, 737->738, 746->747, 763->764, 821->830, 823->821
+src/allmydata/node.py 388 82 146 33 76% 120, 132, 190, 241, 243-245, 278, 284, 294-295, 303-306, 315, 320, 339, 341, 361, 393-396, 422, 449, 453, 490, 493, 500, 511-512, 548, 566, 574, 581, 583, 590-591, 601, 612, 629-633, 679, 681, 738-741, 747, 756, 764, 792-805, 808-809, 814-815, 827-846, 189->190, 240->241, 242->243, 277->278, 314->315, 319->320, 338->339, 340->341, 360->361, 391->393, 421->422, 448->449, 451->453, 489->490, 492->493, 499->500, 510->511, 547->548, 565->566, 573->574, 580->581, 582->583, 589->590, 600->601, 611->612, 622->629, 673->679, 680->681, 737->738, 746->747, 763->764, 821->830, 823->821
src/allmydata/nodemaker.py 97 23 38 10 70% 49, 61, 66, 70, 81, 94, 107-115, 130-138, 141-150, 57->61, 65->66, 69->70, 79->81, 86->95, 90->94, 104->107, 124->exit, 129->130, 129->133
src/allmydata/scripts/admin.py 51 20 2 1 60% 9-14, 25, 28, 31-37, 40-46, 57, 59, 61-66, 56->57
src/allmydata/scripts/backupdb.py 146 91 14 1 36% 84-91, 94-96, 99, 103, 106, 111-114, 117-119, 122, 125, 128, 176-221, 231-242, 245-263, 266-272, 308-324, 327-333, 336-341, 306->308
@@ -8899,7 +8899,7 @@
src/allmydata/windows/fixups.py 133 133 54 0 0% 1-237
src/allmydata/windows/registry.py 42 42 12 0 0% 1-77
------------------------------------------------------------------------------------------------
-TOTAL 27477 11800 8244 605 54%
+TOTAL 27477 11798 8244 605 54%
18 files skipped due to complete coverage.
+ '[' '!' -z 1 ']'
```
2020-10-01 16:15:18 +00:00
|
|
|
ob = o.__self__
|
2008-09-20 17:35:45 +00:00
|
|
|
if isinstance(ob, twlog.FileLogObserver):
|
feat(py3): feat(py3): Fix use of deprecated type
Python 3 did away with the unbound method type entirely, they're just functions under
Python 3, and IIUC the unbound type is just an alias for the method type in Python 2.
As such, this approach should preserve the behavior under Python 2 and should work under
Python 3.
With this change, the diff in test output shows one test error converted to a failure,
increases coverage in all the modules that have a coverage change, and reveals the next
porting bug:
```
...
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 740, in __init__
self.config.write_config_file("my_nodeid", b32encode(self.nodeid).lower() + "\n")
builtins.TypeError: can't concat str to bytes
```
There are no regressions I see under Python 2, so this seems like the right fix to this
particular issue AFAICT.
```diff
--- ../../.tox/make-test-py3-all-old.log 2020-10-04 15:59:59.355692613 -0700
+++ ../../.tox/make-test-py3-all-new.log 2020-10-04 16:59:27.870208496 -0700
@@ -1206,7 +1206,7 @@
test_location2 ... [ERROR]
test_location_auto_and_explicit ... [ERROR]
test_location_not_set ... [ERROR]
- test_logdir_is_str ... [ERROR]
+ test_logdir_is_str ... [FAIL]
test_private_config ... [ERROR]
test_private_config_missing ... [OK]
test_private_config_unreadable ... [ERROR]
@@ -2254,7 +2254,7 @@
yield create_introducer(basedir)
File "/home/rpatterson/src/work/sfu/tahoe-lafs/.tox/py36-coverage/lib/python3.6/site-packages/twisted/trial/_synctest.py", line 355, in __exit__
self._expectedName, reason.getTraceback()),
-twisted.trial.unittest.FailTest: builtins.AttributeError raised instead of ValueError:
+twisted.trial.unittest.FailTest: builtins.TypeError raised instead of ValueError:
Traceback (most recent call last):
File "/home/rpatterson/src/work/sfu/tahoe-lafs/.tox/py36-coverage/lib/python3.6/site-packages/twisted/internet/defer.py", line 1529, in _cancellableInlineCallbacks
_inlineCallbacks(None, g, status)
@@ -2271,11 +2271,9 @@
tor_provider,
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/introducer/server.py", line 87, in __init__
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
- self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
- newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
-builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 740, in __init__
+ self.config.write_config_file("my_nodeid", b32encode(self.nodeid).lower() + "\n")
+builtins.TypeError: can't concat str to bytes
allmydata.test.test_node.IntroducerNotListening.test_port_none_introducer
@@ -2307,6 +2305,30 @@
===============================================================================
[FAIL]
Traceback (most recent call last):
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 340, in test_logdir_is_str
+ yield client.create_client(basedir)
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/.tox/py36-coverage/lib/python3.6/site-packages/twisted/internet/defer.py", line 1418, in _inlineCallbacks
+ result = g.send(result)
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/client.py", line 298, in create_client_from_config
+ storage_broker,
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/client.py", line 676, in __init__
+ node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
+ self.setup_logging()
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 842, in setup_logging
+ foolscap.logging.log.setLogDir(incident_dir.encode(get_filesystem_encoding()))
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 336, in call_setLogDir
+ self.failUnless(isinstance(logdir, str), logdir)
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/.tox/py36-coverage/lib/python3.6/site-packages/twisted/trial/_synctest.py", line 397, in assertTrue
+ super(_Assertions, self).assertTrue(condition, msg)
+ File "/usr/lib/python3.6/unittest/case.py", line 682, in assertTrue
+ raise self.failureException(msg)
+twisted.trial.unittest.FailTest: False is not true : b'/home/rpatterson/src/work/sfu/tahoe-lafs/_trial_temp/test_node/test_logdir_is_str/logs/incidents'
+
+allmydata.test.test_node.TestCase.test_logdir_is_str
+===============================================================================
+[FAIL]
+Traceback (most recent call last):
File "/home/rpatterson/src/work/sfu/tahoe-lafs/.tox/py36-coverage/lib/python3.6/site-packages/twisted/internet/defer.py", line 1418, in _inlineCallbacks
result = g.send(result)
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_runner.py", line 192, in test_eliot_destination
@@ -5933,11 +5955,9 @@
storage_broker,
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/client.py", line 676, in __init__
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
- self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
- newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
-builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 740, in __init__
+ self.config.write_config_file("my_nodeid", b32encode(self.nodeid).lower() + "\n")
+builtins.TypeError: can't concat str to bytes
allmydata.test.test_client.Basic.test_web_apiauthtoken
===============================================================================
@@ -7130,8 +7150,12 @@
===============================================================================
[ERROR]
Traceback (most recent call last):
-Failure: testtools.testresult.real._StringException: Empty attachments:
- twisted-log
+Failure: testtools.testresult.real._StringException: twisted-log: {{{
+2020-10-04 23:57:37.636Z [-] Foolscap logging initialized
+2020-10-04 23:57:37.636Z [-] Note to developers: twistd.log does not receive very much.
+2020-10-04 23:57:37.636Z [-] Use 'flogtool tail -c NODEDIR/private/logport.furl' instead
+2020-10-04 23:57:37.636Z [-] and read docs/logging.rst
+}}}
Traceback (most recent call last):
File "/home/rpatterson/src/work/sfu/tahoe-lafs/.tox/py36-coverage/lib/python3.6/site-packages/twisted/internet/defer.py", line 1416, in _inlineCallbacks
@@ -7144,19 +7168,21 @@
tor_provider,
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/introducer/server.py", line 87, in __init__
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
- self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
- newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
-AttributeError: module 'types' has no attribute 'UnboundMethodType'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 740, in __init__
+ self.config.write_config_file("my_nodeid", b32encode(self.nodeid).lower() + "\n")
+TypeError: can't concat str to bytes
allmydata.test.test_introducer.Node.test_create
===============================================================================
[ERROR]
Traceback (most recent call last):
-Failure: testtools.testresult.real._StringException: Empty attachments:
- twisted-log
+Failure: testtools.testresult.real._StringException: twisted-log: {{{
+2020-10-04 23:57:38.284Z [-] Foolscap logging initialized
+2020-10-04 23:57:38.284Z [-] Note to developers: twistd.log does not receive very much.
+2020-10-04 23:57:38.284Z [-] Use 'flogtool tail -c NODEDIR/private/logport.furl' instead
+2020-10-04 23:57:38.284Z [-] and read docs/logging.rst
+}}}
Traceback (most recent call last):
File "/home/rpatterson/src/work/sfu/tahoe-lafs/.tox/py36-coverage/lib/python3.6/site-packages/twisted/internet/defer.py", line 1416, in _inlineCallbacks
@@ -7169,11 +7195,9 @@
tor_provider,
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/introducer/server.py", line 87, in __init__
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
- self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
- newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
-AttributeError: module 'types' has no attribute 'UnboundMethodType'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 740, in __init__
+ self.config.write_config_file("my_nodeid", b32encode(self.nodeid).lower() + "\n")
+TypeError: can't concat str to bytes
allmydata.test.test_introducer.Node.test_furl
@@ -7540,24 +7564,6 @@
===============================================================================
[ERROR]
Traceback (most recent call last):
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 340, in test_logdir_is_str
- yield client.create_client(basedir)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/.tox/py36-coverage/lib/python3.6/site-packages/twisted/internet/defer.py", line 1418, in _inlineCallbacks
- result = g.send(result)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/client.py", line 298, in create_client_from_config
- storage_broker,
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/client.py", line 676, in __init__
- node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
- self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
- newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
-builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
-
-allmydata.test.test_node.TestCase.test_logdir_is_str
-===============================================================================
-[ERROR]
-Traceback (most recent call last):
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/test/test_node.py", line 259, in test_private_config
config = config_from_string(basedir, "", "")
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 209, in config_from_string
@@ -8446,11 +8452,9 @@
tor_provider,
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/introducer/server.py", line 87, in __init__
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
- self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
- newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
-builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 740, in __init__
+ self.config.write_config_file("my_nodeid", b32encode(self.nodeid).lower() + "\n")
+builtins.TypeError: can't concat str to bytes
allmydata.test.test_system.Connections.test_rref
allmydata.test.test_system.SystemTest.test_filesystem
@@ -8565,11 +8569,9 @@
tor_provider,
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/introducer/server.py", line 87, in __init__
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
- self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
- newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
-builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 740, in __init__
+ self.config.write_config_file("my_nodeid", b32encode(self.nodeid).lower() + "\n")
+builtins.TypeError: can't concat str to bytes
allmydata.test.web.test_introducer.IntroducerWeb.test_basic_information
===============================================================================
@@ -8587,11 +8589,9 @@
tor_provider,
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/introducer/server.py", line 87, in __init__
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
- self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
- newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
-builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 740, in __init__
+ self.config.write_config_file("my_nodeid", b32encode(self.nodeid).lower() + "\n")
+builtins.TypeError: can't concat str to bytes
allmydata.test.web.test_introducer.IntroducerWeb.test_json_front_page
===============================================================================
@@ -8609,11 +8609,9 @@
tor_provider,
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/introducer/server.py", line 87, in __init__
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
- self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
- newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
-builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 740, in __init__
+ self.config.write_config_file("my_nodeid", b32encode(self.nodeid).lower() + "\n")
+builtins.TypeError: can't concat str to bytes
allmydata.test.web.test_introducer.IntroducerWeb.test_tahoe_css
===============================================================================
@@ -8631,11 +8629,9 @@
tor_provider,
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/introducer/server.py", line 87, in __init__
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
- self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
- newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
-builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 740, in __init__
+ self.config.write_config_file("my_nodeid", b32encode(self.nodeid).lower() + "\n")
+builtins.TypeError: can't concat str to bytes
allmydata.test.web.test_introducer.IntroducerWeb.test_welcome
===============================================================================
@@ -8721,7 +8717,7 @@
-------------------------------------------------------------------------------
Ran 1300 tests in ###.###s
-FAILED (skips=42, expectedFailures=1, failures=34, errors=532, successes=707)
+FAILED (skips=42, expectedFailures=1, failures=35, errors=531, successes=707)
Unknown error
Traceback (most recent call last):
@@ -8740,11 +8736,9 @@
storage_broker,
File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/client.py", line 676, in __init__
node.Node.__init__(self, config, main_tub, control_tub, i2p_provider, tor_provider)
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 734, in __init__
- self.setup_logging()
- File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 826, in setup_logging
- newmeth = types.UnboundMethodType(formatTimeTahoeStyle, ob, ob.__class__)
-builtins.AttributeError: module 'types' has no attribute 'UnboundMethodType'
+ File "/home/rpatterson/src/work/sfu/tahoe-lafs/src/allmydata/node.py", line 740, in __init__
+ self.config.write_config_file("my_nodeid", b32encode(self.nodeid).lower() + "\n")
+builtins.TypeError: can't concat str to bytes
+ test_exit=1
+ ./.tox/py36-coverage/bin/coverage combine
+ ./.tox/py36-coverage/bin/coverage html
@@ -8775,11 +8769,11 @@
src/allmydata/immutable/downloader/__init__.py 7 1 2 1 78% 12, 11->12
src/allmydata/immutable/downloader/common.py 14 1 2 1 88% 12, 11->12
src/allmydata/immutable/downloader/fetcher.py 147 1 56 1 99% 12, 11->12
-src/allmydata/immutable/downloader/finder.py 143 11 40 5 91% 11, 88-89, 108, 115, 170-173, 231-232, 10->11, 87->88, 107->108, 113->115, 165->exit
+src/allmydata/immutable/downloader/finder.py 143 9 40 5 92% 11, 88-89, 108, 115, 170-173, 10->11, 87->88, 107->108, 113->115, 165->exit
src/allmydata/immutable/downloader/node.py 282 9 66 9 94% 11, 170-172, 224-235, 271, 10->11, 43->exit, 60->68, 165->169, 169->170, 256->exit, 270->271, 517->exit, 537->exit
src/allmydata/immutable/downloader/segmentation.py 118 1 22 1 99% 11, 10->11
-src/allmydata/immutable/downloader/share.py 453 23 154 11 94% 11, 210, 239-250, 289-290, 354, 399-400, 430-437, 518, 722-725, 775, 862, 10->11, 209->210, 222->239, 288->289, 352->354, 397->399, 515->518, 660->663, 710->722, 762->exit, 774->775
-src/allmydata/immutable/downloader/status.py 154 12 36 1 93% 11, 65-67, 223, 226, 230, 232, 234, 274, 285, 287, 10->11
+src/allmydata/immutable/downloader/share.py 453 15 154 8 96% 11, 210, 248-250, 354, 430-437, 518, 722-725, 862, 10->11, 209->210, 239->248, 352->354, 515->518, 660->663, 710->722, 762->exit
+src/allmydata/immutable/downloader/status.py 154 9 36 1 95% 11, 223, 226, 230, 232, 234, 274, 285, 287, 10->11
src/allmydata/immutable/encode.py 421 13 124 10 95% 114, 197-200, 278-280, 405, 412, 462, 509, 562, 687, 102->104, 113->114, 195->197, 404->405, 411->412, 461->462, 499->509, 505->511, 561->562, 685->687
src/allmydata/immutable/filenode.py 196 48 30 5 72% 77-78, 83, 85, 88, 94-101, 104-124, 127-172, 254, 258, 315, 40->42, 224->227, 227->229, 251->254, 257->258
src/allmydata/immutable/happiness_upload.py 214 1 132 3 99% 15, 13->15, 213->211, 280->279
@@ -8802,7 +8796,7 @@
src/allmydata/mutable/repairer.py 57 37 18 0 29% 13, 15, 17, 19, 29-34, 65-71, 74-126, 129-131
src/allmydata/mutable/retrieve.py 489 123 120 33 71% 46, 48, 50, 52, 56, 58, 60, 62, 64, 89-90, 133, 186-193, 204-208, 211-212, 224-226, 231, 240, 251, 312, 318, 344-354, 377, 385-386, 399-400, 425-434, 490, 501, 515-516, 529-540, 564-578, 591-592, 629-630, 653-654, 674-675, 681-682, 698, 712-729, 758-760, 765, 772-774, 790-792, 871, 883, 909-910, 919-941, 965-966, 981-994, 999-1005, 129->133, 167->169, 169->171, 201->204, 223->224, 230->231, 237->239, 239->240, 243->247, 249->251, 309->312, 317->318, 376->377, 381->385, 391->394, 396->399, 424->425, 489->490, 499->501, 514->515, 590->591, 628->629, 652->653, 673->674, 677->687, 680->681, 687->694, 694->698, 755->764, 764->765, 868->871, 880->883, 964->965
src/allmydata/mutable/servermap.py 612 240 186 26 56% 45, 47, 49, 51, 53, 55, 57, 59, 61, 63, 65, 67, 74, 130-139, 142, 148, 159-161, 175, 177, 183, 186-199, 206, 213, 217-220, 231, 234-238, 243-252, 255-259, 315, 328-350, 358-363, 370-372, 379, 429, 433, 443-447, 495, 498, 506-508, 514-516, 569-570, 603-611, 623-638, 718-721, 732-741, 792, 796, 803-804, 850-851, 872-874, 911-915, 929-945, 961-975, 982-999, 1003-1013, 1043-1045, 1050-1052, 1060-1064, 1069-1070, 1093-1100, 1106-1186, 1214-1215, 1232-1233, 313->315, 427->429, 432->433, 439->443, 459->461, 493->495, 497->498, 504->506, 509->514, 566->569, 597->603, 687->exit, 702->exit, 710->exit, 717->718, 727->732, 759->exit, 791->792, 795->796, 869->872, 1039->1043, 1047->1050, 1059->1060, 1066->1069, 1092->1093, 1213->1214
-src/allmydata/node.py 388 82 146 33 76% 120, 132, 190, 241, 243-245, 278, 284, 294-295, 303-306, 315, 320, 339, 341, 361, 393-396, 422, 449, 453, 490, 493, 500, 511-512, 548, 566, 574, 581, 583, 590-591, 601, 612, 629-633, 679, 681, 738-741, 747, 756, 764, 792-805, 808-809, 814-815, 827-846, 189->190, 240->241, 242->243, 277->278, 314->315, 319->320, 338->339, 340->341, 360->361, 391->393, 421->422, 448->449, 451->453, 489->490, 492->493, 499->500, 510->511, 547->548, 565->566, 573->574, 580->581, 582->583, 589->590, 600->601, 611->612, 622->629, 673->679, 680->681, 737->738, 746->747, 763->764, 821->830, 823->821
+src/allmydata/node.py 388 66 146 33 80% 120, 132, 190, 241, 243-245, 278, 284, 294-295, 303-306, 315, 320, 339, 341, 361, 393-396, 422, 449, 453, 490, 493, 500, 511-512, 548, 566, 574, 581, 583, 590-591, 601, 612, 629-633, 679, 681, 741, 747, 756, 764, 792-805, 808-809, 814-815, 832, 837, 189->190, 240->241, 242->243, 277->278, 314->315, 319->320, 338->339, 340->341, 360->361, 391->393, 421->422, 448->449, 451->453, 489->490, 492->493, 499->500, 510->511, 547->548, 565->566, 573->574, 580->581, 582->583, 589->590, 600->601, 611->612, 622->629, 673->679, 680->681, 746->747, 763->764, 823->821, 831->832, 835->837
src/allmydata/nodemaker.py 97 23 38 10 70% 49, 61, 66, 70, 81, 94, 107-115, 130-138, 141-150, 57->61, 65->66, 69->70, 79->81, 86->95, 90->94, 104->107, 124->exit, 129->130, 129->133
src/allmydata/scripts/admin.py 51 20 2 1 60% 9-14, 25, 28, 31-37, 40-46, 57, 59, 61-66, 56->57
src/allmydata/scripts/backupdb.py 146 91 14 1 36% 84-91, 94-96, 99, 103, 106, 111-114, 117-119, 122, 125, 128, 176-221, 231-242, 245-263, 266-272, 308-324, 327-333, 336-341, 306->308
@@ -8837,7 +8831,7 @@
src/allmydata/storage/common.py 24 1 4 2 89% 11, 10->11, 36->39
src/allmydata/storage/crawler.py 222 1 64 3 99% 16, 13->16, 96->99, 496->505
src/allmydata/storage/expirer.py 240 1 81 2 99% 9, 7->9, 250->exitp
-src/allmydata/storage/immutable.py 198 2 48 6 97% 12, 101, 11->12, 100->101, 142->140, 155->160, 187->197, 273->exit
+src/allmydata/storage/immutable.py 198 1 48 5 98% 12, 11->12, 142->140, 155->160, 187->197, 273->exit
src/allmydata/storage/lease.py 35 1 4 1 95% 12, 11->12
src/allmydata/storage/mutable.py 289 8 90 6 96% 12, 162, 252, 289, 362-367, 11->12, 160->162, 247->252, 307->311, 354->362, 448->exit
src/allmydata/storage/server.py 371 9 120 9 96% 13, 92, 222, 243, 329, 349, 375, 422-423, 10->13, 91->92, 221->222, 241->243, 289->300, 317->329, 325->305, 346->349, 374->375
@@ -8899,7 +8893,7 @@
src/allmydata/windows/fixups.py 133 133 54 0 0% 1-237
src/allmydata/windows/registry.py 42 42 12 0 0% 1-77
------------------------------------------------------------------------------------------------
-TOTAL 27477 11798 8244 605 54%
+TOTAL 27477 11768 8244 601 54%
18 files skipped due to complete coverage.
+ '[' '!' -z 1 ']'
```
2020-10-02 17:23:18 +00:00
|
|
|
newmeth = types.MethodType(formatTimeTahoeStyle, ob)
|
2007-10-15 03:43:11 +00:00
|
|
|
ob.formatTime = newmeth
|
2007-10-12 00:30:07 +00:00
|
|
|
# TODO: twisted >2.5.0 offers maxRotatedFiles=50
|
|
|
|
|
2018-01-31 18:30:46 +00:00
|
|
|
lgfurl_file = self.config.get_private_path("logport.furl").encode(get_filesystem_encoding())
|
2016-07-07 02:47:00 +00:00
|
|
|
if os.path.exists(lgfurl_file):
|
|
|
|
os.remove(lgfurl_file)
|
|
|
|
self.log_tub.setOption("logport-furlfile", lgfurl_file)
|
2017-09-06 01:08:35 +00:00
|
|
|
lgfurl = self.config.get_config("node", "log_gatherer.furl", "")
|
2008-09-30 23:21:49 +00:00
|
|
|
if lgfurl:
|
|
|
|
# this is in addition to the contents of log-gatherer-furlfile
|
2020-10-26 20:48:18 +00:00
|
|
|
lgfurl = lgfurl.encode("utf-8")
|
2016-07-07 02:47:00 +00:00
|
|
|
self.log_tub.setOption("log-gatherer-furl", lgfurl)
|
|
|
|
self.log_tub.setOption("log-gatherer-furlfile",
|
2018-01-31 18:30:46 +00:00
|
|
|
self.config.get_config_path("log_gatherer.furl"))
|
2015-11-03 17:35:21 +00:00
|
|
|
|
2018-01-31 18:30:46 +00:00
|
|
|
incident_dir = self.config.get_config_path("logs", "incidents")
|
2020-10-16 14:55:33 +00:00
|
|
|
foolscap.logging.log.setLogDir(incident_dir)
|
2016-08-09 19:27:33 +00:00
|
|
|
twlog.msg("Foolscap logging initialized")
|
|
|
|
twlog.msg("Note to developers: twistd.log does not receive very much.")
|
|
|
|
twlog.msg("Use 'flogtool tail -c NODEDIR/private/logport.furl' instead")
|
|
|
|
twlog.msg("and read docs/logging.rst")
|
2007-12-13 03:31:01 +00:00
|
|
|
|
2008-01-15 04:16:58 +00:00
|
|
|
def log(self, *args, **kwargs):
|
2008-07-03 00:40:29 +00:00
|
|
|
return log.msg(*args, **kwargs)
|