Gruntfile.js

'use strict'

module.exports = function (grunt) {
  const coverage = process.env.GRUNT_HTML_DOM_SNAPSHOT_COVERAGE

  grunt.initConfig({
    standard: {
      all: {
        src: [
          'Gruntfile.js',
          'tasks/**/*.js',
          '<%= nodeunit.tests %>'
        ]
      }
    },

    instrument: {
      files: 'tasks/**/*.js',
      options: {
        lazy: true,
        basePath: 'coverage/'
      }
    },

    storeCoverage: {
      options: {
        dir: 'coverage'
      }
    },

    makeReport: {
      src: 'coverage/coverage.json',
      options: {
        type: 'lcov',
        dir: 'coverage',
        print: 'detail'
      }
    },

    nodeunit: {
      tests: ['test/*.js']
    },

    connect: {
      server: {
        options: {
          port: 8881
        }
      }
    },

    clean: {
      coverage: ['coverage/**'],
      snapshots: ['test/snapshots/*'],
      screenshots: ['test/screenshots/*']
    },

    'html-dom-snapshot': {
      options: {
        verbose: true,
        webdriver: {
          capabilities: {
            browserName: 'chrome',
            'goog:chromeOptions': {
              args: ['--headless', '--no-sandbox']
            }
          }
        },
        snapshots: 'test/snapshots'
      },
      'single-target.html': {
        url: 'http://localhost:8881/test/pages/single-target.html'
      },
      others: {
        commands: [
          {
            options: {
              snapshots: null,
              screenshots: 'test/screenshots',
              fileNumbering: true
            },
            url: 'http://localhost:8881/test/pages/static.html',
            file: 'static.html'
          },
          {
            url: 'http://localhost:8881/test/pages/delayed.html',
            wait: 200,
            file: 'delayed'
          },
          {
            options: {
              screenshots: 'test/screenshots'
            },
            url: 'http://localhost:8881/test/pages/dynamic.html',
            wait: '.dynamic',
            file: 'dynamic'
          },
          {
            options: {
              viewport: {
                width: 1600,
                height: 900
              }
            },
            url: 'http://localhost:8881/test/pages/dynamic-reverse.html',
            wait: '!.dynamic',
            file: 'dynamic-reverse'
          },
          {
            url: 'http://localhost:8881/test/pages/dynamic-delayed.html',
            wait: [
              '.dynamic',
              200
            ],
            file: 'dynamic-delayed'
          },
          {
            url: 'http://localhost:8881/test/pages/dynamic-custom.html',
            wait: function (browser) {
              return browser.$('.dynamic')
                .then(element => element.waitForExist({ timeout: 1000 }))
            },
            file: 'dynamic-custom'
          },
          {
            options: {
              doctype: '',
              fileNumbering: 'per-directory'
            },
            url: 'http://localhost:8881/test/pages/no-doctype.html',
            file: 'directory/no-doctype'
          },
          {
            options: {
              instructionDelay: 1
            },
            wait: 1
          },
          {
            url: 'http://localhost:8881/test/pages/dynamic-multiple.html'
          },
          {
            file: 'dynamic-first'
          },
          {
            wait: '.second',
            file: 'dynamic-second'
          },
          {
            wait: '.third'
          },
          {
            file: 'dynamic-third'
          },
          {
            go: 'back',
            wait: function (browser) {
              return browser.getUrl()
                .then(function (url) {
                  if (url !== 'http://localhost:8881/test/pages/no-doctype.html') {
                    throw new Error('go:back failed')
                  }
                })
            }
          },
          {
            go: 'forward',
            wait: function (browser) {
              return browser.getUrl()
                .then(function (url) {
                  if (url !== 'http://localhost:8881/test/pages/dynamic-multiple.html') {
                    throw new Error('go:forward failed')
                  }
                })
            }
          },
          {
            go: 'refresh',
            wait: function (browser) {
              return browser.getUrl()
                .then(function (url) {
                  if (url !== 'http://localhost:8881/test/pages/dynamic-multiple.html') {
                    throw new Error('go:forward failed')
                  }
                })
            }
          },
          {
            url: 'http://localhost:8881/test/pages/input.html',
            scroll: 'input',
            moveCursor: 'input',
            click: 'input',
            wait: function (browser) {
              return browser.$('input')
                .then(element => element.isFocused())
                .then(function (value) {
                  if (value !== true) {
                    throw new Error('click failed')
                  }
                })
            }
          },
          {
            scroll: 'body',
            clickIfVisible: 'input',
            wait: function (browser) {
              return browser.$('input')
                .then(element => element.isFocused())
                .then(function (value) {
                  if (value === false) {
                    throw new Error('clickIfVisible on body failed')
                  }
                })
            }
          },
          {
            setValue: {
              selector: 'input',
              value: 'Hi'
            },
            wait: function (browser) {
              return browser.$('input')
                .then(element => element.getValue())
                .then(function (value) {
                  if (value !== 'Hi') {
                    throw new Error('setValue failed')
                  }
                })
            }
          },
          {
            addValue: {
              selector: 'input',
              value: ' there!'
            },
            wait: function (browser) {
              return browser.$('input')
                .then(element => element.getValue())
                .then(function (value) {
                  if (value !== 'Hi there!') {
                    throw new Error('addValue failed')
                  }
                })
            }
          },
          {
            clearValue: 'input',
            wait: function (browser) {
              return browser.$('input')
                .then(element => element.getValue())
                .then(function (value) {
                  if (value !== '') {
                    throw new Error('clearValue failed')
                  }
                })
            }
          },
          {
            click: 'input',
            keys: 'test',
            wait: function (browser) {
              return browser.$('input')
                .then(element => element.getValue())
                .then(function (value) {
                  if (value !== 'test') {
                    throw new Error('sending text failed')
                  }
                })
            }
          },
          {
            clearValue: 'input',
            elementSendKeys: {
              selector: 'input',
              text: 'Test'
            },
            wait: function (browser) {
              return browser.$('input')
                .then(element => element.getValue())
                .then(function (value) {
                  if (value !== 'Test') {
                    throw new Error('sending text to an element failed')
                  }
                })
            }
          },
          {
            keys: ['Home', 'Delete'],
            wait: function (browser) {
              return browser.$('input')
                .then(element => element.getValue())
                .then(function (value) {
                  if (value !== 'est') {
                    throw new Error('sending key strokes failed', value)
                  }
                })
            }
          },
          {
            url: 'http://localhost:8881/test/pages/values.html',
            isEnabled: 'select',
            isExisting: 'select',
            isFocused: 'select',
            isVisible: 'select',
            isVisibleWithinViewport: 'select',
            isSelected: 'select > option:last-child',
            isNotEnabled: 'input',
            isNotExisting: 'textarea',
            isNotFocused: 'input',
            isNotVisible: 'input',
            isNotVisibleWithinViewport: 'input',
            isNotSelected: 'select > option:first-child',
            hasAttribute: {
              selector: 'input',
              name: 'disabled',
              value: 'disabled'
            },
            hasValue: {
              selector: 'input',
              value: 'test'
            },
            hasText: {
              selector: 'div',
              value: 'Text'
            },
            hasInnerHtml: {
              selector: 'div',
              value: 'Text'
            },
            hasOuterHtml: {
              selector: 'div',
              value: '<div class="class" tabindex="0">Text</div>'
            }
          },
          {
            options: {
              singleElementSelections: true
            },
            isExisting: 'select'
          },
          {
            options: {
              singleElementSelections: true,
              force: true
            },
            isExisting: 'option'
          },
          coverage ? { wait: 1 } : {
            focus: 'body',
            wait: function (browser) {
              return browser.$('body')
                .then(element => element.isFocused())
                .then(function (value) {
                  if (value !== false) {
                    throw new Error('focus on body failed')
                  }
                })
            }
          },
          {
            clickIfVisible: 'input',
            wait: function (browser) {
              return browser.$('input')
                .then(element => element.isFocused())
                .then(function (value) {
                  if (value !== false) {
                    throw new Error('clickIfVisible on invisible input failed')
                  }
                })
            }
          },
          {
            hasClass: {
              selector: 'div',
              value: 'class'
            }
          },
          {
            hasClass: {
              selector: 'div',
              value: '!none'
            }
          },
          {
            hasClass: {
              selector: 'div',
              value: 'class none'
            }
          },
          {
            hasClass: {
              selector: 'div',
              value: 'class !none',
              allRequired: true
            }
          },
          {
            selectOptionByIndex: {
              selector: 'select',
              index: 1
            },
            hasValue: {
              selector: 'select',
              value: '2'
            }
          },
          {
            selectOptionByValue: {
              selector: 'select',
              value: '1'
            },
            hasValue: {
              selector: 'select',
              value: '1'
            }
          },
          {
            if: {
              hasClass: {
                selector: 'div',
                value: 'class none'
              }
            },
            else: {
              wait: function () {
                throw new Error('executed else branch')
              }
            }
          },
          {
            if: [{
              hasClass: {
                selector: 'div',
                value: 'dummy'
              }
            }],
            then: [{
              wait: function () {
                throw new Error('executed then branch')
              }
            }],
            else: [{
              wait: 1
            }]
          },
          {
            url: 'http://localhost:8881/test/pages/dynamic.html',
            hasClass: {
              selector: 'body',
              value: '!dynamic'
            }
          },
          {
            while: {
              hasClass: {
                selector: 'body',
                value: '!dynamic'
              }
            },
            do: {
              wait: 10
            }
          },
          {
            url: 'http://localhost:8881/test/pages/input.html',
            isNotFocused: 'input'
          },
          {
            do: {
              keys: ['Tab']
            },
            until: {
              isFocused: 'input'
            }
          },
          {
            go: 'refresh',
            isNotFocused: 'input'
          },
          {
            repeat: 2,
            do: [
              {
                click: 'input'
              },
              {
                if: {
                  isFocused: 'input'
                },
                then: {
                  break: 'input is in focus'
                }
              }
            ]
          },
          {
            isFocused: 'input'
          },
          {
            setViewport: {
              width: 768,
              height: 480
            }
          },
          {
            setViewport: {}
          },
          {
            setViewport: {}
          }
        ],
        scenarios: 'test/scenarios/*.js'
      },
      'no-input': {
        options: {
          force: true
        },
        commands: [
          {}
        ]
      },
      'invalid-instruction': {
        options: {
          force: true
        },
        commands: [
          { invalid: {} }
        ]
      },
      'invalid-file': {
        options: {
          capabilities: {
            browserName: 'chrome',
            'goog:chromeOptions': {
              args: ['--headless', '--no-sandbox']
            }
          },
          screenshots: 'test/screenshots',
          force: true
        },
        pages: [
          {
            url: 'http://localhost:8881',
            file: '/\\//\\'
          }
        ]
      },
      'invalid-dest': {
        options: {
          dest: '/ /',
          force: true
        },
        dummy: {
          url: 'http://localhost:8881',
          file: 'dummy'
        }
      },
      'invalid-screenshots': {
        options: {
          screenshots: '/ /',
          force: true
        },
        pages: [
          {
            url: 'http://localhost:8881',
            file: 'dummy'
          }
        ]
      },
      'invalid-go': {
        options: {
          force: true,
          screenshots: 'test/screenshots'
        },
        pages: [
          {
            url: 'http://localhost:8881',
            go: 'dummy'
          }
        ]
      },
      'invalid-wait': {
        options: {
          force: true
        },
        commands: [
          { wait: true }
        ]
      },
      'abort': {
        options: {
          force: true
        },
        commands: [
          { abort: 'Stop.' },
          { file: 'aborted' }
        ]
      }
    },

    chromedriver: {
      default: {}
    }
  })

  grunt.loadNpmTasks('grunt-chromedriver')
  grunt.loadNpmTasks('grunt-contrib-clean')
  grunt.loadNpmTasks('grunt-contrib-connect')
  grunt.loadNpmTasks('grunt-contrib-nodeunit')
  grunt.loadNpmTasks('grunt-istanbul')
  grunt.loadNpmTasks('grunt-standard')
  grunt.loadTasks(coverage ? 'coverage/tasks' : 'tasks')

  const test = ['clean', 'standard',
    'chromedriver:default:start',
    'connect', 'html-dom-snapshot',
    'chromedriver:default:stop', 'nodeunit']
  const report = coverage ? ['storeCoverage', 'makeReport'] : []
  grunt.registerTask('default', test.concat(report))
}