Zum Inhalt springen
Documentation

CHAMPREP QA Befehle

champrep qa Funktionen, die Sie überCHAMPREP QA Ihr Terminal ausführen können: Repositorys aktivieren, Scans ausführen und deren Abschluss überwachen, Ergebnisse filtern und bewerten, ein Qualitätsgate prüfen, Vorschauumgebungen starten und Cloud-IDE- Arbeitsbereiche öffnen. Es agiert in Ihrem Namen mit Ihrer üblichen CLIAnmeldung. QA überprüft Ihre Rolle im Repository an dessen Quelle (CHAMPREPCode, GitHub oderGitLab Bitbucket) bei jedem Aufruf, und es gelten die Kontingente Ihres Tarifs.

  1. Installieren Sie die CLI und Anmelden mit champrep auth login.
  2. Ihr Tarif muss enthaltenCHAMPREP QA. Verbinden Sie GitHub, GitLab oder Bitbucket zunächst in der QA-Web-App, falls Sie diese nutzen; CHAMPREP Code-Repositorys benötigen keine zusätzliche Verbindung.

QA benennt ein Repository anhand seines Schlüssels, der champrep qa repos ls und champrep qa repos available Ausgabe:

QuelleSchlüssel
CHAMPREP Codecode:<project-uuid>
GitHubgithub:<id>
GitLabgitlab:<id>
Bitbucketbitbucket:<workspace>/<slug>

--workspace Wählen Sie den QA-Arbeitsbereich aus, in dem Sie arbeiten möchten: personal, organization:<id> oder team:<id>. Hiermit wird festgelegt, welche Repositorys welcher Arbeitsbereiche Sie sehen und welchem Arbeitsbereich ein Scan, eine Aktivierung, eine Vorschau oder ein IDE- Arbeitsbereich zugeordnet wird. Ohne diese Angabe verwendet die Qualitätssicherung Ihren Standard-Arbeitsbereich, ebenso wie die Webanwendung.

BefehlZweck
champrep qa repos lsListen Sie die aktiven Repositorys des Arbeitsbereichs mit ihrem Gate und dem letzten Scan auf. --source code|github|gitlab|bitbucket, --gate passed|failed|not_scanned|scanning, --search, --all (auch inaktive), --limit (1-100).
champrep qa repos available --provider PListen Sie die Repositorys auf, die eine Quelle Ihnen anbietet, und geben Sie an, ob jedes davon aktiv ist.
champrep qa repos activate REPO...Starten Sie die Analyse von bis zu 100 Repositories. Jedes davon wird auf Ihr Repository-Kontingent angerechnet.
champrep qa repos deactivate REPO...Beenden Sie die Analyse der Repositorys.
champrep qa repos sync --provider gitlab|bitbucketGitLabProjekte oder Bitbucket-Repositorys erneut aus Ihrem verbundenen Konto einlesen.
champrep qa repos sync code:<uuid>Den Head des Standardzweigs eines CHAMPREPCode-Projekts aktualisieren. GitHub-Repositorys synchronisieren sich automatisch.
BefehlZweck
champrep qa scan REPOStarten Sie einen Scan des Standardzweigs oder --ref BRANCH. --watch (-w) wird bis zum Ende beibehalten; --timeout (Standard 30m) begrenzt die Wartezeit; --profile Wählt jedes Mal ein Scan-Profil aus, wenn Ihre Organisation danach fragt.
champrep qa scans lsListen Sie die von Ihnen gestarteten Scans auf, die eines Repositorys (--repo REPO) oder des Arbeitsbereichs (--org). --run queued,running,held,passed,failed,canceled; --limit.
champrep qa scans show SCAN_IDEinen Scan anzeigen: Zweig, Commit, Ausführungsstatus, Gate, neue und behobene Befunde, Protokoll, etwaige Fehler oder Sperren.

