{"id":24753868,"url":"https://github.com/codeceptjs/aerokube-plugin","last_synced_at":"2025-03-23T05:12:46.098Z","repository":{"id":41771070,"uuid":"206929982","full_name":"codeceptjs/aerokube-plugin","owner":"codeceptjs","description":"Aerokube Browsers support for CodeceptJS","archived":false,"fork":false,"pushed_at":"2023-01-04T09:20:18.000Z","size":690,"stargazers_count":1,"open_issues_count":17,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-29T10:02:56.593Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://browsers.aerokube.com","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/codeceptjs.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-09-07T07:06:16.000Z","updated_at":"2019-09-08T19:57:32.000Z","dependencies_parsed_at":"2023-02-02T06:45:28.580Z","dependency_job_id":null,"html_url":"https://github.com/codeceptjs/aerokube-plugin","commit_stats":null,"previous_names":["codecept-js/aerokube"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeceptjs%2Faerokube-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeceptjs%2Faerokube-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeceptjs%2Faerokube-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeceptjs%2Faerokube-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codeceptjs","download_url":"https://codeload.github.com/codeceptjs/aerokube-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245056908,"owners_count":20553856,"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":[],"created_at":"2025-01-28T11:36:37.453Z","updated_at":"2025-03-23T05:12:46.077Z","avatar_url":"https://github.com/codeceptjs.png","language":"JavaScript","readme":"# aerokube Plugin\n\nCloud browser testing with [Aerokube Browsers](https://browsers.aerokube.com) in CodeceptJS.\n\n![](https://browsers.aerokube.com/static/media/preview-img.277a0d1d.png)\n\n## API\n\n\u003c!-- Generated by documentation.js. Update this documentation by updating the source code. --\u003e\n\n#### Table of Contents\n\n-   [index](#index)\n-   [Setup](#setup)\n-   [Usage](#usage)\n    -   [WebDriver](#webdriver)\n    -   [Puppeteer](#puppeteer)\n    -   [Parameters](#parameters)\n\n### index\n\nRun WebDriver and Puppeteer tests in [cloud browsers provided by Aerokube](https://browsers.aerokube.com).\n**Aerokube provides lightning fast and comparable cheap browsers** without pain of maintaining own infrastructure.\nThis plugin works with WebDriver and Puppeteer helpers of CodeceptJS.\n\n\u003e If you need to host cloud browsers on your own infrastructure consider browsers in Kubernetes with [Aerokube Moon](https://aerokube.com/moon/)\n\n### Setup\n\nInstall this plugin in CodeceptJS project.\n\n    npm i @codeceptjs/aerokube-plugin --save-dev\n\nEnable the plugin in `codecept.conf.js`\n\n```js\n// codecept.conf.js config \nexports.config = {\n  helpers: {\n     // regular Puppeteer config\n     // or regular WebDriver config\n  },\n  // ....\n  plugins: {\n     aerokube: {\n       require: '@codeceptjs/aerokube-plugin',\n       user: '\u003cusername from aerokube\u003e',\n       password: '\u003cpassword from aerokube\u003e',\n     }\n  } \n}\n```\n\n\u003e It is recommended to use `dotenv` package to store `username` and `password` from Aerokube Browsers. See the config in `example` dir.\n\nTo run tests in cloud, enable this plugin:\n\n    npx codeceptjs run --steps -p aerokube\n\n\u003e To enable aerokube plugin permanently use `enabled: true`.\n\n### Usage\n\n#### WebDriver\n\n-   Desired capabilities are ignored\n\n#### Puppeteer\n\nWe use `webdriverio` library to initialize a browser session and obtain DevTool Protocol API credentials.\n\n-   `windowSize` option is used to set initial window size. Not viewport size.\n-   Chrome starting options are ignored.\n\n#### Parameters\n\n-   `conf`  \n\n## Example Project\n\nTo try aerokube plugin without a project, use the one provided in this repo inside `example` directory.\n\n1.  Register at [Browsers Aerokube](https://browsers.aerokube.com).\n2.  Run `npm install` to install all depdndencies.\n3.  Create `.env` file with the following contents. Username and password should be obtained from Aerokube Browsers.\n    -   `ACCOUNT=\u003cusername from aerokube\u003e`\n    -   `PASSWORD=\u003cpassword from aerokube\u003e`\n4.  Execute tests :\n\n    -   To launch tests in WebDriver \n            npx codeceptjs run -c example --steps\n    -   To launch tests in Puppeteer\n\n            PUPPETEER=true npx codeceptjs run -c example --steps\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeceptjs%2Faerokube-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeceptjs%2Faerokube-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeceptjs%2Faerokube-plugin/lists"}