Tools: Added mocking of time for gant demos.

This is needed when running visual comparison tests. I.e if the reference image was created x days ago it wouldn't otherwise match.
rikapo · Aug 23, 2019 · f982840 · f982840
1 parent 9678511
commit f982840
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 7 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -324,7 +324,7 @@ workflows:
           filters:
             branches:
               only:
-                - tools/vis-test-samples
+                - tools/visual-test-samples
                 - master
     jobs:
       - checkout_code

diff --git a/test/karma-conf.js b/test/karma-conf.js
@@ -712,11 +712,16 @@ function createVisualTestTemplate(argv, path, js, assertion) {
         `;
     }
 
+    var useFakeTime = path.startsWith('gantt/');
+    var startOfMockedTime = Date.UTC(2019, 7, 1);
+
     return `
         QUnit.test('${path}', function (assert) {
             // Apply demo.html
             document.getElementById('demo-html').innerHTML = \`${html}\`;
             
+            ${useFakeTime ? `var clock = TestUtilities.lolexInstall({ now: ${startOfMockedTime} });` : ''}
+            
             /*
              * we expect 2 callbacks if --visualcompare argument is supplied,
              * one for the test comparison and one for checking if chart exists.
@@ -748,6 +753,8 @@ function createVisualTestTemplate(argv, path, js, assertion) {
                 }
             }
             assertIfChartExists();
+            
+            ${useFakeTime ? 'TestUtilities.lolexUninstall(clock);' : ''}
         });
     `;
 }
diff --git a/test/test-utilities.js b/test/test-utilities.js
@@ -38,8 +38,11 @@ var TestUtilities = /** @class */ (function () {
     /**
      * Convenient wrapper for installing lolex and bypassing
      * requestAnimationFrame. Returns a clock object.
+     *
+     * @param lolexConfig
+     *        Config supplied to lolex.install
      */
-    TestUtilities.lolexInstall = function () {
+    TestUtilities.lolexInstall = function (lolexConfig) {
         if (!lolex) {
             return;
         }
@@ -48,7 +51,7 @@ var TestUtilities = /** @class */ (function () {
         win.requestAnimationFrame = null;
         // Abort running animations, otherwise they will take over
         Highcharts.timers.length = 0;
-        return lolex.install();
+        return lolex.install(lolexConfig);
     };
     /**
      * Convenient wrapper for uninstalling lolex.

diff --git a/test/test-utilities.ts b/test/test-utilities.ts
@@ -98,9 +98,11 @@ class TestUtilities {
     /**
      * Convenient wrapper for installing lolex and bypassing
      * requestAnimationFrame. Returns a clock object.
+     *
+     * @param lolexConfig
+     *        Config supplied to lolex.install
      */
-    private static lolexInstall (): (LolexClock|undefined) {
-
+    private static lolexInstall (lolexConfig?: any): (LolexClock|undefined) {
         if (!lolex) {
             return;
         }
@@ -113,7 +115,7 @@ class TestUtilities {
         // Abort running animations, otherwise they will take over
         (Highcharts as any).timers.length = 0;
 
-        return lolex.install();
+        return lolex.install(lolexConfig);
     }
 
     /**

diff --git a/test/tsglobal.d.ts b/test/tsglobal.d.ts
@@ -1,7 +1,7 @@
 /// <reference path="../code/highcharts.d.ts" />
 
 declare interface Lolex {
-    install: () => (LolexClock|undefined);
+    install: (lolexConfig? : any) => (LolexClock|undefined);
 }
 
 declare interface LolexClock {