Merge lp:~nataliabidart/ubuntuone-client/send-status-changed-when-quitting into lp:ubuntuone-client

[Natalia Bidart]

Syncdaemon now sends a StatusChanged with a QUIT state when quitting (LP: #704599).

To test IRL, in this branch, run:

u1sdtool -q; PYTHONPATH=. ./bin/ubuntuone-syncdaemon

and then, from another terminal, run:

u1sdtool -q

You should get this in the log file:

2011-01-18 16:36:23,073 - ubuntuone.SyncDaemon.StateManager - DEBUG - ConnectionManager returned None
2011-01-18 16:36:23,073 - ubuntuone.SyncDaemon.EQ - DEBUG - push_event: SYS_QUIT, args:(), kw:{}
2011-01-18 16:36:23,074 - ubuntuone.SyncDaemon.StateManager - DEBUG - received event 'SYS_QUIT'
2011-01-18 16:36:23,074 - ubuntuone.SyncDaemon.StateManager - DEBUG - Transition LOCAL_RESCAN --[SYS_QUIT]--> QUIT (queues: WORKING; connection: Not User With Network)
2011-01-18 16:36:23,074 - ubuntuone.SyncDaemon.EQ - DEBUG - push_event: SYS_STATE_CHANGED, args:(), kw:{'state': QUIT (error=False connected=False online=False) Queue: WORKING Connection: Not User With Network}

[Guillermo Gonzalez (verterok)]

+1

As discussed on IRC, the name should be different. something a bit more state-like.

review: Approve

[lp:~nataliabidart/ubuntuone-client/send-status-changed-when-quitting]

810. By Natalia Bidart on 2011-01-18

Renaming QUIT state to SHUTDOWN.

811. By Natalia Bidart on 2011-01-18

Typo!

[Alejandro J. Cura (alecu)]

All tests pass and works as advertised.

review: Approve

=== modified file 'docs/states_manager.svg'
--- docs/states_manager.svg	2010-04-12 15:15:47 +0000
+++ docs/states_manager.svg	2011-01-18 20:44:49 +0000
@@ -13,7 +13,7 @@
    height="744.09448"
    id="svg2"
    sodipodi:version="0.32"
-   inkscape:version="0.47 r22583"
+   inkscape:version="0.48.0 r9654"
    version="1.0"
    sodipodi:docname="states_manager.svg"
    inkscape:output_extension="org.inkscape.output.svg.inkscape">
@@ -27,15 +27,15 @@
      objecttolerance="10"
      inkscape:pageopacity="0.0"
      inkscape:pageshadow="2"
-     inkscape:zoom="1.0427072"
-     inkscape:cx="495.3424"
-     inkscape:cy="229.5042"
+     inkscape:zoom="4.1708288"
+     inkscape:cx="161.41473"
+     inkscape:cy="87.320796"
      inkscape:document-units="px"
      inkscape:current-layer="layer1"
      showgrid="false"
-     inkscape:window-width="1410"
-     inkscape:window-height="875"
-     inkscape:window-x="0"
+     inkscape:window-width="1380"
+     inkscape:window-height="876"
+     inkscape:window-x="30"
      inkscape:window-y="0"
      inkscape:window-maximized="1"
      showguides="true"
@@ -5989,6 +5989,20 @@
        inkscape:vp_y="0 : 1000 : 0"
        inkscape:vp_x="0 : 0.5 : 1"
        sodipodi:type="inkscape:persp3d" />
+    <marker
+       inkscape:stockid="Arrow1Mend1u64"
+       orient="auto"
+       refY="0"
+       refX="0"
+       id="Arrow1Mend1u64-802"
+       style="overflow:visible">
+      <path
+         inkscape:connector-curvature="0"
+         id="path7114-81"
+         d="M 0,0 5,-5 -12.5,0 5,5 0,0 z"
+         style="fill:#796a69;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;marker-start:none"
+         transform="matrix(-0.4,0,0,-0.4,-4,0)" />
+    </marker>
   </defs>
   <metadata
      id="metadata7">
@@ -6007,6 +6021,24 @@
      id="layer1"
      style="display:inline">
     <path
+       style="opacity:0.80373798;color:#000000;fill:#ececec;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:0.25548708;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
+       d="m 163.37882,673.45664 14.44899,14.449 -13.9982,13.99821 99.42455,0 -14.44899,-14.449 13.9982,-13.99821 -99.42455,0 z"
+       id="rect8502-1-3-1-3-5-8"
+       sodipodi:nodetypes="ccccccc"
+       inkscape:connector-curvature="0" />
+    <text
+       id="text2429-9-7-7-2-2-4-3-9-2"
+       y="690.83258"
+       x="213.31433"
+       style="font-size:8.65986252px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:center;line-height:150%;writing-mode:lr-tb;text-anchor:middle;fill:#000000;fill-opacity:1;stroke:none;display:inline;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans"
+       xml:space="preserve"
+       sodipodi:linespacing="150%"><tspan
+         style="font-size:8.65986252px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:center;line-height:150%;writing-mode:lr-tb;text-anchor:middle;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans"
+         y="690.83258"
+         x="213.31433"
+         sodipodi:role="line"
+         id="tspan8676-1-9-7-6">SHUTDOWN</tspan></text>
+    <path
        style="color:#000000;fill:none;stroke:#000000;stroke-width:1.5;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0;marker:none;marker-start:url(#DotM);visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
        d="m 779.90701,324.28835 21.9219,4.98314"
        id="path9275-28-4"
@@ -7653,12 +7685,12 @@
        sodipodi:linespacing="125%"
        xml:space="preserve"
        style="font-size:12.8904295px;font-style:italic;font-weight:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;color:#000000;fill:#967b71;fill-opacity:1;stroke:none;stroke-width:2;marker:none;marker-end:url(#Arrow1Mend1u64);visibility:visible;display:inline;overflow:visible;enable-background:accumulate;font-family:Bitstream Vera Sans;-inkscape-font-specification:Sans"
-       x="748.91864"
+       x="708.91864"
        y="655.28705"
        id="text2467-1-5-4-7-3-64-9-9-6"><tspan
          sodipodi:role="line"
          id="tspan2469-4-3-8-9-0-4-4-7-4"
-         x="748.91864"
+         x="708.91864"
          y="655.28705"
          style="font-size:8.20300102px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;color:#000000;fill:#967b71;fill-opacity:1;stroke:none;stroke-width:2;marker:none;marker-end:url(#Arrow1Mend1u64);visibility:visible;display:inline;overflow:visible;enable-background:accumulate;font-family:Bitstream Vera Sans Mono;-inkscape-font-specification:Bitstream Vera Sans Mono">SYS_UNKNOWN_ERROR</tspan></text>
     <g
@@ -7703,12 +7735,12 @@
        sodipodi:linespacing="125%"
        xml:space="preserve"
        style="font-size:12.8904295px;font-style:italic;font-weight:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;color:#000000;fill:#967b71;fill-opacity:1;stroke:none;stroke-width:2;marker:none;marker-end:url(#Arrow1Mend1u64);visibility:visible;display:inline;overflow:visible;enable-background:accumulate;font-family:Bitstream Vera Sans;-inkscape-font-specification:Sans"
-       x="916.75098"
+       x="876.75098"
        y="655.28705"
        id="text2467-1-5-4-7-3-64-9-9-6-2"><tspan
          sodipodi:role="line"
          id="tspan2469-4-3-8-9-0-4-4-7-4-2"
-         x="916.75098"
+         x="876.75098"
          y="655.28705"
          style="font-size:8.20300102px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;color:#000000;fill:#967b71;fill-opacity:1;stroke:none;stroke-width:2;marker:none;marker-end:url(#Arrow1Mend1u64);visibility:visible;display:inline;overflow:visible;enable-background:accumulate;font-family:Bitstream Vera Sans Mono;-inkscape-font-specification:Bitstream Vera Sans Mono">SYS_ROOT_MISMATCH</tspan></text>
     <path
@@ -7821,5 +7853,44 @@
        id="path4627-2-8-04-1-5"
        style="opacity:0.65322583;color:#000000;fill:#00ff00;fill-opacity:1;stroke:none;stroke-width:3;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
        sodipodi:type="arc" />
+    <path
+       inkscape:connector-curvature="0"
+       style="color:#000000;fill:none;stroke:#967b71;stroke-width:1.51844954;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0;marker:none;marker-end:url(#Arrow1Mend1u64);visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
+       d="m 106.62966,642.72783 c 113.49645,-0.51905 104.84581,-0.36756 107.441,27.48751"
+       id="path8817-5-8-1-5-2-5-4"
+       sodipodi:nodetypes="cc" />
+    <text
+       sodipodi:linespacing="125%"
+       xml:space="preserve"
+       style="font-size:9.54122162px;font-style:italic;font-weight:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;display:inline;font-family:Bitstream Vera Sans;-inkscape-font-specification:Sans Italic"
+       x="106.23523"
+       y="639.35211"
+       id="text2461-6-0-31-6-2-3-8"><tspan
+         sodipodi:role="line"
+         x="106.23523"
+         y="639.35211"
+         id="tspan2463-3-4-2-8-1-8-7">From any node</tspan></text>
+    <path
+       transform="matrix(0.18533464,0,0,0.17050787,248.96653,596.37403)"
+       d="m -147.4098,407.55515 a 42.646858,47.282387 0 1 1 -85.29371,0 42.646858,47.282387 0 1 1 85.29371,0 z"
+       sodipodi:ry="47.282387"
+       sodipodi:rx="42.646858"
+       sodipodi:cy="407.55515"
+       sodipodi:cx="-190.05666"
+       id="path4627-2-8-0-8-1"
+       style="opacity:0.65322583;color:#000000;fill:#00ff00;fill-opacity:1;stroke:none;stroke-width:3;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
+       sodipodi:type="arc" />
+    <text
+       sodipodi:linespacing="125%"
+       xml:space="preserve"
+       style="font-size:12.72880554px;font-style:italic;font-weight:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;color:#000000;fill:#967b71;fill-opacity:1;stroke:none;stroke-width:2;marker:none;marker-end:url(#Arrow1Mend1u64);visibility:visible;display:inline;overflow:visible;enable-background:accumulate;font-family:Bitstream Vera Sans;-inkscape-font-specification:Sans"
+       x="146.72015"
+       y="655.46698"
+       id="text2467-1-5-4-7-3-64-9-9-6-9"><tspan
+         sodipodi:role="line"
+         id="tspan2469-4-3-8-9-0-4-4-7-4-4"
+         x="146.72015"
+         y="655.46698"
+         style="font-size:8.10014915px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;color:#000000;fill:#967b71;fill-opacity:1;stroke:none;stroke-width:2;marker:none;marker-end:url(#Arrow1Mend1u64);visibility:visible;display:inline;overflow:visible;enable-background:accumulate;font-family:Bitstream Vera Sans Mono;-inkscape-font-specification:Bitstream Vera Sans Mono">SYS_QUIT</tspan></text>
   </g>
 </svg>

=== modified file 'tests/syncdaemon/test_main.py'
--- tests/syncdaemon/test_main.py	2011-01-14 20:43:15 +0000
+++ tests/syncdaemon/test_main.py	2011-01-18 20:44:49 +0000
@@ -91,6 +91,17 @@
         self.assertTrue(self.restarted)
         main.shutdown()
 
+    def test_shutdown_pushes_sys_quit(self):
+        """When shutting down, the SYS_QUIT event is pushed."""
+        main = self.build_main()
+        events = []
+        self.patch(main.event_q, 'push',
+                   lambda *a, **kw: events.append((a, kw)))
+
+        main.shutdown()
+        expected = [(('SYS_USER_DISCONNECT',), {}), (('SYS_QUIT',), {})]
+        self.assertEqual(expected, events)
+
     def test_handshake_timeout(self):
         """Check connecting times out."""
         d0 = defer.Deferred()

=== modified file 'tests/syncdaemon/test_states.py'
--- tests/syncdaemon/test_states.py	2011-01-13 22:06:43 +0000
+++ tests/syncdaemon/test_states.py	2011-01-18 20:44:49 +0000
@@ -338,7 +338,6 @@
         self.assertTrue(new_node is None) # if working, it should return a node
 
 
-
 class TestConnectionManagerTimings(Base):
     """Times handled by ConnectionManager."""
 
@@ -594,7 +593,6 @@
         return defer.DeferredList(d)
 
 
-
 class TestStateManagerTimeoutTransitions(StateManagerTransitions):
     """Test StateManager when HandshakeTimeouts."""
 
@@ -628,6 +626,16 @@
                           'STANDOFF', True)
 
 
