TIR - Totvs Interface Robot

TIR is a Python module used to create test scripts for web interfaces. With it, you are able to easily create and execute test suites and test cases for any supported Totvs' web interface systems, such as Protheus Webapp.

Current Supported Technologies

Protheus Webapp
APW

Documentation
Installation
Config
Usage
Samples
Contact Us
Contributing

Documentation

Our documentation can be found here:

TIR Documentation

This project has a docs folder with Sphinx files.

Our create_docs.cmd script handles the installation of dependencies and creates the offline documentation on doc_files/build/html folder.

Installation

The installation is pretty simple. All you need as a requirement is Python 3.6 or greater and a browser (Mozilla Firefox/Google Chrome) installed in your system.

There are three ways of installing TIR:

1. Installing from PyPI

TIR can ben installed via pip from Pypi

pip install tir_framework

2. via Installation Wizard

Our installation wizard handles the environment setup, the package installation and also it can update your package.

Download TIR Installer

It is also an open-source project, you can see the repository here

OBS: Our installation wizard will install our package in the current active Python instance. If you're willing to use Python's virtual environment in your machine, please be sure that the virtual environment is active before installing our package.

3. via Terminal

You can install TIR via terminal. Make sure your Python and Git is installed and run this command:

pip install git+https://github.com/totvs/tir.git --upgrade

It will install the last release of TIR in the active Python instance.

Config

The environment must be configured through a config.json file. You can find one to be used as a base in this repository. To select your file, you can either put it in your workspace or pass its path as a parameter of any of our classes' initialization.

Config options

Here you can find all the supported keys: Config.json keys

Custom config path

Just pass the path as a parameter in your script:

Protheus WebApp Class example:

#To use a custom path for your config.json
test_helper = Webapp("C:\PATH_HERE\config.json")

Usage

After the module is installed, you could just import it on your Test Case. See the following Protheus WebApp Class example:

# Import from our package the class you're going to use
from tir import Webapp

test_helper = Webapp()
test_helper.Setup('SIGAGCT','10/08/2017','T1','D MG 01 ','05')
test_helper.Program('CNTA010')

test_helper.SetButton('Cancelar')
test_helper.AssertTrue()

test_helper.TearDown()

Samples

We have a repository with different samples of TIR scripts:

TIR Script Samples

Contact

Gitter

Contributing

In order to contribute be sure to follow the Contribution guidelines.

Also, it's import to understand the chosen architecture.

Wilson08/tir