Merge lp:~ralsina/ubuntu-sso-client/log-better into lp:ubuntu-sso-client

[Roberto Alsina]

Move the windows xdg implementation from u1-client to sso so we can use it in all our projects.

Move the windows xdg implementation from u1-client to sso so we can use it in all our projects.

[lp:~ralsina/ubuntu-sso-client/log-better]

767. By Roberto Alsina on 2011-08-23

added the windows-specific tests

[Natalia Bidart (nataliabidart)]

So, since we're adding a new multiplatform module, we need to come up with something like this:

ubuntu_sso/
    main/
    foo/
    xdg_base_directory/
        __init__.py
        windows.py
        tests/
            __init__.py
            test_common.py <- multiplatform tests
            test_windows.py

review: Needs Fixing

[lp:~ralsina/ubuntu-sso-client/log-better]

768. By Roberto Alsina on 2011-08-23

add __init__

769. By Roberto Alsina on 2011-08-23

forgot one

[Natalia Bidart (nataliabidart)]

I'm getting all these failures when running ./run-tests:

ubuntu_sso/utils/ui.py:
    121: [E1101, get_data_dir] Module 'ubuntu_sso.xdg_base_directory' has no 'xdg_data_dirs' member

ubuntu_sso/xdg_base_directory/__init__.py:
    24: [C0103] Invalid name "load_config_paths" (should match (([A-Z_][A-Z0-9_]*)|(__.*__))$)
    25: [C0103] Invalid name "save_config_path" (should match (([A-Z_][A-Z0-9_]*)|(__.*__))$)
    26: [C0103] Invalid name "xdg_cache_home" (should match (([A-Z_][A-Z0-9_]*)|(__.*__))$)
    27: [C0103] Invalid name "xdg_data_home" (should match (([A-Z_][A-Z0-9_]*)|(__.*__))$)
    30: [C0103] Invalid name "load_config_paths" (should match (([A-Z_][A-Z0-9_]*)|(__.*__))$)
    31: [C0103] Invalid name "save_config_path" (should match (([A-Z_][A-Z0-9_]*)|(__.*__))$)
    32: [C0103] Invalid name "xdg_cache_home" (should match (([A-Z_][A-Z0-9_]*)|(__.*__))$)
    33: [C0103] Invalid name "xdg_data_home" (should match (([A-Z_][A-Z0-9_]*)|(__.*__))$)
    35: [C0103] Invalid name "ubuntuone_log_dir" (should match (([A-Z_][A-Z0-9_]*)|(__.*__))$)

ubuntu_sso/xdg_base_directory/tests/__init__.py:
    1: [C0111] Missing docstring

ubuntu_sso/xdg_base_directory/windows.py:
    28: [W0621, get_special_folders] Redefining name 'special_folders' from outer scope (line 45)
    23: [C0111, get_special_folders] Missing docstring
    30: [F0401, get_special_folders] Unable to import 'win32com.shell'
    45: [C0103] Invalid name "special_folders" (should match (([A-Z_][A-Z0-9_]*)|(__.*__))$)
    47: [C0103] Invalid name "home_path" (should match (([A-Z_][A-Z0-9_]*)|(__.*__))$)
    48: [C0103] Invalid name "app_local_data_path" (should match (([A-Z_][A-Z0-9_]*)|(__.*__))$)
    49: [C0103] Invalid name "app_global_data_path" (should match (([A-Z_][A-Z0-9_]*)|(__.*__))$)
    52: [C0103] Invalid name "xdg_data_home" (should match (([A-Z_][A-Z0-9_]*)|(__.*__))$)
    62: [C0103] Invalid name "xdg_data_dirs" (should match (([A-Z_][A-Z0-9_]*)|(__.*__))$)
    66: [C0103] Invalid name "xdg_cache_home" (should match (([A-Z_][A-Z0-9_]*)|(__.*__))$)
    70: [C0103] Invalid name "xdg_config_home" (should match (([A-Z_][A-Z0-9_]*)|(__.*__))$)
    81: [C0103] Invalid name "xdg_config_dirs" (should match (([A-Z_][A-Z0-9_]*)|(__.*__))$)
    83: [C0103] Invalid name "xdg_data_dirs" (should match (([A-Z_][A-Z0-9_]*)|(__.*__))$)
    84: [C0103] Invalid name "xdg_config_dirs" (should match (([A-Z_][A-Z0-9_]*)|(__.*__))$)

