August 2018 - tor-commits - lists.torproject.org

[sbws/master] Create log dir
by pastly＠torproject.org 09 Aug '18

09 Aug '18

commit 52b3d1dd86611931343a843b0d86c909ff65d983 Author: juga0 <juga(a)riseup.net> Date: Tue Jul 24 18:54:14 2018 +0000 Create log dir --- sbws/util/stem.py | 1 + 1 file changed, 1 insertion(+) diff --git a/sbws/util/stem.py b/sbws/util/stem.py index 8e57f96..232be2a 100644 --- a/sbws/util/stem.py +++ b/sbws/util/stem.py @@ -120,6 +120,7 @@ def _init_controller_socket(socket): def launch_tor(conf): assert isinstance(conf, ConfigParser) os.makedirs(conf.getpath('tor', 'datadir'), mode=0o700, exist_ok=True) + os.makedirs(conf.getpath('tor', 'log'), exist_ok=True) os.makedirs(conf.getpath('tor', 'run_dpath'), mode=0o700, exist_ok=True) # Bare minimum things, more or less torrc = copy.deepcopy(TORRC_STARTING_POINT)

1 0

[sbws/master] Change runtime dir to be relative to tests dir
by pastly＠torproject.org 09 Aug '18

09 Aug '18

commit d739c5509a08d99b9ad4802e8cf04834485e9da1 Author: juga0 <juga(a)riseup.net> Date: Tue Jul 24 18:54:39 2018 +0000 Change runtime dir to be relative to tests dir --- tests/integration/conftest.py | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/integration/conftest.py b/tests/integration/conftest.py index 1cadb3b..4b31f8c 100644 --- a/tests/integration/conftest.py +++ b/tests/integration/conftest.py @@ -62,6 +62,7 @@ def conf(sbwshome_dir): """Default configuration with sbws home in the tmp test dir.""" conf = _get_default_config() conf['paths']['sbws_home'] = sbwshome_dir + conf['tor']['run_dpath'] = os.path.join(sbwshome_dir, 'tor', 'run') conf['destinations']['foo'] = 'on' conf['destinations.foo'] = {} conf['destinations.foo']['url'] = 'http://127.0.0.1:28888/sbws.bin'

1 0

[sbws/master] Stop creating user configuration if it does not exists
by pastly＠torproject.org 09 Aug '18

09 Aug '18

commit 2b9fcca8e00ff09fe386f2767b8a162e3f8eed07 Author: juga0 <juga(a)riseup.net> Date: Tue Jul 24 18:19:13 2018 +0000 Stop creating user configuration if it does not exists --- sbws/util/config.py | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-) diff --git a/sbws/util/config.py b/sbws/util/config.py index 99c7d67..d6bb115 100644 --- a/sbws/util/config.py +++ b/sbws/util/config.py @@ -1,5 +1,4 @@ """Util functions to manage sbws configuration files.""" -import shutil from configparser import (ConfigParser, ExtendedInterpolation) from configparser import InterpolationMissingOptionError @@ -10,7 +9,7 @@ from urllib.parse import urlparse from string import Template from tempfile import NamedTemporaryFile from sbws.globals import (DEFAULT_CONFIG_PATH, DEFAULT_LOG_CONFIG_PATH, - MINIMUM_USER_CONFIG_PATH, USER_CONFIG_PATH) + USER_CONFIG_PATH, fail_hard) _ALPHANUM = 'abcdefghijklmnopqrstuvwxyz' _ALPHANUM += _ALPHANUM.upper() @@ -32,12 +31,6 @@ def _expand_path(path): return os.path.expanduser(os.path.expandvars(path)) -def _create_user_config_file(fname): - """Copy minimal user config to user config path.""" - if not os.path.isfile(fname): - shutil.copyfile(MINIMUM_USER_CONFIG_PATH, fname) - - def _extend_config(conf, fname): """Extend ConfigParser from file configuration.""" log.debug('Reading config file %s', fname) @@ -66,14 +59,12 @@ def _get_user_config(args, conf=None): assert isinstance(conf, ConfigParser) if args.config: if not os.path.isfile(args.config): - log.warning('Configuration file %s not found, ' - 'using default configuration, and creating a minimal ' - 'configuration in %s.', args.config, args.config) - _create_user_config_file(args.config) - return conf + fail_hard('Configuration file %s not found.', args.config) return _extend_config(conf, args.config) - _create_user_config_file(USER_CONFIG_PATH) - return _extend_config(conf, USER_CONFIG_PATH) + if os.path.isfile(USER_CONFIG_PATH): + return _extend_config(conf, USER_CONFIG_PATH) + log.debug('No user config found.') + return conf def _get_default_logging_config(conf=None):

