Linha RM

Atalhos

Páginas filhas
  • Implantação

Versões comparadas

Versão antiga 1

changes.mady.by.user Engenharia de Software

Gravado em

comparado com

Nova versão 39

changes.mady.by.user Ana Lucia Oliveira de Paula

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Este documento visa fornecer um guia passo a passo para o processo de implantação do ambiente do TestFlow. 

Índice
maxLevel1
excludeOnde baixar?;Como instalar?

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
        • Image Added

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:

 OrigemDestinoProtocolo

Porta

Motivo

HostAgentTCP

5010, 5011, 5012, 445

Compartilhamento de arquivo e Conexão do Host com Agent.

AgentHostTCP

6060, 445

Compartilhamento de arquivo e Conexão do Agent com Host.

AgentServidor de Banco SQLTCP

1433

Conexão do Agent com o Banco.

AgentServidor de Banco SQLUDP

1434

Conexão do Agent com o Banco.

Máquina local do usuário (Opcional caso tenha)HostTCP

6060

Conexão do computador local com o Host do TestFlow. 

Máquina local do usuário (Opcional caso tenha)Host, AgentTCP

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:

Bloco de código
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.

Image Added




Na pasta AgentFiles, você encontrará três arquivos:

  1. TestFlow.Agent.Instance.zip: Este arquivo ZIP contém a pasta com o executável do Agent. 
  2. TestFlow.AutoUpdate.exe: Este executável realiza a atualização automática do Agent. 
  3. TestFlow: Esta pasta inclui os plugins necessários para automações com WinForms. 

Image Added

Instalações

Deck of Cards
idInstalações
Card
labelHost
Expandir
titleInstalando o IIS

Instalando o IIS

1) Abra o Dashboard do Server Manager e clique em “Add roles and features”

Image Added

2) Next -> Next -> Next.

3) Em Server Roles, selecione a opção “Web Server (IIS)” -> Next.

Image Added Image Added

4) Em Features, selecione a opção "IIS Hostable Web Core".

Image Added

4) Next -> Next -> Install.

Aviso

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.

Image Added

Expandir
titleConfiguração do arquivo appsettings.json

1) Entre no diretório C:\inetpub\tf3 e procure pelo arquivo appsettings.json.

Image Added

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:

Image Added

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.

Image Added

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;

Image Added

OBS: Restaure a Base e modifique seu nome para TF3;

5) As demais informações já estarão previamente preenchidas por nossa equipe.

Expandir
titleConfiguração do WebSite no IIS

1) Entre no IIS, vá em “Application Pools” e depois em “Add Application Pool”.

Image Added

2) Entre com o nome “tf3” e clique em OK.

Image Added

3) No Pool novo gerado, clique nele e vá em Advanced Settings.

Image Added

Na aba aberta, configure o campo Identity para o valor ApplicationPoolIdentity.

Image Added

4) Vá em sites e clique em Add Website.

Image Added

5) No campo Site name, entre com o diretório C:\inetpub\tf3 e no campo Application pool selecione tf3

Image Added

6) 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.

Image Added

7) Faça o bind para a porta 6060.

Image Added

8) Faça a instalação do IIS URL Rewrite: https://www.iis.net/downloads/microsoft/url-rewrite. 

9) Abra o IIS e clique no site “tf3" e verifique se foi instalado o URL Rewrite.

Image Added

Expandir
titleConfiguração das permissões dos usuários no Website

1) Vá em sites, clique em "tf3" e selecione a opção "Edit Permissions".

Image Added

2) Clique Security → Advanced → Add.

Image Added

3) Clique em Select a principal.

Image Added

4) Adicione o seguinte usuário e clique em Ok e depois em Apply.

Image Added

4) Dê todas as permissões (FUUL CONTROL) para o usuário em questão.

Image Added

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.

Expandir
titleInstalação de frameworks

É 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 x64 conforme a imagem abaixo.

 Image Added

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. 

Informações
Validação

Após esse passo, já é possível acessar o TestFlow pela URL configurada.

Card
labelAgent
Expandir
titleInstalação do Agent

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.


Image Added


Isso fará com que seja baixado um arquivo zip. Descompacte-o no disco C:

OBS: A sugestão é descompactar em uma pasta C:\Agent