You may wanna disable C0103 in ubuntu_sso/xdg_base_directory/windows.py and ubuntu_sso/xdg_base_directory/__init__.py.

review: Needs Fixing

[Natalia Bidart (nataliabidart)]

Another style fix:

* this import from logging.handlers import RotatingFileHandler should be separated by a blank line from the stdlib imports.

review: Needs Fixing

[lp:~ralsina/ubuntu-sso-client/log-better]

770. By Roberto Alsina on 2011-08-23

style fix

771. By Roberto Alsina on 2011-08-23

Lint fixes

[Roberto Alsina (ralsina)]

Pushed with all the lint fixes (and hey, it was missing making xdg_data_dirs visible)

[lp:~ralsina/ubuntu-sso-client/log-better]

772. By Roberto Alsina on 2011-08-23

publish missing member, lint fixes

[Natalia Bidart (nataliabidart)]

Looks good!

review: Approve

=== modified file 'ubuntu_sso/logger.py'
--- ubuntu_sso/logger.py	2011-01-11 19:13:19 +0000
+++ ubuntu_sso/logger.py	2011-08-23 15:43:28 +0000
@@ -25,12 +25,11 @@
 import os
 import sys
 
-import xdg.BaseDirectory
-
 from logging.handlers import RotatingFileHandler
 
+from ubuntu_sso import xdg_base_directory
 
-LOGFOLDER = os.path.join(xdg.BaseDirectory.xdg_cache_home, 'sso')
+LOGFOLDER = os.path.join(xdg_base_directory.xdg_cache_home, 'sso')
 # create log folder if it doesn't exists
 if not os.path.exists(LOGFOLDER):
     os.makedirs(LOGFOLDER)
 
=== modified file 'ubuntu_sso/utils/ui.py'
--- ubuntu_sso/utils/ui.py	2011-07-28 22:50:33 +0000
+++ ubuntu_sso/utils/ui.py	2011-08-23 15:43:28 +0000
@@ -20,10 +20,10 @@
 
 import os
 import re
-import xdg
 import gettext
 
 from ubuntu_sso.logger import setup_logging
+from ubuntu_sso import xdg_base_directory
 
 logger = setup_logging('ubuntu_sso.utils.ui')
 
@@ -118,7 +118,7 @@
         return result
 
     # no local data dir, looking within system data dirs
-    data_dirs = xdg.BaseDirectory.xdg_data_dirs
+    data_dirs = xdg_base_directory.xdg_data_dirs
     for path in data_dirs:
         result = os.path.join(path, 'ubuntu-sso-client', 'data')
         result = os.path.abspath(result)
 
=== added directory 'ubuntu_sso/xdg_base_directory'
=== added file 'ubuntu_sso/xdg_base_directory/__init__.py'
--- ubuntu_sso/xdg_base_directory/__init__.py	1970-01-01 00:00:00 +0000
+++ ubuntu_sso/xdg_base_directory/__init__.py	2011-08-23 15:43:28 +0000
@@ -0,0 +1,40 @@
+# Author: Natalia B. Bidart <[e-mail]>
+#
+# Copyright 2011 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""XDG multiplatform."""
+
+import os
+import sys
+
+# pylint: disable=C0103
+if sys.platform == "win32":
+    from ubuntu_sso.xdg_base_directory import windows
+    load_config_paths = windows.load_config_paths
+    save_config_path = windows.save_config_path
+    xdg_cache_home = windows.xdg_cache_home
+    xdg_data_home = windows.xdg_data_home
+    xdg_data_dirs = windows.xdg_data_dirs
+else:
+    import xdg.BaseDirectory
+    load_config_paths = xdg.BaseDirectory.load_config_paths
+    save_config_path = xdg.BaseDirectory.save_config_path
+    xdg_cache_home = xdg.BaseDirectory.xdg_cache_home
+    xdg_data_home = xdg.BaseDirectory.xdg_data_home
+    xdg_data_dirs = xdg.BaseDirectory.xdg_data_dirs
+
+ubuntuone_log_dir = os.path.join(xdg_cache_home, 'ubuntuone', 'log')
+if not os.path.exists(ubuntuone_log_dir):
+    os.makedirs(ubuntuone_log_dir)
 
