{"id":20932438,"url":"https://github.com/testingbot/karma-testingbot-launcher","last_synced_at":"2025-03-13T02:18:52.163Z","repository":{"id":141991901,"uuid":"44821190","full_name":"testingbot/karma-testingbot-launcher","owner":"testingbot","description":"Karma Launcher for TestingBot.com","archived":false,"fork":false,"pushed_at":"2021-06-07T12:27:53.000Z","size":40,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-19T19:17:41.591Z","etag":null,"topics":["karma","karma-launcher","testingbot","webdriver"],"latest_commit_sha":null,"homepage":null,"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/testingbot.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2015-10-23T15:22:12.000Z","updated_at":"2023-06-23T11:40:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"7c59989d-06ca-4c27-9796-90ac4905db75","html_url":"https://github.com/testingbot/karma-testingbot-launcher","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testingbot%2Fkarma-testingbot-launcher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testingbot%2Fkarma-testingbot-launcher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testingbot%2Fkarma-testingbot-launcher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testingbot%2Fkarma-testingbot-launcher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/testingbot","download_url":"https://codeload.github.com/testingbot/karma-testingbot-launcher/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243324504,"owners_count":20273113,"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":["karma","karma-launcher","testingbot","webdriver"],"created_at":"2024-11-18T21:48:37.720Z","updated_at":"2025-03-13T02:18:52.144Z","avatar_url":"https://github.com/testingbot.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# karma-testingbot-launcher\n\n[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/karma-runner/karma-testingbot-launcher)\n [![npm version](https://img.shields.io/npm/v/karma-testingbot-launcher.svg?style=flat-square)](https://www.npmjs.com/package/karma-testingbot-launcher) [![npm downloads](https://img.shields.io/npm/dm/karma-testingbot-launcher.svg?style=flat-square)](https://www.npmjs.com/package/karma-testingbot-launcher)\n\n[![Build Status](https://img.shields.io/travis/testingbot/karma-testingbot-launcher/master.svg?style=flat-square)](https://travis-ci.org/testingbot/karma-testingbot-launcher) [![Dependency Status](https://img.shields.io/david/karma-runner/karma-testingbot-launcher.svg?style=flat-square)](https://david-dm.org/karma-runner/karma-testingbot-launcher) [![devDependency Status](https://img.shields.io/david/dev/karma-runner/karma-testingbot-launcher.svg?style=flat-square)](https://david-dm.org/karma-runner/karma-testingbot-launcher#info=devDependencies)\n\n\n\u003e Run your tests on the [TestingBot](https://testingbot.com/) browser cloud!\n\n\n## Installation\n\nInstall `karma-testingbot-launcher` as a `devDependency` in your package.json:\n\n```bash\nnpm install karma-testingbot-launcher --save-dev\n```\n\n## Usage\n\nThis launcher is used to run your tests across many browsers and platforms on TestingBot. Typically this runner is used in a CI (Continuous Integration) system.\n\n### Adding karma-testingbot-launcher to an existing Karma config\n\nTo use and configure this launcher, you will need to add two properties to your top-level Karma config, `testingbot` and `customLaunchers`, set the `browsers` array to use TestingBot browsers, and add the `testingbot` reporter.\n\nThe `testingbot` object defines global properties for each browser/platform while the `customLaunchers` object configures individual browsers. The `testingbot` reporter will send back the test success state to https://testingbot.com. Here is a sample Karma config to get the launcher running:\n\n```js\nmodule.exports = function(config) {\n  // Check out https://testingbot.com/support/getting-started/browsers.html for all browser possibilities\n  var customLaunchers = {\n    TB_chrome: {\n      base: 'TestingBot',\n      browserName: 'chrome',\n      platform: 'Windows 7',\n      version: '35'\n    },\n    TB_firefox: {\n      base: 'TestingBot',\n      browserName: 'firefox',\n      version: '30'\n    }\n  }\n\n  config.set({\n\n    // The rest of your karma config is here\n    // ...\n    testingbot: {\n        testName: 'Web App Unit Tests'\n    },\n    customLaunchers: customLaunchers,\n    browsers: Object.keys(customLaunchers),\n    reporters: ['dots', 'testingbot'],\n    singleRun: true\n  })\n}\n```\n\n**Note: this config assumes that `process.env.TB_KEY` and `process.env.TB_SECRET` are set.**\n\n## `testingbot` config properties shared across all browsers\n\n### apiKey\nType: `String`\nDefault: `process.env.TB_KEY`\n\nYour TestingBot api key, you can sign up [here](https://testingbot.com/users/sign_up).\n\n### apiSecret\nType: `String`\nDefault: `process.env.TB_SECRET`\n\nYour TestingBot api secret which you will see on your [account page](https://testingbot.com/members).\n\n### startConnect\nType: `Boolean`\nDefault: `true`\n\nIf `true`, TestingBot Tunnel will be started automatically. Set this to `false` if you are launching tests locally and want to start TestingBot manually.\n\n### connectOptions\nType: `Object`\nDefault:\n```js\n{\n  apiKey: 'apiKey',\n  apiSecret: 'apiSecret',\n  tunnelIdentifier: 'tunnelId' //optional\n}\n```\n\nOptions to send to TestingBot. Check [here](https://testingbot.com/support/other/test-options) for all available options.\n\n### seleniumHost\nType: `String`\ndefault: `hub.testingbot.com`\n\n### seleniumPort\nType: `Number`\ndefault: `80`\n\n### build\nType: `String`\nDefault: *One of the following environment variables*:\n`process.env.BUILD_NUMBER`\n`process.env.BUILD_TAG`\n`process.env.CI_BUILD_NUMBER`\n`process.env.CI_BUILD_TAG`\n`process.env.TRAVIS_BUILD_NUMBER`\n`process.env.CIRCLE_BUILD_NUM`\n`process.env.DRONE_BUILD_NUMBER`\n\nID of the build currently running. This should be set by your CI.\n\n### testName\nType: `String`\nDefault: `'Karma test'`\n\nName of the unit test group you are running.\n\n### tags\nType: `Array of Strings`\n\nTags to use for filtering jobs in your TestingBot account.\n\n### tunnelIdentifier\nType: `String`\n\nTestingBot Tunnel can proxy multiple sessions, this is an id of a tunnel session.\n\n\n### screenrecorder\nType: `Boolean`\nDefault: `false`\n\nSet to `true` if you want to record a video of your Karma session.\n\n### screenshots\nType: `Boolean`\nDefault: `true`\n\nSet to `false` if you don't want to record screenshots.\n\n### public\nType: `String`\nDefault: `null`\n\nControl who can view job details.\n\n## `customLaunchers` config properties\n\nThe `customLaunchers` object has browser names as keys and configs as values. Documented below are the different properties which you can configure for each browser/platform combo.\n\n*Note: You can learn about the available browser/platform combos on the [TestingBot browsers page](https://testingbot.com/support/getting-started/browsers.html).*\n\n### base\nType: `String`\nRequired: `true`\n\nThis defines the base configuration for the launcher. In this case it should always be `TestingBot` so that browsers can use the base TestingBot config defined at the root `testingbot` property.\n\n### browserName\nType: `String`\nRequired: `true`\n\nName of the browser.\n\n### version\nType: `String`\nDefault: Latest browser version for all browsers\n\nVersion of the browser to use.\n\n### platform\nType: `String`\nDefault: `'Linux'` for Firefox/Chrome, `'Windows 7'` for IE/Safari\n\nName of platform to run browser on.\n\n### deviceOrientation\nType: `String`\nDefault: `'portrait'`\n\nAccepted values: `'portrait' || 'landscape'`\n\nSet this string if your unit tests need to run on a particular mobile device orientation for Android Browser or iOS Safari.\n\n## More Information\n\nYou can find more information on our website regarding [TestingBot Tunnel](https://testingbot.com/support/other/tunnel)  and [Karma](https://testingbot.com/support/getting-started/karma.html).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftestingbot%2Fkarma-testingbot-launcher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftestingbot%2Fkarma-testingbot-launcher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftestingbot%2Fkarma-testingbot-launcher/lists"}