@silasfmartins/testhub 1.0.0

package/scripts/init-api.ts

@@ -0,0 +1,613 @@
+#!/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 API 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, 'api', versions)
+
+  // ✅ Gerar tsconfig.json baseado no AutoCore
+  const tsconfigContent = generateTsConfigForProject('api')
+
+  // ✅ Gerar vitest.config.ts sincronizado com o AutoCore (corrige ReferenceError)
+  const vitestConfigContent = generateVitestConfigString('api')
+
+  // ✅ 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,
+  },
+  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/
+
+# Tests e logs
+/tests
+/logs
+docs
+docs/
+
+# Environment files
+.env
+.env.preprod
+.env.esteira1
+.env.esteira2
+.env.prodlike
+.env.prod
+
+.vscode
+.vscode/
+
+# AutoCore específicos
+.test-data-store.json
+.env.lock
+.configlogger.lock
+
+# VS Code
+.vscode/settings.json
+.github/
+.github
+
+# Biome
+.biome.log
+
+# Coverage
+coverage/
+*.lcov
+
+# Screenshots e videos
+/test-results/
+/playwright-report/`,
+  )
+
+  // 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
+# Adicione suas variáveis de ambiente aqui`,
+  )
+
+  // Arquivo de environment esteira1
+  write(
+    '.env.esteira1',
+    `# Configurações de ambiente para esteira1
+# Adicione suas variáveis de ambiente aqui`,
+  )
+
+  // Arquivo de environment esteira2
+  write(
+    '.env.esteira2',
+    `# Configurações de ambiente para esteira2
+# Adicione suas variáveis de ambiente aqui`,
+  )
+
+  // ✅ 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, TestAnnotations, ApiActions } from '@silasfmartins/testhub'
+
+test.describe('API Tests - ${projectName}', () => {
+  TestAnnotations.stopOnFailure() // opcional: para o runner ao falhar um CT
+
+  test('CT001 - Exemplo de requisição API', async ({ }, testInfo: TestInfo) => {
+    TestAnnotations.Api.testInfo = testInfo
+    await TestAnnotations.setSystem('MEU_SISTEMA')
+    
+    // Exemplo de requisição - substitua pelo seu statement
+    // await new StatementsToken().getToken()
+    
+    // Exemplo de chamada API direta
+    await ApiActions.executeGet(
+      'Buscar dados do endpoint',
+      '/api/endpoint'
+    )
+  })
+})
+`,
+  )
+
+  // Arquivo de environment prodlike
+  write(
+    '.env.prodlike',
+    `# Configurações de ambiente para prodlike
+# Adicione suas variáveis de ambiente aqui`,
+  )
+
+  // Exemplo de Request Token
+  write(
+    'src/request/token/RequestToken.ts',
+    `import type { ApiRequest } from '@silasfmartins/testhub'
+
+export class RequestToken {
+  requestToken(): ApiRequest {
+    const headers = {
+      authorization: 'Basic exemplo',
+      'Content-Type': 'application/json',
+    }
+
+    const data = 'exemplo'
+
+    return {
+      url: '/ms_oauth/oauth2/endpoints/vivooauthservice/tokens',
+      options: { headers, data },
+    }
+  }
+}
+`,
+  )
+
+  // Exemplo de statements
+  write(
+    'src/statements/token/StatementsToken.ts',
+    `import { ApiActions, DataStore, Logger } from "@silasfmartins/testhub"
+import { RequestToken } from "../request/token/RequestToken.js"
+
+export class StatementsToken {
+  /**
+   * Obter token sistêmico para autenticação
+   */
+  async getToken(): Promise<void> {
+    Logger.info("Executando o método: getToken");
+    Logger.info("Iniciando Get Token Sistêmico");
+
+    const VALIDATE_TOKEN = 200
+
+    const tokenResponse = await ApiActions.post(
+      new RequestToken().requestToken(), 
+      "Requisição Token Sistêmico", 
+      true
+    );
+
+    ApiActions.validateEquals(
+      tokenResponse.status(),
+      VALIDATE_TOKEN, 
+      "Validação do status code da requisição de token"
+    );
+
+    // Armazenar token para uso posterior
+    DataStore.set("ACCESS_TOKEN", tokenResponse.get("token"))
+    
+    Logger.info("Token obtido e armazenado com sucesso");
+  }
+}
+`,
+  )
+
+  // Exemplo de teste básico
+  write(
+    'tests/example.spec.ts',
+    `import { type TestInfo, test, TestAnnotations } from '@silasfmartins/testhub'
+import { StatementsToken } from '../src/statements/token/StatementsToken.js';
+
+test.describe('Exemplo API Tests', () => {
+  TestAnnotations.Api.testInfo = testInfo;
+  await TestAnnotations.setSystem('MEU_SISTEMA');
+  test('Deve obter token com sucesso', async () => {  
+    // Obter token
+    await new StatementsToken().getToken()
+  });
+});`,
+  )
+
+  //env.ts
+  write('src/env.ts', `import { config } from 'dotenv'
+
+config()
+
+const rawEnv = {
+  ENV: process.env.ENV,
+}
+export const env = rawEnv
+`)
+
+  // 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 de API 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
+sonar.coverage.exclusions=**/*.d.ts,node_modules/**,dist/**,coverage/**,**/*.config.js,**/*.config.ts,**/*.spec.ts,**/*.test.ts
+sonar.test.exclusions=node_modules/**,dist/**,coverage/**
+
+# Configurações específicas para projetos API
+sonar.javascript.environments=node
+sonar.typescript.node=true
+`,
+  )
+
+  // README.md
+  write(
+    'README.md',
+    `# ${projectName}
+
+Projeto de automação de testes de API baseado no AutoCore.
+
+## 🚀 Como usar
+
+### Instalação de dependências
+\`\`\`bash
+npm install
+\`\`\`
+
+### 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
+
+### Configuração de ambiente
+
+1. Configure as variáveis de ambiente nos arquivos \`.env.*\`
+2. Adicione suas URLs de API e credenciais
+3. Execute os testes
+
+## 📋 Estrutura do projeto
+
+\`\`\`
+${projectName}/
+├── src/
+│   ├── statements/          # Lógica de negócio dos testes
+│   └── request/            # Configurações de requisições
+|   └── 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
+- **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 de API
+\`\`\`typescript
+import { type TestInfo, test, TestAnnotations } from '@silasfmartins/testhub'
+
+test('Meu teste de API', async ({ }, testInfo) => {
+  TestAnnotations.Api.testInfo = testInfo;
+  
+  const response = await ApiActions.get({
+    url: 'https://api.example.com/endpoint',
+    options: {}
+  }, 'Descrição da requisição');
+  
+  ApiActions.validateEquals(response.status, 200, 'Status deve ser 200');
+});
+\`\`\`
+
+### Fluxo com autenticação
+\`\`\`typescript
+import { StatementsToken } from '../src/statements/StatementsToken.js';
+import { DataStore } from '@silasfmartins/testhub';
+
+test('Fluxo autenticado', async () => {
+  // Obter token
+  const statements = new StatementsToken();
+  await statements.getToken();
+  
+  // Usar token
+  const token = DataStore.get('ACCESS_TOKEN');
+  // ... usar token em requisições subsequentes
+});
+\`\`\`
+
+## 🔧 Comandos Úteis
+
+\`\`\`bash
+# Desenvolvimento
+npm run test:preprod        # Executar testes em preprod
+npm run build              # Compilar projeto (se necessário)
+npm run update             # Atualizar índices
+
+# 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
+npm run test:preprod -- --headed   # Executar com interface visual
+npm run test:preprod -- --ui       # Executar com UI do Playwright
+\`\`\`
+
+## 🔄 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
+npx autocore-sync-configs
+\`\`\`
+
+## 📈 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
+
+## 🆘 Resolução de Problemas
+
+### Erro de autenticação npm
+\`\`\`bash
+npm config set registry https://pkgs.dev.azure.com/telefonica-vivo-brasil/_packaging/DevOps/npm/registry/
+npm login
+\`\`\`
+
+### Problemas de certificado
+\`\`\`bash
+npm config set strict-ssl false
+\`\`\`
+
+### 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
+3. Use o sistema de logging do AutoCore
+4. Documente mudanças significativas
+
+---
+
+**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')
+    }
+  }
+
+  // ✅ 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 API gerado com sucesso!')
+  console.log('')
+  console.log('📋 Próximos passos:')
+  console.log('   1. Configure suas variáveis de ambiente nos arquivos .env.*')
+  console.log('   2. Adicione suas URLs de API no .env.preprod')
+  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('')
+  console.log('🚀 Projeto pronto para desenvolvimento!')
+}
+
+// Executar função principal
+main().catch((error) => {
+  console.error('❌ Erro durante inicialização:', error)
+  process.exit(1)
+})