Pular para o conteúdo
Documentation

CHAMPREP QA comandos

champrep qa funciona com CHAMPREP QA a partir do seu terminal: ative repositórios, execute varreduras e acompanhe sua conclusão, filtre e classifique os resultados, verifique um gate de qualidade, inicie ambientes de pré-visualização e abra espaços de trabalho do IDE na nuvem . Ele atua em seu nome, com seu CLIlogin normal. O QA verifica sua função no repositório em sua origem (CHAMPREPCode, GitHub ouGitLab Bitbucket) a cada chamada, e as cotas do seu plano são aplicadas.

  1. Instale o CLI e fazer login com champrep auth login.
  2. Seu plano deve incluir CHAMPREP QA. Conecte o GitHub, GitLab ou o Bitbucket no aplicativo web do QA primeiro, caso os utilize; os repositórios de CHAMPREPcódigo não precisam de conexão adicional.

O QA identifica um repositório por sua chave, que champrep qa repos ls e champrep qa repos available imprimir:

FonteChave
CHAMPREP Codecode:<project-uuid>
GitHubgithub:<id>
GitLabgitlab:<id>
Bitbucketbitbucket:<workspace>/<slug>

--workspace seleciona o espaço de trabalho de QA no qual agir: personal, organization:<id> ou team:<id>. Isso determina quais repositórios do espaço de trabalho você visualiza e a qual espaço de trabalho uma varredura, uma ativação, uma pré-visualização ou um espaço de trabalho de IDE é atribuído. Sem essa configuração, o QA utiliza seu espaço de trabalho padrão, assim como o aplicativo web.

ComandoObjetivo
champrep qa repos lsListe os repositórios ativos do espaço de trabalho com seu gate e a última verificação. --source code|github|gitlab|bitbucket, --gate passed|failed|not_scanned|scanning, --search, --all (inclusive inativas), --limit (1-100).
champrep qa repos available --provider PListe os repositórios que uma fonte oferece a você e indique se cada um deles está ativo.
champrep qa repos activate REPO...Comece a analisar até 100 repositórios. Cada um conta para a sua cota de repositórios.
champrep qa repos deactivate REPO...Interromper a análise de repositórios.
champrep qa repos sync --provider gitlab|bitbucketLeia novamente os projetosGitLab ou repositórios do Bitbucket a partir de sua conta conectada.
champrep qa repos sync code:<uuid>Atualizar a ponta do ramo padrão de um projeto de códigoCHAMPREP. Os repositórios do GitHub são sincronizados automaticamente.

ComandoObjetivo
champrep qa scan REPOInicie uma verificação do ramo padrão, ou --ref BRANCH. --watch (-w) acompanha até o final; --timeout (padrão) 30m) limita o tempo de espera; --profile seleciona um perfil de varredura sempre que sua organização solicitar.
champrep qa scans lsListe as varreduras que você iniciou, de um repositório (--repo REPO), ou do espaço de trabalho (--org). --run queued,running,held,passed,failed,canceled; --limit.
champrep qa scans show SCAN_IDExibir uma varredura: ramificação, commit, estado da execução, gate, achados novos e corrigidos, minutos, qualquer erro ou retenção.

As varreduras de repositórios do CodeCHAMPREP e do GitHub são executadas a partir do CLI. Uma varredura é cobrada de você uma única vez. Quando o CodeCHAMPREP trata a solicitação como sua própria CHAMPREP QAverificação, o CLIindica isso e você deve seguir com champrep qa scans ls --repo REPO.

ComandoObjetivo
champrep qa findings lsListar achados, por padrão os que estão em aberto. Filtros abaixo. --page, --limit (1-100).
champrep qa findings show FINDINGMostrar uma constatação por ID ou número de QA, como QA-0970: gravidade, estado, regra, CWE, localização, trecho de código.
champrep qa findings dismiss FINDING --reason RRejeitar uma constatação. --comment; --secret-revoked para segredos.
champrep qa findings reopen FINDINGDesfazer uma rejeição, aceitação ou resolução: a constatação volta para “Necessita de triagem”.
FiltroValores
--repo REPOUm repositório; na ausência dessa especificação, todo o espaço de trabalho.
--severitycritical, high, medium, low, info, unknown (separadas por vírgula)
--cweUm CWE, como 79 ou CWE-79
--branchConstatações neste ramo
--statedetected (Necessita de triagem), confirmed, dismissed, accepted, resolved, ou all. Padrão: detected,confirmed
--typesast, secret, iac, dependency
--searchPesquisa de texto, 3 caracteres ou mais
--mineConstatações atribuídas a você

Os motivos de demissão são false_positive, acceptable_risk, mitigating_control, used_in_tests e not_applicable. Para descartar, é necessário a função de Mantenedor ou superior. Descartar um segredo também requer --secret-revoked: confirme se o segredo foi revogado ou se nunca foi válido.

ComandoObjetivo
champrep qa gates status REPOMostre se o repositório atende aos critérios de qualidade no ramo padrão ou --branch, com a contagem e o limite de cada condição.

gates status encerra com o código 1 quando o gate falha, de modo que o senhor pode utilizá-lo para proteger um script ou uma etapa de implantação.

