Merge lp:~mikemc/ubuntuone-client/skip-test-wait-no-more-events-blame-pb into lp:ubuntuone-client

[Mike McCracken]

- Remove unused and potentially incorrect wait_no_more_events.

- Remove unused and potentially incorrect wait_no_more_events.

On windows and darwin, twisted PB's connect_signal is async, so
wait_no_more_events, which depends on connecting a handler to the
'Event' signal, will not be connected until after the
event_q.push('FILE_CREATE') call has already executed, which means
that we won't see that event.

Because wait_no_more_events internally waits for the signal to show,
it may not work as expected. Here's an incorrect sequence that happens every time in test_wait_no_more_events on darwin:

t:
0.00: call wait_no_more_events(last_event_interval=.1)
0.0?: it calls connect_signal, but doesn't wait for it to complete.
0.0?: it finishes, and registers check_last_event with the reactor to be called at 0.10.

0.0?: an event shows up sometime before the signal is connected.

0.10: check_last_event is called, and incorrectly returns True because the event
handler was not connected yet, so it saw no events.

0.1?: the event signal is potentially disconnected before it was
finished being connected (or not, it was still wrong)

So, because it's impossible to test on 2/3 of the platforms, and
doesn't appear to be used anywhere, I've removed wait_no_more_events.

[dobey (dobey)]

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

The attempt to merge lp:~mikemc/ubuntuone-client/skip-test-wait-no-more-events-blame-pb into lp:ubuntuone-client failed. Below is the output from the failed tests.

/usr/bin/gnome-autogen.sh
checking for autoconf >= 2.53...
  testing autoconf2.50... not found.
  testing autoconf... found 2.69
checking for automake >= 1.10...
  testing automake-1.12... not found.
  testing automake-1.11... found 1.11.6
checking for libtool >= 1.5...
  testing libtoolize... found 2.4.2
checking for intltool >= 0.30...
  testing intltoolize... found 0.50.2
checking for pkg-config >= 0.14.0...
  testing pkg-config... found 0.26
checking for gtk-doc >= 1.0...
  testing gtkdocize... found 1.18
Checking for required M4 macros...
Checking for forbidden M4 macros...
Processing ./configure.ac
Running libtoolize...
libtoolize: putting auxiliary files in `.'.
libtoolize: copying file `./ltmain.sh'
libtoolize: putting macros in AC_CONFIG_MACRO_DIR, `m4'.
libtoolize: copying file `m4/libtool.m4'
libtoolize: copying file `m4/ltoptions.m4'
libtoolize: copying file `m4/ltsugar.m4'
libtoolize: copying file `m4/ltversion.m4'
libtoolize: copying file `m4/lt~obsolete.m4'
Running intltoolize...
Running gtkdocize...
Running aclocal-1.11...
Running autoconf...
Running autoheader...
Running automake-1.11...
Running ./configure --enable-gtk-doc --enable-debug ...
checking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes
checking for a thread-safe mkdir -p... /bin/mkdir -p
checking for gawk... no
checking for mawk... mawk
checking whether make sets $(MAKE)... yes
checking how to create a ustar tar archive... gnutar
checking whether make supports nested variables... yes
checking for style of include used by make... GNU
checking for gcc... gcc
checking whether the C compiler works... yes
checking for C compiler default output file name... a.out
checking for suffix of executables...
checking whether we are cross compiling... no
checking for suffix of object files... o
checking whether we are using the GNU C compiler... yes
checking whether gcc accepts -g... yes
checking for gcc option to accept ISO C89... none needed
checking dependency style of gcc... gcc3
checking for library containing strerror... none required
checking for gcc... (cached) gcc
checking whether we are using the GNU C compiler... (cached) yes
checking whether gcc accepts -g... (cached) yes
checking for gcc option to accept ISO C89... (cached) none needed
checking dependency style of gcc... (cached) gcc3
checking build system type... x86_64-unknown-linux-gnu
checking host system type... x86_64-unknown-linux-gnu
checking how to print strings... printf
checking for a sed that does not truncate output... /bin/sed
checking for grep that handles long lines and -e... /bin/grep
checking for egrep... /bin/grep -E
checking for fgrep... /bin/grep -F
checking for ld used by gcc... /usr/bin/ld
checking if the linker (/usr/bin/ld) is GNU ld... yes
checking for BSD- or MS-compatible name lister (nm)... /usr/bin/nm -B
checking the name lister (/usr/bin/nm -B) interface... BSD nm
checking whether ln -s works... yes
checking the maximum length of command line arguments... 1572864
check...

