Orange Testing CLI

Requisitos para utilização da biblioteca:

• Node.js - versão 14.19.0 ou superior;
• Usuário cadastrado na plataforma Orange Testing.

Passo-a-passo para a configuração da biblioteca:

1. Instale o pacote como dependência de desenvolvimento:

npm install orangetesting -D

2. Crie um arquivo JSON de configuração com a instância e os dados do agendamento:

{
  "instance": "instancia",
  "scheduleBody": {
    "name": "Agendamento 01",
    "product": "Produto",
    "url": "https://url",
    "identifiers": ["testcase-01"]
  }
}

3. No arquivo "package.json", crie um script que executa o comando "orangetesting", forneça algum dado de autenticação (token de acesso ou usuário e senha) e, opcionalmente, o caminho para o arquivo de configuração do agendamento (por padrão, o pacote buscará pelo arquivo "ot-config.json" na raiz do projeto):

"scripts": {
  "schedule": "orangetesting --path ./arquivos/config.json --username usuario --password senha"
},

Obs.: É recomendável a utilização de variáveis de ambiente para não expor suas credenciais.

Argumentos disponíveis na CLI

--help  Manual de uso da linha de comando
--token, --t  Token de autenticação (login)
--username, --usr  Usuário para login
--password, --ps  Senha para login
--path, --p  Caminho do arquivo de configuração (caminho padrão = ./ot-config.json)
--url  URL onde o agendamento será executado

Parâmetros do agendamento

Parâmetros obrigatórios:

{
  "instance": Instância onde o agendamento será criado e executado,
  "scheduleBody": Parâmetros do agendamento
}

Parâmetros obrigatórios do agendamento:

{
  "name": Nome do Agendamento.
  "product": Nome do Produto que contém os Módulos a serem executados.
  "url": URL do Agendamento (também pode ser informado via linha de comando). 

Ao menos um dos arrays abaixo precisa conter informação

  "identifiers": Array com identificadores dos Casos de Teste.
  "modules": Array com módulos a serem executados.
  "qualityGates": Array dos Padrões de Qualidade a serem executados. Esse parâmetro é opcional, podendo ser utilizado no lugar do array modules para executar todos os testes dentro dos padrões de qualidade informados.
}

Parâmetros do objeto scheduleBody

"scheduleBody": {
  "modules": Array com os nomes dos Módulos a serem executados.
  "robots": Array com os nomes dos robôs que devem ser executados.
  "variables": informe o nome e os valores das variáveis que devem ser preenchidas no momento da execução.
  "qualityGates": Array dos Padrões de Qualidade a serem executados. Esse parâmetro é opcional, podendo ser utilizado no lugar do array modules para executar todos os testes dentro dos padrões de qualidade informados.
  "browsers": Array com os browsers onde os testes devem ser executados, caso não seja informado o teste será executado no Google Chrome.
  "identifiers": identificadores do caso de teste.
  "Scheduled": horário de execução do agendamento.
  "Mobile": Array de objetos com informações dos dispositivos que será executado.
  "EmailNotifications": Array de objetos com lista dos emails que devem receber notificação e frequência(sempre ou apenas nas falhas).
  "SlackNotifications": Array de objetos com lista dos canais que devem receber notificação e frequência(sempre ou apenas nas falhas).
  "TeamsNotifications": Array de objetos com lista dos ids dos canais que devem receber notificação e frequência(sempre ou apenas nas falhas).
}

Observações:

• Para notificações, somente são permitidos canais e e-mails cadastrados no sistema;
• Parâmetros informados via linha de comando serão priorizados sobre os parâmetros informados no arquivo de configuração.