ComandoObjetivo
champrep qa previews lsListe suas visualizações em tempo real. --ended, --org (todo o espaço de trabalho), --repo REPO, --limit.
champrep qa previews show PREVIEW_IDMostre uma pré-visualização, seu endereço e quando ela expira.
champrep qa previews createCompile e inicie uma pré-visualização. Requer --provider e --repo owner/name; também --branch, --code-project ID, --port.
champrep qa previews extend PREVIEW_ID --minutes NMantenha uma pré-visualização em execução por mais tempo: de 5 a 1.440 minutos, até seu prazo de validade definitivo.
champrep qa previews stop PREVIEW_IDInterrompa uma visualização.

Para CHAMPREP Código, --repo é o caminho do projeto, como acme/web.

ComandoObjetivo
champrep qa ide lsListe seus espaços de trabalho do IDE em execução (--ended (para os anteriores). --json omite o de cada espaço de trabalho idePath, que contém seu token de sessão.
champrep qa ide startInicie um espaço de trabalho em --provider e --repo owner/name (--branch, --work-branch, --code-project), ou um vazio com --scratch.
champrep qa ide open SESSION_IDImprima o endereço do espaço de trabalho; --browser abre-o.
champrep qa ide stop SESSION_IDEncerre um espaço de trabalho. As alterações não enviadas são mantidas por um tempo para fins de recuperação.

ide open imprime https://qa.champrep.com/workspaces/<id>. O endereço não contém credenciais: você faz login no CHAMPREP QA no navegador, como de costume.

Ative um repositório de códigoCHAMPREP e faça a varredura nele:

Terminal window
champrep qa repos available --provider code
champrep qa repos activate code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --yes
champrep qa scan code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --ref main --watch --yes

Analise as falhas mais graves e descarte um conjunto de testes:

Terminal window
champrep qa findings ls --repo code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --severity critical,high
champrep qa findings ls --cwe 89 --branch main
champrep qa findings show QA-0970
champrep qa findings dismiss QA-0970 --reason used_in_tests --comment "fixture key" --yes
champrep qa findings reopen QA-0970 --yes

Interrompa uma implantação quando o gateway falhar:

Terminal window
champrep qa gates status code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --branch main \
&& ./deploy.sh

Visualize um branch e, em seguida, abra um IDE nele:

Terminal window
champrep qa previews create --provider code --repo acme/web --branch feature/login --yes
champrep qa previews extend 6731c0ffee0000000000abcd --minutes 60 --yes
champrep qa ide start --provider code --repo acme/web --branch feature/login --yes
champrep qa ide open 6731c0ffee0000000000beef --browser

Comandos que alteram algo ou utilizam sua cota solicitam autorização prévia: repos activate e deactivate, scan, findings dismiss e reopen, previews create, extend e stop, e ide start e stop. Resposta y em um terminal, ou passe --yes (-y) em um script. Sem um terminal e sem --yes O comando recusa e não altera nada. scan, previews create e ide start possuem uma chave de idempotência, de modo que CLIa tentativa automática após um erro de rede nunca inicia duas vezes.

Adicionar --json para exibir o que o QA retornou. O código de saída permanece o mesmo com --json: scan --watch --json exibe a verificação concluída e encerra 1 quando a verificação ou seu gateway falham, gates status --json encerra 1 em um gateway com falha, e repos activate --json encerra 1 quando um repositório foi recusado. Espaço de trabalho do IDE as respostas são exibidas sem idePath: contém o token de sessão do espaço de trabalho. Abra um espaço de trabalho com ide open em vez disso.

Terminal window
champrep qa findings ls --severity critical --json | jq -r '.[] | "\(.qaId) \(.title)"'

scan --watch encerra com o código 1 quando a varredura falha ou seu gateway falha.

MensagemO que fazer
payment required … (REPOSITORY_ALLOWANCE_EXCEEDED)A cota de repositórios do seu plano foi esgotada. Desative um repositório ou aumente a capacidade em CHAMPREP Faturamento. Código de saída 1.
not allowed for your role … (SOURCE_ROLE_REQUIRED), (SECURITY_MANAGE_REQUIRED), (ROLE_REQUIRED)Sua função na fonte ou no espaço de trabalho não permite isso. Para rejeitar e aceitar resultados, é necessário ter a função de Mantenedor ou superior.
needs your web session … (SESSION_REQUIRED), (IMPERSONATION_NOT_ALLOWED)Somente o(a) senhor(a), conectado(a) ao aplicativo web de QA, pode tomar essa decisão.
not available to your account …Seu plano ou a política da organização não inclui CHAMPREP QA nem este recurso.
http 422 … (QA_PROVIDER_NOT_SCANNABLE_YET)As verificações de repositórios do GitLab eGitLab do Bitbucket ainda não estão disponíveis.
not found … (REPO_NOT_FOUND), (SCAN_NOT_FOUND)O repositório não está ativo neste espaço de trabalho ou você não consegue abri-lo.

Cada recusa acima é encerrada com o código 1; existe um limite de taxa do gateway 5. Um recusado repos activate exibe cada repositório recusado com o motivo e encerra 1; os demais continuam ativados.