{"id":15561870,"url":"https://github.com/doodzik/visual-acceptance-test","last_synced_at":"2025-04-23T22:51:22.979Z","repository":{"id":74937134,"uuid":"106790850","full_name":"doodzik/visual-acceptance-test","owner":"doodzik","description":"🛂 create visual acceptance tests ","archived":false,"fork":false,"pushed_at":"2020-06-01T01:01:49.000Z","size":2768,"stargazers_count":10,"open_issues_count":9,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-30T04:22:18.303Z","etag":null,"topics":["regression-testing","visual-acceptance","visual-regression","visual-regression-testing","visual-specification-testing"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/doodzik.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-10-13T07:14:17.000Z","updated_at":"2022-04-13T14:54:02.000Z","dependencies_parsed_at":"2023-02-24T20:00:33.086Z","dependency_job_id":null,"html_url":"https://github.com/doodzik/visual-acceptance-test","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doodzik%2Fvisual-acceptance-test","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doodzik%2Fvisual-acceptance-test/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doodzik%2Fvisual-acceptance-test/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doodzik%2Fvisual-acceptance-test/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/doodzik","download_url":"https://codeload.github.com/doodzik/visual-acceptance-test/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250528693,"owners_count":21445511,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["regression-testing","visual-acceptance","visual-regression","visual-regression-testing","visual-specification-testing"],"created_at":"2024-10-02T16:10:32.827Z","updated_at":"2025-04-23T22:51:22.970Z","avatar_url":"https://github.com/doodzik.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# visual-acceptance-test\n\n[![Build Status](https://travis-ci.org/doodzik/visual-acceptance-test.svg?branch=master)](https://travis-ci.org/doodzik/visual-acceptance-test) [![Greenkeeper badge](https://badges.greenkeeper.io/doodzik/visual-acceptance-test.svg)](https://greenkeeper.io/) [![Coverage Status](https://coveralls.io/repos/github/doodzik/javascript-html-tags/badge.svg?branch=master)](https://coveralls.io/github/doodzik/javascript-html-tags?branch=master)[![Maintainability](https://api.codeclimate.com/v1/badges/9cbe308f2317f1339bc6/maintainability)](https://codeclimate.com/github/doodzik/visual-acceptance-test/maintainability)\n\nCreate visual acceptance tests.\n\n# Usage\n\nInstall visual-acceptance-test\n```\n$ npm install doodzik/visual-acceptance-test\n```\n\nConfigure your Visual Accaptance Test\n\u003cdetails\u003e\n  \u003csummary\u003eStatic Regression Test\u003c/summary\u003e\n\nCreate a `vat.js` file in the project root\n```javascript\nconst {\n  browser,\n  FileServer,\n  Time,\n  diff,\n  confirmation\n} = require('visual-acceptance-test')\n\nconst fs        = require('fs-extra')\nconst path      = require('path')\nconst time      = new Time.LastCommit(__dirname)\nconst staticDir = path.resolve(__dirname, '.tmp')\nconst server    = new FileServer({dir: staticDir})\n\nconst dimensions = [{width: 1080}, {width: 720}]\n\nfunction pathTo(dir) {\n  return path.resolve(__dirname, '.visual-acceptance-test', dir)\n}\n\nvar shell = require('shelljs')\n\nfunction build() {\n  return new Promise(function(resolve, reject) {\n    shell.exec('npm install', function(code, stdout, stderr) {\n      shell.exec('make build', function(code, stdout, stderr) {\n        resolve()\n      })\n    })\n  })\n}\n\n\nreturn Promise.all([\n  server.listen(),\n  build(),\n  fs.remove(pathTo('HEAD')),\n  fs.remove(pathTo('DIFF')),\n])\n  .then(() =\u003e browser.screenshotSitemap({server, dir: pathTo('HEAD'), dimensions}))\n  .then(() =\u003e time.past())\n  .then(build)\n  .then(() =\u003e browser.screenshotSitemap({server, dir: pathTo(time.pastCommit), dimensions}))\n  .then(() =\u003e time.now())\n  .then(() =\u003e {\n    return diff({\n      actual:      pathTo(time.pastCommit),\n      expected:    pathTo('HEAD'),\n      diff:        pathTo('DIFF'),\n      persistDiff: true\n    })\n  })\n  .then(result =\u003e {\n    return (process.env.CI) ? confirmation.cli({result}) : confirmation.browser({result})\n  })\n  .then(exitCode =\u003e {\n    return server.destroy().then(() =\u003e process.exit(exitCode))\n  })\n```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eDynamic Regression Test\u003c/summary\u003e\n  \n  \u003e DOESN'T WORK YET\n  \nCreate a `vat.js` file in the project root\n\n```javascript\nconst {\n  browser,\n  FileServer,\n  Time,\n  diff,\n  confirmation\n} = require('visual-acceptance-test')\n\nconst fs        = require('fs-extra')\nconst path      = require('path')\nconst time      = new Time.LastCommit(__dirname)\nconst staticDir = path.resolve(__dirname, '.tmp')\nconst server    = new FileServer({dir: staticDir})\n\nconst dimensions = [{width: 1080}, {width: 720}]\n\nfunction pathTo(dir) {\n  return path.resolve(__dirname, '.visual-acceptance-test', dir)\n}\n\nvar shell = require('shelljs')\n\nfunction build(pathToResults) {\n  return new Promise(function(resolve, reject) {\n    shell.exec('npm install', function(code, stdout, stderr) {\n      shell.exec(`VAT_DIR=${pathToResults} make test`, function(code, stdout, stderr) {\n        resolve()\n      })\n    })\n  })\n}\n\n\nreturn Promise.all([\n  server.listen(),\n  fs.remove(pathTo('HEAD')),\n  fs.remove(pathTo('DIFF')),\n])\n  .then(() =\u003e build(pathTo('HEAD')))\n  .then(() =\u003e time.past())\n  .then(() =\u003e build(pathTo(time.pastCommit)))\n  .then(() =\u003e time.now())\n  .then(() =\u003e {\n    return diff({\n      actual:      pathTo(time.pastCommit),\n      expected:    pathTo('HEAD'),\n      diff:        pathTo('DIFF'),\n      persistDiff: true\n    })\n  })\n  .then(result =\u003e {\n    return (process.env.CI) ? confirmation.cli({result}) : confirmation.browser({result})\n  })\n  .then(exitCode =\u003e {\n    return server.destroy().then(() =\u003e process.exit(exitCode))\n  })\n```\n\nAnd then add the following helper in your tests where you want to test your website visuals. [NightmareJs](https://github.com/segmentio/nightmare)\n``` javascript\nconst { browser, } = require('visual-acceptance-test')\nconst Nightmare    = require('nightmare')\n\nbrowser.dynamicScreenshot(Nightmare) \n\nconst nightmare=new Nightmare({ show: false, frame: false, useContentSize: true})\n\nnightmare\n  .goto('https://duckduckgo.com')\n  .type('#search_form_input_homepage', 'github nightmare')\n  .click('#search_button_homepage')\n  .wait('#r1-0 a.result__a')\n  .vatScreenshot(() =\u003e document.querySelector('#r1-0 a.result__a').href)\n  .end()\n``` \n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eVisual Spec Testing\u003c/summary\u003e\n``` javascript\n// TODO\n``` \n\u003c/details\u003e\n\nRun your acceptance tests by executing\n```\n$ node vat.js\n```\n\n# Projects\n\nfeel free to open a pr to add your project (only links to source code)\n\n\u003cdetails\u003e\n\u003csummary\u003eStatic Regression Tests\u003c/summary\u003e\n\n[dudzik.co](https://github.com/doodzik/dudzik.co)\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eDynamic Regression Tests\u003c/summary\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eVisual Spec Testing\u003c/summary\u003e\n\u003c/details\u003e\n\n\n\n# [Roadmap](https://github.com/doodzik/visual-acceptance-test/projects/1)\n\n# API\n\n# Author\n\n[Frederik Dudzik](https://dudzik.co)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoodzik%2Fvisual-acceptance-test","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdoodzik%2Fvisual-acceptance-test","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoodzik%2Fvisual-acceptance-test/lists"}