+class TestStateManagerShutdown(StateManagerTransitions):
+    """Test StateManager when shutting down."""
+
+    def test_shutdown(self):
+        """All nodes go to SHUTDOWN."""
+        d = []
+        for node in self.sm_allnodes:
+            d.append(self.check(node, 'SYS_QUIT', 'SHUTDOWN'))
+        return defer.DeferredList(d)
+
 
 class TestStateManagerErrors(StateManagerTransitions):
     """Test StateManager on error conditions."""
@@ -657,7 +665,6 @@
         return defer.DeferredList(d)
 
 
-
 class TestStateManagerEnterExit(Base):
     """Test StateManager on enter and exit transitions."""
 
@@ -1003,3 +1010,7 @@
         self.sm.state = StateManager.STANDOFF
         self.check_node("STANDOFF", error=False, conn=True, online=False)
 
+    def test_SHUTDOWN(self):
+        """SHUTDOWN internals."""
+        self.sm.state = StateManager.SHUTDOWN
+        self.check_node("SHUTDOWN", error=False, conn=False, online=False)

=== modified file 'ubuntuone/syncdaemon/event_queue.py'
--- ubuntuone/syncdaemon/event_queue.py	2011-01-13 21:32:21 +0000
+++ ubuntuone/syncdaemon/event_queue.py	2011-01-18 20:44:49 +0000
@@ -139,6 +139,7 @@
     'SYS_SERVER_ERROR': ('error',),
     'SYS_QUOTA_EXCEEDED': ('volume_id', 'free_bytes'),
     'SYS_BROKEN_NODE': ('volume_id', 'node_id', 'path', 'mdid'),
