Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/clj-commons/etaoin

Pure Clojure Webdriver protocol implementation
https://github.com/clj-commons/etaoin

chrome clojure firefox phantom safari webdriver

Last synced: about 1 month ago
JSON representation

Pure Clojure Webdriver protocol implementation

Awesome Lists containing this project

README 

        

image::art/pattern-small.jpg[]



= Etaoin

:toclevels: 4

:project-src-coords: clj-commons/etaoin

:project-mvn-coords: etaoin/etaoin

:url-webdriver: https://www.w3.org/TR/webdriver/

:url-short-story: https://archive.org/details/Unknown_v05n05_1942-02_slpn/page/n66/mode/1up

:url-doc: https://cljdoc.org/d/{project-mvn-coords}

:url-slack: https://clojurians.slack.com/messages/C7KDM0EKW/



// Badges

link:{url-doc}[image:https://cljdoc.org/badge/{project-mvn-coords}[cljdoc]]

https://github.com/{project-src-coords}/actions/workflows/test.yml[image:https://github.com/{project-src-coords}/actions/workflows/test.yml/badge.svg[GitHub Actions Tests]]

https://clojars.org/{project-mvn-coords}[image:https://img.shields.io/clojars/v/{project-mvn-coords}.svg[Clojars project]]

https://babashka.org[image:https://raw.githubusercontent.com/babashka/babashka/master/logo/badge.svg[bb compatible]]

https://clojurians.slack.com/archives/C7KDM0EKW[image:https://img.shields.io/badge/slack-join_chat-brightgreen.svg[Join chat]]



A pure Clojure implementation of the link:{url-webdriver}[Webdriver] protocol, named after link:{url-short-story}[Etaoin Shrdlu] -- a typing machine that came to life after a mysterious note was produced on it.



Use the Etaoin library to automate a browser, test your frontend behaviour, simulate human actions or whatever you want.



== Benefits



* Selenium-free: no big dependencies, no tons of downloaded jars, etc.

* Lightweight, fast.

Simple, easy to understand.

* Compact: just one main namespace with a couple of helpers.

* Declarative: the code is just a list of actions.



== Capabilities



* Currently supports Chrome, Firefox, Safari and Edge.

* Can either connect to a remote WebDriver process, or have Etaoin launch one for you.

* Run your unit tests directly from Emacs by pressing `C-t t` as usual.

* Can imitate human-like behaviour (delays, typos, etc).



== Documentation



API docs and articles are best viewed on link:{url-doc}[cljdoc]:



* link:doc/01-user-guide.adoc[User Guide]

* link:doc/02-developer-guide.adoc[Developer Guide]



See also:



:ui-test: http://grishaev.me/en/ui-test

:stream: https://www.youtube.com/watch?v=cLL_5rETLWY



* link:{url-slack}[Slack channel]

* link:{ui-test}[Thoughts on UI tests]

Ivan's blog-post about pitfalls that can occur when testing UI.

* link:{stream}[Live-coding session] where Ivan works through some Etaoin issues.



== Who uses Etaoin?



Some companies:



* https://www.exoscale.com/[Exoscale]

* https://www.flyerbee.com/[Flyerbee]

* http://www.barrick.com/[Barrick Gold]

* http://drevidence.com/[Doctor Evidence]

* https://kevel.com/[Kevel (formerly Adzerk)]

* https://www.rate.com/[Guaranteed Rate]



Some examples usages:



* Control a https://github.com/DaniruKun/spacex-iss-docking-sim-autopilot[SpaceX ISS Docking Simulator].

* Automatically https://github.com/babashka/book/blob/9853d7ed1d72b328e30342f546071cd450035a3f/script/watch.clj[watch/refresh] the browser when making edits to https://book.babashka.org/[Babashka book].

* Generate contributor badges for https://github.com/clj-commons/rewrite-clj#people[rewrite-clj], https://github.com/cljdoc/cljdoc#contributors[cljdoc] and https://github.com/lread/test-doc-blocks#people[test-doc-blocks] via a https://github.com/clj-commons/rewrite-clj/blob/1795a71b7f8937a1482cf63de7f8dd90579c2007/script/doc_update_readme.clj[doc-update-readme babashka task].

* https://github.com/borkdude/re-find.web/blob/1a2cc409b2f2791324798f6e1adb13efc244b3e2/test/re_find/web_test.clj[Test browser behavior] for https://borkdude.github.io/re-find.web/[re-find.web].

* https://github.com/quil/quil/blob/1f214e712d834ede311fdc652eafe9cc0232c96e/test/clj/quil/snippet.clj#L159[Test browser interactions] for https://github.com/quil/quil[Quil].

* https://github.com/jarcane/clojurice/blob/96f6af795636903b543b9f29aaea586c49a776c6/test/clj/app/test/integration.clj[Integration tests] for https://github.com/jarcane/clojurice[clojurice].



You are most welcome to submit your company or project to this list.



== Versioning



Eatoin uses: `major`.`minor`.`patch`-`test-qualifier`



* `major` increments when a non alpha release API has been broken - something, as a rule, we'd like to avoid.

* `minor` increments to convey significant new features have been added.

* `patch` indicates bug fixes or minor changes - it is the total number of releases to date.

* `test-qualifier` is absent for stable releases.

Can be `alpha`, `beta`, `rc1`, etc.



== People



=== Contributors



* https://github.com/Uunnamed[Alexey Shipilov]

* https://github.com/AdamFrey[Adam Frey]

* https://github.com/jwkoelewijn[JW Koelewijn]

* https://github.com/nenadalm[Miloslav Nenadál]

* https://github.com/atsman[Aleh Atsman]

* https://github.com/marco-m[Marco Molteni]

* https://github.com/nebesnytihohod[Maxim Stasenkov]

* https://github.com/daveyarwood[Dave Yarwood]

* https://github.com/jkrasnay[John Krasnay]

* https://github.com/kidd[Raimon Grau]

* https://github.com/verma[Uday Verma]

* https://github.com/mjmeintjes[Matt Meintjes]

* https://github.com/tupini07[Andrea Tupini]

* https://github.com/dgr[Dave Roberts]



=== Current Maintainers



* https://github.com/lread[Lee Read]

* https://github.com/borkdude[Michiel Borkent]



=== Founder



* https://github.com/igrishaev[Ivan Grishaev]



Etaoin is open for your improvements and ideas.

If any of unit tests fail on your machine, please submit an issue giving your OS version, browser and console output.



== License



Copyright © 2017—2020 Ivan Grishaev.



Distributed under the Eclipse Public License either version 1.0 or (at your option) any later version.