Support marking sessions with a TTL (fix #52)

Author: vmalloc

backslash/client.py

@@ -45,6 +45,7 @@ def report_session_start(self, logical_id=NOTHING,
                              keepalive_interval=NOTHING,
                              subjects=NOTHING,
                              infrastructure=NOTHING,
+                             ttl_seconds=NOTHING,
     ):
         """Reports a new session starting
 
@@ -59,6 +60,7 @@ def report_session_start(self, logical_id=NOTHING,
             'keepalive_interval': keepalive_interval,
             'subjects': subjects,
             'infrastructure': infrastructure,
+            'ttl_seconds': ttl_seconds,
         }
         if parent_logical_id is not None or is_parent_session:
             supports_parallel = (self.api.info().endpoints.report_session_start.version >= 2)

backslash/contrib/slash_plugin.py

@@ -111,6 +111,11 @@ def get_name(self):
 
     def get_config(self):
         return {
+            "session_ttl_days": 0 // Doc(
+                'Optional number of days after which this session will be discarded '
+                'from Backslash') // Cmdline(arg='--session-ttl-days', metavar='DAYS'),
+
+
             "session_labels": [] // Doc('Specify labels to be added to the session when reported') \
                                  // Cmdline(append="--session-label", metavar="LABEL"),
         }
@@ -181,7 +186,11 @@ def _get_initial_session_metadata(self):
         return returned
 
     def _get_extra_session_start_kwargs(self):
-        return {}
+        returned = {}
+        ttl_seconds = slash_config.root.plugin_config.backslash.session_ttl_days * 24 * 60 * 60
+        if ttl_seconds:
+            returned['ttl_seconds'] = ttl_seconds
+        return returned
 
     @slash.plugins.register_if(_HAS_TEST_AVOIDED)
     @handle_exceptions

docs/changelog.rst

@@ -1,6 +1,7 @@
 Changelog
 =========
 
+* :feature:`52` Support reporting sessions with a specific TTL, marking them for future deletion on the server
 * :feature:`51` Report local and remote SCM branches if supported
 * :release: `2.30.0 <8-8-2017>`
 * :feature:`50` Added session_webapp_url property to the Slash plugin