=== added directory 'ubuntu_sso/xdg_base_directory/tests'
=== added file 'ubuntu_sso/xdg_base_directory/tests/__init__.py'
--- ubuntu_sso/xdg_base_directory/tests/__init__.py	1970-01-01 00:00:00 +0000
+++ ubuntu_sso/xdg_base_directory/tests/__init__.py	2011-08-23 15:43:28 +0000
@@ -0,0 +1,16 @@
+# ubuntu_sso - Ubuntu Single Sign On client support for desktop apps
+#
+# Copyright 2009-2010 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""XDG tests."""
 
=== added file 'ubuntu_sso/xdg_base_directory/tests/test_common.py'
--- ubuntu_sso/xdg_base_directory/tests/test_common.py	1970-01-01 00:00:00 +0000
+++ ubuntu_sso/xdg_base_directory/tests/test_common.py	2011-08-23 15:43:28 +0000
@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+#
+# Authors: Natalia B. Bidart <[e-mail]>
+#
+# Copyright 2011 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Platform independent tests for the XDG constants."""
+
+import os
+
+from twisted.trial.unittest import TestCase
+
+from ubuntu_sso import xdg_base_directory
+
+
+class TestBaseDirectory(TestCase):
+    """Tests for the BaseDirectory module."""
+
+    def test_ubuntuone_log_dir(self):
+        """The ubuntuone_log_dir is correct."""
+        expected = os.path.join(xdg_base_directory.xdg_cache_home,
+                                'ubuntuone', 'log')
+        self.assertEqual(expected, xdg_base_directory.ubuntuone_log_dir)
+        self.assertTrue(os.path.exists(expected))
+
+    def test_xdg_cache_home_is_bytes(self):
+        """The returned path is bytes."""
+        actual = xdg_base_directory.xdg_cache_home
+        self.assertIsInstance(actual, str)
+
+    def test_xdg_data_home_is_bytes(self):
+        """The returned path is bytes."""
+        actual = xdg_base_directory.xdg_data_home
+        self.assertIsInstance(actual, str)
+
+    def test_load_config_paths_filter(self):
+        """Since those folders don't exist, this should be empty."""
+        self.assertEqual(list(xdg_base_directory.load_config_paths("x")), [])
+
+    def test_save_config_path(self):
+        """The path should end with xdg_config/x (respecting the separator)."""
+        self.patch(os, "makedirs", lambda *args: None)
+        result = xdg_base_directory.save_config_path("x")
+        self.assertEqual(result.split(os.sep)[-2:], ['xdg_config', 'x'])
 
