sakuli

                                        
Sakuli is an end-2-end testing and monitoring tool for web sites and common UIs with multiple monitoring integrations

                    

        
        

            
            

                

    

    
:sakuli-latest-version: v1.2.0
:sakuli-doc-base-url: http://consol.github.io/sakuli
:sakuli-doc-url: {sakuli-doc-base-url}/latest


= Attention: EOL of Sakuli 1


Sakuli was completely rewritten in node and typescript and is now available in version 2:


https://sakuli.io


https://github.com/sakuli


There will be no further maintenance of Sakuli 1, it is easily possible and suggested to migrate existing tests to Sakuli 2.


image:./docs/images/sakuli_logo_small.png[sakuli-logo]


An end-to-end testing tool for web sites and common UIs with multiple monitoring integrations


= About the project
image:./docs/images/sakuli_concept.png[sakuli concept]


Sakuli simulates user actions on graphical user interfaces (web, fat client, citrix, …), and provides the obtained information (runtime, result, screenshots) to third party (e.g. Nagios compatible monitoring) systems.


Sakuli is written in Java and runs on many platforms:


    

  • {sakuli-doc-url}/#windows[Windows]
    • 

  • {sakuli-doc-url}/#linux[Linux]
    • 

  • {sakuli-doc-url}/#containerized-execution[Docker containers]
    • 

  • MacOS
    • 



The Sakuli project brings together two Open-Source end-to-end testing tools which perfectly fit together: http://www.sahi.co.in/[Sahi] for web-based tests (by injecting JavaScript code into the browser), as well as the screenshot-based testing tool http://sikulix.com/[Sikuli], which allows the execution of keyboard and mouse actions on screen areas that have been defined by previously recorded screenshots and are recognized using the OpenCV engine.


= Key Features


    

  • Platform-independent UI testing tool
    • 

  • End-2-End monitoring of application functionality and quality
    • 

  • Combines two automation technologies:
 DOM based web testing
 Image pattern based UI automation (for non-web content)
    • 

  • Scalable from single-client up to multi-node container setup for parallel execution
    • 

  • Integration of test results into
 Monitoring systems (e.g. Nagios/Icinga)
 CI builds (e.g. Jenkins)
    • 



= Documentation
The complete versions of our documentation you can find under:


{sakuli-doc-base-url}[consol.github.io/sakuli]


* Dev version:* latest vX.X.X-SNAPSHOT version


* Stable/Latest version: {sakuli-doc-url}[{sakuli-latest-version}]*


= Quick links


http://www.sakuli.org/[Project Homepage - www.sakuli.org]


{sakuli-doc-url}/#download[Download]


{sakuli-doc-url}/#examples[Sakuli Examples]


https://labs.consol.de/tags/sakuli/[Blog Entries]


{sakuli-doc-url}/#publications[Publications]


{sakuli-doc-url}/#events[Events]


{sakuli-doc-url}/#media[Media]


{sakuli-doc-url}/#changelog[Change Log]


{sakuli-doc-url}/#support[Support]


image:./docs/images/twitter_birdlogo.png[twitter logo] https://twitter.com/sakuli_e2e[@sakuli_e2e]


= Sakuli Short Overview Presentation


[link={sakuli-doc-url}/files/Sakuli_Short_Overview.pdf]
image::./docs/images/Sakuli_Short_Overview.png[Sakuli Short Overview Presentation]


= Sakuli UI Introduction


video::5RJY_FD6YvQ[youtube]


https://github.com/ConSol/sakuli-ui[]




image::./docs/images/bmi_logo_eng.png[Supported by Federal Ministry for Economic Affairs and Energy]