Trace Feature

Instalação

Virtualenv

1. Instale o Pip

Para visualizar se você possui o pip instalado, use:

pip --version

Caso não tenha o pip instalado, use:

sudo apt-get install python3-pip

2. Instale o Virtualenv

Para visualizar se você possui o virtualenv instalado, use:

virtualenv --version

Caso não tenha o pip instalado, use:

sudo pip3 install virtualenv

3. Crie um Virtualenv com Python3

virtualenv -p python3 env

4. Entre no Virtualenv

Entre na pasta que contém seu virtualenv e use:

source env/bin/activate

5. Instalação da ferramenta

Temos duas formas de executar o trace feature: utilizando o pacote trace-feature ou clonando o repositório.

---

Utilizando o pacote trace-feature:

Após criar um virtualenv execute o seguinte comando:

$ pip install trace-feature

---

Utilizando o projeto clonado localmente:

Após criar um virtualenv, navegue até o diretório trace_feature e execute o seguinte comando:

$ pip install .

Instale outras dependências do projeto:

$ pip install -r requirements.txt

---

Execução do projeto:

Para executar o projeto, use o comando:

trace-feature -f [feature] -s [linha do cenário] -u [url do servidor]

Os argumentos são opcionais e não precisam ser especificados depois do comando. Vale lembrar também que para que o comando seja executado sem parâmetros, é necessário navegar até a pasta do projeto onde se deseja executar a ferramenta.

Para obter ajuda sobre o comando e os argumentos, basta usar

trace-feature --help

Para execução completa da análise de features e métodos, devemos subir o servidor de análise de dados, com código fonte disponível aqui. Então, devemos executar esta ferramenta na seguinte ordem:

Primeiramente instalar Excellent:

gem install excellent

Então devemos incluir um arquivo de configuração onde vamos definir os dados que deverão ser obtidos pela gema Excellent. Para isso, crie um arquivo chamado .excellent.yml na pasta raíz do projeto analisado. Então inclua as seguintes linhas no arquivo:

AbcMetricMethodCheck: True
CyclomaticComplexityMethodCheck:
      threshold: 0
MethodLineCountCheck:
      threshold: 0

Feito isso, execute:

trace-feature -m

Aguardar a conclusão da análise de todos os métodos do projeto e executar:

trace-feature

Testes:

Para executar os testes em conjunto com o output de cobertura, use o comando:

pytest -v --cov

Para visualizar a cobertura dos testes em uma página HTML, execute:

pytest -v --cov --cov-report=html

E abra o arquivo index.html do diretório htmlcov