コンテンツにスキップ
Documentation

CHAMPREP QA コマンド

champrep qa ターミナルCHAMPREP QAから `activate` を実行すると、 リポジトリのアクティブ化、スキャンの実行と完了の確認、検出結果のフィルタリングとトリアージ、 品質ゲートの確認、プレビュー環境の起動、およびクラウドIDE ワークスペースの起動が可能です。 これは、通常のCLIサインインと同様に、ユーザーとして動作します。QAは、呼び出しのたびにリポジトリのソース(CHAMPREPCode、GitHub、またはGitLabBitbucket)でユーザーの役割を確認し、プランの割り当てが適用されます。

  1. インストールしてください。 CLI および ログイン で champrep auth login.
  2. ご利用のプランには が含まれている必要がありますCHAMPREP QA。GitHub、 GitLab または Bitbucket をご利用の場合は、 まず QA Web アプリで接続設定を行ってください。 CHAMPREP コードリポジトリについては、 追加の接続設定は不要です。

リポジトリキーとワークスペース

Section titled “リポジトリキーとワークスペース”

QAはリポジトリをキーで識別し、そのキーは champrep qa repos ls および champrep qa repos available 表示:

ソースキー
CHAMPREP Codecode:<project-uuid>
GitHubgithub:<id>
GitLabgitlab:<id>
Bitbucketbitbucket:<workspace>/<slug>

--workspace 操作を行うQAワークスペースを選択します: personal, organization:<id> または team:<id>。これにより、どのワークスペースのリポジトリが 表示されるか、またスキャン、アクティベーション、プレビュー、またはIDE ワークスペースがどのワークスペースに割り当てられるかが決定されます。指定がない場合、QAではWebアプリと同様に、 デフォルトのワークスペースが使用されます。

コマンド目的
champrep qa repos lsワークスペースのアクティブなリポジトリを、ゲートおよび最終スキャン日時とともに一覧表示します。 --source code|github|gitlab|bitbucket, --gate passed|failed|not_scanned|scanning, --search, --all (非アクティブなブランチも含む)、 --limit (1-100).
champrep qa repos available --provider Pソースが提供するリポジトリの一覧と、各リポジトリがアクティブかどうかを表示します。
champrep qa repos activate REPO...最大100のリポジトリの分析を開始できます。各リポジトリは、リポジトリ利用枠にカウントされます。
champrep qa repos deactivate REPO...リポジトリの分析を停止します。
champrep qa repos sync --provider gitlab|bitbucket接続済みのアカウントから、プロジェクトGitLabまたはBitbucketリポジトリを再度読み込みます。
champrep qa repos sync code:<uuid>1つのコードCHAMPREPプロジェクトのデフォルトブランチのヘッドを更新します。GitHubリポジトリは自動的に同期されます。

コマンド目的
champrep qa scan REPOデフォルトブランチのスキャンを開始するか、 --ref BRANCH. --watch (-w) は末尾まで続きます; --timeout (デフォルト 30m) 待機時間を制限します; --profile 組織から毎回求められた場合、スキャンプロファイルを選択します。
champrep qa scans ls開始したスキャン、リポジトリの(--repo REPO)、またはワークスペースの(--org). --run queued,running,held,passed,failed,canceled; --limit.
champrep qa scans show SCAN_IDスキャンの表示:ブランチ、コミット、実行状態、ゲート、新規および修正済みの検出結果、分単位、エラーまたは保留状態。

CHAMPREPCode および GitHub リポジトリのスキャンは から実行されますCLI。スキャンは 1回のみ課金されます。CHAMPREPCode がリクエストを独自の CHAMPREP QAチェックとして処理する場合、 はその旨を通知CLIしますので、それに従って champrep qa scans ls --repo REPO.

コマンド目的
champrep qa findings ls検出結果を一覧表示します。デフォルトでは未解決のものが表示されます。以下のフィルターをご利用ください。 --page, --limit (1-100).
champrep qa findings show FINDINGIDまたはQA番号で1つの検出結果を表示します。例: QA-0970:重大度、状態、ルール、CWE、場所、スニペット。
champrep qa findings dismiss FINDING --reason R検出結果を却下します。 --comment; --secret-revoked シークレットの場合。
champrep qa findings reopen FINDING却下、承認、または解決を元に戻す:検出結果は「トリアージが必要」の状態に戻ります。
フィルタ値
--repo REPO1つのリポジトリ。指定しない場合は、ワークスペース全体となります。
--severitycritical, high, medium, low, info, unknown (カンマ区切り)
--cwe1つのCWE(例:) 79 または CWE-79
--branchこのブランチ上の検出結果
--statedetected (トリアージが必要です)、 confirmed, dismissed, accepted, resolved、または all。デフォルト: detected,confirmed
--typesast, secret, iac, dependency
--searchテキスト検索(3文字以上)
--mineあなたに割り当てられた発見事項