=== added file 'ubuntu_sso/xdg_base_directory/tests/test_windows.py'
--- ubuntu_sso/xdg_base_directory/tests/test_windows.py	1970-01-01 00:00:00 +0000
+++ ubuntu_sso/xdg_base_directory/tests/test_windows.py	2011-08-23 15:43:28 +0000
@@ -0,0 +1,112 @@
+# -*- coding: utf-8 -*-
+#
+# Authors: Natalia B. Bidart <[e-mail]>
+#
+# Copyright 2011 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Windows-specific tests for the XDG constants."""
+
+import os
+import sys
+
+from twisted.trial.unittest import TestCase
+from ubuntuone.devtools.testcase import skipIfOS
+
+
+# pylint: disable=E1101, E0611, F0401
+if sys.platform == "win32":
+    import win32com.shell
+    from ubuntu_sso.xdg_base_directory.windows import (
+         get_config_dirs,
+         get_data_dirs,
+         get_special_folders,
+    )
+
+
+# pylint: disable=C0103
+class FakeShellConModule(object):
+    """Override CSIDL_ constants."""
+    CSIDL_PROFILE = 0
+    CSIDL_LOCAL_APPDATA = 1
+    CSIDL_COMMON_APPDATA = 2
+
+
+class FakeShellModule(object):
+
+    """Fake Shell Module."""
+
+    def __init__(self):
+        """Set the proper mapping between CSIDL_ consts."""
+        self.values = {
+            0: u'c:\\path\\to\\users\\home',
+            1: u'c:\\path\\to\\users\\home\\appData\\local',
+            2: u'c:\\programData',
+        }
+
+    def SHGetFolderPath(self, dummy0, shellconValue, dummy2, dummy3):
+        """Override SHGetFolderPath functionality."""
+        return self.values[shellconValue]
+
+
+@skipIfOS('linux2', 'Windows-specific tests.')
+class TestBaseDirectoryWindows(TestCase):
+    """Tests for the BaseDirectory module."""
+
+    def test_get_special_folders(self):
+        """Make sure we can import the platform module."""
+
+        shellModule = FakeShellModule()
+        self.patch(win32com.shell, "shell", shellModule)
+        self.patch(win32com.shell, "shellcon", FakeShellConModule())
+        special_folders = get_special_folders()
+        self.assertTrue('Personal' in special_folders)
+        self.assertTrue('Local AppData' in special_folders)
+        self.assertTrue('AppData' in special_folders)
+        self.assertTrue('Common AppData' in special_folders)
+
+        self.assertTrue(special_folders['Personal'] == \
+            shellModule.values[FakeShellConModule.CSIDL_PROFILE])
+        self.assertTrue(special_folders['Local AppData'] == \
+            shellModule.values[FakeShellConModule.CSIDL_LOCAL_APPDATA])
+        self.assertTrue(special_folders['Local AppData'].startswith(
+            special_folders['AppData']))
+        self.assertTrue(special_folders['Common AppData'] == \
+            shellModule.values[FakeShellConModule.CSIDL_COMMON_APPDATA])
+
+        # Can't use assert_syncdaemon_path
+        for val in special_folders.itervalues():
+            self.assertIsInstance(val, str)
+            val.decode('utf8')
+        # Should not raise exceptions
+
+    def test_get_data_dirs(self):
+        """Check thet get_data_dirs uses pathsep correctly."""
+        bad_sep = filter(lambda x: x not in os.pathsep, ":;")
+        dir_list = ["A", "B", bad_sep, "C"]
+        self.patch(os, "environ",
+            dict(XDG_DATA_DIRS=os.pathsep.join(
+                dir_list)))
+        dirs = get_data_dirs()
+        self.assertEqual(dirs, dir_list)
+
+    def test_get_config_dirs(self):
+        """Check thet get_data_dirs uses pathsep correctly."""
+        bad_sep = filter(lambda x: x not in os.pathsep, ":;")
+        dir_list = ["A", "B", bad_sep, "C"]
+        self.patch(os, "environ",
+            dict(XDG_CONFIG_DIRS=os.pathsep.join(
+                dir_list)))
+        dirs = get_config_dirs()[1:]
+        self.assertEqual(dirs, dir_list)
 