1 0

[sbws/master] Remove unneded minimal user config
by pastly＠torproject.org 09 Aug '18

09 Aug '18

commit 22209c2c0f9645b150222a4b6769cc811a795b8c Author: juga0 <juga(a)riseup.net> Date: Tue Jul 24 18:20:17 2018 +0000 Remove unneded minimal user config --- sbws/globals.py | 1 - 1 file changed, 1 deletion(-) diff --git a/sbws/globals.py b/sbws/globals.py index 56597b1..daa0a55 100644 --- a/sbws/globals.py +++ b/sbws/globals.py @@ -26,7 +26,6 @@ TORRC_STARTING_POINT = { PKG_DIR = os.path.abspath(os.path.dirname(__file__)) DEFAULT_CONFIG_PATH = os.path.join(PKG_DIR, 'config.default.ini') DEFAULT_LOG_CONFIG_PATH = os.path.join(PKG_DIR, 'config.log.default.ini') -MINIMUM_USER_CONFIG_PATH = os.path.join(PKG_DIR, 'config.user.ini') USER_CONFIG_PATH = os.path.join(os.path.expanduser('~'), '.sbws.ini') SOCKET_TIMEOUT = 60 # seconds

1 0

[sbws/master] Include examples
by pastly＠torproject.org 09 Aug '18

09 Aug '18

commit d1eee1d18977a45a8d2f9802c7415d0bb6032508 Author: juga0 <juga(a)riseup.net> Date: Tue Jul 24 18:40:55 2018 +0000 Include examples --- setup.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/setup.py b/setup.py index e009a7b..7985eac 100755 --- a/setup.py +++ b/setup.py @@ -24,12 +24,11 @@ def get_package_data(): return [ 'config.default.ini', 'config.log.default.ini', - 'config.example.ini', ] def get_data_files(): - return [] + return [('examples', [os.path.join('examples', 'config.example.ini')])] def find_version():

1 0

[sbws/master] Change logging to stdout by default
by pastly＠torproject.org 09 Aug '18

09 Aug '18

commit 02d59bbf68ef73f23b6ac713efa3081c41fc8252 Author: juga0 <juga(a)riseup.net> Date: Tue Jul 24 18:56:00 2018 +0000 Change logging to stdout by default --- sbws/config.default.ini | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sbws/config.default.ini b/sbws/config.default.ini index 5dcc8f4..0ad0ebf 100644 --- a/sbws/config.default.ini +++ b/sbws/config.default.ini @@ -95,9 +95,9 @@ min_relays = 50 [logging] # Whether or not to log to a rotating file the directory paths.log_dname -to_file = yes +to_file = no # Whether or not to log to stdout -to_stdout = no +to_stdout = yes # Whether or not to log to syslog to_syslog = no # If logging to file, how large (in bytes) should the file be allowed to get

1 0

[sbws/master] Remove init from documentation
by pastly＠torproject.org 09 Aug '18

09 Aug '18

commit 51810c81252054bb44f1695f3a6b7b59d220fe48 Author: juga0 <juga(a)riseup.net> Date: Tue Jul 24 19:19:54 2018 +0000 Remove init from documentation --- docs/source/sbws.core.rst | 54 ----------------------------------------------- 1 file changed, 54 deletions(-) diff --git a/docs/source/sbws.core.rst b/docs/source/sbws.core.rst deleted file mode 100644 index 4d71f1f..0000000 --- a/docs/source/sbws.core.rst +++ /dev/null @@ -1,54 +0,0 @@ -sbws.core package -===================== - -Submodules ----------- - -sbws.core.cleanup module -~~~~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: sbws.core.cleanup - :members: - :undoc-members: - :show-inheritance: - -sbws.core.generate module -~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: sbws.core.generate - :members: - :undoc-members: - :show-inheritance: - -sbws.core.init module -~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: sbws.core.init - :members: - :undoc-members: - :show-inheritance: - -sbws.core.scanner module -~~~~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: sbws.core.scanner - :members: - :undoc-members: - :show-inheritance: - -sbws.core.stats module -~~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: sbws.core.stats - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: sbws.core - :members: - :undoc-members: - :show-inheritance:

1 0

[sbws/master] Remove init section
by pastly＠torproject.org 09 Aug '18

09 Aug '18

commit eb14b4c8e4ab70aa7339e796b091a760815d9472 Author: juga0 <juga(a)riseup.net> Date: Tue Jul 24 19:32:29 2018 +0000 Remove init section --- INSTALL.rst | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/INSTALL.rst b/INSTALL.rst index a6b1ece..1ccfa1b 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -83,22 +83,19 @@ of sbws. git checkout v1.5.3 pip install . -Initialize sbws -~~~~~~~~~~~~~~~~~~~ - -This creates ``~/.sbws`` and initializes some files in it. - -:: +Run sbws +~~~~~~~~~~ - sbws init +If you would like to use a custom configuration file you can create it in +``~/.sbws.ini`` or provide ``sbws`` with it via ``-c`` ``--config`` option. -If you would like to keep sbws's data directory somewhere else, use ``-d``. -**You will have to use -d every time you run an sbws command to use this custom -directory**. +See the documentation section about configuration files for more information +about how to create a configuration file. +Tor run the scanner run :: - sbws -d /tmp/dotsbws-testing init + sbws scanner [OBSOLETE DO NOT FOLLOW] Virtualenv - Production

1 0

[sbws/master] Remove init section
by pastly＠torproject.org 09 Aug '18

09 Aug '18

commit 18e55131115278cf373464242c4bc7a7c44ea51c Author: juga0 <juga(a)riseup.net> Date: Tue Jul 24 19:33:51 2018 +0000 Remove init section --- README.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0b762a2..7072f8b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Build Status](https://travis-ci.org/pastly/simple-bw-scanner.svg?branch=master)](… -`simple-bw-scanner` (also called `sbws`) is a Tor bandwidth scanner that +`simple-bw-scanner` (also called `sbws`) is a Tor bandwidth scanner that produces bandwidth measurements files to be used by Directory Authorities. It doesn't get simpler than this, folks. @@ -121,16 +121,10 @@ The generated HTML will be in `docs/build/`. ## The `.sbws` directory -By default is `~/.sbws`. You can choose a different one by specifying `-d` when -calling sbws. - - sbws -d /tmp/testing-dotsbws init - sbws -d /tmp/testing-dotsbws client +By default is `~/.sbws`. In this directory you will find -- `config.ini` The configuration file you should be editing if you want to - modify sbws's behavior. - `datadir/` Once your sbws scanner has started gathering results, it will dump them into this directory. Other sbws commands (such as generate and stats) read results from the files in this directory.

1 0

[sbws/master] Rename user config back to example
by pastly＠torproject.org 09 Aug '18

09 Aug '18

commit 8c87a9b39c67ca8a0a97e43f8b049f39054106b3 Author: juga0 <juga(a)riseup.net> Date: Tue Jul 24 18:21:10 2018 +0000 Rename user config back to example and place it in examples dir so that the user can easily access to it. --- sbws/config.user.ini => examples/config.example.ini | 0 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/sbws/config.user.ini b/examples/config.example.ini similarity index 100% rename from sbws/config.user.ini rename to examples/config.example.ini

1 0