Merge ~pieq/bugit/+git/qabro:lp1892198-new-checkbox-session-dir into bugit:master

[Pierre Equoy]

qabro will now search for Checkbox sessions in /var/tmp/checkbox-ng/sessions (in addition to previous directories for retro-compatibility).

How to test
===========

Build a snap and install it:

$ snapcraft
(...)
$ sudo snap install qabro_0.14dev_amd64.snap --devmode

Make sure you have some sessions in /var/tmp/checkbox-ng/sessions:

$ ls /var/tmp/checkbox-ng/sessions
session_title-2020-09-17T07.53.45.session throwaway-2020-09-17T07.53.49.session

Launch qabro on staging LP and file a bug:

$ APPORT_LAUNCHPAD_INSTANCE=staging qabro

→ The created issue should have a checkbox-session.tgz attachment containing the latest session available on your testing device.

[Maciej Kisielewski (kissiel)]

Looks good! +1

review: Approve

diff --git a/CHANGELOG.md b/CHANGELOG.md
index eefb675..b476e42 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,9 +8,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Added
 - Unit tests (see Contributing Guidelines for more info)
 
+### Changed
+- Look for Checkbox sessions in `/var/tmp/checkbox-ng/sessions` to comply with the new session path in place in checkbox-ng ([LP #1892198](https://bugs.launchpad.net/qabro/+bug/1892198)).
+
 ### Fixed
 ([LP #1891609](https://bugs.launchpad.net/qabro/+bug/1887903))
-- `JSONDecodeError` when launching qabro on some installations ([LP #1891609](https://bugs.launchpad.net/qabro/+bug/1887903))
+- `JSONDecodeError` when launching qabro on some installations ([LP #1887903](https://bugs.launchpad.net/qabro/+bug/1887903))
 - Cannot upload attachments: 'title' error is shown ([LP #1891609](https://bugs.launchpad.net/qabro/+bug/1891609))
 
 
diff --git a/qabro/bug_assistant.py b/qabro/bug_assistant.py
index 6a720b0..f8630e4 100644
--- a/qabro/bug_assistant.py
+++ b/qabro/bug_assistant.py
@@ -267,20 +267,22 @@ class AttachmentAssistant:
                               snap.props.confinement.value_nick)
         self.attachments["snap_list.log"] = out.encode()
 
-    def _get_last_checkbox_session_path(self, usr_dir="/home/$USER", root_dir="/root"):
+    def _get_last_checkbox_session_path(self, usr_home="/home/$USER", root_home="/root", root_dir="/"):
         """Return path of the most recent Checkbox session directory."""
         rootpath = ''
         latest_session_dir = ''
-        # Determine if we use a classic install or a snap install
-        classic_path = os.path.expandvars(os.path.join(usr_dir, ".cache/plainbox/sessions"))
-        if os.path.exists(classic_path):
+        generic_path = os.path.join(root_dir, "var/tmp/checkbox-ng/sessions")
+        classic_path = os.path.expandvars(os.path.join(usr_home, ".cache/plainbox/sessions"))
+        if os.path.exists(generic_path): # for any checkbox installs based on checkbox-ng >= 1.10
+            rootpath = generic_path
+        elif os.path.exists(classic_path): # for classic checkbox installs based on checkbox-ng <= 1.9
             rootpath = classic_path
-        else:
+        else: # for snap checkbox installs based on checkbox-ng <= 1.9
             snaps = qabro.utils.get_snaps()
             snap_list = [e.props.name for e in snaps if 'checkbox-' in e.props.name]
             for snap_name in snap_list:
-                sp = [os.path.join(usr_dir, "snap/{}/current/.cache/plainbox/sessions"),
-                      os.path.join(root_dir, "snap/{}/current/.cache/plainbox/sessions")]
+                sp = [os.path.join(usr_home, "snap/{}/current/.cache/plainbox/sessions"),
+                      os.path.join(root_home, "snap/{}/current/.cache/plainbox/sessions")]
                 for p in sp:
                     snap_path = os.path.expandvars(p.format(snap_name))
                     if os.path.exists(snap_path):
diff --git a/tests/test_bug_assistant.py b/tests/test_bug_assistant.py
index 752db7d..7a6fe07 100644
--- a/tests/test_bug_assistant.py
+++ b/tests/test_bug_assistant.py
@@ -23,6 +23,23 @@ def get_snaps(session_mocker):
     session_mocker.patch("qabro.utils.get_snaps", return_value=[test_snap, ])
 
 
+def test_get_last_checkbox_session_path_generic(get_snaps, tmp_path):
+    session_dir = "var/tmp/checkbox-ng/sessions"
+    for session in ["session1", "session2", "last_session"]:
+        s = tmp_path / session_dir / session
+        s.mkdir(parents=True)
+    last_session_path = tmp_path / session_dir / "last_session"
+    # Add 1 second to last session directory access/modify time to make sure
+    # it will be seen as the most recent session directory
+    last_session_time = os.stat(last_session_path).st_mtime + 1
+    os.utime(last_session_path, times=(last_session_time, last_session_time))
+    aa = AttachmentAssistant()
+    last_session = aa._get_last_checkbox_session_path(usr_home="/nothing/here",
+                                                      root_home="/nothing/here",
+                                                      root_dir=tmp_path)
+    assert last_session.endswith("last_session")
+
+
 @pytest.mark.parametrize("usr_dir",
                          [".cache/plainbox/sessions",
                           "snap/checkbox-snappy/current/.cache/plainbox/sessions"])
@@ -36,7 +53,8 @@ def test_get_last_checkbox_session_path_ubuntu_classic(get_snaps, tmp_path, usr_
     last_session_time = os.stat(last_session_path).st_mtime + 1
     os.utime(last_session_path, times=(last_session_time, last_session_time))
     aa = AttachmentAssistant()
-    last_session = aa._get_last_checkbox_session_path(usr_dir=tmp_path, root_dir="/nothing/here")
+    last_session = aa._get_last_checkbox_session_path(usr_home=tmp_path,
+                                                      root_home="/nothing/here")
     assert last_session.endswith("last_session")
 
 
@@ -51,13 +69,15 @@ def test_get_last_checkbox_session_path_ubuntu_core(get_snaps, tmp_path):
     last_session_time = os.stat(last_session_path).st_mtime + 1
     os.utime(last_session_path, times=(last_session_time, last_session_time))
     aa = AttachmentAssistant()
-    last_session = aa._get_last_checkbox_session_path(usr_dir="/nothing/here", root_dir=tmp_path)
+    last_session = aa._get_last_checkbox_session_path(usr_home="/nothing/here",
+                                                      root_home=tmp_path)
     assert last_session.endswith("last_session")
 
 
 def test_get_last_checkbox_session_path_no_session(get_snaps, tmp_path):
     aa = AttachmentAssistant()
-    last_session = aa._get_last_checkbox_session_path(usr_dir="/nothing/here", root_dir="/nothing/there")
+    last_session = aa._get_last_checkbox_session_path(usr_home="/nothing/here",
+                                                      root_home="/nothing/there")
     assert last_session == ""