=== added file 'ubuntu_sso/xdg_base_directory/windows.py'
--- ubuntu_sso/xdg_base_directory/windows.py	1970-01-01 00:00:00 +0000
+++ ubuntu_sso/xdg_base_directory/windows.py	2011-08-23 15:43:28 +0000
@@ -0,0 +1,119 @@
+# Authors: Manuel de la Pena <[e-mail]>
+#          Diego Sarmentero <[e-mail]>
+#
+# Copyright 2011 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""XDG helpers for windows."""
+
+import os
+
+
+# pylint: disable=C0103
+def get_special_folders():
+    """ Routine to grab all the Windows Special Folders locations.
+
+    If successful, returns dictionary
+    of shell folder locations indexed on Windows keyword for each;
+    otherwise, returns an empty dictionary.
+    """
+    # pylint: disable=W0621, F0401, E0611
+    special_folders = {}
+
+    from win32com.shell import shell, shellcon
+    # CSIDL_LOCAL_APPDATA = C:\Users\<username>\AppData\Local
+    # CSIDL_PROFILE = C:\Users\<username>
+    # CSIDL_COMMON_APPDATA = C:\ProgramData
+    # More information on these at
+    # http://msdn.microsoft.com/en-us/library/bb762494(v=vs.85).aspx
+    get_path = lambda name: shell.SHGetFolderPath(
+        0, getattr(shellcon, name), None, 0).encode('utf8')
+    special_folders['Personal'] = get_path("CSIDL_PROFILE")
+    special_folders['Local AppData'] = get_path("CSIDL_LOCAL_APPDATA")
+    special_folders['AppData'] = os.path.dirname(
+        special_folders['Local AppData'])
+    special_folders['Common AppData'] = get_path("CSIDL_COMMON_APPDATA")
+    return special_folders
+
+special_folders = get_special_folders()
+
+home_path = special_folders['Personal']
+app_local_data_path = special_folders['Local AppData']
+app_global_data_path = special_folders['Common AppData']
+
+# use the non roaming app data
+xdg_data_home = os.environ.get('XDG_DATA_HOME',
+    os.path.join(app_local_data_path, 'xdg'))
+
+
+def get_data_dirs():
+    """Returns XDG data directories."""
+    return os.environ.get('XDG_DATA_DIRS',
+        '{0}{1}{2}'.format(app_local_data_path, os.pathsep,
+        app_global_data_path)).split(os.pathsep)
+
+xdg_data_dirs = get_data_dirs()
+
+# we will return the roaming data wich is as close as we get in windows
+# regarding caching.
+xdg_cache_home = os.environ.get('XDG_CACHE_HOME',
+    os.path.join(xdg_data_home, 'cache'))
+
+# point to the not roaming app data for the user
+xdg_config_home = os.environ.get('XDG_CONFIG_HOME',
+    app_local_data_path)
+
+
+def get_config_dirs():
+    """Return XDG config directories."""
+    return [xdg_config_home] + \
+        os.environ.get('XDG_CONFIG_DIRS',
+            app_global_data_path,
+            ).split(os.pathsep)
+
+xdg_config_dirs = get_config_dirs()
+
+xdg_data_dirs = filter(lambda x: x, xdg_data_dirs)
+xdg_config_dirs = filter(lambda x: x, xdg_config_dirs)
+
+
+def load_config_paths(*resource):
+    """Iterator of configuration paths.
+
+    Return an iterator which gives each directory named 'resource' in
+    the configuration search path. Information provided by earlier
+    directories should take precedence over later ones (ie, the user's
+    config dir comes first).
+    """
+    resource = os.path.join(*resource)
+    for config_dir in xdg_config_dirs:
+        path = os.path.join(config_dir, resource)
+        if os.path.exists(path):
+            yield path
+
+
+def save_config_path(*resource):
+    """Path to save configuration.
+
+    Ensure $XDG_CONFIG_HOME/<resource>/ exists, and return its path.
+    'resource' should normally be the name of your application. Use this
+    when SAVING configuration settings. Use the xdg_config_dirs variable
+    for loading.
+    """
+    resource = os.path.join(*resource)
+    assert not resource.startswith('/')
+    path = os.path.join(xdg_config_home, resource)
+    if not os.path.isdir(path):
+        os.makedirs(path, 0700)
+    return path