tir-framework

TIR - Test Interface Robot

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

Current Supported Technologies

• Protheus Webapp
• APW

Table of Contents

Documentation
Installation
Config
Usage
Docker
Samples
Contact Us
Contributing

Documentation

Our documentation can be found here:

• TIR Documentation

• TIR Technical 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 the doc_files/build/html folder.

Installation

The installation is pretty simple. All you need as a requirement is Python 3.7.9 (Mozilla Firefox) installed in your system.

There are three ways of installing TIR:

1. Installing and Upgrade from PyPI

TIR can be installed via pip from Pypi

pip install tir_framework --upgrade

2. via Terminal(Deprecated For The Branch Master)

You can install TIR via the terminal. Make sure your Python and Git are 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 into your Test Case. See the following example:

Protheus WebApp Class

Samples

We have a repository with different samples of TIR scripts:

TIR Script Samples

Utilizando TIR com ambiente virtual

Conhecendo o conceito

Para execução do TIR em ambiente virtual, utilizaremos a biblioteca Virtualenv. Essa é uma ferramenta usada em Python para criar ambientes isolados. Cada ambiente virtual tem seus próprios diretórios de instalação de pacotes, separados do ambiente global do sistema. Isso é útil para gerenciar dependências de diferentes projetos/versões sem conflito.

Configurando com VScode

Instalando a biblioteca e Criando o ambiente

1. No terminal, execute o comando pip install virtualenv para instalar a biblioteca de ambiente virtual.

2. Ainda no terminal, execute o comando python -m virtualenv venv para criação de um ambiente no diretório atual.

Nota: Caso você possua mais de uma versão de Python instalada pode ser necessário especificar a versão desejada. Verifique o caminho de instalação do executável e referencie ele no comando Exemplo: C:/caminho/python/python -m virtualenv venv

Por padrao a pasta de instalaçao do Pyhon fica em C:\Users[user]\AppData\Local\Programs\Python\Python[version].

1. Será adicionada uma pasta (venv) no diretório atual , com isso o ambiente estará pronto para utilização.

Configurando o Vscode

Após a configuração do ambiente virtual iremos definir o interpretador do VScode para utiliza-lo

1. Com o VScode aberto na pasta do projeto, pressione Ctrl + Shift + P e pesquise pela opção >Python: Select Interpreter

2. Na lista de interpretadores reconhecidos no sistema, selecione o interpretador anteriormente criado, caminho padrão é: ./venv/Scripts/python.exe . Ao selecionar, o interpretador padrao utilizado se tornara esse, caso deseje utilizar outro é só seleciona-lo na lista.

3. Abra um novo terminal no Vscode indo em "Terminal" e "Novo terminal"

4. Ao abrir o terminal veja se está inicializada a venv na linha de comando.

5. Agora rode o comando para instalação do TIR! pip install tir_framework

6. Pronto! Agora seu tir esta pronto para executar em um ambiente isolado!.

Contact

Gitter

Contributing

To contribute be sure to follow the Contribution guidelines.

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