tests: Port InjectionManager test to jasmine

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/3164>

tests/meson.build

@@ -21,6 +21,7 @@ unit_testenv.append('GI_TYPELIB_PATH', st_typelib_path, separator: ':')
 
 unit_tests = [
     'highlighter',
+    'injectionManager',
 ]
 
 foreach test : unit_tests
@@ -39,7 +40,6 @@ foreach test : unit_tests
 endforeach
 
 legacy_tests = [
-    'injectionManager',
     'insertSorted',
     'jsParse',
     'markup',

tests/unit/injectionManager.js

@@ -1,16 +1,16 @@
-const JsUnit = imports.jsUnit;
-
 import GObject from 'gi://GObject';
 
 import 'resource:///org/gnome/shell/ui/environment.js';
 
 import {InjectionManager} from 'resource:///org/gnome/shell/extensions/extension.js';
 
+const FIXED_NUMBER = 42;
+
 class Object1 {
     count = 0;
 
     getNumber() {
-        return 42;
+        return FIXED_NUMBER;
     }
 
     getCount() {
@@ -29,89 +29,133 @@ class GObject1 extends GObject.Object {
     static {
         GObject.registerClass(this);
     }
-
-    plonk() {
-        this.set_property('plonked', true);
-    }
 }
 
-/**
- * @param {object} object to modify
- */
-function addInjections(object) {
-    // extend original method
-    injectionManager.overrideMethod(
-        object, 'getNumber', originalMethod => {
+describe('InjectionManager', () => {
+    const INJECTIONS = {
+        'getNumber': originalMethod => {
             return function () {
                 // eslint-disable-next-line no-invalid-this
                 const num = originalMethod.call(this);
                 return 2 * num;
             };
-        });
-
-    // override original method
-    injectionManager.overrideMethod(
-        object, 'getCount', () => {
+        },
+        'getCount': () => {
             return function () {
-                return 42;
+                return FIXED_NUMBER;
             };
-        });
-
-    // inject new method
-    injectionManager.overrideMethod(
-        object, 'getOtherNumber', () => {
+        },
+        'getOtherNumber': () => {
             return function () {
-                return 42;
+                return FIXED_NUMBER;
             };
-        });
+        },
+    };
+
+    let injectionManager;
+
+    function injectAll(obj) {
+        for (const func in INJECTIONS) {
+            injectionManager.overrideMethod(obj,
+                func, INJECTIONS[func]);
+        }
     }
 
+    beforeEach(() => {
+        injectionManager = new InjectionManager();
+    });
 
-const injectionManager = new InjectionManager();
-let obj;
+    afterEach(() => {
+        injectionManager.clear();
+    });
 
-// Prototype injections
-addInjections(Object1.prototype);
+    it('can extend prototype methods', () => {
+        injectionManager.overrideMethod(Object1.prototype,
+            'getNumber', INJECTIONS['getNumber']);
 
-obj = new Object1();
+        const obj = new Object1();
+        expect(obj.getNumber()).toEqual(2 * FIXED_NUMBER);
+    });
 
-// new obj is modified
-JsUnit.assertEquals(obj.getNumber(), 84);
-JsUnit.assertEquals(obj.getCount(), 42);
-JsUnit.assertEquals(obj.count, 0);
-JsUnit.assertEquals(obj.getOtherNumber(), 42);
+    it('can replace prototype methods', () => {
+        injectionManager.overrideMethod(Object1.prototype,
+            'getCount', INJECTIONS['getCount']);
+
+        const obj = new Object1();
+        expect(obj.getCount()).toEqual(42);
+        expect(obj.count).toEqual(0);
+    });
+
+    it('can inject methods into prototypes', () => {
+        injectionManager.overrideMethod(Object1.prototype,
+            'getOtherNumber', INJECTIONS['getOtherNumber']);
+
+        const obj = new Object1();
+        expect(obj.getOtherNumber()).toEqual(42);
+    });
+
+    it('can undo prototype injections', () => {
+        injectAll(Object1.prototype);
 
         injectionManager.clear();
 
-obj = new Object1();
+        const obj = new Object1();
+        expect(obj.getNumber()).toEqual(FIXED_NUMBER);
+        expect(obj.getCount()).toEqual(obj.count);
+        expect(obj.count).toBeGreaterThan(0);
+        expect(() => obj.getOtherNumber()).toThrow();
+    });
 
-// new obj is unmodified
-JsUnit.assertEquals(obj.getNumber(), 42);
-JsUnit.assertEquals(obj.getCount(), obj.count);
-JsUnit.assert(obj.count > 0);
-JsUnit.assertRaises(() => obj.getOtherNumber());
+    it('can extend instance methods', () => {
+        const obj = new Object1();
+        injectionManager.overrideMethod(obj,
+            'getNumber', INJECTIONS['getNumber']);
 
-// instance injections
-addInjections(obj);
+        expect(obj.getNumber()).toEqual(2 * FIXED_NUMBER);
+    });
 
-// obj is now modified
-JsUnit.assertEquals(obj.getNumber(), 84);
-JsUnit.assertEquals(obj.getCount(), 42);
-JsUnit.assertEquals(obj.count, 1);
-JsUnit.assertEquals(obj.getOtherNumber(), 42);
+    it('can replace instance methods', () => {
+        const obj = new Object1();
+        injectionManager.overrideMethod(obj,
+            'getCount', INJECTIONS['getCount']);
+
+        expect(obj.getCount()).toEqual(42);
+        expect(obj.count).toEqual(0);
+    });
+
+    it('can inject methods into instances', () => {
+        const obj = new Object1();
+        injectionManager.overrideMethod(obj,
+            'getOtherNumber', INJECTIONS['getOtherNumber']);
+
+        expect(obj.getOtherNumber()).toEqual(42);
+    });
+
+    it('can undo instance injections', () => {
+        const obj = new Object1();
+
+        injectAll(obj);
+
+        injectionManager.clear();
+
+        expect(obj.getNumber()).toEqual(FIXED_NUMBER);
+        expect(obj.getCount()).toEqual(obj.count);
+        expect(obj.count).toBeGreaterThan(0);
+        expect(() => obj.getOtherNumber()).toThrow();
+    });
+
+    it('can restore an original method', () => {
+        const obj = new Object1();
+
+        injectAll(obj);
+
+        expect(obj.getNumber()).toEqual(2 * FIXED_NUMBER);
 
         injectionManager.restoreMethod(obj, 'getNumber');
-JsUnit.assertEquals(obj.getNumber(), 42);
+        expect(obj.getNumber()).toEqual(FIXED_NUMBER);
+    });
 
-injectionManager.clear();
-
-// obj is unmodified again
-JsUnit.assertEquals(obj.getNumber(), 42);
-JsUnit.assertEquals(obj.getCount(), obj.count);
-JsUnit.assert(obj.count > 0);
-JsUnit.assertRaises(() => obj.getOtherNumber());
-
-// GObject injections
+    it('can extend a GObject vfunc', () => {
         const gobj = new GObject1();
         let vfuncCalled;
 
@@ -124,14 +168,27 @@ injectionManager.overrideMethod(
                 };
             });
 
-// gobj is now modified
         vfuncCalled = false;
-gobj.plonk();
-JsUnit.assertTrue(vfuncCalled);
+        gobj.set_property('plonked', true);
+        expect(vfuncCalled).toEqual(true);
+    });
 
+    it('can restore a GObject vfunc', () => {
+        const gobj = new GObject1();
+        let vfuncCalled;
+
+        injectionManager.overrideMethod(
+            GObject1.prototype, 'vfunc_set_property', originalMethod => {
+                return function (...args) {
+                    // eslint-disable-next-line no-invalid-this
+                    originalMethod.apply(this, args);
+                    vfuncCalled = true;
+                };
+            });
         injectionManager.clear();
 
-// gobj is unmodified again
         vfuncCalled = false;
-gobj.plonk();
-JsUnit.assertFalse(vfuncCalled);
+        gobj.set_property('plonked', true);
+        expect(vfuncCalled).toEqual(false);
+    });
+});