Merge lp:~mikemc/ubuntuone-control-panel/fix-1024623-install-confs into lp:ubuntuone-control-panel

[Mike McCracken]

- Add darwin-only function to perform first-run "install" steps (LP: #1024623)

- Add darwin-only function to perform first-run "install" steps (LP: #1024623)

Function is set to no_op in utils.__init__ for linux and windows.

This function does first-run install stuff, but it just copies the default conf files to the right place if they're not there, which is better than using the presence or absence of just one file/directory to signal "first-run".

Also, excludes "test_darwin.py" on windows. This is the first branch to add a test_darwin.py.

Tested on all three platforms.

[Roberto Alsina (ralsina)]

review: Approve

[Alejandro J. Cura (alecu)]

The code looks good. I was unable to run the tests though, because something on my dev environment is broken.

review: Approve

=== modified file 'run-tests.bat'
--- run-tests.bat	2012-04-20 14:45:56 +0000
+++ run-tests.bat	2012-08-06 17:51:56 +0000
@@ -19,7 +19,7 @@
 SET MODULE="ubuntuone"
 SET PYTHONEXEPATH=""
 SET IGNORE_PATHS="ubuntuone\controlpanel\dbustests"
-SET IGNORE_MODULES="test_linux.py, test_libsoup.py"
+SET IGNORE_MODULES="test_linux.py, test_libsoup.py, test_darwin.py"
 SET PYTHONPATH=%PYTHONPATH%;..\ubuntu-sso-client;..\ubuntuone-client;.
 
 ECHO Checking for Python on the path

=== modified file 'ubuntuone/controlpanel/gui/qt/main/__init__.py'
--- ubuntuone/controlpanel/gui/qt/main/__init__.py	2012-08-01 19:14:35 +0000
+++ ubuntuone/controlpanel/gui/qt/main/__init__.py	2012-08-06 17:51:56 +0000
@@ -38,6 +38,8 @@
     source = dbus_main
 # pylint: enable=C0103
 
+from ubuntuone.controlpanel.utils import install_config_and_daemons
+
 
 def parser_options():
     """Parse command line parameters."""
@@ -119,6 +121,8 @@
         data.append(unicode(qss.data()))
     app.setStyleSheet('\n'.join(data))
 
+    install_config_and_daemons()
+
     # Unused variable 'window', 'icon', pylint: disable=W0612
     icon, window = start(lambda: source.main_quit(app),
                          minimized=minimized, with_icon=with_icon,

=== modified file 'ubuntuone/controlpanel/gui/qt/main/tests/test_main.py'
--- ubuntuone/controlpanel/gui/qt/main/tests/test_main.py	2012-08-01 20:18:52 +0000
+++ ubuntuone/controlpanel/gui/qt/main/tests/test_main.py	2012-08-06 17:51:56 +0000
@@ -260,3 +260,11 @@
         self.patch(sys, 'platform', 'not-darwin')
         main.main([sys.argv[0]], install_reactor_darwin=False)
         self.assertEqual(self.qt4reactor_installed, False)
+
+    def test_install_config(self):
+        """Test that install_config_and_daemons is called."""
+        self.patch(main, 'install_config_and_daemons',
+                   self._set_called)
+
+        main.main([sys.argv[0]], install_reactor_darwin=False)
+        self.assertEqual(self._called, ((), {}))

=== modified file 'ubuntuone/controlpanel/utils/__init__.py'
--- ubuntuone/controlpanel/utils/__init__.py	2012-04-05 14:52:55 +0000
+++ ubuntuone/controlpanel/utils/__init__.py	2012-08-06 17:51:56 +0000
@@ -40,13 +40,23 @@
     add_to_autostart = windows.add_to_autostart
     are_updates_present = windows.are_updates_present
     default_folders = windows.default_folders
+    install_config_and_daemons = no_op
     perform_update = windows.perform_update
     uninstall_application = windows.uninstall_application
+elif sys.platform == 'darwin':
+    from ubuntuone.controlpanel.utils import darwin
+    add_to_autostart = no_op
+    are_updates_present = no_op
+    default_folders = darwin.default_folders
+    install_config_and_daemons = darwin.install_config_and_daemons
+    perform_update = no_op
+    uninstall_application = no_op
 else:
     from ubuntuone.controlpanel.utils import linux
     add_to_autostart = no_op
     are_updates_present = no_op
     default_folders = linux.default_folders
+    install_config_and_daemons = no_op
     perform_update = no_op
     uninstall_application = no_op
 

=== added file 'ubuntuone/controlpanel/utils/darwin.py'
--- ubuntuone/controlpanel/utils/darwin.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/controlpanel/utils/darwin.py	2012-08-06 17:51:56 +0000
@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2012 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/>.
+
+"""Miscelaneous functions and constants for darwin."""
+
+import os
+import shutil
+import sys
+
+from twisted.internet import defer
+
+from dirspec.basedir import save_config_path
+from ubuntuone.controlpanel.logger import setup_logging
+
+logger = setup_logging('utils.darwin')
+AUTOUPDATE_BIN_NAME = 'autoupdate-darwin'
+UNINSTALL_BIN_NAME = 'uninstall-darwin'
+
+
+def add_to_autostart():
+    """Add syncdaemon to the session's autostart."""
+    # TODO
+
+
[e-mail]
+def are_updates_present():
+    """Return if there are updates for Ubuntu One."""
+    result = False
+    # TODO
+    defer.returnValue(result)
+
+
+def default_folders(user_home=None):
+    """Return a list of the folders to add by default."""
+    folders = []
+    # TODO
+    return folders
+
+
+def install_config_and_daemons():
+    """Install required data files and fsevents daemon.
+
+    This function is a replacement for an installer. As such it is
+    required on first-run, but it's also called every time we start
+    up, in case anything has moved or been deleted.
+    """
+
+    # Do nothing if we are running from source:
+    if getattr(sys, 'frozen', None) is None:
+        return
+
+    main_app_dir = ''.join(__file__.partition('.app')[:-1])
+    main_app_resources_dir = os.path.join(main_app_dir,
+                                          'Contents',
+                                          'Resources')
+
+    config_path = save_config_path('ubuntuone')
+
+    conf_filenames = ['syncdaemon.conf',
+                      'logging.conf']
+    for conf_filename in conf_filenames:
+        src_path = os.path.join(main_app_resources_dir,
+                                conf_filename)
+        dest_path = os.path.join(config_path,
+                                 conf_filename)
+
+        if not os.path.exists(dest_path):
+            shutil.copyfile(src_path, dest_path)
+
+
+def perform_update():
+    """Spawn the autoupdate process and call the stop function."""
+    # TODO
+
+
+def uninstall_application():
+    """Uninstall Ubuntu One."""
+    # TODO

=== added file 'ubuntuone/controlpanel/utils/tests/test_darwin.py'
--- ubuntuone/controlpanel/utils/tests/test_darwin.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/controlpanel/utils/tests/test_darwin.py	2012-08-06 17:51:56 +0000
@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2012 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/>.
+
+"""Test the darwin utils functions."""
+
+import os
+import sys
+
+from twisted.internet import defer
+
+from ubuntuone.controlpanel import utils
+from ubuntuone.devtools.testcases import TestCase
+
+# let me use protected methods
+# pylint: disable=W0212
+
+
+class InstallConfigTestCase(TestCase):
+    """Test install_config_and_daemons."""
+
+    @defer.inlineCallbacks
+    def setUp(self):
+        """Set up multi-call checker."""
+        yield super(InstallConfigTestCase, self).setUp()
+        self._called = []
+
+    def _set_called(self, *args, **kwargs):
+        """Store 'args' and 'kwargs for test assertions."""
+        self._called.append((args, kwargs))
+
+    def test_do_nothing_unfrozen(self):
+        """Test that install_config_and_daemons does nothing when unfrozen."""
+
+        self.patch(utils.darwin, 'save_config_path',
+                   self._set_called)
+        utils.install_config_and_daemons()
+        self.assertEqual(self._called, [])
+
+    def _test_copying_conf_files(self, exists):
+        """Call install_config_and_daemons, parameterize os.path.exists."""
+        sys.frozen = 'macosx_app'
+        self.addCleanup(delattr, sys, 'frozen')
+        self.patch(utils.darwin, 'save_config_path', lambda x: "TARGET_PATH")
+        self.patch(utils.darwin, '__file__', "/path/to/Main.app/ignore")
+        self.patch(os.path, "exists", lambda x: exists)
+        self.patch(utils.darwin.shutil, 'copyfile',
+                   self._set_called)
+        utils.install_config_and_daemons()
+
+    def test_copies_conf_files(self):
+        """When frozen, we copy the conf files if they don't exist."""
+        self._test_copying_conf_files(False)
+        self.assertEqual(self._called,
+                         [(('/path/to/Main.app/Contents/'
+                           'Resources/syncdaemon.conf',
+                           'TARGET_PATH/syncdaemon.conf'), {}),
+                          (('/path/to/Main.app/Contents/'
+                            'Resources/logging.conf',
+                            'TARGET_PATH/logging.conf'),
+                           {})])
+
+    def test_does_not_copy_conf_files(self):
+        """When frozen, we do not copy the conf files if they do exist."""
+        self._test_copying_conf_files(True)
+        self.assertEqual(self._called, [])

=== modified file 'ubuntuone/controlpanel/utils/tests/test_utils.py'
--- ubuntuone/controlpanel/utils/tests/test_utils.py	2011-11-14 11:33:31 +0000
+++ ubuntuone/controlpanel/utils/tests/test_utils.py	2012-08-06 17:51:56 +0000
@@ -24,6 +24,7 @@
 from twisted.internet import defer
 
 from ubuntuone.devtools.handlers import MementoHandler
+from ubuntuone.devtools.testcases import skipIfOS
 
 from ubuntuone.controlpanel import utils
 from ubuntuone.controlpanel.tests import TestCase
@@ -149,3 +150,13 @@
                     utils.ERROR_MESSAGE: unicode(exc)}
 
         self.assertEqual(expected, result)
+
+
+class FirstRunInstallTestCase(TestCase):
+    """Test cases for darwin-only first-run installations."""
+
+    @skipIfOS("darwin", "Darwin-only code is tested in test_darwin.")
+    def test_no_op_on_win_or_linux(self):
+        """Test that install_config_and_daemons does nothing on win/linux."""
+        self.assertEqual(utils.install_config_and_daemons,
+                         utils.no_op)