automacao-core-carga-back 1.0.2

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "automacao-core-carga-back",
+  "version": "1.0.2",
+  "description": "Core compartilhado de utilitários k6 e Playwright para testes de carga dos módulos erpx_* e erp_*",
+  "exports": {
+    "./k6": {
+      "types": "./src/types/k6.d.ts",
+      "import": "./dist/k6.mjs",
+      "require": "./dist/k6.cjs"
+    },
+    "./playwright": {
+      "types": "./src/types/playwright.d.ts",
+      "import": "./dist/playwright.mjs",
+      "require": "./dist/playwright.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "src/types"
+  ],
+  "scripts": {
+    "build": "npm install && rollup -c",
+    "eslint": "eslint . --ignore-path .eslintignore"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/senior-sistemas/snr-automacao-core-carga-back.git"
+  },
+  "bugs": {
+    "url": "https://github.com/senior-sistemas/snr-automacao-core-carga-back/issues"
+  },
+  "homepage": "https://github.com/senior-sistemas/snr-automacao-core-carga-back#readme",
+  "keywords": [
+    "k6",
+    "playwright",
+    "performance",
+    "carga",
+    "senior",
+    "erpx"
+  ],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@babel/cli": "^7.24.5",
+    "@babel/core": "^7.24.5",
+    "@babel/eslint-parser": "^7.24.1",
+    "@babel/plugin-syntax-optional-chaining": "^7.8.3",
+    "@babel/plugin-transform-object-rest-spread": "^7.24.5",
+    "@babel/preset-env": "^7.24.5",
+    "@playwright/test": "1.63.0",
+    "@rollup/plugin-babel": "^6.0.4",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@types/node": "^20.12.8",
+    "@types/k6": "^0.50.0",
+    "eslint": "^8.57.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-playwright": "^1.5.1",
+    "rollup": "^2.0.0"
+  },
+  "dependencies": {
+    "automacao-core-playwright": "^5.18.1",
+    "sharp": "^0.34.5"
+  },
+  "peerDependencies": {
+    "@playwright/test": ">=1.40.0"
+  },
+  "peerDependenciesMeta": {
+    "@playwright/test": {
+      "optional": true
+    }
+  }
+}

package/src/types/k6.d.ts

@@ -0,0 +1,136 @@
+/**
+ * Declarações de tipo de `automacao-core-carga-back/k6`.
+ *
+ * Self-contained de propósito: não re-exporta os arquivos de `src/lib/`, que não
+ * são publicados no pacote, e não depende de `@types/k6` estar instalado no
+ * repositório consumidor.
+ */
+
+/** Headers para requisições autenticadas, montados por `K6AuthUtils.paramsHeader`. */
+export interface ParamsHeader {
+  headers: {
+    'Content-Type': string;
+    Authorization: string;
+  };
+}
+
+/** Subconjunto da Response do k6 usado por este core. */
+export interface RespostaHttp {
+  status: number;
+  body: string | null;
+  timings: { duration: number };
+  json(selector?: string): unknown;
+  [chave: string]: unknown;
+}
+
+/** Retorno do endpoint SearchNotifications da plataforma. */
+export interface RespostaNotificacoes {
+  listInformation?: { totalElements: number };
+  [chave: string]: unknown;
+}
+
+/**
+ * Conexão aberta pela extensão `k6/x/sql`. Requer um binário k6 compilado com
+ * `xk6-sql` e o driver Postgres.
+ */
+export interface ConexaoSql {
+  query(sql: string, ...args: unknown[]): Array<Record<string, unknown>>;
+  exec(sql: string, ...args: unknown[]): void;
+  close(): void;
+}
+
+/** Mapa aceito pelo `handleSummary` do k6: caminho de arquivo → conteúdo. */
+export interface SaidaSummary {
+  [caminho: string]: string;
+}
+
+/** Opções de saída de `K6ReportUtils.gerarSummary`. */
+export interface OpcoesSummary {
+  /** Nome do teste, usado no diretório, no nome do arquivo e no campo `teste` do JSON. */
+  nome?: string;
+}
+
+/** Autenticação na plataforma Senior. */
+export declare class K6AuthUtils {
+  /** Monta os headers com `Authorization: Bearer <token>`. */
+  static paramsHeader(tokenId: string): ParamsHeader;
+
+  /**
+   * Faz login na plataforma e devolve o `access_token`.
+   * Registra a duração da chamada na trend `tempo_resposta_login`.
+   *
+   * @param inputLogin JSON stringificado com `{ "username": "...", "password": "..." }`.
+   *   As credenciais vêm do repositório de teste, nunca deste core.
+   */
+  static login(inputLogin: string): Promise<string>;
+}
+
+/** Acesso a banco Postgres via extensão `k6/x/sql`. */
+export declare class K6DbUtils {
+  /**
+   * Abre conexão com o Postgres.
+   * @param connectionString `postgres://user:pass@host:port/db`, montada pelo
+   *   repositório de teste a partir de variáveis de ambiente.
+   */
+  static abreConexao(connectionString: string): ConexaoSql;
+
+  /** Executa um SELECT. */
+  static pesquisa(conexao: ConexaoSql, query: string): Array<Record<string, unknown>>;
+
+  /** Converte um único valor retornado do banco de código ASCII para string. */
+  static converteDado(result: Array<Record<string, unknown>>, coluna: string): string | undefined;
+
+  /** Converte um array de valores retornados do banco de código ASCII para strings. */
+  static converteArrayDados(results: Array<Record<string, unknown>>, coluna: string): string[];
+
+  /** Fecha a conexão. */
+  static fechaConexao(conexao: ConexaoSql): void;
+
+  /** Executa comando DML/DDL (UPDATE, INSERT, DELETE, DROP, etc). */
+  static executaComando(conexao: ConexaoSql, comando: string): void;
+}
+
+/** Geração do resumo de métricas para o `handleSummary`. */
+export declare class K6ReportUtils {
+  /**
+   * Gera o resumo em JSON e o texto para o terminal.
+   * Destino padrão `k6/imagensIA/<nome>/k6<nome>.json`; sobrescrevível por
+   * `K6_JSON_DIR` e `K6_JSON_FILE`.
+   */
+  static gerarSummary(data: unknown, opcoes?: OpcoesSummary): SaidaSummary;
+}
+
+/** Helpers de array e cálculo. */
+export declare class K6DataUtils {
+  /** Divide um array plano em lotes de `tamanho` itens. */
+  static criaSubArrays<T>(array: T[], tamanho: number): T[][];
+
+  /** Soma cada subarray, formatando o total com 2 casas decimais. */
+  static somaValores(array: number[][]): string[];
+}
+
+/** Notificações da plataforma Senior. */
+export declare class K6NotificationsUtils {
+  /** POST em SearchNotifications, devolvendo o JSON da resposta. */
+  static pesquisar(
+    input: object | string,
+    params: ParamsHeader,
+    fullResponse?: false,
+  ): RespostaNotificacoes;
+  /** POST em SearchNotifications, devolvendo a Response completa. */
+  static pesquisar(
+    input: object | string,
+    params: ParamsHeader,
+    fullResponse: true,
+  ): RespostaHttp;
+
+  /**
+   * Faz polling até atingir `quantidadeEsperada` notificações.
+   * Até 100 tentativas, 4s de intervalo; falha o teste se não atingir.
+   */
+  static aguardarTotal(
+    input: object | string,
+    params: ParamsHeader,
+    quantidadeEsperada: number,
+  ): number;
+}

package/src/types/playwright.d.ts

@@ -0,0 +1,220 @@
+/**
+ * Declarações de tipo de `automacao-core-carga-back/playwright`.
+ *
+ * Self-contained de propósito: não re-exporta os arquivos de `src/lib/`, que não
+ * são publicados no pacote.
+ *
+ * Requer `@playwright/test` instalado no repositório consumidor (peer dependency).
+ */
+
+import type {
+  FrameLocator,
+  Locator,
+  Page,
+  PlaywrightTestArgs,
+  PlaywrightTestOptions,
+  PlaywrightWorkerArgs,
+  PlaywrightWorkerOptions,
+  TestType,
+} from '@playwright/test';
+
+/** Credenciais do Grafana. Vêm do repositório de teste, nunca deste core. */
+export interface UsuarioGrafana {
+  email: string;
+  senha: string;
+}
+
+/** Credenciais do APM Elastic. Vêm do repositório de teste, nunca deste core. */
+export interface UsuarioApm {
+  usuario: string;
+  senha: string;
+}
+
+/** Opções de `ComunsUtils.aguardarAte`. */
+export interface OpcoesAguardarAte {
+  /** Intervalo entre verificações, em ms. Padrão `100`. */
+  intervalo?: number;
+  /** Tempo máximo de espera, em ms. Padrão `10000`. */
+  timeout?: number;
+}
+
+/**
+ * Interações genéricas compartilhadas entre os specs: login APM/Grafana,
+ * capturas de tela e combinação de imagens.
+ *
+ * Os campos `locator*` existem em runtime mas são internos e não fazem parte da
+ * superfície tipada.
+ */
+export declare class ComunsUtils {
+  constructor(page: Page);
+
+  page: Page;
+
+  /**
+   * Helpers de `automacao-core-playwright`. Tipados como `any` porque o pacote
+   * de origem não publica declarações de tipo.
+   */
+  dataUtils: any;
+  formUtils: any;
+  navigationUtils: any;
+
+  /** Ano corrente, capturado na construção. */
+  ano: number;
+  /** Mês corrente com 2 dígitos, capturado na construção. */
+  mes: string;
+  /** Dia corrente com 2 dígitos, capturado na construção. */
+  dia: string;
+
+  /**
+   * Aguarda N milissegundos — sempre o tempo cheio.
+   *
+   * Prefira `aguardarAte` quando houver uma condição observável.
+   */
+  delay(ms: number): Promise<void>;
+
+  /**
+   * Aguarda até `condicao` retornar verdadeiro, saindo assim que satisfeita.
+   *
+   * Não lança no timeout: devolve `false` para quem chamou decidir. Uma exceção
+   * na `condicao` conta como não satisfeita.
+   *
+   * @returns `true` se a condição foi satisfeita; `false` se estourou o timeout.
+   */
+  aguardarAte(
+    condicao: () => boolean | Promise<boolean>,
+    opcoes?: OpcoesAguardarAte,
+  ): Promise<boolean>;
+
+  /**
+   * Gera URL do APM com o intervalo de tempo atualizado, ajustando
+   * `rangeFrom` e `rangeTo`.
+   * @param data Data `DD-MM-YYYY`; se omitida usa a data atual.
+   */
+  gerarUrlApmComDataAtual(
+    baseUrl: string,
+    horarioInicial: string,
+    horarioFinal: string,
+    data?: string | null,
+  ): string;
+
+  /**
+   * Gera URL do Grafana com o intervalo de tempo atualizado, ajustando
+   * `from` e `to`.
+   * @param data Data `DD-MM-YYYY`; se omitida usa a data atual.
+   */
+  gerarUrlGrafanaComDataAtual(
+    baseUrl: string,
+    horarioInicial: string,
+    horarioFinal: string,
+    data?: string | null,
+  ): string;
+
+  /** Faz login no Grafana. */
+  loginGrafana(usuario: UsuarioGrafana): Promise<void>;
+
+  /** Faz login no APM Elastic. */
+  loginApm(usuario: UsuarioApm): Promise<void>;
+
+  /**
+   * Captura screenshot da página inteira, com 3 tentativas e criação do
+   * diretório de destino.
+   */
+  tirarPrintTelaInteira(nomeArquivo: string, caminhoCustomizado?: string): Promise<void>;
+
+  /** Captura screenshot de um elemento específico. */
+  tirarPrintLocator(
+    locator: Locator,
+    nomeArquivo: string,
+    caminhoCustomizado?: string,
+  ): Promise<void>;
+
+  /**
+   * Combina múltiplas screenshots numa única imagem vertical.
+   * @returns Caminhos das imagens individuais usadas na composição.
+   */
+  combinarPrints(
+    nomesImagens: string[],
+    nomeArquivoFinal: string,
+    caminhoOriginais?: string,
+    deletarOriginais?: boolean,
+    caminhoDestino?: string | null,
+  ): Promise<string[]>;
+}
+
+/** Navegação no APM Elastic: serviços, transactions e traces. */
+export declare class ApmUtils {
+  constructor(page: Page);
+
+  page: Page;
+  comunsUtils: ComunsUtils;
+
+  /** Navega para a URL do APM e aguarda a lista de serviços carregar. */
+  acessaTelaApm(url: string): Promise<void>;
+
+  /** Abre os detalhes de um serviço. Faz até 3 tentativas com reload. */
+  acessarDetalhesServico(nomeServico: string): Promise<void>;
+
+  /**
+   * Abre os detalhes de uma transaction.
+   * @param traceExpandido `'Não'` expande o trace; `'Sim'` apenas valida o título.
+   */
+  acessarDetalhesTransactions(
+    nomeTransaction: string,
+    traceExpandido?: 'Sim' | 'Não',
+  ): Promise<void>;
+
+  /** Navega entre abas/seções do APM. */
+  navegarTelaAPM(nomeAba: string): Promise<void>;
+}
+
+/** Navegação nos painéis RabbitMQ e Kubernetes do Grafana. */
+export declare class GrafanaUtils {
+  constructor(page: Page);
+
+  page: Page;
+  comunsUtils: ComunsUtils;
+
+  /** Navega para a URL do dashboard e fecha o "Dock menu" se visível. */
+  acessaTelaGrafana(url: string): Promise<void>;
+
+  /** Expande uma row colapsada, validando que o painel filho ficou visível. */
+  expandirPainel(nomePainel: string, painelExpandido: string): Promise<void>;
+
+  /** Valida que o dashboard RabbitMQ carregou com os painéis esperados. */
+  validarGrafanaCarregado(): Promise<void>;
+
+  /** Ordena a tabela pelo total de mensagens. */
+  ordenarMensagensTotal(): Promise<void>;
+
+  /** Abre a visão completa (View) de um painel, com scroll automático. */
+  acessarVisaoCompleta(nomeSecao: string): Promise<void>;
+
+  /** Volta ao dashboard principal. */
+  voltarParaDashboard(): Promise<void>;
+}
+
+/** `page` do fixture, com os page objects do core injetados. */
+export interface PaginaComCore extends Page {
+  comunsUtils: ComunsUtils;
+  grafanaUtils: GrafanaUtils;
+  apmUtils: ApmUtils;
+}
+
+/**
+ * `test` do Playwright estendido com os page objects do core em `page`.
+ *
+ * Importe daqui em vez de `@playwright/test` para ter `page.comunsUtils`,
+ * `page.apmUtils` e `page.grafanaUtils` disponíveis.
+ */
+export declare const test: TestType<
+  Omit<PlaywrightTestArgs, 'page'> & PlaywrightTestOptions & { page: PaginaComCore },
+  PlaywrightWorkerArgs & PlaywrightWorkerOptions
+>;
+
+export { expect } from '@playwright/test';
+
+/**
+ * FrameLocator do iframe `ci`, atribuído pelo fixture quando um teste começa.
+ * É `undefined` até lá, por isso o tipo inclui `undefined`.
+ */
+export declare const frame: FrameLocator | undefined;