{"id":15387183,"url":"https://github.com/wildhoney/webmonkey","last_synced_at":"2025-04-15T18:30:44.287Z","repository":{"id":40244161,"uuid":"169141597","full_name":"Wildhoney/Webmonkey","owner":"Wildhoney","description":"🙊 Robust and versatile headless monkey testing for the modern web with reproducible steps, error alerts, strategy sharing and many other good things.","archived":false,"fork":false,"pushed_at":"2023-01-06T01:58:57.000Z","size":3033,"stargazers_count":11,"open_issues_count":16,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-29T00:34:06.449Z","etag":null,"topics":["headless","monkey-testing","puppeteer","stress-testing","testing"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Wildhoney.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}},"created_at":"2019-02-04T20:09:46.000Z","updated_at":"2025-01-15T10:30:30.000Z","dependencies_parsed_at":"2023-02-05T02:16:44.611Z","dependency_job_id":null,"html_url":"https://github.com/Wildhoney/Webmonkey","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Wildhoney%2FWebmonkey","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Wildhoney%2FWebmonkey/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Wildhoney%2FWebmonkey/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Wildhoney%2FWebmonkey/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Wildhoney","download_url":"https://codeload.github.com/Wildhoney/Webmonkey/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249128889,"owners_count":21217237,"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":["headless","monkey-testing","puppeteer","stress-testing","testing"],"created_at":"2024-10-01T14:52:26.058Z","updated_at":"2025-04-15T18:30:43.748Z","avatar_url":"https://github.com/Wildhoney.png","language":"JavaScript","readme":"\u003cimg src=\"media/logo.png\" alt=\"Webmonkey\" width=\"350\" /\u003e\n\n\u003e Robust and versatile headless monkey testing for the modern web with reproducible steps, error alerts, strategy sharing and many other good things.\n\n![Travis](http://img.shields.io/travis/Wildhoney/Webmonkey.svg?style=for-the-badge)\n\u0026nbsp;\n![npm](http://img.shields.io/npm/v/webmonkey.svg?style=for-the-badge)\n\u0026nbsp;\n![License MIT](http://img.shields.io/badge/license-mit-lightgrey.svg?style=for-the-badge)\n\u0026nbsp;\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)\n\nIt's important to remember that [monkey testing](https://en.wikipedia.org/wiki/Monkey_testing) should be used in conjunction with smarter tests such as [integration tests](https://en.wikipedia.org/wiki/Integration_testing).\n\n![Screenshot](media/screenshot-0.3.5.png)\n\n## Getting Started\n\nOnce `webmonkey` has been installed globally, you can begin testing by supplying the `--url` parameter you'd like to test. As that's the only required field, testing begins immediately and proceeds with 50 actions.\n\n```console\nfoo@bar:~$ webmonkey --url https://news.bbc.co.uk/\n```\n\nFor other parameters you can type `webmonkey --help` at any time.\n\n### Strategy\n\nBy default each action has an equal chance of being chosen at random to be run. However you can tweak this by passing the `--strategy` parameter which allows for a comma separated list of actions followed by how likely they are to be chosen \u0026mdash; for example `--strategy clicker=10,reloader=0` would make clicker 10 times as likely to run than any other action \u0026ndash; aside from reloader which will never run.\n\n### Authenticating\n\nOftentimes you'll want to authenticate before proceeding with the testing. In cases such as these `webmonkey` provides a hooks file where you export two optional functions \u0026mdash; `create` and `destroy` \u0026mdash; you can specify the location of the hooks file with the `--hooks` parameter.\n\nThe hooks file **must** be in the `*.mjs` format \u0026ndash; for instance to authenticate on a fictitious website one might implement the following.\n\n```javascript\nexport const create = async (page) =\u003e {\n    await page.goto('https://www.example.com/');\n    await page.focus('#username');\n    await page.keyboard.type('webmonkey');\n    await page.focus('#password');\n    await page.keyboard.type('monkeynuts');\n    await page.keyboard.press('Enter');\n    await page.waitForNavigation({ waitUntil: 'networkidle0' });\n};\n```\n\n## Meet the Team\n\nCurrently we have the following set of monkeys that perform various actions on your supplied domain:\n\n\u003ctable\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cimg src=\"media/team/clicker.svg\" alt=\"Webmonkey\" width=\"50\" /\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003cstrong\u003eClicker\u003c/strong\u003e\u003c/td\u003e\n        \u003ctd\u003ePerforms clicks in random regions of the visible viewport.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cimg src=\"media/team/networker.svg\" alt=\"Webmonkey\" width=\"50\" /\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003cstrong\u003eNetworker\u003c/strong\u003e\u003c/td\u003e\n        \u003ctd\u003eCycles through a list of preset network conditions.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cimg src=\"media/team/scroller.svg\" alt=\"Webmonkey\" width=\"50\" /\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003cstrong\u003eScroller\u003c/strong\u003e\u003c/td\u003e\n        \u003ctd\u003eScrolls the viewport to different areas of the page.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cimg src=\"media/team/sizer.svg\" alt=\"Webmonkey\" width=\"50\" /\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003cstrong\u003eSizer\u003c/strong\u003e\u003c/td\u003e\n        \u003ctd\u003eRandomly selects a different height and width for the viewport.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cimg src=\"media/team/toucher.svg\" alt=\"Webmonkey\" width=\"50\" /\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003cstrong\u003eToucher\u003c/strong\u003e\u003c/td\u003e\n        \u003ctd\u003eSimilar to the \u003ccode\u003eclicker\u003c/code\u003e action but instead performs touches.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cimg src=\"media/team/typer.svg\" alt=\"Webmonkey\" width=\"50\" /\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003cstrong\u003eTyper\u003c/strong\u003e\u003c/td\u003e\n        \u003ctd\u003eFocuses on random input fields and types random characters.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cimg src=\"media/team/refresher.svg\" alt=\"Webmonkey\" width=\"50\" /\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003cstrong\u003eRefresher\u003c/strong\u003e\u003c/td\u003e\n        \u003ctd\u003eRefreshes the page occasionally.\u003c/td\u003e\n    \u003c/tr\u003e\n\u003c/table\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwildhoney%2Fwebmonkey","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwildhoney%2Fwebmonkey","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwildhoney%2Fwebmonkey/lists"}