Clean up NixOSContext setup

Author: Thesola10

tests/features/environment.py

@@ -1,8 +1,42 @@
-from steps.common import NixOSNamespace
+from types import SimpleNamespace
+from pathlib import Path
+
+class NixOSNamespace(SimpleNamespace):
+    ''' Derived version of SimpleNamespace, helps unpack our NixOS test objects
+    and add utility functions for commonly used test steps.
+    '''
+
+    def __init__(self, context):
+        self.__dict__.update(**context.config.userdata)
+        self._base_dir = Path(context.config.base_dir).parent.resolve()
+
+    def _gjs_cmdline(self, code):
+        SHELL_DBUS = "org.gnome.Shell"
+        SHELL_OBJECT = "/org/gnome/Shell"
+        EVAL_DBUS = "org.gnome.Shell.Eval"
+        code_full = f''' paperwm = Main.extensionManager.lookup("paperwm@paperwm.github.com").stateObj; {code} '''
+        esc_code = code_full.replace('"', '\\"').replace('`', '\\`')
+        return f"sudo -u user gdbus call -a unix:path=/run/user/1000/bus -d {SHELL_DBUS} --object-path {SHELL_OBJECT} --method {EVAL_DBUS} \"{esc_code}\""
+
+    def libinput_play(self, recording):
+        ''' Play the specified libinput recording file.
+        '''
+        recordFile = self._base_dir / "recordings" / recording
+        self.machine.succeed("libinput replay --once --replay-after 0 %s" %recordFile)
+
+    def gjs_eval(self, code):
+        ''' Execute the specified GJS code from within the GNOME Shell process.
+        '''
+        return self.machine.succeed(self._gjs_cmdline(code))
+
+    def wait_for_paperwm(self):
+        ''' Wait until GNOME Shell is able to yield PaperWM internal state.
+        '''
+        return self.machine.wait_until_succeeds(self._gjs_cmdline('paperwm.findModule("tiling").spaces._initDone'))
 
 def before_all(context):
     ''' Wait until PaperWM is actually running
     '''
     print("Waiting for PaperWM...")
-    nixos = NixOSNamespace(context)
-    nixos.wait_for_paperwm()
+    context.nixos = NixOSNamespace(context)
+    context.nixos.wait_for_paperwm()

tests/features/steps/basic.py

@@ -1,12 +1,10 @@
 from behave import given, when, then
-from common import NixOSNamespace
 
 @when("the machine starts")
 def machine_boot(context):
-    nixos = NixOSNamespace(context)
+    pass
     # no-op: our test template starts the machine already
 
 @then("the machine should reach graphics")
 def graphical_target(context):
-    nixos = NixOSNamespace(context)
-    nixos.machine.wait_for_unit("graphical.target")
+    context.nixos.machine.wait_for_unit("graphical.target")

tests/features/steps/common.py

@@ -1,7 +1,5 @@
 from behave import given, when, then
-from common import NixOSNamespace
 
 @when("the user performs {gesture}")
 def play_gesture(context, gesture):
-    nixos = NixOSNamespace(context)
-    nixos.libinput_play(gesture + ".yaml")
+    context.nixos.libinput_play(gesture + ".yaml")