Merge pull request #27 from NimaSoroush/evaluate

- Adding evaluate functionality to steps

Author: NimaSoroush

API.md

@@ -12,8 +12,24 @@
 |----|----|-----|
 |`goto`|`string`|Url|
 |`wait`|`string`, `integer` or `func`|waiting time in millisecond `or` waiting for a selector `or` waiting until the function you supplied is evaluated as true|
+|`evaluate`|`func`|Evaluates a expression in the browser context|
 |`capture`|`string`|`undefiend`, `document` or selector name|
 
+#### Steps example
+
+```
+{
+  ...
+  steps: [
+    { name: 'goto', value: 'http://www.example.com' },
+    { name: 'wait', value: 5000 },
+    { name: 'evaluate', value: () => { alert("Hello! I am an alert box!!") } },
+    { name: 'capture', value: 'document' },
+  ],
+  ...
+}
+```
+
 ##### Coming steps
 - click
 - setCookie

src/actions.js

@@ -3,4 +3,5 @@ export default {
   capture: 'capture',
   test: 'test',
   wait: 'wait',
+  evaluate: 'evaluate',
 };

src/chromyRunner.js

@@ -87,6 +87,20 @@ const run = async (chromy, options, test) => {
           return false;
         }
         break;
+      case actions.evaluate:
+        try {
+          if (check.function(action.value)) {
+            prefixedLogger.log('waiting for to evaluate function in browser');
+            await chromy.evaluate(action.value);
+          } else {
+            prefixedLogger.log('failed to detect evaluate function');
+            return false;
+          }
+        } catch (error) {
+          prefixedLogger.error(error);
+          return false;
+        }
+        break;
       default:
         break;
     }

src/chromyRunner.test.js

@@ -13,6 +13,7 @@ jest.mock('chromy', () => jest.fn(() =>
     screenshotSelector: jest.fn(() => 'png file'),
     screenshot: jest.fn(() => 'png file'),
     wait: jest.fn(),
+    evaluate: jest.fn(),
   }),
 ));
 
@@ -46,6 +47,7 @@ describe('ChromyRunner', () => {
     chromy.screenshot.mockClear();
     chromy.screenshotSelector.mockClear();
     chromy.wait.mockClear();
+    chromy.evaluate.mockClear();
   });
   it('run update', async () => {
     testConfig.type = configTypes.update;
@@ -245,4 +247,38 @@ describe('ChromyRunner', () => {
       expect(loggerCalls[1]).toEqual('failed to detect waiting mechanism');
     });
   });
+  describe('Chromy runner', () => {
+    it('Evaluate: function', async () => {
+      const newConfig = {
+        name: 'default',
+        resolution: {
+          width: 800,
+          height: 600,
+        },
+        steps: [
+          { name: 'evaluate', value: () => {} },
+        ],
+      };
+      const result = await run(chromy, globalConfig, newConfig);
+      expect(result).toEqual(true);
+      expect(chromy.evaluate).toHaveBeenCalledTimes(1);
+      expect(loggerCalls[0]).toEqual('waiting for to evaluate function in browser');
+    });
+    it('Evaluate: non-function', async () => {
+      const newConfig = {
+        name: 'default',
+        resolution: {
+          width: 800,
+          height: 600,
+        },
+        steps: [
+          { name: 'evaluate', value: 123 },
+        ],
+      };
+      const result = await run(chromy, globalConfig, newConfig);
+      expect(result).toEqual(false);
+      expect(chromy.evaluate).toHaveBeenCalledTimes(0);
+      expect(loggerCalls[0]).toEqual('failed to detect evaluate function');
+    });
+  });
 });