Merge ~kissiel/plainbox:fix-1262898-warns-when-XFG_HOME-RO into plainbox:master

[Maciej Kisielewski]

silence EPERM on log_dir when using provider_manager

When plainbox is unable to create log_dir it displays a warning. That logdir is created in XDG_CACHE_HOME which when using debian build systems is not writable. This is not only the case when running plainbox commands, but also when setting up providers.

This patch adds a flag to the logging config that suppresses that warning, and uses it in provider_manager calls.

That warning still pops up when plainbox is called (as in plainbox the command in $PATH). But I'm ignoring it, as calling plainbox directly will soon be disabled.

Fixes: LP:1262898

To test it I created a dir with mode "uog-w" and pointed XDG_CACHE_HOME before running ./manage.py of some provider.

[Paul Larson (pwlars)]

is provider_manager the only place that hits it? I assume this will be enough to stop it during the normal builds, which appears to be the intent of the bug. +1 assuming that's true. Nice cleanup!

review: Approve

[Maciej Kisielewski (kissiel)]

> is provider_manager the only place that hits it? I assume this will be enough
> to stop it during the normal builds, which appears to be the intent of the
> bug. +1 assuming that's true. Nice cleanup!

AFAIK this is the only place outside plainbox that uses facilities from plainbox and is used in building anything.

[Sylvain Pineau (sylvain-pineau)]

I think this commit broke one debian patch:

Applying patch /home/buildd/build-RECIPEBRANCHBUILD-1515077/chroot-autobuild/home/buildd/work/tree/recipe/debian/patches/silence-logging-failure
patching file plainbox/impl/logging.py
Hunk #1 FAILED at 94.
1 out of 1 hunk FAILED -- rejects in file plainbox/impl/logging.py
Restoring plainbox/impl/logging.py
Patch /home/buildd/build-RECIPEBRANCHBUILD-1515077/chroot-autobuild/home/buildd/work/tree/recipe/debian/patches/silence-logging-failure does not apply (enforce with -f)
Restoring plainbox/impl/logging.py
Traceback (most recent call last):
  File "/usr/lib/python3/dist-packages/gitbuildrecipe/main.py", line 164, in main
    package_version.upstream_version, working_basedir)
  File "/usr/lib/python3/dist-packages/gitbuildrecipe/deb_util.py", line 86, in extract_upstream_tarball
    raise NoSuchTag(tag_names[0])
gitbuildrecipe.deb_util.NoSuchTag

I'll try to refresh it to restore our daily builds of plainbox

diff --git a/plainbox/impl/logging.py b/plainbox/impl/logging.py
index 85fe7dd..6e8b2d5 100644
--- a/plainbox/impl/logging.py
+++ b/plainbox/impl/logging.py
@@ -84,20 +84,23 @@ class LoggingHelper:
     Helper class that manages logging subsystem
     """
 
-    def setup_logging(self):
-        config_dict = self.DEFAULT_CONFIG
+    def setup_logging(self, config_dict = dict()):
         # Ensure that the logging directory exists. This is important
         # because we're about to open some files there. If it can't be created
         # we fall back to a console-only config.
+        if not config_dict:
+            config_dict = self.DEFAULT_CONFIG
         if not os.path.exists(self.log_dir):
             # It seems that exists_ok is flaky
             try:
                 os.makedirs(self.log_dir, exist_ok=True)
             except OSError as error:
-                logger.warning(
-                    _("Unable to create log directory: %s"), self.log_dir)
-                logger.warning(_("Reason: %s. All logs will go to "
-                                 "console instead."), error)
+                if not config_dict.get(
+                        'silence_eperm_on_logdir_warning', False):
+                    logger.warning(
+                        _("Unable to create log directory: %s"), self.log_dir)
+                    logger.warning(_("Reason: %s. All logs will go to "
+                                    "console instead."), error)
                 config_dict = self.DEFAULT_CONSOLE_ONLY_CONFIG
         # Apply the selected configuration. This overrides anything currently
         # defined for all of the logging subsystem in this python runtime
@@ -403,6 +406,7 @@ class LoggingHelper:
             },
             "incremental": False,
             "disable_existing_loggers": True,
+            "silence_eperm_on_logdir_warning": False,
         }
 
     @property
diff --git a/plainbox/provider_manager.py b/plainbox/provider_manager.py
index 58611ea..96767ea 100644
--- a/plainbox/provider_manager.py
+++ b/plainbox/provider_manager.py
@@ -44,7 +44,7 @@ from plainbox.i18n import ngettext
 from plainbox.impl.buildsystems import all_buildsystems
 from plainbox.impl.commands import ToolBase, CommandBase
 from plainbox.impl.job import JobDefinition
-from plainbox.impl.logging import setup_logging
+from plainbox.impl.logging import setup_logging, LoggingHelper
 from plainbox.impl.providers.special import get_categories
 from plainbox.impl.providers.special import get_manifest
 from plainbox.impl.providers.v1 import InsecureProvider1PlugInCollection
@@ -1478,7 +1478,9 @@ def setup(**kwargs):
         gettext_domain:
             gettext translation domain for job definition strings, optional
     """
-    setup_logging()
+    config = LoggingHelper().DEFAULT_CONFIG.copy()
+    config['silence_eperm_on_logdir_warning'] = True
+    setup_logging(config)
     manage_py = inspect.stack()[1][0].f_globals['__file__']
     location = os.path.dirname(os.path.abspath(manage_py))
     definition = Provider1Definition()