AutomationSy

Instalação

Início

Faça a Instalação do AutomationSy via NPM package

Execute no seu terminal

npm i automationsy@1.0.6

Importação

import { AutomationSy } from 'automationsy';

Requerimentos

É necessário node 14 ou superior instalado

Versão

v1.0.6

Configuração

Modo sem cabeça

Você pode ativar o modo sem cabeça para que o navegador não seja visível em tela, por padrão o valor é falso.

Informe um parâmetro obrigatório do tipo booleano

Veja como usar:
AutomationSy.setHeadless(true);

Defina a tela ao máximo

Você pode maximizar o tamanho da tela do navegador, por padrão o valor é falso.

Informe um parâmetro obrigatório do tipo booleano

Veja como usar:
AutomationSy.setMaximized(true);

Defina a altura e largura da janela

Você pode alterar o tamanho da largura e altura da janela do navegador, por padrão a largura é 800 e altura 600

Informe dois parâmetros obrigatórios, o primeiro é a largura e o segundo é a altura

Veja como usar:
AutomationSy.setWindowSize(1024, 768);

Defina o tempo de espera das ações

Você pode definir o tempo de espera de cada ação, por padrão é 0, infinitamente.

Informe um parâmetro obrigatório, o valor deve ser em milissegundos

Veja como usar:
AutomationSy.setDefaultTimeout(5000);

Espere até

Você pode definir o tipo para a espera da navegação de um site, o tempo que a conexão do navegador finalizou após carregar os dados, por padrão o tipo é load

Informe um parâmetro obrigatório, os tipos aceitos são: load, domcontentloaded, networkidle0 e networkidle2

  • load - considera a navegação encerrada quando tudo estiver carregado
  • domcontentloaded - considera a navegação fechada quando apenas os elementos da página foram carregados
  • networkidle0 - considera a navegação encerrada quando não houver mais de 0 conexões de rede por pelo menos 500ms
  • networkidle2 - considera a navegação encerrada quando não há mais de 2 conexões de rede por pelo menos 500ms
Veja como usar:
AutomationSy.setWaitUntil('domcontentloaded');

Defina o tempo de espera da navegação

Você pode definir o tempo de espera da navegação, por padrão é 0, infinitamente.

Informe um parâmetro obrigatório, o valor deve ser em milissegundos

Veja como usar:
AutomationSy.setDefaultNavigationTimeout(5000);

Ações

Inicialização

Para que possa iniciar as ações da automação no navegador é necessário executar esta ação primeiramente

Está ação é assíncrona

Veja como usar:
await AutomationSy.init();

Descartar

Você pode descartar e finalizar as ações do navegador

Está ação é assíncrona

Veja como usar:
await AutomationSy.dispose();

Atrasar

Você pode atrasar as ações definindo um tempo em milissegundos

Informe um parâmetro obrigatório, o valor deve ser em milissegundos

Está ação é assíncrona

Veja como usar:
await AutomationSy.sleep(5000);

Digitar

Você pode digitar um texto em um campo de formulário

Informe dois parâmetros obrigatórios, o primeiro é o localizador da página e o segundo é o texto a digitar

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.type('#id', 'texto a digitar');

Foco

Você pode focar um elemento da página

Informe um parâmetro obrigatório, o localizador da página

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.focus('input');

Teclado

Você pode pressionar uma tecla do teclado na página

Informe um parâmetro obrigatório, a tecla do teclado

Exemplo de teclas: Tab, Enter

Está ação é assíncrona

Veja como usar:
await AutomationSy.keyboard('Enter');

Limpar

Você pode limpar um campo de um elemento da página

Informe um parâmetro obrigatório, o localizador da página

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.clear('.clear');

Clicar

Você pode clicar em um elemento da página

Informe um parâmetro obrigatório, o localizador da página

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.click('/html/body/button');

Voltar

Você pode navegar para uma rota anterior

Está ação é assíncrona

Veja como usar:
await AutomationSy.goBack();

Vá em frente

Você pode navegar para uma rota a frente

Está ação é assíncrona

Veja como usar:
await AutomationSy.goForward();

Clique na posição

Você pode clicar em uma posição da página

Informe dois parâmetros inteiros obrigatórios, o primeiro é sua posição x, o segundo é a posição y

Os valores da posição são em pixel

Está ação é assíncrona

Veja como usar:
await AutomationSy.clickPosition(20 ,40);

Duplo clique

Você pode usar o clique duplo em um elemento da página

Informe um parâmetro obrigatório, o localizador da página

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.doubleClick('//*[@id="goToTop"]');

Preencher

Diferente do Digitar, você pode preencher um texto em um campo de formulário rapidamente

Informe dois parâmetros obrigatórios, o primeiro é o localizador da página e o segundo é o texto a digitar

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.fill('#id', 'texto a digitar');

Clique longo

Você pode usar o clique longo em um elemento da página

Informe dois parâmetros obrigatórios, o primeiro é o localizador da página, o segundo é o tempo de espera em milissegundos

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.longClick('#id', 2000);

Selecione por valor

Você pode selecione um dropdown pelo valor

Informe dois parâmetros obrigatórios, o primeiro é o localizador da página, o segundo é uma lista para cada valor do dropdown

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.selectByValue('#id', 'primeiro');

ou


await AutomationSy.selectByValue('#id', 'primeiro', 'segundo');

Selecione por índice

Você pode selecione um dropdown pelo índice

Informe dois parâmetros obrigatórios, o primeiro é o localizador da página, o segundo é um número inteiro ordenado pelo seu índice na lista do dropdown

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.selectByIndex('#id', 0);