Scans von CHAMPREPCode- und GitHub-Repositorys werden über die Plattform ausgeführtCLI. Ein Scan wird Ihnen einmalig in Rechnung gestellt. Wenn CHAMPREPCode die Anfrage als eigene CHAMPREP QAPrüfung behandelt, CLIgibt die Plattform dies an, und Sie fahren fort mit champrep qa scans ls --repo REPO.

BefehlZweck
champrep qa findings lsBefunde auflisten, standardmäßig offene. Filter siehe unten. --page, --limit (1-100).
champrep qa findings show FINDINGEinen Befund anhand der ID oder QA-Nummer anzeigen, z. B. QA-0970: Schweregrad, Status, Regel, CWE, Ort, Codeausschnitt.
champrep qa findings dismiss FINDING --reason REinen Befund ablehnen. --comment; --secret-revoked für Geheimnisse.
champrep qa findings reopen FINDINGEine Ablehnung, Annahme oder Behebung rückgängig machen: Der Befund kehrt in den Status „Triage erforderlich“ zurück.
FilterWerte
--repo REPOEin Repository; andernfalls der gesamte Arbeitsbereich.
--severitycritical, high, medium, low, info, unknown (durch Kommas getrennt)
--cweEin CWE, z. B. 79 oder CWE-79
--branchBefunde in diesem Zweig
--statedetected (Muss geprüft werden), confirmed, dismissed, accepted, resolvedoder all. Standard: detected,confirmed
--typesast, secret, iac, dependency
--searchTextsuche, 3 Zeichen oder mehr
--mineIhnen zugewiesene Befunde

Gründe für eine Entlassung sind false_positive, acceptable_risk, mitigating_control, used_in_tests und not_applicable. Zum Schließen ist die Rolle „Maintainer“ oder höher erforderlich. Zum Schließen eines Geheimnisses ist außerdem --secret-revoked: Überprüfen Sie, ob das Geheimnis widerrufen wurde oder nie gültig war.

BefehlZweck
champrep qa gates status REPOZeigen Sie an, ob das Repository auf dem Standardzweig die Qualitätsprüfung besteht oder --branch, mit der Anzahl und dem Limit jeder Bedingung.

gates status Beendet das Programm mit dem Code 1 wenn die Überprüfung fehlschlägt, sodass Sie damit ein Skript oder einen Bereitstellungsschritt absichern können.

BefehlZweck
champrep qa previews lsListen Sie Ihre Live-Vorschauen auf. --ended, --org (der gesamte Arbeitsbereich), --repo REPO, --limit.
champrep qa previews show PREVIEW_IDZeigen Sie eine Vorschau, deren Adresse und deren Ablaufdatum an.
champrep qa previews createErstellen und starten Sie eine Vorschau. Erfordert --provider und --repo owner/name; außerdem --branch, --code-project ID, --port.
champrep qa previews extend PREVIEW_ID --minutes NLassen Sie eine Vorschau länger laufen: 5 bis 1.440 Minuten, bis zu ihrem festen Ablaufzeitpunkt.
champrep qa previews stop PREVIEW_IDBeenden Sie eine Vorschau.

Für CHAMPREP Code, --repo ist der Projektpfad, zum Beispiel acme/web.

