Aller au contenu
Documentation

CHAMPREP QA commandes

champrep qa fonctionne avec CHAMPREP QA depuis votre terminal : activez des référentiels, lancez des analyses et suivez leur progression, filtrez et triez les résultats, vérifiez un contrôle qualité, démarrez des environnements de prévisualisation et ouvrez des espaces de travail IDE dans le cloud. Il agit en votre nom, avec votre CLIconnexion habituelle. QA vérifie votre rôle dans le référentiel à la source (CHAMPREPCode, GitHub ouGitLab Bitbucket) à chaque appel, et les limites de votre forfait s’appliquent.

  1. Installez le CLI et se connecter avec champrep auth login.
  2. Votre forfait doit inclure CHAMPREP QA. Connectez-vous d’abord à GitHub, GitLab ou Bitbucket dans l’application web QA si vous les utilisez ; les dépôts de CHAMPREPcode ne nécessitent aucune connexion supplémentaire.

QA identifie un référentiel par sa clé, qui champrep qa repos ls et champrep qa repos available afficher :

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

--workspace sélectionne l’espace de travail QA dans lequel agir : personal, organization:<id> ou team:<id>. Ce paramètre détermine les dépôts de quel espace de travail vous voyez et à quel espace de travail est attribué un scan, une activation, un aperçu ou un espace de travail IDE. Sans cette option, QA utilise votre espace de travail par défaut, tout comme l’application web.

CommandeObjectif
champrep qa repos lsRépertorier les dépôts actifs de l’espace de travail avec leur « gate » et leur dernière analyse. --source code|github|gitlab|bitbucket, --gate passed|failed|not_scanned|scanning, --search, --all (y compris les inactifs), --limit (1-100).
champrep qa repos available --provider PRépertoriez les référentiels proposés par une source et indiquez si chacun d’entre eux est actif.
champrep qa repos activate REPO...Commencez à analyser jusqu’à 100 dépôts. Chacun d’entre eux est décompté de votre quota de dépôts.
champrep qa repos deactivate REPO...Arrêter l’analyse des dépôts.
champrep qa repos sync --provider gitlab|bitbucketRelire les projetsGitLab ou les dépôts Bitbucket à partir de votre compte connecté.
champrep qa repos sync code:<uuid>Actualiser la tête de la branche par défaut d’un projet CodeCHAMPREP. Les dépôts GitHub se synchronisent automatiquement.

CommandeObjectif
champrep qa scan REPOLancer une analyse de la branche par défaut, ou --ref BRANCH. --watch (-w) s’applique jusqu’à la fin ; --timeout (par défaut 30m) limite le délai d’attente ; --profile sélectionne un profil d’analyse lorsque votre organisation vous le demande à chaque fois.
champrep qa scans lsRépertorier les analyses que vous avez lancées, celles d’un dépôt (--repo REPO), ou celles de l’espace de travail (--org). --run queued,running,held,passed,failed,canceled; --limit.
champrep qa scans show SCAN_IDAfficher une analyse : branche, commit, état d’exécution, porte, résultats nouveaux et corrigés, minutes, toute erreur ou mise en attente.

Les analyses des dépôts CodeCHAMPREP et GitHub sont exécutées à partir de CLI. Une analyse vous est facturée une seule fois. Lorsque CHAMPREPCode traite la demande comme sa propre CHAMPREP QAvérification, le système vous l’indiqueCLI et vous devez alors suivre la procédure suivante : champrep qa scans ls --repo REPO.

CommandeObjectif
champrep qa findings lsRépertorier les résultats, ceux en attente par défaut. Filtres ci-dessous. --page, --limit (1-100).
champrep qa findings show FINDINGAfficher un résultat par ID ou numéro QA, par exemple QA-0970: gravité, état, règle, CWE, emplacement, extrait de code.
champrep qa findings dismiss FINDING --reason RRejeter un résultat. --comment; --secret-revoked pour les secrets.
champrep qa findings reopen FINDINGAnnuler un rejet, une acceptation ou une résolution : la vulnérabilité revient à l’état « À trier ».
FiltrerValeurs
--repo REPOUn référentiel ; à défaut, l’ensemble de l’espace de travail.
--severitycritical, high, medium, low, info, unknown (séparés par des virgules)
--cweUn CWE, tel que 79 ou CWE-79
--branchConstatations sur cette branche
--statedetected (À trier), confirmed, dismissed, accepted, resolved, ou all. Par défaut : detected,confirmed
--typesast, secret, iac, dependency
--searchRecherche de texte, 3 caractères ou plus
--mineProblèmes qui vous ont été attribués

Les motifs de licenciement sont les suivants : false_positive, acceptable_risk, mitigating_control, used_in_tests et not_applicable. La suppression nécessite le rôle de responsable ou un rôle supérieur. La suppression d’un secret nécessite également --secret-revoked: vérifiez que le secret a bien été révoqué ou qu’il n’a jamais été valide.

CommandeObjectif
champrep qa gates status REPOIndiquez si le dépôt satisfait aux critères de qualité sur la branche par défaut ou --branch, avec le nombre et la limite de chaque condition.