Expandir
titleGarantir que nenhum arquivo está bloqueado após o download de arquivos do Agent

É importante garantir o desbloqueio dos arquivos do Agent e os plugins do WinForms, usando a opção Unblock do Windows.

Nesse caso, é necessário clicar com o botão direito em um arquivo bloqueado e clicar em "Desbloquear".

image-2023-11-10_11-48-4.pngImage Added

Faça a inspeção dos seguintes arquivos contidos na pasta Testflow contida no diretório , verificando se os mesmos estão bloqueados:

  • Verifique as dlls contidas na pasta AutomationPlugins
  • Verifique o arquivo TestFlow.App.Lib.dll

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.

Card
labelValidações

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.


Expandir
titleAutenticação com o Fluig Identity

Image Added

Expandir
titleCadastro de grupos

Image Added

Expandir
titleInclusão de atividade

Image Added

Expandir
titleCadastro de ambientes

Image Added

Expandir
titleCadastro de projetos

Image Added

Expandir
titleCadastro de conexão com servidor do Agent

Image Added

Expandir
titleExecução de projetos

Image Added

Expandir
titleCadastro de agendamentos

Image Added

Expandir
titleExecução de agendamentos

Image Added

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

O que são?

Grupos são funcionalidades do TestFlow utilizadas para organizar e controlar o acesso dos usuários às atividades criadas no sistema.

Para que servem?

Os Grupos permitem que usuários sejam organizados conforme a necessidade das equipes, facilitando o controle de acesso e a gestão das atividades relacionadas a um produto ou projeto específico.

Exemplo de Uso

Deck of Cards
idCriação de um grupo
Card
labelCriar grupo

1. Criação de um Grupo: 

Após o login, um usuário administrador deve adicionar você a um grupo específico para que você possa acessar as atividades criadas pelos membros desse grupo. Se o grupo não existir, basta navegar até a seção "Grupos" na barra de menu do TestFlow e clicar no ícone de pasta verde para criá-lo.

Image Removed

Card
labelDefinir Nome e Descrição

2. Definir Nome e Descrição do Grupo: 

Descreva o nome e a descrição desse Grupo. O nome do grupo deve representar para qual finalidade esse grupo está sendo criado, seja por produto ou para um projeto específico.

Image Removed

Card
labelDefinição do Nível de Acesso.

3. Adição de novos membros e definição do seu nível de acesso: 

Para adicionar um novo membro ao grupo, basta digitar o nome desse novo integrante na seção "Membros" e selecioná-lo dentre as sugestões apresentadas

Image Removed

Após esse passo, selecione a permissão do usuário.

- Administrador: Tem acesso total às atividades criadas pelo grupo.
- Membro: Tem acesso somente de leitura às atividades criadas pelo grupo.

Image Removed

Card
labelConfiguração de Notificações

4. Configuração de Notificações

Caso queira receber notificações sobre o grupo em questão via e-mail, você pode adicioná-lo clicando no seguinte ícone em questão.

Image Removed

Card
labelUso do sistema após a adição do usuário a um grupo

5. Uso do sistema após a adição do usuário a um grupo

Após o usuário ser adicionado em um grupo, será possível para o mesmo criar, editar e executar atividades no TestFlow.

Image Removed

Saiba mais

Dica

Os Grupos são definidos de acordo com a necessidade das equipes. Aconselha-se a definição de grupos por produto.

Dica
Grupos podem ser alterados ou excluídos pelos administradores. No entanto, a exclusão de um grupo resultará na exclusão de todas as atividades pertencentes a esse grupo.
Dica
A exclusão de usuários é permitida apenas para membros administradores.
Dica
Cada grupo deve ter pelo menos um usuário administrador para garantir a transferência de atividades quando necessário.

FAQ

...

P: O que acontece quando um grupo é excluído?
R: Todas as atividades pertencentes ao grupo serão automaticamente excluídas.

P: É possível excluir todos os usuários de um grupo?
R: Não. Pelo menos um usuário administrador deve permanecer no grupo. Quando um usuário é excluído, as atividades pertencentes a ele são transferidas automaticamente para o primeiro usuário administrador.

P: Quem pode excluir ou alterar grupos?
R: Apenas os administradores podem excluir ou alterar grupos.

...

.