Jenkinsパイプラインでの SonarQube スキャンの構成

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：3分

    • Jenkinsパイプラインで SonarQube スキャンを構成します。

    始める前に

    Jenkins パイプラインを SonarQube スキャン用に構成する前に、次の前提条件を満たしていることを確認してください
    • SonarCloud または SonarQube バージョン 8.6.1 コミュニティエディション
    • SonarQube Scanner for Jenkins 2.4 以降が Jenkins インスタンス/環境にインストールされている。
    • ServiceNow DevOps プラグインバージョン 1.27 以降 Jenkins 用。
    • Jenkins の SonarQube スキャナープラグインを使用して、SonarQube スキャンが構成され、 Jenkins パイプラインに存在することを確認します。詳細については、次を参照してください。
    • SonarQube ツールが作成され、SonarQube サーバーに接続されます。詳細については、「SonarQubeとDevOps チェンジベロシティとの統合」を参照してください。
    必要なロール:sn_devops.admin

    このタスクについて

    SonarQube スキャンを実行するパイプラインを実行すると、詳細がJenkinsパイプラインからServiceNow DevOpsにフェッチされます。Jenkins プラグインを使用して、スキャンの実行が Jenkins パイプラインで構成されているかどうかを確認し、withSonarQubeEnv タグを使用して、すべてのオーケストレーションステージで SonarQube スキャンを確認します。SonarQube 分析がパイプライン実行のいずれかのステージで発生した場合は、終了通知の一部として、特定のステージで発生するすべてのスキャンの scanID と url の詳細を含むモデルを追加します。これらのスキャン分析または詳細は、関連付けられ、[変更要求] および [タスク実行] から [ソフトウェア品質サマリー] 関連リストに表示されます。

    手順

    1. Jenkins で、 Jenkins の管理 > システムの構成をクリックし、[SonarQube サーバー] セクションの [Enable injection of SonarQube server configuration as build environment variables (ビルド環境変数としての SonarQube サーバー構成の注入を有効にする)] チェックボックスをオンにして、フィールドに入力します。
      表 : 1. SonarQube のインストール
      Field (フィールド) 説明
      名前 構成/プロジェクトの一意の名前。
      サーバー URL SonarQube サーバーの URL または IP アドレス。
      サーバー認証 構成に関連する認証トークンタイプを選択します。
      注:
      ServiceNow DevOps および Jenkins パイプラインで SonarQube ツールを作成するときに、これらの同じ SonarQube サーバーの詳細または値を使用します。
    2. [テスト接続] をクリックします。
      「接続に成功しました」というメッセージが表示されていることを確認します。
    3. 「 適用 」と 「保存」をクリックします。
    4. パイプラインを実行します。

    タスクの結果

    パイプライン実行のさまざまなステージでのスキャン結果に基づいて、パイプラインの対応するステップに結果が表示されます。通知の受信イベントが作成され、通知のタイプと機能に基づいてサブフローがトリガーされます。

    次のタスク

    注:

    パイプライン UI に移動して、 品質 > ソフトウェア品質結果.

    • タスク実行の一部としてスキャンの詳細を表示します。ビルドまたはリリースパイプラインの実行ステップにマッピングされたタスク実行の一部であるすべてのソナースキャンの詳細を表示します。
      1. 移動先 DevOps > オーケストレーション > タスク実行 関連するタスク実行レコードをクリックします。
      2. [ソフトウェア品質サマリー] 関連リストをクリックします。
      3. 関連するスキャン ID レコードをクリックします。
      [ソフトウェア品質スキャンサマリー] と [スキャンの詳細] が表示されます。
    • 変更要求の一部としてスキャンの詳細を表示します。このビルド/リリースパイプラインに含まれていたすべてのスキャンを ソフトウェア品質結果 > ソフトウェア数量サマリー 関連付けられます
      1. 移動先 DevOps > オーケストレーション > パイプライン変更要求
      2. [ソフトウェア品質サマリー] 関連リストをクリックします。
      3. 関連するスキャン ID レコードをクリックします。
      [ソフトウェア品質スキャンサマリー] と [スキャンの詳細] が表示されます。