@silasfmartins/testhub 1.0.0

package/scripts/init-ssh.ts

@@ -0,0 +1,734 @@
+#!/usr/bin/env node
+// @ts-nocheck
+
+import fs from 'node:fs'
+import { execSync } from 'child_process'
+import yaml from 'js-yaml'
+import path from 'path'
+import {
+  generateBiomeConfigString,
+  generatePackageJson,
+  generateTsConfigForProject,
+  generateVitestConfigString,
+  getLatestVersions,
+} from './package-versions.js'
+import { setupUltracite } from './ultracite-setup.js'
+
+const root = process.cwd()
+const catalogPath = path.join(root, 'catalog-info.yaml')
+
+if (!fs.existsSync(catalogPath)) {
+  console.error('❌ Arquivo catalog-info.yaml não encontrado.')
+  process.exit(1)
+}
+
+const catalog = yaml.load(fs.readFileSync(catalogPath, 'utf-8')) as any
+const projectName = catalog?.metadata?.name || 'meu-projeto'
+const projectNameUnderscore = projectName.replace(/-/g, '_')
+
+const write = (filePath: string, content: string) => {
+  const fullPath = path.join(root, filePath)
+  fs.mkdirSync(path.dirname(fullPath), { recursive: true })
+  fs.writeFileSync(fullPath, content)
+}
+
+async function main() {
+  console.log('🚀 Inicializando projeto SSH com versões atualizadas...')
+  console.log(`📦 Projeto: ${projectName}`)
+  console.log('')
+
+  // ✅ Buscar versões mais recentes
+  const versions = await getLatestVersions()
+
+  // ✅ Gerar package.json com versões atualizadas
+  const packageJsonContent = generatePackageJson(projectName, 'ssh', versions)
+
+  // ✅ Gerar tsconfig.json baseado no AutoCore
+  const tsconfigContent = generateTsConfigForProject('ssh')
+
+  // ✅ Gerar vitest.config.ts baseado no AutoCore (NOVO!)
+  const vitestConfigContent = generateVitestConfigString('ssh')
+
+  // ✅ Gerar biome.json sincronizado com AutoCore
+  const biomeConfigContent = generateBiomeConfigString()
+
+  console.log('📝 Criando arquivos do projeto...')
+
+  // package.json com versões dinâmicas
+  write('package.json', JSON.stringify(packageJsonContent, null, 2))
+
+  // ✅ tsconfig.json sempre sincronizado com o AutoCore
+  write('tsconfig.json', JSON.stringify(tsconfigContent, null, 2))
+
+  // ✅ biome.json sincronizado automaticamente com o AutoCore
+  write('biome.json', biomeConfigContent)
+
+  // playwright.config.ts
+  write(
+    'playwright.config.ts',
+    `import { defineConfig } from '@playwright/test'
+export default defineConfig({
+  globalSetup: '@silasfmartins/testhub/setup',
+  reporter: [
+    ['list'],
+    ['html', { open: 'never' }],
+    ['@silasfmartins/testhub/reporter'],
+  ],
+  testDir: './tests',
+  testMatch: ['**/*.spec.ts', '**/*.test.ts'],
+  // Timeouts adequados para testes rápidos
+  timeout: 120_000,
+  expect: {
+    timeout: 60_000,
+  },
+  fullyParallel: false,
+  workers: 1,
+  retries: 0,
+  use: {
+    trace: 'on',
+  },
+})
+`,
+  )
+
+  // .npmrc
+  write(
+    '.npmrc',
+    `registry=https://pkgs.dev.azure.com/telefonica-vivo-brasil/_packaging/DevOps/npm/registry/`,
+  )
+
+  // .gitignore
+  write(
+    '.gitignore',
+    `# Playwright
+node_modules/
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/
+
+.vscode
+.vscode/
+
+# Tests e logs
+/tests
+/logs
+docs
+docs/
+
+# Environment files
+.env
+.env.preprod
+.env.esteira1
+.env.esteira2
+.env.prodlike
+
+# AutoCore específicos
+.test-data-store.json
+.env.lock
+.configlogger.lock
+.rbqa
+.rbqa/
+
+# VS Code
+.vscode/settings.json
+
+# Biome
+.biome.log
+
+# Coverage
+coverage/
+*.lcov
+
+# SSH específicos
+*.pem
+*.key
+ssh_keys/
+private_keys/`,
+  )
+
+  // Arquivo de environment padrão
+  write(
+    '.env',
+    `# Arquivo que seleciona o ambiente a ser utilizado
+ENV=preprod`,
+  )
+
+  // Arquivo de environment padrão
+  write(
+    '.env.preprod',
+    `# Configurações de ambiente para preprod - SSH
+SSH_HOST=
+SSH_PORT=22
+SSH_USER=
+SSH_PASSWORD=
+SSH_PRIVATE_KEY_PATH=
+SSH_PASSPHRASE=
+SSH_TIMEOUT=30000
+# Adicione suas variáveis de SSH aqui`,
+  )
+
+  // Arquivo de environment esteira1
+  write(
+    '.env.esteira1',
+    `# Configurações de ambiente para esteira1 - SSH
+SSH_HOST=
+SSH_PORT=22
+SSH_USER=
+SSH_PASSWORD=
+SSH_PRIVATE_KEY_PATH=
+SSH_PASSPHRASE=
+SSH_TIMEOUT=30000
+# Adicione suas variáveis de SSH aqui`,
+  )
+
+  // Arquivo de environment esteira2
+  write(
+    '.env.esteira2',
+    `# Configurações de ambiente para esteira2 - SSH
+SSH_HOST=
+SSH_PORT=22
+SSH_USER=
+SSH_PASSWORD=
+SSH_PRIVATE_KEY_PATH=
+SSH_PASSPHRASE=
+SSH_TIMEOUT=30000
+# Adicione suas variáveis de SSH aqui`,
+  )
+
+  // Arquivo de environment prodlike
+  write(
+    '.env.prodlike',
+    `# Configurações de ambiente para prodlike - SSH
+SSH_HOST=
+SSH_PORT=22
+SSH_USER=
+SSH_PASSWORD=
+SSH_PRIVATE_KEY_PATH=
+SSH_PASSPHRASE=
+SSH_TIMEOUT=30000
+# Adicione suas variáveis de SSH aqui`,
+  )
+
+  // Exemplo de statements SSH
+  write(
+    'src/statements/StatementsSSH.ts',
+    `import { Logger, SSHActions, type SSHClient } from "@silasfmartins/testhub"
+
+/**
+ * Executa o processo de consumo de voz VC1 via SSH
+ */
+export class StatementsConsumeVoice {
+  async consumeVoiceVcOne(client: SSHClient) {
+    Logger.info("Iniciando processo de consumo de voz VC1")
+
+    // Executar comando LS
+    await client.write("ls", "Executando LS para listar diretórios")
+
+    // Ler resposta
+    const response = client.read("Lendo resultado do comando LS")
+
+    // Validar se contém LOGS
+    SSHActions.validateContains(
+      response,
+      "LOGS",
+      "Validando se diretório LOGS existe"
+    )
+  }
+}`,
+  )
+
+  // Chave SSH
+  write('secrets/CHAVE_ACESSO.key', '')
+
+  // Exemplo de teste básico
+  write(
+    'tests/example.spec.ts',
+    `/**
+* ConectorSSH - SSH Test Runner
+* Package: br.com.vivo
+* Generated: 2026-01-13T19:26:21.843Z
+*/
+
+import { test, TestAnnotations, type TestInfo } from '@silasfmartins/testhub'
+import { ConectorSSH } from '../src/statements/StatementsSSH.js'
+
+test.describe('SSH - criar Lead', () => {
+  TestAnnotations.stopOnFailure()
+  test('CT01 - criar Lead', async ({}, testInfo: TestInfo) => {
+    TestAnnotations.SSH.testInfo = testInfo
+    await TestAnnotations.setSystem('SANITY_SSH')
+    await new ConectorSSH().criarLead()
+  })
+})`,
+  )
+
+  // Exemplo de teste sem chave
+  write(
+    'tests/example_sem_chave.spec.ts',
+    `/**
+* ConectorSSH - SSH Test Runner
+* Package: br.com.vivo
+* Generated: 2026-01-13T19:26:21.843Z
+*/
+
+import { test, TestAnnotations, type TestInfo } from '@silasfmartins/testhub'
+import { ConectorSSH } from '../src/statements/StatementsSSH.js'
+
+test.describe('SSH - criar Lead', () => {
+  TestAnnotations.stopOnFailure()
+  test('CT01 - criar Lead', async ({}, testInfo: TestInfo) => {
+    TestAnnotations.SSH.testInfo = testInfo
+    await TestAnnotations.setSystem('SISTEMA')
+    await SSHActions.connectWithKey("CAMINHO_DA_CHAVE")
+    await new ConectorSSH().criarLead()
+  })
+})`,
+  )
+
+  // Pipeline Azure DevOps
+  write(
+    '.azuredevops/azure-pipeline.yml',
+    `trigger:
+  batch: true
+  branches:
+    include:
+    - 'master'
+  paths:
+    include:
+    - '*'
+    exclude:
+    - .azuredevops/*
+    - docs/*
+    - catalog-info.yaml
+    - mkdocs.yml
+    - scripts.py
+    - catalog/*
+
+resources:
+  repositories:
+    - repository: CodePlay
+      name: DevOps/Vivo.CodePlay.Pipelines
+      type: git
+      ref: refs/heads/test-playwright
+      endpoint: CodePlay
+
+pool:
+  name: GeneralPurposeLinuxAgentsCI
+
+extends:
+  template: tech_products/qa/build/pipeline_node_npm.yml@CodePlay
+  parameters:
+    jobName: 'build_${projectNameUnderscore}_pkg'
+    commitSHA: '$(Build.SourceVersion)'
+    registryServiceConnection: 'ACR-DEVOPS'
+    govAppAcronym: ''
+    skipScan: false  # Alterado para false para executar Fortify e SonarQube
+`,
+  )
+
+  // SonarQube configuration
+  write(
+    '.azuredevops/sonar-project.properties',
+    `################### NÃO ALTERAR!!! ###################
+# Informações gerais sobre o projeto.                #
+# Todas as variáveis de ambiente são fornecidas pela #
+# automação, não alterar!                            #
+######################################################
+
+sonar.projectDescription=Projeto SSH com AutoCore
+sonar.analysis.orgName=\${env.AZ_ORG_NAME}
+sonar.analysis.buildAuthor=\${env.AZ_BUILD_AUTHOR}
+sonar.scm.exclusions.disabled=false
+sonar.scm.forceReloadAll=true
+sonar.log.level=DEBUG
+sonar.verbose=true
+sonar.sourceEncoding=UTF-8
+
+# Diretórios e arquivos relevantes para Node.js/TypeScript
+sonar.sources=src
+sonar.inclusions=**/*.ts
+sonar.test.inclusions=**/*.spec.ts,**/*.test.ts
+sonar.typescript.lcov.reportPaths=coverage/lcov.info
+sonar.javascript.lcov.reportPaths=coverage/lcov.info
+
+# Exclusões de cobertura e análise
+sonar.exclusions=node_modules/**,dist/**,coverage/**,**/*.config.js,**/*.config.ts,**/*.key,**/*.pem
+sonar.coverage.exclusions=**/*.d.ts,node_modules/**,dist/**,coverage/**,**/*.config.js,**/*.config.ts,**/*.spec.ts,**/*.test.ts,**/*.key,**/*.pem
+sonar.test.exclusions=node_modules/**,dist/**,coverage/**,**/*.key,**/*.pem
+
+# Configurações específicas para projetos SSH
+sonar.javascript.environments=node
+sonar.typescript.node=true
+`,
+  )
+
+    //env.ts
+  write('src/env.ts', `import { config } from 'dotenv'
+
+config()
+
+const rawEnv = {
+  ENV: process.env.ENV,
+}
+export const env = rawEnv
+`)
+
+  // README.md
+  write(
+    'README.md',
+    `# ${projectName}
+
+Projeto de automação de testes SSH baseado no AutoCore.
+
+## 🚀 Como usar
+
+### Pré-requisitos
+1. **Node.js**: Versão 24+ instalada
+2. **Acesso SSH**: Servidor SSH configurado
+3. **Chave privada**: Arquivo de chave privada SSH (opcional, pode usar senha)
+
+### Instalação de dependências
+\`\`\`bash
+npm install
+\`\`\`
+
+### Configuração SSH
+1. Configure as variáveis de ambiente nos arquivos \`.env.*\`
+2. Adicione suas credenciais SSH (host, usuário, chave privada ou senha)
+3. Execute os testes
+
+### Executar testes
+\`\`\`bash
+# Ambiente preprod
+npm run test:preprod
+
+# Ambiente esteira1
+npm run test:esteira1
+
+# Ambiente esteira2
+npm run test:esteira2
+
+# Ambiente prodlike
+npm run test:prodlike
+\`\`\`
+
+### Gerar Artefato para Projetos de Cenários
+npm run build
+
+## 📋 Estrutura do projeto
+
+\`\`\`
+${projectName}/
+├── src/
+│   └── statements/          # Lógica de operações SSH
+|   └── env.ts                # Configuração de environment
+├── tests/                   # Arquivos de teste
+├── .env.*                  # Variáveis de ambiente por ambiente
+├── playwright.config.ts    # Configuração do Playwright
+├── tsconfig.json          # Configuração TypeScript (sincronizada)
+├── biome.json           # Configuração Biome (sincronizada)
+└── README.md            # Esta documentação
+\`\`\`
+
+## 🔧 Desenvolvimento
+
+- **TypeScript**: Configurado e sincronizado com AutoCore
+- **Playwright**: Framework de testes
+- **AutoCore**: Biblioteca de utilitários para automação SSH
+- **Biome**: Linting e formatação (configuração sincronizada)
+- **Ultracite**: Experiência de desenvolvimento aprimorada
+
+## 📊 Relatórios
+
+Os relatórios são gerados automaticamente em:
+- \`playwright-report/\` - Relatório HTML visual
+- \`test-results/\` - Resultados detalhados e artifacts
+- Logs estruturados no console
+
+## 🧪 Exemplos de Uso
+
+### Teste básico SSH
+\`\`\`typescript
+import { type TestInfo, test, TestAnnotations } from '@silasfmartins/testhub'
+import { StatementsSSH } from 'projetoSSH';
+
+test('Conexão SSH', async ({ }, testInfo) => {
+  TestAnnotations.SSH.testInfo = testInfo;
+  await TestAnnotations.setSystem('MEU_SISTEMA');
+  await new StatementsSSH().criarLead()
+});
+\`\`\`
+
+### Verificação de serviços
+\`\`\`typescript
+import { Logger, SSHActions } from '@silasfmartins/testhub'
+
+export class ConectorSSH {
+  async criarLead(): Promise<void> {
+    Logger.info('Executando o método: criarLead')
+    Logger.info('Iniciando processo de criação de Lead')
+    const comando =
+      'cmd.exe /c "cd /d  C:\\Program Files (x86)\\salesforce.com\\Data Loader\\bin && dir && call InsertTesteRelease.bat && call InsertCampanhaTesteRelease.bat && call updateAdabasTesteRelease.bat"'
+    Logger.info('Executando comando no servidor')
+    await SSHActions.write(comando, 'Executando scripts de Lead no Data Loader')
+    const response = SSHActions.read('Resposta do comando')
+    Logger.info('--- Saída do comando ---')
+    Logger.info(response)
+    SSHActions.validateNotContains(
+      response,
+      'ERROR',
+      'Validando ausência de erros',
+    )
+    SSHActions.validateNotContains(
+      response,
+      'Exception',
+      'Validando ausência de exceções',
+    )
+    await SSHActions.desconectar()
+    Logger.info('Processo de criação de Lead finalizado com sucesso.')
+    Logger.info('Teste Finalizado.')
+  }
+}
+\`\`\`
+
+## 🔧 Comandos Úteis
+
+\`\`\`bash
+# Desenvolvimento
+npm run test:preprod        # Executar testes em preprod
+npm run build              # Compilar projeto Local (se necessário)
+
+# Qualidade de código
+npx biome check            # Verificar código com Biome
+npx biome format           # Formatar código com Biome
+npx biome check --apply    # Aplicar correções automáticas
+
+# Debug
+npm run test:preprod -- --debug    # Executar em modo debug
+\`\`\`
+
+## 🔐 Configuração SSH
+
+### Variáveis de ambiente necessárias:
+\`\`\`bash
+SSH_PRIVATE_KEY_PATH=/path/to/private/key
+SSH_TIMEOUT=30000
+\`\`\`
+
+### Alternativamente com senha:
+\`\`\`bash
+SSH_TIMEOUT=30000
+\`\`\`
+
+## 🔄 Sincronização com AutoCore
+
+Este projeto mantém sincronização automática com o AutoCore para:
+
+- **tsconfig.json**: Configuração de compilação TypeScript
+- **biome.json**: Configuração de linting e formatação
+- **Versões de dependências**: Sempre atualizadas
+
+Para sincronizar manualmente:
+\`\`\`bash
+npm run sync
+\`\`\`
+
+## 📈 Métricas e Monitoramento
+
+- **Relatórios HTML**: Visualização rica dos resultados
+- **Logs estruturados**: Para análise e debugging
+- **Screenshots automáticos**: Em caso de falhas
+- **Traces**: Para análise detalhada de execução
+- **Métricas de conexão**: Tempo de resposta SSH
+
+## 🔒 Segurança
+
+### Boas práticas implementadas:
+- **Variáveis de ambiente**: Credenciais não expostas no código
+- **Chaves privadas**: Preferência por autenticação via chave
+- **Timeouts**: Evita conexões infinitas
+- **Logs seguros**: Senhas não são logadas
+
+### Dicas de segurança:
+- Use sempre chaves SSH ao invés de senhas
+- Mantenha chaves privadas com permissões restritivas (600)
+- Configure fail2ban no servidor SSH
+- Use portas SSH não padrão quando possível
+- Mantenha logs de auditoria habilitados
+
+## 🆘 Resolução de Problemas
+
+### Erro de conexão SSH
+\`\`\`bash
+# Verificar conectividade
+telnet $SSH_HOST $SSH_PORT
+
+# Testar autenticação
+ssh -i $SSH_PRIVATE_KEY_PATH $SSH_USER@$SSH_HOST
+
+# Verificar permissões da chave
+chmod 600 /path/to/private/key
+\`\`\`
+
+### Problemas de autenticação
+\`\`\`bash
+# Verificar se chave está no servidor
+ssh-copy-id -i ~/.ssh/id_rsa.pub user@servidor.com
+
+# Verificar logs SSH no servidor
+sudo tail -f /var/log/auth.log
+
+# Testar com verbosidade
+ssh -vvv -i /path/to/key user@servidor.com
+\`\`\`
+
+### Problemas de timeout
+\`\`\`bash
+# Aumentar timeout no .env
+SSH_TIMEOUT=60000  # 60 segundos
+
+# Verificar latência de rede
+ping $SSH_HOST
+\`\`\`
+
+### Atualizar dependências
+\`\`\`bash
+npx npm-check-updates -u && npm install
+\`\`\`
+
+## 📝 Contribuição
+
+1. Mantenha os padrões de código (Biome configurado)
+2. Adicione testes para novas funcionalidades SSH
+3. Use o sistema de logging do AutoCore
+4. Documente comandos e scripts adicionados
+5. Valide segurança das operações SSH
+
+## 📚 Referências
+
+- [AutoCore Website](http://brtlvlty0559pl:3002/pt/login)
+- [SSH Protocol Documentation](https://tools.ietf.org/html/rfc4254)
+- [SSH Security Best Practices](https://stribika.github.io/2015/01/04/secure-secure-shell.html)
+
+---
+
+**Gerado automaticamente pelo AutoCore v${versions?.dependencies?.['@silasfmartins/testhub'] || 'latest'}**
+`,
+  )
+
+  console.log('📦 Instalando dependências...')
+
+  const installLockPath = path.join(root, '.install.lock')
+  if (fs.existsSync(installLockPath)) {
+    // Pula npm install se o lock já existe
+    console.log('🔄 Dependências já instaladas, pulando npm install')
+  } else {
+    // Executa npm install e cria o lock
+    console.log('📦 Instalando dependências...')
+    try {
+      execSync('npm install', {
+        stdio: 'inherit',
+        cwd: root,
+      })
+      fs.writeFileSync(installLockPath, 'ok')
+      console.log('✅ Dependências instaladas com sucesso')
+    } catch (error) {
+      console.warn('⚠️ Erro ao instalar dependências automaticamente')
+      console.log('💡 Execute manualmente: npm install')
+    }
+  }
+
+  // ✅ Estrutura de testes
+  console.log('📝 Criando estrutura de testes...')
+
+  // tests/example.spec.ts - Teste E2E com Playwright
+  write(
+    'tests/example.spec.ts',
+    `import { type TestInfo, test } from '@playwright/test'
+import { SSHClient, TestAnnotations } from '@silasfmartins/testhub'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { StatementsConsumeVoice } from '../src/statements/StatementsSSH.js'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
+test.describe('Teste SSH via Gateway - SMP', () => {
+  const client = new SSHClient()
+
+  test.beforeEach(async ({}, testInfo: TestInfo) => {
+    TestAnnotations.SSH.testInfo = testInfo
+    // Use SSHActions.connectWithKey to manage connection automatically
+    // await SSHActions.connectWithKey(path.resolve(__dirname, '../secrets/UserSistAutBRM'))
+    // If you prefer low-level client, ensure SSHClient.setPrivateKeyPath exists
+  })
+
+  test('CT01 - Consumo de Voz VC1', async () => {
+    await new StatementsConsumeVoice().consumeVoiceVcOne(client)
+  })
+})
+`,
+  )
+
+  // ✅ Configurar Ultracite automaticamente
+  console.log('🤖 Configurando ambiente de desenvolvimento...')
+  await setupUltracite(root)
+
+  // ✅ Garantir sincronização final do biome.json
+  console.log('🔧 Sincronizando configuração do Biome...')
+  const finalBiomeConfig = generateBiomeConfigString()
+  write('biome.json', finalBiomeConfig)
+
+  // Remover o lock após tudo finalizar
+  if (fs.existsSync(installLockPath)) {
+    fs.unlinkSync(installLockPath)
+    console.log('🗑️ Lock de instalação removido')
+  }
+
+  console.log('')
+  console.log('🎉 Projeto SSH gerado com sucesso!')
+  console.log('')
+  console.log('📋 Próximos passos:')
+  console.log('   1. Configure suas variáveis SSH nos arquivos .env.*')
+  console.log('   2. Adicione host, usuário e chave privada SSH')
+  console.log('   3. Execute: npm run test:preprod')
+  console.log('   4. O Ultracite está configurado para VS Code')
+  console.log('')
+  console.log('🛠️ Comandos úteis:')
+  console.log('   npm run test:preprod     - Executar testes em preprod')
+  console.log('   npm run test:esteira1    - Executar testes em esteira1')
+  console.log('   npm run test:esteira2    - Executar testes em esteira2')
+  console.log('   npm run test:prodlike    - Executar testes em prodlike')
+  console.log('   npm run build           - Compilar projeto')
+  console.log('   npm run update          - Atualizar índices')
+  console.log('   npx biome check         - Verificar código com Biome')
+  console.log('   npx biome format        - Formatar código com Biome')
+  console.log('')
+  console.log('✅ Configurações sincronizadas com AutoCore:')
+  console.log('   📝 tsconfig.json - Compilação TypeScript')
+  console.log('   🎨 biome.json - Linting e formatação (SINCRONIZADO)')
+  console.log('   🤖 Ultracite - Experiência de desenvolvimento')
+  console.log('   📦 Dependências - Versões mais recentes')
+  console.log('   🔐 SSH Client - Configuração completa para automação')
+  console.log('')
+  console.log('🚀 Projeto pronto para desenvolvimento SSH!')
+  console.log('')
+  console.log('💡 Dicas importantes:')
+  console.log(
+    '   • Configure chaves SSH ao invés de senhas para maior segurança',
+  )
+  console.log(
+    '   • Teste a conectividade SSH manualmente antes de executar testes',
+  )
+  console.log(
+    '   • Mantenha chaves privadas com permissões 600 (apenas owner pode ler)',
+  )
+  console.log('   • Use o timeout adequado para operações SSH lentas')
+}
+
+// Executar função principal
+main().catch((error) => {
+  console.error('❌ Erro durante inicialização:', error)
+  process.exit(1)
+})