Adding visual testing with Applitools example (#234)

bahmutov · web-flow · commit efa8689a8798 · 2020-05-19T09:48:49.000-04:00
diff --git a/circle.yml b/circle.yml
@@ -99,6 +99,19 @@ workflows:
             - store_artifacts:
                 path: examples/visual-sudoku/cypress/snapshots
 
+      - cypress/run:
+          name: Visual with Applitools
+          executor: base-12-16-2
+          requires:
+            - Install
+          # each example installs "cypress-react-unit-test" as a local dependency (symlink)
+          install-command: npm install
+          verify-command: echo 'Already verified'
+          no-workspace: true
+          working_directory: examples/visual-testing-with-applitools
+          command: npm test
+          store_artifacts: true
+
       - cypress/run:
           name: Visual with Percy
           executor: base-12-16-2
@@ -169,6 +182,7 @@ workflows:
             - Visual Sudoku
             - Visual with Percy
             - Visual with Happo
+            - Visual with Applitools
           install-command: echo 'Already installed'
           verify-command: echo 'Already verified'
           no-workspace: true
diff --git a/examples/visual-testing-with-applitools/.gitignore b/examples/visual-testing-with-applitools/.gitignore
@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/examples/visual-testing-with-applitools/.npmrc b/examples/visual-testing-with-applitools/.npmrc
@@ -0,0 +1 @@
+package-lock=false
diff --git a/examples/visual-testing-with-applitools/README.md b/examples/visual-testing-with-applitools/README.md
@@ -0,0 +1,13 @@
+# example: visual testing using Applitools
+
+Shows how to use Applitools to visually check React charts made with [Victory](https://formidable.com/open-source/victory/) library.
+
+![Screenshot](images/eyes.png)
+
+See [src/Chart.spec.js](src/Chart.spec.js)
+
+The `cy.eyes*` commands are ignored during local interactive run. On CI, the `cy.eyes*` send the snapshots to Applitools servers to be analyzed and compared against the baseline images.
+
+![Test result](images/result.png)
+
+For more information, see [Applitools tutorial](https://applitools.com/tutorials/cypress.html)
diff --git a/examples/visual-testing-with-applitools/cypress.json b/examples/visual-testing-with-applitools/cypress.json
@@ -0,0 +1,12 @@
+{
+  "fixturesFolder": false,
+  "testFiles": "**/*spec.js",
+  "viewportWidth": 1000,
+  "viewportHeight": 1000,
+  "experimentalComponentTesting": true,
+  "componentFolder": "src",
+  "video": false,
+  "env": {
+    "coverage": false
+  }
+}
diff --git a/examples/visual-testing-with-applitools/cypress/integration/cy-spec.js b/examples/visual-testing-with-applitools/cypress/integration/cy-spec.js
@@ -0,0 +1,6 @@
+/// <reference types="cypress" />
+describe('integration spec', () => {
+  it('works', () => {
+    expect(1).to.equal(1)
+  })
+})
diff --git a/examples/visual-testing-with-applitools/cypress/plugins/index.js b/examples/visual-testing-with-applitools/cypress/plugins/index.js
@@ -0,0 +1,8 @@
+const preprocessor = require('../../../../plugins/react-scripts')
+module.exports = (on, config) => {
+  preprocessor(on, config)
+  // IMPORTANT to return the config object
+  // with the any changed environment variables
+  return config
+}
+require('@applitools/eyes-cypress')(module)
diff --git a/examples/visual-testing-with-applitools/cypress/support/index.js b/examples/visual-testing-with-applitools/cypress/support/index.js
@@ -0,0 +1,2 @@
+require('cypress-react-unit-test/dist/hooks')
+require('@applitools/eyes-cypress/commands')
diff --git a/examples/visual-testing-with-applitools/images/eyes.png b/examples/visual-testing-with-applitools/images/eyes.png
diff --git a/examples/visual-testing-with-applitools/images/result.png b/examples/visual-testing-with-applitools/images/result.png
diff --git a/examples/visual-testing-with-applitools/package.json b/examples/visual-testing-with-applitools/package.json
@@ -0,0 +1,12 @@
+{
+  "name": "example-visual-testing-with-applitools",
+  "description": "Visual diffing for component testing using Applittols",
+  "private": true,
+  "scripts": {
+    "test": "../../node_modules/.bin/cypress run",
+    "cy:open": "../../node_modules/.bin/cypress open"
+  },
+  "devDependencies": {
+    "cypress-react-unit-test": "file:../.."
+  }
+}
diff --git a/examples/visual-testing-with-applitools/src/Chart.js b/examples/visual-testing-with-applitools/src/Chart.js
@@ -0,0 +1,285 @@
+// @ts-check
+import React from 'react'
+import { VictoryLabel, VictoryAxis, VictoryLine } from 'victory'
+
+export class CustomTheme extends React.Component {
+  render() {
+    const styles = this.getStyles()
+    const dataSetOne = this.getDataSetOne()
+    const dataSetTwo = this.getDataSetTwo()
+    const tickValues = this.getTickValues()
+
+    return (
+      <svg style={styles.parent} viewBox="0 0 450 350">
+        {/* Create stylistic elements */}
+        <rect x="0" y="0" width="10" height="30" fill="#f01616" />
+        <rect x="420" y="10" width="20" height="20" fill="#458ca8" />
+
+        {/* Define labels */}
+        <VictoryLabel x={25} y={24} style={styles.title} text="An outlook" />
+        <VictoryLabel x={430} y={20} style={styles.labelNumber} text="1" />
+        <VictoryLabel
+          x={25}
+          y={55}
+          style={styles.labelOne}
+          text={'Economy \n % change on a year earlier'}
+        />
+        <VictoryLabel
+          x={425}
+          y={55}
+          style={styles.labelTwo}
+          text={'Dinosaur exports\n $bn'}
+        />
+
+        <g transform={'translate(0, 40)'}>
+          {/* Add shared independent axis */}
+          <VictoryAxis
+            scale="time"
+            standalone={false}
+            style={styles.axisYears}
+            tickValues={tickValues}
+            tickFormat={x => {
+              if (x.getFullYear() === 2000) {
+                return x.getFullYear()
+              }
+              if (x.getFullYear() % 5 === 0) {
+                return x
+                  .getFullYear()
+                  .toString()
+                  .slice(2)
+              }
+            }}
+          />
+
+          {/*
+            Add the dependent axis for the first data set.
+            Note that all components plotted against this axis will have the same y domain
+          */}
+          <VictoryAxis
+            dependentAxis
+            domain={[-10, 15]}
+            offsetX={50}
+            orientation="left"
+            standalone={false}
+            style={styles.axisOne}
+          />
+
+          {/* Red annotation line */}
+          <VictoryLine
+            data={[
+              { x: new Date(1999, 1, 1), y: 0 },
+              { x: new Date(2014, 6, 1), y: 0 },
+            ]}
+            domain={{
+              x: [new Date(1999, 1, 1), new Date(2016, 1, 1)],
+              y: [-10, 15],
+            }}
+            scale={{ x: 'time', y: 'linear' }}
+            standalone={false}
+            style={styles.lineThree}
+          />
+
+          {/* dataset one */}
+          <VictoryLine
+            data={dataSetOne}
+            domain={{
+              x: [new Date(1999, 1, 1), new Date(2016, 1, 1)],
+              y: [-10, 15],
+            }}
+            interpolation="monotoneX"
+            scale={{ x: 'time', y: 'linear' }}
+            standalone={false}
+            style={styles.lineOne}
+          />
+
+          {/*
+            Add the dependent axis for the second data set.
+            Note that all components plotted against this axis will have the same y domain
+          */}
+          <VictoryAxis
+            dependentAxis
+            domain={[0, 50]}
+            orientation="right"
+            standalone={false}
+            style={styles.axisTwo}
+          />
+
+          {/* dataset two */}
+          <VictoryLine
+            data={dataSetTwo}
+            domain={{
+              x: [new Date(1999, 1, 1), new Date(2016, 1, 1)],
+              y: [0, 50],
+            }}
+            interpolation="monotoneX"
+            scale={{ x: 'time', y: 'linear' }}
+            standalone={false}
+            style={styles.lineTwo}
+          />
+        </g>
+      </svg>
+    )
+  }
+
+  getDataSetOne() {
+    return [
+      { x: new Date(2000, 1, 1), y: 12 },
+      { x: new Date(2000, 6, 1), y: 10 },
+      { x: new Date(2000, 12, 1), y: 11 },
+      { x: new Date(2001, 1, 1), y: 5 },
+      { x: new Date(2002, 1, 1), y: 4 },
+      { x: new Date(2003, 1, 1), y: 6 },
+      { x: new Date(2004, 1, 1), y: 5 },
+      { x: new Date(2005, 1, 1), y: 7 },
+      { x: new Date(2006, 1, 1), y: 8 },
+      { x: new Date(2007, 1, 1), y: 9 },
+      { x: new Date(2008, 1, 1), y: -8.5 },
+      { x: new Date(2009, 1, 1), y: -9 },
+      { x: new Date(2010, 1, 1), y: 5 },
+      { x: new Date(2013, 1, 1), y: 1 },
+      { x: new Date(2014, 1, 1), y: 2 },
+      { x: new Date(2015, 1, 1), y: -5 },
+    ]
+  }
+
+  getDataSetTwo() {
+    return [
+      { x: new Date(2000, 1, 1), y: 5 },
+      { x: new Date(2003, 1, 1), y: 6 },
+      { x: new Date(2004, 1, 1), y: 4 },
+      { x: new Date(2005, 1, 1), y: 10 },
+      { x: new Date(2006, 1, 1), y: 12 },
+      { x: new Date(2007, 2, 1), y: 48 },
+      { x: new Date(2008, 1, 1), y: 19 },
+      { x: new Date(2009, 1, 1), y: 31 },
+      { x: new Date(2011, 1, 1), y: 49 },
+      { x: new Date(2014, 1, 1), y: 40 },
+      { x: new Date(2015, 1, 1), y: 21 },
+    ]
+  }
+
+  getTickValues() {
+    return [
+      new Date(1999, 1, 1),
+      new Date(2000, 1, 1),
+      new Date(2001, 1, 1),
+      new Date(2002, 1, 1),
+      new Date(2003, 1, 1),
+      new Date(2004, 1, 1),
+      new Date(2005, 1, 1),
+      new Date(2006, 1, 1),
+      new Date(2007, 1, 1),
+      new Date(2008, 1, 1),
+      new Date(2009, 1, 1),
+      new Date(2010, 1, 1),
+      new Date(2011, 1, 1),
+      new Date(2012, 1, 1),
+      new Date(2013, 1, 1),
+      new Date(2014, 1, 1),
+      new Date(2015, 1, 1),
+      new Date(2016, 1, 1),
+    ]
+  }
+
+  getStyles() {
+    const BLUE_COLOR = '#00a3de'
+    const RED_COLOR = '#7c270b'
+
+    return {
+      parent: {
+        background: '#ccdee8',
+        boxSizing: 'border-box',
+        display: 'inline',
+        padding: 0,
+        fontFamily: "'Fira Sans', sans-serif",
+      },
+      title: {
+        textAnchor: 'start',
+        verticalAnchor: 'end',
+        fill: '#000000',
+        fontFamily: 'inherit',
+        fontSize: '18px',
+        fontWeight: 'bold',
+      },
+      labelNumber: {
+        textAnchor: 'middle',
+        fill: '#ffffff',
+        fontFamily: 'inherit',
+        fontSize: '14px',
+      },
+
+      // INDEPENDENT AXIS
+      axisYears: {
+        axis: { stroke: 'black', strokeWidth: 1 },
+        ticks: {
+          size: ({ tick }) => {
+            const tickSize = tick.getFullYear() % 5 === 0 ? 10 : 5
+            return tickSize
+          },
+          stroke: 'black',
+          strokeWidth: 1,
+        },
+        tickLabels: {
+          fill: 'black',
+          fontFamily: 'inherit',
+          fontSize: 16,
+        },
+      },
+
+      // DATA SET ONE
+      axisOne: {
+        grid: {
+          stroke: ({ tick }) => (tick === -10 ? 'transparent' : '#ffffff'),
+          strokeWidth: 2,
+        },
+        axis: { stroke: BLUE_COLOR, strokeWidth: 0 },
+        ticks: { strokeWidth: 0 },
+        tickLabels: {
+          fill: BLUE_COLOR,
+          fontFamily: 'inherit',
+          fontSize: 16,
+        },
+      },
+      labelOne: {
+        fill: BLUE_COLOR,
+        fontFamily: 'inherit',
+        fontSize: 12,
+        fontStyle: 'italic',
+      },
+      lineOne: {
+        data: { stroke: BLUE_COLOR, strokeWidth: 4.5 },
+      },
+      axisOneCustomLabel: {
+        fill: BLUE_COLOR,
+        fontFamily: 'inherit',
+        fontWeight: 300,
+        fontSize: 21,
+      },
+
+      // DATA SET TWO
+      axisTwo: {
+        axis: { stroke: RED_COLOR, strokeWidth: 0 },
+        tickLabels: {
+          fill: RED_COLOR,
+          fontFamily: 'inherit',
+          fontSize: 16,
+        },
+      },
+      labelTwo: {
+        textAnchor: 'end',
+        fill: RED_COLOR,
+        fontFamily: 'inherit',
+        fontSize: 12,
+        fontStyle: 'italic',
+      },
+      lineTwo: {
+        data: { stroke: RED_COLOR, strokeWidth: 4.5 },
+      },
+
+      // HORIZONTAL LINE
+      lineThree: {
+        data: { stroke: '#e95f46', strokeWidth: 2 },
+      },
+    }
+  }
+}
diff --git a/examples/visual-testing-with-applitools/src/Chart.spec.js b/examples/visual-testing-with-applitools/src/Chart.spec.js
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+require('cypress-react-unit-test/dist/hooks')`
	`2`	`+require('@applitools/eyes-cypress/commands')`