oTTo was born out of a need for a quick and simple web automation framework for a small project. As the project grew, so did oTTo. It quickly took on a much more coherent form and started to look more complete than the loose gathering of tools hanging off a framework.
There were lots of things that were found along the way, lots of help and hints and tips given and the hope is that by putting this here, others might be able to use it to quickly get something setup for their own purposes and/or get a nice introduction to automation tools and some of the usage. There are READMEs along the way that should explain the basics and a general usage guide that should mean you can get up and running pretty quickly.
oTTo does assume a basic knowledge of Ruby, however this is not difficult to pick up for newcomers and the community is very helpful. Remember, no question is a stupid question! There are also some cheatsheets included with oTTo which might come in handy.
Some of the main tech used under the hood
oTTo is currently only optomised for use on MAC OSX so might not function as intended on Windows machines (and the install will be different) but this is something that is high on the list of issues to address
Whilst the automatic install is very useful...NEVER INSTALL A RANDOM SCRIPT FROM ANYWHERE! READ THE setup_script FILE BEFORE DOING ANYTHING
To automatically install all components for oTTo
./setup_script 2>&1 | tee ~/setup_script.logYou will need to get the specified version of Ruby (currently v2.6.0) as well as installing RVM for Ruby version management.
You will also need to install all the additional RubyGems listed in the Gemfile using the bundler gem built in to Ruby. This will generate a Gemfile.lock and this will set all the Gem versions for your project. Do not delete this unless you plan to update.
Currently oTTo supports all Ruby v2.X.x. Ruby 3 is not currently supported but it is planned to be!
curl -L https://get.rvm.io | bash -s stable
rvm install 2.6.0 # new shell
rvm use ruby-2.6.0
rvm --default ruby-2.6.0 # new shell
bundle installEnsure you have Homebrew installed by checking
brew --versionIf you do not have a valid version of Homebrew then you will need to install it. There are excellent instructions for installation on their webpage so no need to reproduce here.
You might need to also install some drivers for Selenium to use
brew cask install chromedriver
brew install geckodriverIf an alternate version of Ruby is installed (Mojave comes with Ruby 2.5.1 pre bundled for example) then you may need to uninstall this before use using. Check the versions of Ruby installed using
ruby --versionand if you have anything other than than version you installed in the setup above
brew uninstall rubyYou will also need to ensure that you have installed Cucumber Standalone JSON Formatter as per their instructions on the Github page
https://github.com/cucumber/cucumber/tree/master/json-formatter#cucumber-json-formatter
If you do not install this correctly then you will fall into trouble with the reporting element of this tool.
For adding to your PATH, this page may be of some help
https://www.architectryan.com/2012/10/02/add-to-the-path-on-mac-os-x-mountain-lion/
The basic usage of oTTo is running a single script, scripts/test.sh. This is a bash script and is run from the home directory using
sh scripts/test.shThis will take configuration options passed in by the user and use them to run the specified BDD features.
To see how to configure the script check out the README which goes into detail about each part of the script and what it is used for.
The script runs several tasks from the Rakefile including the test, rerun and report tasks. All of these can be run in isolation if needed/wanted using the command
rake <task name>This task is responsible for actually running the testing. It is constructed using Rake syntax for a Cucumber command
It uses the test.sh script to construct a Cucumber syntax command. The options are the specific tags to be run and the default text is to output a json file of results used by the report builder as well as a text file designed to keep track of failed test items. This constructs and runs the command
cucumber -t <tag> --format pretty --expand --format=message -o 'test_report.ndjson' -f rerun --out rerun.txt --publish-quietAlternative Cucumber commands can be added to this file in this format if you wish to.
This is very similar to rake test however, as you would expect, it runs the failed tests from the initial run. It requires you to have already run rake test, or at least have a rerun.txt file available with failures listed, as this is where it draws from instead of Cucumber tags. It constructs and runs the command
cucumber @rerun.txt --format pretty --expand --format=message -o 'retest_report.ndjson' --publish-quiet'This is a very simple rake task that simply runs the script './lib/report_builder.rb' (which you will notice is defined at the top of the file)
This generates an easy to read html report (see the lib README for more information)
Runs the unit tests (see the unit_tests README)
oTTo could not have been put together without the help of many people along the way.
This isn't complete or perfect but hey, nothing ever is! If you want to contribute to oTTo that would be great! Please do contribute in any way that makes this a better tool or teaching/learning aid 😊 All we ask is that you follow the normal kind of things, Code of Conduct and Contributing and then you can win a place on the coveted List of Contributors! ("ooo, it's so shiny!")
Contributors:
- Jullian Tellez
- Kieren Brown
- Adam Vincent
- Joseph Hughes