[lp:~mikemc/ubuntuone-client/skip-test-wait-no-more-events-blame-pb]

1378. By Mike McCracken on 2013-01-12

remove unused import time

=== modified file 'tests/platform/test_tools.py'
--- tests/platform/test_tools.py	2013-01-08 00:05:58 +0000
+++ tests/platform/test_tools.py	2013-01-12 00:30:31 +0000
@@ -124,22 +124,6 @@
         result = yield self.tool.wait_connected()
         self.assertEqual(True, result)
 
-    def test_wait_no_more_events(self):
-        """Test wait_no_more_events."""
-        d = self.tool.wait_no_more_events(last_event_interval=.1)
-
-        self.event_q.push("FS_FILE_CREATE", path="somepath")
-
-        def check(result):
-            """Check result."""
-            self.assertTrue(self.handler.check_debug("new event",
-                                                     "FS_FILE_CREATE"))
-            self.assertTrue(self.handler.check_debug("No more events"))
-            self.assertEqual(True, result)
-
-        d.addBoth(check)
-        return d
-
     def test_all_downloads(self):
         """ test wait_all_downloads """
         d = self.tool.wait_all_downloads()

=== modified file 'ubuntuone/platform/tools/__init__.py'
--- ubuntuone/platform/tools/__init__.py	2012-10-22 13:31:02 +0000
+++ ubuntuone/platform/tools/__init__.py	2013-01-12 00:30:31 +0000
@@ -30,7 +30,6 @@
 
 import logging
 import sys
-import time
 import warnings
 
 from twisted.internet import defer
@@ -162,62 +161,6 @@
         return d
 
     @log_call(logger.debug)
-    def wait_no_more_events(self, last_event_interval, verbose=False):
-        """Wait until no more events are fired by the syncdaemon."""
-        from twisted.internet import reactor
-        d = defer.Deferred()
-
-        def check_last_event():
-            """Check time!
-
-            Check if the daemon is connected and didn't received any events
-            in the last_event_interval.
-
-            """
-            current_time = time.time()
-            if self.last_event and \
-               current_time - self.last_event < last_event_interval:
-                # keep it running in case this is the last event
-                self.log.debug('rescheduling wait_no_more_events')
-                if not self.delayed_call.active():
-                    self.delayed_call = reactor.callLater(last_event_interval,
-                                                          check_last_event)
-                else:
-                    self.delayed_call.reset(last_event_interval)
-            else:
-                self.log.debug('wait_no_more_events: No more events!')
-                d.callback(True)
-
-        if verbose:
-            sys.stdout.write("Listening events")
-            sys.stdout.flush()
-
-        def event_handler(event_dict):
-            """Update last_event and run checks."""
-            self.last_event = time.time()
-            self.log.debug('wait_no_more_events - new event: %s - %s',
-                           event_dict['event_name'], str(self.last_event))
-            if verbose:
-                sys.stdout.write('.')
-                sys.stdout.flush()
-            if self.delayed_call.active():
-                self.delayed_call.reset(last_event_interval)
-
-        match = self.connect_signal(signal_name='Event', handler=event_handler)
-
-        def cleanup(result):
-            """Remove the signal handler."""
-            self.disconnect_signal(signal_name='Event', handler_or_match=match)
-            return result
-
-        d.addBoth(cleanup)
-
-        # in case the daemon already reached nirvana
-        self.delayed_call = reactor.callLater(last_event_interval,
-                                              check_last_event)
-        return d
-
-    @log_call(logger.debug)
     def wait_for_nirvana(self, last_event_interval=5, verbose=False):
         """Wait until the syncdaemon reachs nirvana.