{"id":19935054,"url":"https://github.com/nickersoft/oa","last_synced_at":"2025-05-03T12:30:58.125Z","repository":{"id":178469809,"uuid":"661900054","full_name":"Nickersoft/oa","owner":"Nickersoft","description":"Dead-simple monkey testing on the command-line 🦍","archived":false,"fork":false,"pushed_at":"2023-12-21T18:33:32.000Z","size":1215,"stargazers_count":10,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-07T15:54:37.735Z","etag":null,"topics":["command-line","end-to-end-testing","monkey-testing","performance","puppeteer","sellenium","testing"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Nickersoft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2023-07-03T23:40:51.000Z","updated_at":"2024-12-19T08:17:32.000Z","dependencies_parsed_at":"2023-12-15T15:42:46.724Z","dependency_job_id":"4fbf24a5-6d07-4171-b5a0-d80612bf4fee","html_url":"https://github.com/Nickersoft/oa","commit_stats":null,"previous_names":["nickersoft/oa"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nickersoft%2Foa","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nickersoft%2Foa/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nickersoft%2Foa/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nickersoft%2Foa/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Nickersoft","download_url":"https://codeload.github.com/Nickersoft/oa/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252190658,"owners_count":21708919,"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":["command-line","end-to-end-testing","monkey-testing","performance","puppeteer","sellenium","testing"],"created_at":"2024-11-12T23:18:39.037Z","updated_at":"2025-05-03T12:30:57.675Z","avatar_url":"https://github.com/Nickersoft.png","language":"TypeScript","readme":"![Logo](./logo.png)\n\n`oa` (short for [\"ooh ooh ah ah\"](https://www.youtube.com/watch?v=yb8ZAP5JCuk)) is a simple command-line tool for monkey testing frontend applications. \n\n[Monkey testing](https://en.wikipedia.org/wiki/Monkey_testing) is a technique in which random click, input and keyboard events are sent to an application to test its resilience. In other words, as if a monkey was using it. Monkey testing can also be helpful for adding an increased load to the application to debug performance and memory bottlenecks.\n\nUnlike other load testing tools, `oa` uses [Puppeteer](https://pptr.dev) under-the-hood to run your website in a real browser environment. While the browser is hidden by default, you can choose to show it via the `--show` flag.\n\n**Disclaimer: this tool is intended primarily for use on local websites. Attempting to run `oa` on a hosted website, especially one you don't own, is a good way to get your IP blocked.**\n\n## Installation \n\nUntil official binaries can be released, the easiest way to install `oa` is from Deno itself:\n\n```bash\ndeno install --allow-env --allow-write --allow-read --allow-run --allow-net https://deno.land/x/oa2\n```\n\n## Usage\n\nUsing `oa` is fairly straightforward. You can test a website using the default options by just passing the URL to the command:\n\n```bash\noa http://127.0.0.1:8080/login\n```\n\n## Flags\n\n`oa` supports a few flags to customize its behavior:\n\n| Name              | Alias | Description                                                                              | Default |\n| ----------------- | ----- | ---------------------------------------------------------------------------------------- | ------- |\n| `--show`          | `-s`  | Show the browser window while testing.                                                   | `false` |\n| `--num`           | `-n`  | The number of monkeys/instances to run.                                                  | 1       |\n| `--duration`      | `-d`  | The duration to run the test. Supports human-readable times such as '5m', '1 hour', etc. | 10s     |\n| `--header`        | `-H`  | HTTP header to pass to the browser. Can be used multiple times.                          |         |\n| `--cookie`        | `-c`  | Cookie string to pass to the browser. Can be used multiple times.                        |         |\n| `--skip-links`    | `-L`  | Skip clicking on links.                                                                  | `false` |\n| `--skip-inputs`   | `-I`  | Skip filling in inputs.                                                                  | `false` |\n| `--skip-clicking` | `-C`  | Skip random clicking on the page.                                                        | `false` |\n| `--skip-buttons`  | `-B`  | Skip clicking on buttons.                                                                | `false` |\n| `--filter-links`  | `-l`  | Only click on links that contain the provided string.                                    |         |\n| `--config-file`   | `-F`  | Path to a configuration file.                                                            |         |\n\n## Configuration File\n\nYou can also pass a `oa.config.json` configuration file to `oa` to specify the above options as well:\n\n```json\n{\n  \"$schema\": \"./oa.schema.json\",\n  \"url\": \"http://127.0.0.1:8080/login\",\n  \"show\": false,\n  \"cookies\": [\n    {\n      \"name\": \"Key\",\n      \"value\": \"Value\",\n      \"expiresIn\": 5000,\n      \"domain\": \"facebook.com\"\n    }\n  ],\n  \"headers\": {\n    \"Key\": \"Value\"\n  },\n  \"targets\": {\n    \"links\": {\n      \"enabled\": true,\n      \"filter\": \"/read/1\"\n    },\n    \"buttons\": {\n      \"enabled\": true\n    },\n    \"inputs\": {\n      \"enabled\": true\n    },\n    \"clicking\": {\n      \"enabled\": true\n    },\n    \"typing\": {\n      \"enabled\": true\n    }\n  }\n}\n```\n\nIn this case, you just need to run `oa` to start the monkeys. Unless the `--config-file` flag is used, `oa` will look in the current directory for a `oa.config.json` file.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickersoft%2Foa","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnickersoft%2Foa","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickersoft%2Foa/lists"}