Este documento visa fornecer um guia passo a passo para o processo de implantação do ambiente do TestFlow.
Ambiente recomendado
Para uso, segue especificações recomendadas das máquinas para hospedar o Host e o Agent do TestFlow.
- VM Host: Neste ambiente será hospedado o host do TF3.
- SO: Windows Server 2012+
- 2VCPU
- 4GB RAM
- 60GB Disco.
- VM Banco de Dados: Base de dados do TF3 e as bases de testes do cliente
- SQL Server 2019 ou 2022
- 2VCPU
- 4GB RAM
- 60GB de disco (Windows + Base TF3) + disco suficiente para 2x tamanho da base de testes do cliente.
- VM de Agent: Nesse ambiente será hospedado o Agent do TF3.
- 2VCPU
- 4GB de ram
- 60GB de disco.
- Ambiente do RM
Base de dados do TestFlow
É necessário solicitar uma base aceleradora do TestFlow para o time de automação da TOTVS. Há bases de dados disponíveis nas versões 2019 e 2022 do SQL Server.
Após a solicitação, a base deve ser instalada em uma instância SQL Server conforme a versão selecionada.
Liberações de rede
Para a utilização do TestFlow é necessário fazer algumas liberações de rede entre os ambientes e localmente no firewall dos servidores.
Entre os ambientes
- Verificar a conectividade entre as redes da máquina Host e da máquina Agent
Descubra qual o IPV4 dos servidores
Abra o prompt de comando (cmd) em ambas as máquinas.
Digite o comando 'ipconfig' e pressione Enter.
- Verifique no seu adaptador de internet o seu endereço de IPV4
Para determinar se dois endereços IP estão na mesma rede, utiliza-se a máscara de sub-rede. Esta máscara é utilizada para distinguir a parte de rede da parte de host em um endereço IP.
Em resumo, se todos os números antes do último ponto resultantes do comando 'ipconfig' forem idênticos, isso indica que as máquinas estão conectadas na mesma rede. Por exemplo:
10.171.32.200 e 10.171.32.201
10.31.7.13 e 10.31.7.14
192.168.0.1 e 192.168.0.2
Caso não estejam na mesma rede ou ainda não seja possível fazer a conexão, é necessário garantir as seguintes liberações de rede:
| Origem | Destino | Protocolo | Porta | Motivo |
|---|---|---|---|---|
| Host | Agent | TCP | 5010, 5011, 5012, 445 | Compartilhamento de arquivo e Conexão do Host com Agent. |
| Agent | Host | TCP | 6060, 445 | Compartilhamento de arquivo e Conexão do Agent com Host. |
| Agent | Servidor de Banco SQL | TCP | 1433 | Conexão do Agent com o Banco. |
| Agent | Servidor de Banco SQL | UDP | 1434 | Conexão do Agent com o Banco. |
| Máquina local do usuário (Opcional caso tenha) | Host | TCP | 6060 | Conexão do computador local com o Host do TestFlow. |
| Máquina local do usuário (Opcional caso tenha) | Host, Agent | TCP | 3389 | Conexão remota com a VM do Host e do Agent. |
Para testar a conexão entre duas máquinas (por exemplo, entre a máquina do Agent e o servidor de banco de dados), abra o PowerShell como Administrador e execute o seguinte comando:
Test-NetConnection -ComputerName <hostname> -Port <porta>
Firewall
Localmente nos servidores do Agent e do Host é necessário fazer as mesmas liberações de rede para a utilização do TestFlow.
Pré-condições
Para uso, segue pré-condições para a utilização do TestFlow.
- Solicitação da configuração do Fluig Identity feito pelo time de automação da TOTVS
- Servidores do Agent e Host disponíveis para a implantação
- Solicitação para configuração do arquivo de ambiente (appsettings) para o time de automação da TOTVS, informando os ambientes que foram criados para a utilização do TestFlow
- Liberações de rede entre os servidores do Agent e Host já feitas
- Zip com o TestFlow na versão mais atual disponível no ambiente
O que será disponibilizado antes da implantação
Duas pastas serão fornecidas: uma contendo os arquivos do Agent e outra com os arquivos do Host.
Na pasta AgentFiles, você encontrará três arquivos:
- TestFlow.Agent.Instance.zip: Este arquivo ZIP contém a pasta com o executável do Agent.
- TestFlow.AutoUpdate.exe: Este executável realiza a atualização automática do Agent.
- TestFlow: Esta pasta inclui os plugins necessários para automações com WinForms.
Instalações
Instalando o IIS
1) Abra o Dashboard do Server Manager e clique em “Add roles and features”
2) Next -> Next -> Next.
3) Em Server Roles, selecione a opção “Web Server (IIS)” -> Next.
4) Em Features, selecione a opção "IIS Hostable Web Core".
4) Next -> Next -> Install.
Após instalar o IIS, copie os arquivos da pasta Host (fornecidos anteriormente) para o diretório C:\inetpub\tf3.
Além disso, extraia a pasta AgentFiles (fornecidos anteriormente) também nesse diretório em questão.
1) Entre no diretório C:\inetpub\tf3 e procure pelo arquivo appsettings.json.
2) O TestFlow permite o envio de email após a execução de agendamentos em algumas condições selecionadas pelo usuário.
Para a sua configuração, é necessário alterar o arquivo appsettings.json do Host com as informações abaixo:
3) Em seguida, preencha o campo Endpoint com a URL no formato exibido na imagem abaixo. Essa URL será utilizada para acessar o TestFlow na máquina.
4) Após restaurar a base de dados Aceleradora do TF3 no servidor de banco de dados, atualize o parâmetro Connection String nesse mesmo arquivo com as informações do seu servidor. Veja abaixo um exemplo de formato para a Connection String:
Data Source=server\\SQL<Instancia-SQL>;User ID=user;Password=senha;Initial Catalog=TF3;
OBS: Restaure a Base e modifique seu nome para TF3;
5) As demais informações já estarão previamente preenchidas por nossa equipe.
1) Vá em sites e clique em Add Website.
2) No campo Site name, entre com o diretório C:\inetpub\tf3 e no campo Application pool selecione tf3
3) Clique em “connect as” e selecione a opção “specific user”. Entre com o usuário administrador do servidor e sua respectiva senha (a mesma utilizada para realizar login nas demais funcionalidades com esse usuário). Por fim, clique em Ok.
4) Faça o bind para a porta 6060.
5) Faça a instalação do IIS URL Rewrite: https://www.iis.net/downloads/microsoft/url-rewrite.
6) Abra o IIS e clique no site “tf3" e verifique se foi instalado o URL Rewrite.
7) Entre no IIS, vá em “Application Pools” e depois em “Add Application Pool”.
8) Entre com o nome “tf3” e clique em OK.
9) No Pool novo gerado, clique nele e vá em Advanced Settings.
10) Na aba aberta, configure o campo Identity para o valor ApplicationPoolIdentity.
1) Vá em sites, clique em "tf3" e selecione a opção "Edit Permissions".
2) Clique Security → Advanced → Add.
3) Clique em Select a principal.
4) Adicione o seguinte usuário e clique em Ok e depois em Apply.
4) Dê todas as permissões (FUUL CONTROL) para o usuário em questão.
5) Repita o mesmo processo para o usuário Administrador do servidor.
6) Para finalizar o processo e salvar todas as operações, dê um restart no IIS.
É necessário fazer a instalação do framework .NET Core 2.2.x na versão Hosting Bundle para a utilização do TestFlow.
Onde baixar?
Acesse o site https://dotnet.microsoft.com/en-us/download/dotnet/2.2 e selecione a opção de Hosting Bundle conforme a imagem abaixo.
Como instalar?
Siga o passo a passo do executável até o final.
Validação
Após a instalação, é possível executar o comando "dotnet --list-runtimes" no CMD e obter a versão instalada.
Validação
Após esse passo, já é possível acessar o TestFlow pela URL configurada.
Proceda da seguinte forma:
- Acesse a URL correspondente ao host do TestFlow configurado anteriormente em um navegador da web.
- Em seguida, proceda com o download do Agent.
Isso fará com que seja baixado um arquivo zip. Descompacte-o no disco C:
OBS: A sugestão é descompactar em uma pasta C:\Agent
Utilização de um usuário de serviço
A recomendação é que seja utilizado um usuário de serviço para iniciar o Agent. Assim, é possível garantir que ele nunca estará offline, mesmo quando um usuário seja desconectado do servidor.
Validações após instalações
Após a instalação e configuração dos ambientes é interessante validar se os cadastros e execuções estão funcionando conforme esperado.
Uso do sistema somente após a vínculo do usuário em um grupo
Após o usuário ser adicionado em um grupo, será possível para o mesmo criar, editar, visualizar e executar atividades no TestFlow.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas