Skip to main content

統合例：Contrast AssessとGitHub

本項の例では、Javaエージェントを使用しています。この手順は、他のContrastエージェントにも適用できます。

開始する前に

  • テストを実行するGitHubワークフローを見つけます。

  • 以下のコマンド例のように、mvnが実行されている場所を見つけます。

    run : mvn -B clean install -Dmaven.gitcommitid.skip=true

  • 以下のコマンド例のように、Contrast Assessをテストに追加します。

    -DargLine="-javaagent:/tmp/contrast.jar --add-opens java.base/sun.net.spi=ALL-UNNAMED"

  • エージェントをダウンロードして設定する最も簡単な方法は、Contrast Webインターフェイスで「新規登録」ウィザードを使用して、該当する言語のエージェントを追加することです。

手順

  1. 以下のコマンド例のように、Contrastエージェントをダウンロードします。

    curl -L https://download.java.contrastsecurity.com/latest -o contrast.jar

    Contrast Webインターフェイスの「新規登録」ウィザードには、Contrastエージェントをダウンロードするための最新のコマンドが表示されます。

  2. GitHub envワークフローで、以下の環境変数をGitHub Actionsのシークレットとしてエージェントを設定します。

    注記

    環境変数の値はセキュリティ上重要なので、シークレットとして設定することを推奨します。

    env:
  # Setting an environment variable with the value of a configuration variable update test
 CONTRAST__ASSESS__ENABLED: true
 CONTRAST__PROTECT__ENABLED: false  
 CONTRAST__API__TOKEN: <token-value>

    トークンの値は、Contrast Webインターフェイスの組織の設定 > エージェントキーから、またはContrastエージェント設定エディタを使用して取得できます。

    古いエージェントを使用している場合は、以下の環境変数をGitHub Actionsでのシークレットとして設定してください。

    env:
  # Setting an environment variable with the value of a configuration variable update test
  CONTRAST__API__URL: https://<yourURL>/Contrast
  CONTRAST__ASSESS__ENABLED: true
  CONTRAST__PROTECT__ENABLED: false
  CONTRAST__API__API_KEY: ${{ secrets.CONTRAST__API__API_KEY }}
  CONTRAST__API__SERVICE_KEY: ${{ secrets.CONTRAST__API__SERVICE_KEY }}
  CONTRAST__API__USER_NAME: ${{ secrets.CONTRAST__API__USER_NAME }}
このセクションの内容: