@silasfmartins/testhub 1.0.0

package/dist/src/ssh/SSHActions.d.ts

@@ -0,0 +1,262 @@
+import '../hubdocs/StatementTracker.js';
+/**
+ * Classe principal de ações SSH, inspirada no padrão Java Actions.
+ * Permite executar comandos, ler saídas, validar resultados e registrar logs/unificados.
+ */
+export declare class SSHActions {
+    /** Instância única de SSHClient para uso nas ações */
+    private static client;
+    private static inicioExecucao;
+    private static fimExecucao;
+    private static duracoes;
+    /**
+     * Conecta ao servidor SSH usando chave privada.
+     *
+     * 🆕 HOST e USERNAME vêm automaticamente do AutoCore Hub!
+     * A chave privada é o único parâmetro obrigatório.
+     *
+     * @param keyPath Caminho para a chave privada.
+     * @param options Opções para sobrescrever valores do Hub (opcional)
+     */
+    /**
+     * Conecta ao SSH usando chave privada relativa ao diretório do projeto.
+     *
+     * 🆕 HOST e USERNAME vêm automaticamente do AutoCore Hub!
+     * Basta chamar TestAnnotations.setSystem('SEU_SISTEMA') antes.
+     * A chave privada é o único parâmetro obrigatório (local).
+     *
+     * @param relativePath Caminho relativo à raiz do projeto (ex: 'secrets/key', './secrets/key')
+     * @param options Opções opcionais para sobrescrever valores do Hub
+     *
+     * @example
+     * // ✅ Simples - host/user vêm do Hub, só passa a chave
+     * await TestAnnotations.setSystem('SANITY_SSH')
+     * await SSHActions.connectWithKey('secrets/UserSistAutBRM')
+     *
+     * // ✅ Também funciona com ./
+     * await SSHActions.connectWithKey('./secrets/UserSistAutBRM')
+     *
+     * // ✅ Sobrescrevendo valores do Hub se necessário
+     * await SSHActions.connectWithKey('secrets/key', { host: 'outro-host.com' })
+     */
+    static connectWithKey(relativePath: string, options?: {
+        host?: string;
+        port?: number;
+        username?: string;
+        passphrase?: string;
+    }): Promise<void>;
+    /**
+     * 🆕 Conecta ao servidor SSH usando usuário e senha do AutoCore Hub.
+     * Chamado automaticamente pelo setSystem() quando PROJECT_TYPE=SSH.
+     *
+     * @param host Host do servidor SSH
+     * @param port Porta SSH (default: 22)
+     * @param username Usuário SSH
+     * @param password Senha SSH
+     *
+     * @example
+     * // Conexão manual com senha
+     * await SSHActions.conectarComSenha('servidor.com', 22, 'user', 'senha')
+     *
+     * // Ou use auto-conexão (recomendado):
+     * await SSHActions.autoConectar() // Usa credenciais do Hub
+     */
+    static connectWithPassword(host: string, port: number | undefined, username: string, password: string): Promise<void>;
+    /**
+     * 🆕 Auto-conexão SSH usando credenciais do AutoCore Hub.
+     * Usa as variáveis SSH_HOST, SSH_USER e SSH_PASSWORD injetadas pelo setSystem().
+     *
+     * @throws {IntegrationError} Se as credenciais não estiverem configuradas
+     *
+     * @example
+     * // No teste:
+     * test('CT01', async ({}, testInfo) => {
+     *   TestAnnotations.SSH.testInfo = testInfo
+     *   await TestAnnotations.setSystem('MEU_SISTEMA_SSH')
+     *   await SSHActions.autoConnect() // 👈 Usa credenciais do Hub automaticamente
+     *   await SSHActions.write('ls -la', 'Listar arquivos')
+     * })
+     */
+    static autoConnect(): Promise<void>;
+    /**
+     * 🆕 Verifica se o cliente SSH está conectado.
+     * @returns true se conectado, false caso contrário
+     */
+    static isConnected(): boolean;
+    /**
+     * 🆕 Garante que o cliente SSH está conectado, tentando auto-conexão se necessário.
+     * @param actionName Nome da ação para mensagens de erro
+     * @throws IntegrationError se não conseguir conectar
+     */
+    private static ensureConnected;
+    /**
+     * Desconecta do servidor SSH.
+     */
+    static desconectar(): Promise<void>;
+    /**
+     * Envia um comando SSH para o servidor remoto.
+     * @param command Comando SSH a ser enviado.
+     * @param descriptionToAction Descrição da ação, usada no relatório.
+     * @returns this
+     */
+    static write(command: string, descriptionToAction: string): Promise<typeof SSHActions>;
+    /**
+     * Envia um comando SSH e verifica o resultado do comando (usando "$?").
+     * @param command Comando SSH a ser enviado.
+     * @param descriptionToAction Descrição da ação, usada no relatório.
+     * @returns true se sucesso, false caso contrário.
+     */
+    static writeAndReturnCommand(command: string, descriptionToAction: string): Promise<boolean>;
+    /**
+     * Lê a saída do log do servidor remoto.
+     * @param descriptionToAction Descrição da ação, usada no relatório.
+     * @returns Saída do log como string.
+     */
+    static read(descriptionToAction: string): string;
+    /**
+     * Verifica a saída do comando enviado ao servidor remoto.
+     * @returns true se o comando foi executado com sucesso, false caso contrário.
+     */
+    static readOutputCommand(): Promise<boolean>;
+    /**
+     * Faz download de arquivo do servidor remoto para o caminho de destino especificado.
+     * @param sourcePath Caminho do arquivo no servidor remoto.
+     * @param destinyPath Caminho de destino para salvar o arquivo.
+     * @param descriptionToAction Descrição da ação, usada no relatório.
+     */
+    static download(sourcePath: string, destinyPath: string, descriptionToAction: string): Promise<void>;
+    /**
+     * Registra o início da execução e limpa o contexto SSH.
+     */
+    static registrarInicioExecucao(): void;
+    /**
+     * Registra o fim da execução.
+     */
+    static registrarFimExecucao(): void;
+    /**
+     * Registra um evento de log no contexto SSH.
+     * @param message Mensagem de log.
+     */
+    static logEvent(message: string): void;
+    /**
+     * Registra a duração de um teste SSH.
+     * @param nome Nome do teste.
+     * @param duracao Duração em milissegundos.
+     */
+    static registrarDuracaoDoTeste(nome: string, duracao: number): void;
+    /**
+     * Valida se a saída contém o texto esperado.
+     * @param output Saída do comando SSH.
+     * @param expected Texto esperado.
+     * @param message Mensagem descritiva da validação.
+     * @throws {Error} Se o texto não for encontrado.
+     */
+    static validateContains(output: string, expected: string, message: string): void;
+    /**
+     * Valida se a saída NÃO contém o texto especificado.
+     * @param output Saída do comando SSH.
+     * @param notExpected Texto que não deve estar presente.
+     * @param message Mensagem descritiva da validação.
+     * @throws {Error} Se o texto for encontrado.
+     */
+    static validateNotContains(output: string, notExpected: string, message: string): void;
+    /**
+     * Valida se a saída corresponde a uma expressão regular.
+     * @param output Saída do comando SSH.
+     * @param pattern Padrão regex.
+     * @param message Mensagem descritiva da validação.
+     * @throws {Error} Se a saída não corresponder ao padrão.
+     */
+    static validateMatches(output: string, pattern: RegExp, message: string): void;
+    /**
+     * Adiciona log personalizado ao contexto SSH.
+     * @param mensagem Mensagem de log.
+     * @param tipo Tipo do log ('info', 'success', 'error', 'warning').
+     */
+    static adicionarLog(mensagem: string, tipo?: 'info' | 'success' | 'error' | 'warning'): void;
+    /**
+     * Anexa o relatório final do teste SSH ao UnifiedReportManager.
+     */
+    static anexarRelatorioFinal(): Promise<void>;
+    /**
+     * Limpa todos os dados e métricas SSH.
+     */
+    static limparTudo(): void;
+    /**
+     * Obtém estatísticas do teste SSH atual.
+     * @returns Objeto com total de logs, sucessos, erros, comandos executados e duração total.
+     */
+    static obterEstatisticas(): {
+        totalLogs: number;
+        sucessos: number;
+        erros: number;
+        comandosExecutados: number;
+        duracaoTotal: number;
+    };
+    /**
+     * Verifica se há logs registrados para o teste SSH atual.
+     * @returns true se houver logs, false caso contrário.
+     */
+    static temLogs(): boolean;
+    /**
+     * Obtém todos os logs registrados para o teste SSH atual.
+     * @returns Array de logs.
+     */
+    static obterLogs(): string[];
+    /**
+     * Verifica se houve falhas no teste SSH atual.
+     * @returns true se houver falhas, false caso contrário.
+     */
+    static temFalhas(): boolean;
+    /**
+     * Obtém um resumo do teste SSH atual.
+     * @returns Objeto com informações de logs, falhas, estatísticas e datas.
+     */
+    static obterResumo(): {
+        temLogs: boolean;
+        temFalhas: boolean;
+        estatisticas: ReturnType<typeof SSHActions.obterEstatisticas>;
+        inicioExecucao?: Date;
+        fimExecucao?: Date;
+    };
+    /**
+     * Indica se o SSHActions foi utilizado no teste atual.
+     * @returns true se utilizado, false caso contrário.
+     */
+    static foiUtilizado(): boolean;
+    /**
+     * Obtém métricas resumidas do teste SSH atual.
+     * @returns Objeto com comandosExecutados, sucessos, erros e duracaoTotal.
+     */
+    static getMetrics(): {
+        comandosExecutados: number;
+        sucessos: number;
+        erros: number;
+        duracaoTotal: number;
+    };
+    /**
+     * Valida se a saída contém o texto esperado dentro de um timeout.
+     * @param output Saída do comando SSH.
+     * @param expected Texto esperado.
+     * @param message Mensagem descritiva da validação.
+     * @param timeout Tempo máximo em ms para aguardar.
+     * @throws {Error} Se o texto não for encontrado no tempo especificado.
+     */
+    static validateContainsWithTimeout(output: string, expected: string, message: string, timeout?: number): Promise<void>;
+    /**
+     * Valida se todos os textos esperados estão presentes na saída.
+     * @param output Saída do comando SSH.
+     * @param expectedTexts Array de textos esperados.
+     * @param message Mensagem descritiva da validação.
+     * @throws {Error} Se algum texto não for encontrado.
+     */
+    static validateContainsAll(output: string, expectedTexts: string[], message: string): void;
+    /**
+     * Valida se pelo menos um dos textos esperados está presente na saída.
+     * @param output Saída do comando SSH.
+     * @param expectedTexts Array de textos esperados.
+     * @param message Mensagem descritiva da validação.
+     * @throws {Error} Se nenhum texto for encontrado.
+     */
+    static validateContainsAny(output: string, expectedTexts: string[], message: string): void;
+}