Integracao API de Testes de Carga

Este guia explica como utilizar o Cliente API do LoadFocus, tanto atraves da interface de linha de comandos (CLI) como utilizando diretamente a biblioteca JavaScript nas suas aplicacoes.

Indice

• Instalacao
• Configuracao
• Interface de Linha de Comandos (CLI)
  • Execucao de Testes JMeter
  • Monitorizacao do Estado dos Testes
  • Obtencao de Resultados
  • Trabalhar com Limites
  • Formatos de Saida
• Utilizacao da Biblioteca JavaScript
  • Configuracao Basica
  • Cliente JMeter
  • Executar Testes
  • Monitorizar Estado dos Testes
  • Obter Resultados
  • Exemplo Completo
• Utilizacao Avancada
  • Configuracao HTTP Personalizada
  • Tratamento de Erros
  • Execucao de Testes em Paralelo
• Resolucao de Problemas

Instalacao

Instalacao Global

npm install -g @loadfocus/loadfocus-api-client

Instalacao Local no Projeto

npm install @loadfocus/loadfocus-api-client

Configuracao

Antes de utilizar o Cliente API do LoadFocus, precisa de configurar as suas credenciais de API.

Configuracao CLI

# Set API key and team ID
loadfocus-api config set apikey YOUR_API_KEY
loadfocus-api config set teamid YOUR_TEAM_ID

# Verify configuration
loadfocus-api config show

Configuracao JavaScript

const { configManager } = require('@loadfocus/loadfocus-api-client');

// Set configuration
configManager.set('apikey', 'YOUR_API_KEY');
configManager.set('teamid', 'YOUR_TEAM_ID');

// Verify configuration
console.log(configManager.get('apikey')); // Should print your API key
console.log(configManager.isConfigured()); // Should print true if all required config is set

Interface de Linha de Comandos (CLI)

O Cliente API do LoadFocus fornece uma CLI abrangente para interagir com a API do LoadFocus.

Execucao de Testes JMeter

Executar um Teste

# Execute a test by name
loadfocus-api jmeter execute --name "My JMeter Test"

# Execute a test with specific parameters
loadfocus-api jmeter execute --name "My JMeter Test" --threads 50 --rampup 30 --duration 300

Executar um Teste e Aguardar pela Conclusao

# Run a test and wait for completion
loadfocus-api jmeter run-test --name "My JMeter Test"

# Run a test with thresholds
loadfocus-api jmeter run-test --name "My JMeter Test" --thresholds "avgresponse<=200,errors==0,p95<=250"

# Run a test with custom timeout and polling interval
loadfocus-api jmeter run-test --name "My JMeter Test" --waitTimeout 1800 --pollInterval 15

Monitorizacao do Estado dos Testes

# Check status of a test by name and ID
loadfocus-api jmeter status --name "My JMeter Test" --id 12345

# Get a list of recent test runs
loadfocus-api jmeter runs --limit 10

Obtencao de Resultados

# Get results for a specific test
loadfocus-api jmeter results --name "My JMeter Test" --id 12345

# Get results with specific metrics
loadfocus-api jmeter results --name "My JMeter Test" --id 12345 --include samples,avgresponse,errors

Trabalhar com Limites

O comando run-test suporta avaliacao de limites para determinar automaticamente se um teste passa ou falha com base em metricas de desempenho.

# Run a test with multiple thresholds
loadfocus-api jmeter run-test --name "My JMeter Test" --thresholds "avgresponse<=200,errors==0,p95<=250,hitspersec>=10"

Operadores de limites suportados:

• <= - Menor ou igual a
• < - Menor que
• >= - Maior ou igual a
• > - Maior que
• == - Igual a
• != - Diferente de

Formatos de Saida

# Get results in JSON format
loadfocus-api jmeter run-test --name "My JMeter Test" --format json > results.json

# Default pretty-printed output
loadfocus-api jmeter run-test --name "My JMeter Test"

Utilizacao da Biblioteca JavaScript

O Cliente API do LoadFocus tambem pode ser utilizado diretamente como biblioteca JavaScript nas suas aplicacoes.

Configuracao Basica

// Import the LoadFocus API Client
const loadfocus = require('@loadfocus/loadfocus-api-client');

// Access specific components
const { JMeterClient, configManager } = loadfocus;

Cliente JMeter

// Create a JMeter client
const jmeterClient = new loadfocus.JMeterClient();

// Or with explicit configuration
const jmeterClient = new loadfocus.JMeterClient({
  apikey: 'YOUR_API_KEY',
  teamid: 'YOUR_TEAM_ID'
});

Executar Testes

async function executeTest() {
  try {
    const result = await jmeterClient.execute({
      testrunname: 'My JMeter Test',
      threads: 50,
      rampup: 30,
      duration: 300
    });

    console.log('Test execution started:', result);
    return result.testrunid; // Return the test ID for later use
  } catch (error) {
    console.error('Error executing test:', error);
  }
}

Monitorizar Estado dos Testes