Espere pelo localizador

Você pode aguardar até que um elemento na página apareça

Informe um parâmetro obrigatório, o localizador da página

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.waitForLocator('#id');

Para definir o tempo da espera utilize o Defina o tempo de espera das ações

Mudar de página

Você pode alternar entre as páginas abertas no navegador

Informe um parâmetro obrigatório, o índice da página

O índice da página é definindo pela ordem das abas abertas no navegador

Está ação é assíncrona

Veja como usar:
await AutomationSy.switchPage(1);

Saia da página

Você pode sair das páginas abertas no navegador

Informe um parâmetro obrigatório, o índice da página

O índice da página é definindo pela ordem das abas abertas no navegador

Está ação é assíncrona

Veja como usar:
await AutomationSy.quitPage(1);

Espere que o localizador desapareça

Você pode aguardar até que um elemento na página desapareça

Informe um parâmetro obrigatório, o localizador da página

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.waitForLocatorDisappear('#id');

Para definir o tempo da espera utilize o Defina o tempo de espera das ações

Arrastar e soltar pela posição

Você pode arrastar um elemento até uma posição da página

Informe três parâmetros obrigatórios, o primeiro é o localizador da página, o segundo é posição x da página, o terceiro é a posição y da página

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.dragAndDropByPosition('#id', 20 , 40);

Você pode obter a posição de outro elemento da página usando o Obter posição x e Obter posição y

Arrastar e soltar no alvo

Você pode arrastar um elemento até a outro elemento na página

Informe dois parâmetros obrigatórios, o primeiro é o localizador da página, o segundo é o localizador do alvo na página

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.dragAndDropByTarget('#id', '#alvo');

Rolagem

Mova a barra de rolagem do navegador verticalmente

Informe um parâmetro obrigatório, a distância em pixels

Está ação é assíncrona

Veja como usar:
await AutomationSy.scroll(300);

Definir HTML

Escreva tags HTML na página

Informe um parâmetro obrigatório, marcação HTML

Está ação é assíncrona

Veja como usar:
await AutomationSy.setHTML('<h1>Olá mundo</h1>');

Remover HTML

Você pode remover elementos HTML da página

Informe um parâmetro obrigatório, o localizador da página

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.removeHTML('text=Remover');

Captura de tela

Você pode tirar um print ou captura de tela do navegador no exato momentos dos testes

Por padrão a pasta de captura de telas é screenshots localizada na pasta raiz do projeto inicializado pelo usuário

Está ação é assíncrona

Veja como usar:
await AutomationSy.screenshot();

Criar PDF

Você pode criar um PDF do HTML da página navegada no exato momentos dos testes

Por padrão a pasta de criação de PDF é pdf localizada na pasta raiz do projeto inicializado pelo usuário

Está ação é assíncrona

Veja como usar:
await AutomationSy.pdf();

Rolagem infinita

Mova a barra de rolagem do navegador verticalmente infinitamente

Informe dois parâmetros não obrigatórios, o primeiro é a distância em pixels, o segundo é o atraso em milissegundos até que a rolagem chega ao final da página, por padrão os valores da distância é 100 e o atraso é 100

Está ação pode ser usado em casos em que haja paginação infinita no final da página

Está ação é assíncrona

Veja como usar:
await AutomationSy.autoScroll(500, 1000);

Mouse flutuante

Você pode passar o mouse por cima do elemento

Informe um parâmetro obrigatório, o localizador da página

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.hover('#id');

Recursos

Obter habilitado / desabilitado

Obtenha um valor booleano se o elemento da página é desabilitado ou não

Informe um parâmetro obrigatório, o localizador da página

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.isDisabled('#id');

Obter marcado / desmarcado

Obtenha um valor booleano se o elemento da página é marcado ou não

Informe um parâmetro obrigatório, o localizador da página

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.isChecked('#id');

Obter título

Obtenha o título da página

Está ação é assíncrona

Veja como usar:
await AutomationSy.getTitle();

Obter URL

Obtenha a url atual da página

Veja como usar:
AutomationSy.getUrl();

Obter atributo

Obtenha o atributo de um elemento da página

Informe dois parâmetros obrigatórios, o primeiro é o localizador da página, o segundo é o atributo desejado do localizador

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.getByAttribute('#id', 'href');

Obter todos por atributo

Obtenha uma lista de atributo por cada elemento duplicado na página

Informe dois parâmetros obrigatórios, o primeiro é o localizador da página, o segundo é o atributo desejado do localizador

Lembrando que o localizador pode ser duplicado

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.getAllByAttribute('input', 'value');

Obter texto

Obtenha um texto contido no elemento da página

Informe um parâmetro obrigatório, o localizador da página

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.getText('#id');

Obter posição x

Obtenha a posição x de um elemento na página

Informe um parâmetro obrigatório, o localizador da página

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.getPositionX('#id');

Obter posição y

Obtenha a posição y de um elemento na página

Informe um parâmetro obrigatório, o localizador da página

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.getPositionY('#id');

Obter largura

Obtenha a largura de um elemento na página

Informe um parâmetro obrigatório, o localizador da página

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.getWidth('#id');

Obter altura

Obtenha a altura de um elemento na página

Informe um parâmetro obrigatório, o localizador da página

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.getHeight('#id');

Obter visível / invisível

Obtenha um valor booleano se o elemento da página é visível ou não

Informe um parâmetro obrigatório, o localizador da página

O localizador da página são os elementos da página como id, tagname, classe, xpath, etcs...

Está ação é assíncrona

Veja como usar:
await AutomationSy.isVisible('#id');