gates status se termine avec le code 1 lorsque la barrière échoue, ce qui vous permet de l’utiliser pour protéger un script ou une étape de déploiement.

CommandeObjectif
champrep qa previews lsAffichez la liste de vos aperçus en direct. --ended, --org (l’espace de travail complet), --repo REPO, --limit.
champrep qa previews show PREVIEW_IDAffichez un aperçu, son adresse et sa date d’expiration.
champrep qa previews createCompilez et lancez un aperçu. Nécessite --provider et --repo owner/name; également --branch, --code-project ID, --port.
champrep qa previews extend PREVIEW_ID --minutes NProlongez la durée d’exécution d’un aperçu : de 5 à 1 440 minutes, jusqu’à son expiration définitive.
champrep qa previews stop PREVIEW_IDArrêtez un aperçu.

Pour le codeCHAMPREP, --repo correspond au chemin d’accès au projet, par exemple acme/web.

CommandeObjectif
champrep qa ide lsRépertoriez vos espaces de travail IDE en cours d’exécution (--ended (pour les anciens). --json Omette l’identifiant de chaque espace de travail idePath, qui contient son jeton de session.
champrep qa ide startLancez un espace de travail sur --provider et --repo owner/name (--branch, --work-branch, --code-project), ou un espace de travail vide avec --scratch.
champrep qa ide open SESSION_IDAffichez l’adresse de l’espace de travail ; --browser l’ouvre.
champrep qa ide stop SESSION_IDArrêtez un espace de travail. Les modifications non transmises sont conservées pendant un certain temps à des fins de restauration.

ide open affiche https://qa.champrep.com/workspaces/<id>. L’adresse ne contient aucune information d’identification : vous vous connectez à CHAMPREP QA dans le navigateur comme d’habitude.

Activez un dépôt de codeCHAMPREP et analysez-le :

Fenêtre de terminal
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

Passez en revue les résultats les plus graves et ignorez un scénario de test :

Fenêtre de terminal
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

Interrompre un déploiement en cas d’échec de la passerelle :

Fenêtre de terminal
champrep qa gates status code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --branch main \
&& ./deploy.sh

Prévisualisez une branche, puis ouvrez un IDE dessus :

Fenêtre de terminal
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

Les commandes qui modifient quelque chose ou utilisent votre quota vous demandent d’abord votre accord : repos activate et deactivate, scan, findings dismiss et reopen, previews create, extend et stop, et ide start et stop. Réponse y sur un terminal, ou exécutez --yes (-y) dans un script. Sans terminal et sans --yes La commande « refuses » ne modifie rien. scan, previews create et ide start comportent une clé d’idempotence, de sorte que la CLInouvelle tentative automatique après une erreur réseau n’en lance jamais deux.

Ajouter --json pour afficher les résultats renvoyés par QA. Le code de sortie reste le même avec --json: scan --watch --json affiche l’analyse terminée et se termine 1 Lorsque l’ analyse ou sa passerelle échoue, gates status --json se termine 1 en cas d’échec au niveau de la passerelle, et repos activate --json se termine 1 lorsqu’un dépôt a été refusé. Espace de travail IDE les réponses sont affichées sans idePath: il contient le jeton de session de l’espace de travail. Ouvrez un espace de travail avec ide open à la place.

Fenêtre de terminal
champrep qa findings ls --severity critical --json | jq -r '.[] | "\(.qaId) \(.title)"'

scan --watch se termine par le code 1 lorsque l’analyse échoue ou que sa passerelle échoue.

MessageQue faire ?
payment required … (REPOSITORY_ALLOWANCE_EXCEEDED)Le quota de dépôts de votre forfait est épuisé. Désactivez un dépôt ou augmentez votre capacité dans la section « FacturationCHAMPREP ». Code de sortie 1.
not allowed for your role … (SOURCE_ROLE_REQUIRED), (SECURITY_MANAGE_REQUIRED), (ROLE_REQUIRED)Votre rôle à la source ou dans l’espace de travail ne vous y autorise pas. Le rejet et l’acceptation des résultats nécessitent le rôle de « Maintainer » ou un rôle supérieur.
needs your web session … (SESSION_REQUIRED), (IMPERSONATION_NOT_ALLOWED)Vous seul, connecté à l’application web QA, pouvez prendre cette décision.
not available to your account …Votre forfait ou la politique de votre organisation n’inclut pas niCHAMPREP QA cette fonctionnalité.
http 422 … (QA_PROVIDER_NOT_SCANNABLE_YET)Les analyses des dépôts GitLab etGitLab Bitbucket ne sont pas encore disponibles.
not found … (REPO_NOT_FOUND), (SCAN_NOT_FOUND)Le dépôt n’est pas actif dans cet espace de travail, ou vous ne pouvez pas l’ouvrir.

Chaque refus ci-dessus se termine par le code 1; une limite de débit au niveau de la passerelle est en vigueur 5. Un refus repos activate affiche chaque dépôt refusé avec son motif et se termine 1; les autres restent activés.