解雇の理由は以下の通りです。 false_positive, acceptable_risk, mitigating_control, used_in_tests および not_applicable。を閉じるには 「Maintainer」ロール以上が必要です。シークレットを閉じるのにも --secret-revoked:シークレットが無効化されたか、あるいは最初から有効ではなかったことを確認します。

コマンド目的
champrep qa gates status REPOリポジトリがデフォルトブランチで品質ゲートを通過しているかどうかを表示します。または --branch、各条件のカウントと制限付き。

gates status コードで終了します 1 ゲートが失敗した際に、これを使用して スクリプトやデプロイメントステップを保護することができます。

コマンド目的
champrep qa previews lsライブプレビューを一覧表示します。 --ended, --org (ワークスペース全体)、 --repo REPO, --limit.
champrep qa previews show PREVIEW_IDプレビュー、そのアドレス、および有効期限を表示します。
champrep qa previews createビルドを行い、プレビューを開始します。以下が必要です。 --provider および --repo owner/name; また --branch, --code-project ID, --port.
champrep qa previews extend PREVIEW_ID --minutes Nプレビューの実行時間を延長します:5分から1440分まで、ハード期限まで設定可能です。
champrep qa previews stop PREVIEW_IDプレビューを停止します。

CodeCHAMPREP の場合、 --repo はプロジェクトのパスです。例えば、 acme/web.

コマンド目的
champrep qa ide ls実行中のIDEワークスペースを一覧表示します(--ended (過去のワークスペースの場合)。 --json 各ワークスペースの idePath、これにはそのワークスペースのセッショントークンが含まれています。
champrep qa ide startでワークスペースを起動します。 --provider および --repo owner/name (--branch, --work-branch, --code-project)、または空のワークスペースを --scratch.
champrep qa ide open SESSION_IDワークスペースのアドレスを出力します。 --browser でワークスペースを開きます。
champrep qa ide stop SESSION_IDワークスペースを停止します。プッシュされていない変更は、復旧のためにしばらくの間保持されます。

ide open を出力します。 https://qa.champrep.com/workspaces/<id>。アドレスには 認証情報は含まれていません。通常通り、ブラウザCHAMPREP QAで CHAMPREP QA にサインインしてください。

CHAMPREPコードリポジトリをアクティブにして、スキャンします:

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

最も深刻な検出結果を確認し、テストフィクスチャを却下してください:

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

ゲートウェイの失敗時にデプロイを停止するには:

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

ブランチをプレビューし、そのブランチで IDE を開くには:

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

何かを変更したり、割り当て枠を消費したりするコマンドは、まず確認を求めます: repos activate および deactivate, scan, findings dismiss および reopen, previews create, extend および stop、および ide start および stop。回答 y ターミナルで実行するか、 --yes (-y) をスクリプト内で実行します。ターミナルがなく、 また --yes このコマンドは拒否され、何も変更されません。 scan, previews create および ide start にはイデポテンシーキーが含まれているため、ネットワークエラー後の自動再試行CLIにより 2回実行されることはありません。

追加 --json QAの返答内容を出力するには。終了コードは --json: scan --watch --json 完了したスキャンを出力して終了します 1 スキャンまたはそのゲートウェイが失敗した場合、 gates status --json 終了します 1 ゲートで失敗した場合、および repos activate --json 終了します 1 リポジトリが拒否された場合、IDEワークスペースの 応答は、 idePath: ワークスペースのセッショントークンを保持しています。 ワークスペースを開くには、 ide open 代わりに。

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

scan --watch コードで終了します 1 スキャンが失敗した場合、またはそのゲートウェイが失敗した場合。

メッセージ対処方法
payment required … (REPOSITORY_ALLOWANCE_EXCEEDED)ご利用のプランのリポジトリ利用枠が上限に達しています。リポジトリを無効にするか、「請求CHAMPREP」で容量を追加してください。終了コード 1.
not allowed for your role … (SOURCE_ROLE_REQUIRED), (SECURITY_MANAGE_REQUIRED), (ROLE_REQUIRED)ソースまたはワークスペースにおけるあなたの役割では、この操作を行う権限がありません。検出結果の却下および承認には、「Maintainer」以上の権限が必要です。
needs your web session … (SESSION_REQUIRED), (IMPERSONATION_NOT_ALLOWED)QA Web アプリにログインしているご本人様のみが、この決定を行うことができます。
not available to your account …ご利用のプランまたは組織のポリシーには、CHAMPREP QA またはCHAMPREP QAこの機能が含まれていません。
http 422 … (QA_PROVIDER_NOT_SCANNABLE_YET)GitLab およびGitLab Bitbucket リポジトリのスキャンは、まだ利用できません。
not found … (REPO_NOT_FOUND), (SCAN_NOT_FOUND)このリポジトリは、このワークスペースでアクティブではないか、または開くことができません。

上記の拒否はすべて、コードで終了します。 1; ゲートウェイのレート制限が発生しています 5。 拒否された repos activate 拒否された各リポジトリとその理由を出力し、 終了します 1; それ以外のリポジトリは引き続き有効です。