tests: magic mitogen_shutdown_all action

LRU tests break when run as part of the whole suite rather than
individually, because LRU stuff is already happening for earlier tests.

ansible_mitogen/services.py

@@ -92,7 +92,7 @@ class ContextService(mitogen.service.Service):
         #: List of contexts in creation order by via= parameter. When
         #: :attr:`max_interpreters` is reached, the most recently used context
         #: is destroyed to make room for any additional context.
-        self._update_lru_by_via = {}
+        self._lru_by_via = {}
         #: :meth:`key_from_kwargs` result by Context.
         self._key_by_context = {}
 
@@ -106,7 +106,10 @@ class ContextService(mitogen.service.Service):
         count reaches zero.
         """
         LOG.debug('%r.put(%r)', self, context)
-        assert self._refs_by_context[context] > 0
+        if self._refs_by_context.get(context, 0) == 0:
+            LOG.warning('%r.put(%r): refcount was 0. shutdown_all called?',
+                        self, context)
+            return
         self._refs_by_context[context] -= 1
 
     def key_from_kwargs(self, **kwargs):
@@ -139,6 +142,28 @@ class ContextService(mitogen.service.Service):
             self._lock.release()
         return count
 
+    def _shutdown(self, context, lru=None, new_context=None):
+        """
+        Arrange for `context` to be shut down, and optionally add `new_context`
+        to the LRU list while holding the lock.
+        """
+        LOG.info('%r._shutdown(): shutting down %r', self, context)
+        context.shutdown()
+
+        key = self._key_by_context[context]
+
+        self._lock.acquire()
+        try:
+            del self._response_by_key[key]
+            del self._refs_by_context[context]
+            del self._key_by_context[context]
+            if lru:
+                lru.remove(context)
+            if new_context:
+                lru.append(new_context)
+        finally:
+            self._lock.release()
+
     def _update_lru(self, new_context, **kwargs):
         """
         Update the LRU ("MRU"?) list associated with the connection described
@@ -150,7 +175,7 @@ class ContextService(mitogen.service.Service):
             # We don't have a limit on the number of directly connections.
             return
 
-        lru = self._update_lru_by_via.setdefault(via, [])
+        lru = self._lru_by_via.setdefault(via, [])
         if len(lru) < self.max_interpreters:
             lru.append(new_context)
             return
@@ -163,20 +188,16 @@ class ContextService(mitogen.service.Service):
                         'but they are all marked as in-use.', via)
             return
 
-        LOG.info('%r._discard_one(): shutting down %r', self, context)
+        self._shutdown(context, lru=lru, new_context=new_context)
-        context.shutdown()
-
-        key = self._key_by_context[context]
 
-        self._lock.acquire()
+    @mitogen.service.expose(mitogen.service.AllowParents())
-        try:
+    def shutdown_all(self):
-            del self._response_by_key[key]
+        """
-            del self._refs_by_context[context]
+        For testing use, arrange for all connections to be shut down.
-            del self._key_by_context[context]
+        """
-            lru.remove(context)
+        for context in list(self._key_by_context):
-            lru.append(new_context)
+            self._shutdown(context)
-        finally:
+        self._lru_by_via = {}
-            self._lock.release()
 
     def _connect(self, key, method_name, **kwargs):
         """

tests/ansible/integration/become/sudo_password.yml

@@ -7,7 +7,7 @@
       assert:
         that: true
 
-    - name: Ensure password sudo absent.
+    - name: Ensure sudo password absent but required.
       shell: whoami
       become: true
       become_user: mitogen__pw_required

tests/ansible/integration/context_service/lru_one_target.yml

@@ -11,6 +11,9 @@
       assert:
         that: true
 
+    - name: Reset all connections
+      mitogen_shutdown_all:
+
     - name: Spin up a bunch of interpreters
       custom_python_detect_environment:
       become: true

tests/ansible/lib/action/mitogen_shutdown_all.py

@@ -0,0 +1,27 @@
+"""
+Arrange for all ContextService connections to be torn down unconditionally,
+required for reliable LRU tests.
+"""
+
+import traceback
+import sys
+
+import ansible_mitogen.services
+import mitogen.service
+
+from ansible.plugins.strategy import StrategyBase
+from ansible.plugins.action import ActionBase
+
+
+class ActionModule(ActionBase):
+    def run(self, tmp=None, task_vars=None):
+        self._connection._connect()
+        return {
+            'changed': True,
+            'result': mitogen.service.call(
+                context=self._connection.parent,
+                handle=ansible_mitogen.services.ContextService.handle,
+                method='shutdown_all',
+                kwargs={}
+            )
+        }