+    'SYS_QUIT': (),
 
     'FSM_FILE_CONFLICT': ('old_name', 'new_name'),
     'FSM_DIR_CONFLICT': ('old_name', 'new_name'),

=== modified file 'ubuntuone/syncdaemon/main.py'
--- ubuntuone/syncdaemon/main.py	2011-01-14 22:32:48 +0000
+++ ubuntuone/syncdaemon/main.py	2011-01-18 20:44:49 +0000
@@ -200,6 +200,7 @@
     def shutdown(self, with_restart=False):
         """Shutdown the daemon; optionally restart it."""
         self.event_q.push('SYS_USER_DISCONNECT')
+        self.event_q.push('SYS_QUIT')
         self.event_q.shutdown()
         self.hash_q.shutdown()
         self.db.shutdown()

=== modified file 'ubuntuone/syncdaemon/states.py'
--- ubuntuone/syncdaemon/states.py	2011-01-14 14:04:37 +0000
+++ ubuntuone/syncdaemon/states.py	2011-01-18 20:44:49 +0000
@@ -288,6 +288,7 @@
     'SYS_NET_DISCONNECTED',
     'SYS_PROTOCOL_VERSION_ERROR',
     'SYS_PROTOCOL_VERSION_OK',
+    'SYS_QUIT',
     'SYS_ROOT_MISMATCH',
     'SYS_SERVER_RESCAN_DONE',
     'SYS_SERVER_ERROR',
@@ -329,6 +330,8 @@
                          "different", error=True)
     UNKNOWN_ERROR = Node('UNKNOWN_ERROR', "something went wrong", error=True)
 
+    SHUTDOWN = Node('SHUTDOWN', "shutting down the service")
+
     def __init__(self, main, handshake_timeout=None):
         self.main = main
         self.aq = main.action_q
@@ -381,6 +384,11 @@
             return
         self.log.debug("received event %r", event)
 
+        # quit
+        if event == 'SYS_QUIT':
+            self._transition(event, StateManager.SHUTDOWN)
+            return
+
         # error management
         if event == 'SYS_UNKNOWN_ERROR':
             self._transition(event, StateManager.UNKNOWN_ERROR)