async function checkTestStatus(testName, testId) {
  try {
    const status = await jmeterClient.getStatus({
      testrunname: testName,
      testrunid: testId
    });

    console.log('Test status:', status);
    return status.state; // Return the current state
  } catch (error) {
    console.error('Error checking test status:', error);
  }
}

Obter Resultados

async function getTestResults(testName, testId) {
  try {
    // Get available labels for the test
    const labels = await jmeterClient.getLabels({
      testrunname: testName,
      testrunid: testId
    });

    console.log('Test labels:', labels);

    // Get results for each label
    const allResults = [];
    for (const label of labels) {
      const labelResults = await jmeterClient.getResults({
        testrunname: testName,
        testrunid: testId,
        filter: label
      });

      allResults.push({
        label,
        results: labelResults
      });
    }

    console.log('Test results:', allResults);
    return allResults;
  } catch (error) {
    console.error('Error retrieving test results:', error);
  }
}

Exemplo Completo

Aqui esta um exemplo completo que executa um teste, aguarda pela conclusao e obtem os resultados:

const { JMeterClient, configManager } = require('@loadfocus/loadfocus-api-client');

// Set up configuration
configManager.set('apikey', 'YOUR_API_KEY');
configManager.set('teamid', 'YOUR_TEAM_ID');

// Create client
const jmeterClient = new JMeterClient();

async function runCompleteTest() {
  try {
    // Execute the test
    console.log('Executing test...');
    const executeResult = await jmeterClient.execute({
      testrunname: 'My JMeter Test'
    });

    const testId = executeResult.testrunid;
    console.log(`Test execution started with ID: ${testId}`);

    // Wait for completion
    console.log('Waiting for test to complete...');
    let completed = false;
    while (!completed) {
      const status = await jmeterClient.getStatus({
        testrunname: 'My JMeter Test',
        testrunid: testId
      });

      console.log(`Current state: ${status.state}`);

      if (status.state === 'finished') {
        completed = true;
      } else if (status.state === 'failed' || status.state === 'error') {
        throw new Error(`Test failed with state: ${status.state}`);
      } else {
        // Wait before checking again
        await new Promise(resolve => setTimeout(resolve, 10000));
      }
    }

    // Get results
    console.log('Getting test results...');
    const labels = await jmeterClient.getLabels({
      testrunname: 'My JMeter Test',
      testrunid: testId
    });

    const allResults = [];
    for (const label of labels) {
      const labelResults = await jmeterClient.getResults({
        testrunname: 'My JMeter Test',
        testrunid: testId,
        filter: label
      });

      allResults.push({
        label,
        results: labelResults
      });
    }

    console.log('Test results:', JSON.stringify(allResults, null, 2));
    return allResults;
  } catch (error) {
    console.error('Error running test:', error);
  }
}

// Run the test
runCompleteTest();

Utilizacao Avancada

Configuracao HTTP Personalizada

Pode personalizar o cliente HTTP utilizado pelo Cliente API do LoadFocus:

const { JMeterClient } = require('@loadfocus/loadfocus-api-client');

// Create client with custom HTTP options
const jmeterClient = new JMeterClient({
  apikey: 'YOUR_API_KEY',
  teamid: 'YOUR_TEAM_ID',
  httpOptions: {
    timeout: 30000, // 30 seconds
    retries: 3,
    headers: {
      'User-Agent': 'My Custom Application'
    }
  }
});

Tratamento de Erros

O Cliente API do LoadFocus fornece informacoes detalhadas sobre erros:

try {
  const result = await jmeterClient.execute({
    testrunname: 'My JMeter Test'
  });
} catch (error) {
  if (error.response) {
    // The request was made and the server responded with a status code
    // that falls out of the range of 2xx
    console.error('API Error:', error.response.status, error.response.data);
  } else if (error.request) {
    // The request was made but no response was received
    console.error('Network Error:', error.request);
  } else {
    // Something happened in setting up the request that triggered an Error
    console.error('Request Error:', error.message);
  }
}

Resolucao de Problemas

Problemas Comuns

1. Erros de Autenticacao:

   • Certifique-se de que a sua API key e team ID estao corretamente configurados
   • Verifique se a sua API key tem as permissoes necessarias

2. Falhas na Execucao de Testes:

   • Verifique se o nome do teste existe na sua conta LoadFocus
   • Verifique se atingiu o limite de testes concorrentes da sua conta

3. Problemas de Timeout:

   • Para testes de longa duracao, aumente o parametro waitTimeout
   • Considere implementar um mecanismo de polling em vez de aguardar de forma sincrona

4. Problemas na Obtencao de Resultados:

   • Certifique-se de que o teste foi concluido antes de obter os resultados
   • Verifique se o ID do teste esta correto

Depuracao

Ative o registo de depuracao para obter informacoes mais detalhadas:

// In your JavaScript code
process.env.DEBUG = 'true';

// Or when using the CLI
DEBUG=true loadfocus-api jmeter run-test --name "My JMeter Test"

Para ajuda adicional, consulte a documentacao da API do LoadFocus ou contacte o suporte.