BefehlZweck
champrep qa ide lsListen Sie Ihre laufenden IDE-Arbeitsbereiche auf (--ended (für frühere). --json lässt die des jeweiligen Arbeitsbereichs weg idePath, das sein Sitzungstoken enthält.
champrep qa ide startStarten Sie einen Arbeitsbereich auf --provider und --repo owner/name (--branch, --work-branch, --code-project) oder einen leeren mit --scratch.
champrep qa ide open SESSION_IDGeben Sie die Adresse des Arbeitsbereichs aus; --browser öffnet ihn.
champrep qa ide stop SESSION_IDBeenden Sie einen Arbeitsbereich. Nicht übertragene Änderungen werden für eine gewisse Zeit zur Wiederherstellung aufbewahrt.

ide open gibt Folgendes aus https://qa.champrep.com/workspaces/<id>. Die Adresse enthält keine Anmeldedaten: Sie melden sich wie gewohnt imCHAMPREP QA Browser bei an.

Aktivieren Sie ein CHAMPREPCode-Repository und scannen Sie es:

Terminal-Fenster
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

Überprüfen Sie die schwerwiegendsten Befunde und schließen Sie eine Testvorlage aus:

Terminal-Fenster
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

Beenden Sie eine Bereitstellung, wenn das Gateway fehlschlägt:

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

Zeigen Sie eine Vorschau eines Zweigs an und öffnen Sie anschließend eine IDE dafür:

Terminal-Fenster
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

Befehle, die Änderungen vornehmen oder Ihr Kontingent belasten, fragen zunächst nach: repos activate und deactivate, scan, findings dismiss und reopen, previews create, extend und stop, und ide start und stop. Antwort y auf einem Terminal oder geben Sie --yes (-y) in einem Skript. Ohne Terminal und ohne --yes Der Befehl führt zu einer Ablehnung und nimmt keine Änderungen vor. scan, previews create und ide start verfügen über einen Idempotenzschlüssel, sodass CLIder automatische Wiederholungsversuch nach einem Netzwerkfehler niemals zweimal gestartet wird.

Hinzufügen --json um die von QA zurückgegebenen Ergebnisse anzuzeigen. Der Beendigungscode bleibt derselbe wie bei --json: scan --watch --json gibt den abgeschlossenen Scan aus und beendet den Vorgang 1 Wenn der Scan oder dessen Gateway fehlschlägt, gates status --json beendet 1 bei einem fehlgeschlagenen Gateway und repos activate --json beendet 1 wenn ein Repository abgelehnt wurde. IDE-Arbeitsbereich Antworten werden ohne idePath: Es enthält das Sitzungstoken des Arbeitsbereichs. Öffnen Sie einen Arbeitsbereich mit ide open stattdessen.

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

scan --watch beendet den Vorgang mit dem Code 1 wenn der Scan fehlschlägt oder sein Gateway ausfällt.

MeldungWas ist zu tun?
payment required … (REPOSITORY_ALLOWANCE_EXCEEDED)Das Repository-Kontingent Ihres Tarifs ist aufgebraucht. Deaktivieren Sie ein Repository oder erweitern Sie die Kapazität unter „AbrechnungCHAMPREP“. Beendigungscode 1.
not allowed for your role … (SOURCE_ROLE_REQUIRED), (SECURITY_MANAGE_REQUIRED), (ROLE_REQUIRED)Ihre Rolle an der Quelle oder im Arbeitsbereich erlaubt dies nicht. Das Ablehnen und Akzeptieren von Befunden erfordert die Rolle „Maintainer“ oder höher.
needs your web session … (SESSION_REQUIRED), (IMPERSONATION_NOT_ALLOWED)Nur Sie, wenn Sie in der QA-Webanwendung angemeldet sind, können diese Entscheidung treffen.
not available to your account …Ihr Tarif oder Ihre Organisationsrichtlinie umfasst weder CHAMPREP QA CHAMPREP QAnoch diese Funktion.
http 422 … (QA_PROVIDER_NOT_SCANNABLE_YET)Scans von GitLab und Bitbucket-Repositorys sind noch nicht verfügbar.
not found … (REPO_NOT_FOUND), (SCAN_NOT_FOUND)Das Repository ist in diesem Arbeitsbereich nicht aktiv oder Sie können es nicht öffnen.

Jede der oben genannten Ablehnungen endet mit dem Code 1; es liegt eine Ratenbegrenzung des Gateways vor 5. Ein abgelehntes repos activate gibt jedes abgelehnte Repository mit dem jeweiligen Grund aus und beendet den Vorgang 1; die übrigen sind weiterhin aktiviert.