Modify behavior of runUntil test option

Author: appurva21

lib/sandbox/pmapi-setup-runner.js

@@ -12,13 +12,13 @@ const _ = require('lodash'),
 
     OPTIONS = {
         When: 'when',
-        RunCount: 'runCount',
-        RunUntil: 'runUntil'
+        Count: 'count',
+        Timeout: 'timeout'
     },
     OPTION_TYPE = {
         [OPTIONS.When]: 'function',
-        [OPTIONS.RunCount]: 'number',
-        [OPTIONS.RunUntil]: 'number'
+        [OPTIONS.Count]: 'number',
+        [OPTIONS.Timeout]: 'number'
     };
 
 /**
@@ -76,7 +76,7 @@ module.exports = function (pm, testsState, onAssertion) {
                 ...(options ? _.pick(options, _.values(OPTIONS)) : {}),
                 testId: uuid(),
                 timer: null,
-                currRunCount: 0,
+                runCount: 0,
                 pending: true
             };
         },
@@ -120,6 +120,8 @@ module.exports = function (pm, testsState, onAssertion) {
             assertionData.passed = false;
         },
 
+        // Processes the assertion data and test state to determine if the assertion should be resolved or not
+        // and then calls the onAssertion callback
         processAssertion = function (_testId, assertionData, options) {
             const testState = testsState[_testId];
 
@@ -135,8 +137,8 @@ module.exports = function (pm, testsState, onAssertion) {
                 assertionData.error || // TODO: Make conditions (test status) to mark a test resolved, configurable.
                 assertionData.skipped ||
                 _.isEmpty(options) ||
-                isOptionConfigured(options, OPTIONS.RunCount) && testState.runCount === testState.currRunCount ||
-                isOptionConfigured(options, OPTIONS.RunUntil) && testState.currRunCount && !testState.timer
+                isOptionConfigured(options, OPTIONS.Count) && testState.count === testState.runCount ||
+                isOptionConfigured(options, OPTIONS.Timeout) && testState.runCount && !testState.timer
             );
 
             testState.pending = assertionData.pending = !shouldResolve;
@@ -149,23 +151,35 @@ module.exports = function (pm, testsState, onAssertion) {
             onAssertion(assertionData);
         },
 
+
+        // Processes the provided options and updates the test state accordingly every time a test spec is encountered
         processOptions = function (_testId, assertionData, options) {
             const testState = testsState[_testId],
                 shouldRun = testState.pending &&
                     (isOptionConfigured(options, OPTIONS.When) ? Boolean(options.when()) : true) &&
-                    (isOptionConfigured(options, OPTIONS.RunCount) ? testState.currRunCount < options.runCount : true);
+                    (isOptionConfigured(options, OPTIONS.Count) ? testState.runCount < options.count : true),
+                startTimer =
+                    isOptionConfigured(options, OPTIONS.Timeout) &&
+                    testState.runCount === 0 &&
+                    !testState.timer;
 
             if (shouldRun) {
-                testState.currRunCount++;
+                testState.runCount++;
+            }
 
-                const startTimer = isOptionConfigured(options, OPTIONS.RunUntil) && !testState.timer;
+            if (startTimer) {
+                testState.timer = setTimeout(() => {
+                    const shouldFail =
+                        (!testState.count && testState.runCount === 0) ||
+                        (isOptionConfigured(options, OPTIONS.Count) && testState.runCount < options.count);
 
-                if (startTimer) {
-                    testState.timer = setTimeout(() => {
-                        testState.timer = null;
-                        processAssertion(_testId, assertionData, options);
-                    }, testState.runUntil);
-                }
+                    if (shouldFail) {
+                        markAssertionAsFailure(assertionData, new Error('Test timed out'));
+                    }
+
+                    testState.timer = null;
+                    processAssertion(_testId, assertionData, options);
+                }, testState.timeout);
             }
 
             return shouldRun;