Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joshdk/chromatic
🍪 Configurable human assisted Chrome automation
https://github.com/joshdk/chromatic
automation chrome chrome-debugger-protocol chrome-devtools go golang google-chrome
Last synced: about 1 month ago
JSON representation
🍪 Configurable human assisted Chrome automation
- Host: GitHub
- URL: https://github.com/joshdk/chromatic
- Owner: joshdk
- License: mit
- Created: 2018-07-10T03:11:25.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-15T04:57:06.000Z (over 3 years ago)
- Last Synced: 2024-09-30T17:03:34.677Z (about 2 months ago)
- Topics: automation, chrome, chrome-debugger-protocol, chrome-devtools, go, golang, google-chrome
- Language: Go
- Homepage:
- Size: 337 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[![CircleCI][circleci-badge]][circleci-link]
[![Go Report Card][go-report-card-badge]][go-report-card-link]
[![License][license-badge]][license-link]
# Chromatic
🍪 Configurable human assisted Chrome automation
## Installing
### From source
You can use `go get` to install this tool by running:
```bash
$ go get -u github.com/joshdk/chromatic
```
## Motivations
There are certain services that require programmatic interaction, but otherwise make it difficult. Web-only APIs, [CAPTCHAs](https://en.wikipedia.org/wiki/CAPTCHA), and MFA are a few examples of things that might not work well with typical automation.
This tool, `chromatic`, implements an escape-hatch around these difficulties. It can be configured to open up a Chrome window to a given starting URL, and will continue to be interactive until a given set of ending conditions are met, at which time the Chrome window will close. This user interaction is typically a login flow.
When `chromatic` exits, it will dump details about the last visited page as json. This json (and the session data contained within) is meant to be consumed by additional automation.
## Usage
In this example we will use `chromatic` to extract and consume a web session for CircleCI.
### Configuration
The following [`examples/circleci.yml`](https://github.com/joshdk/chromatic/blob/master/examples/circleci.yml) will launch Chrome to CircleCI's Github/Bitbucket authorization page.
```yaml
start:
url: https://circleci.com/vcs-authorize/
end:
timeout: 60
url: https://circleci.com/dashboard
cookie:
name: ring-session
domain: circleci.com
title: CircleCI
```
### Interaction
You can then login to Github using your username, password, & maybe an MFA code. When you eventually login and are redirected to your CircleCI dashboard, `chromatic` will check if the desired URL, title, & cookie match the current page.
### Output
Once a match is found, Chrome will exit successfully and `chromatic` will dump details about the last page as json.
```
$ chromatic examples/circleci.yml | tee page.json
{
"url": "https://circleci.com/dashboard",
"title": "CircleCI",
"cookies": [
{
"name": "ring-session",
"domain": "circleci.com",
"value": "vKAm...72Af"
}
...
]
}
```
### Consumption
Using this output, the session value can be stored and later used with the web API.
```
$ SESSION="$(cat page.json | jq -r '.cookies[] | select(.name=="ring-session") | .value')"
$ echo $SESSION
vKAm...72Af
$ curl -H "Cookie: ring-session=$SESSION" https://circleci.com/api/v1/me
{
"name" : "...",
"selected_email" : "...",
...
}
```
## License
This library is distributed under the [MIT License][license-link], see [LICENSE.txt][license-file] for more information.
[circleci-badge]: https://circleci.com/gh/joshdk/chromatic.svg?&style=shield
[circleci-link]: https://circleci.com/gh/joshdk/chromatic/tree/master
[go-report-card-badge]: https://goreportcard.com/badge/github.com/joshdk/chromatic
[go-report-card-link]: https://goreportcard.com/report/github.com/joshdk/chromatic
[license-badge]: https://img.shields.io/badge/license-MIT-green.svg
[license-file]: https://github.com/joshdk/chromatic/blob/master/LICENSE.txt
[license-link]: https://opensource.org/licenses/MIT