テンプレートテスト

ラベル SonarQube の投稿を表示しています。すべての投稿を表示

2018/04/29

2018/04/28

[C#] GitLab CI と SonarQube で .NET アプリケーションの CI を行う

具体的には Push をトリガーとして自動的にコードを解析を行い、またその解析結果をマージリクエストの画面に表示します。   尚、Jenkins 等の他の CI ツールは必要ありません。  ## 環境  - GitLab 10.2.0 - gitlab-runner 10.2.0 - SonarQube 6.7 - SonarQube Scanner for MSBuild 4.0 - .NET Core 2.0  ## 準備  GitLab と SonarQube の環境構築は済んでいる前提です。   Docker を使った環境構築については以下を参考にしてください。  - [GitLab を docker-compose で動かしてみる](http://kuttsun.blogspot.jp/2016/09/dockergitlab.html) - [SonarQube を docker-compose で動かしてみる](http://kuttsun.blogspot.jp/2017/12/sonarqube-docker-compose.html)  また、GitLab CI を使うためにはタスクランナーとして gitlab-runner が必要です。    以下の記事に書いたように、C# プログラムのコード解析には OpenCover と SonarQube Scanner を使っていますが、これらは Windows 上でしか動作しません。  - [[C#] OpenCover でコードカバレッジを計測する](http://kuttsun.blogspot.jp/2017/12/opencover.html) - [[C#] SonarQube で .NET アプリケーションのコード解析を行う](http://kuttsun.blogspot.jp/2017/12/sonarqube-net.html)  従って、gitlab-runner は Windows 上にインストールしたものを使う必要があります。   gitlab-runner を Windows にインストールする手順については以下の記事を参照してください。  - [GitLab Runner を Windows で動かす](http://kuttsun.blogspot.jp/2017/12/gitlab-runner-windows.html)  GitLab に gitlab-runner を登録するところまでも済んでいる前提とします。  ## GitLab の設定  ### ユーザーの追加  SonarQube から GitLab に通知するためのユーザーを GitLab に作成します。   後で SonarQube の設定を行うときに作成したユーザーのトークンが必要になります。   トークンは作成したユーザーでログインし、Account のメニューの Private Token で確認できます。   もちろん、別途トークンを作成しても OK です。  ### Pipeline 失敗時のマージ拒否  Pipeline で失敗している場合にマージリクエストをマージできないようにしたい場合は、該当のプロジェクトで以下を設定します。  [Edit Project] > `Only allow merge requests to be merged if the build succeeds` を ON にし、`Save changes` をクリック   ## SonarQube の設定  管理者アカウントでログインして以下のことを行います。  ### GitLab Plugin のインストール  [Administration] > [Marketplace] > `GitLab` で検索し、`GitLab` をインストールします。  <a href="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEgJIpNOSw7O8nVCuBzQfh9or4Imlk05XOr_xHVrYN11Dwqgh6nG4MJ5ZQ0hcYaIWs7Cnh-M_JtoqovPk5GXPfVfEfzp5gEip6a_pmPI03LSdzUTtH3zwunFDCnokOJEq2ChRuB61qLjsdE/s1600/sq01.png" imageanchor="1" ><img border="0" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEgJIpNOSw7O8nVCuBzQfh9or4Imlk05XOr_xHVrYN11Dwqgh6nG4MJ5ZQ0hcYaIWs7Cnh-M_JtoqovPk5GXPfVfEfzp5gEip6a_pmPI03LSdzUTtH3zwunFDCnokOJEq2ChRuB61qLjsdE/s320/sq01.png" width="320" height="61" data-original-width="1094" data-original-height="207" /></a> インストールしたら SonarQube を再起動します。  ### GitLab Plugin の設定  [Administration] > [Configuration] > サイドメニューより `GitLab` を選択します。  `GitLab url` と `GitLab User Token` を設定します。   `GitLab User Token` には、あらかじめ GitLab に作成しておいたアカウントのトークンを設定します。  <a href="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEh65MA09okXK1OIop6WKmxvQzV1VXwMDQ1Hh9vieZy-fwsMau-Zfxi4eIKGRcEBhH0H8_2evzFMp6JGjRnMbKtgSQFp335SUxLAr13I5E8JEdgnpgQoJvzZCysJD9X-QbUGACT8NxOuG6o/s1600/sq02.png" imageanchor="1" ><img border="0" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEh65MA09okXK1OIop6WKmxvQzV1VXwMDQ1Hh9vieZy-fwsMau-Zfxi4eIKGRcEBhH0H8_2evzFMp6JGjRnMbKtgSQFp335SUxLAr13I5E8JEdgnpgQoJvzZCysJD9X-QbUGACT8NxOuG6o/s320/sq02.png" width="320" height="213" data-original-width="946" data-original-height="630" /></a> 詳細は以下を参照してください。  - https://gitlab.talanlabs.com/gabriel-allaigre/sonar-gitlab-plugin  ### プロジェクトの設定  該当のプロジェクトの画面で以下を設定します。  [Administration] > [General Settings] > サイドメニューより `GitLab` を選択します。  `GitLab Project id` を設定します。  <a href="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEjndImnjrmOyBdF-yhqKSjHEzzsP-umWkzmYyvBmwS9u9Mk1HuMmWbiScA6xXdgM7Ap0buk6PEh4KoCZyqjSJzHP8Ue7NeLQTVYqJtxeAp8nVAEWoQAmFHm6lqps5fv-17e1DF00eiWYM8/s1600/sq03.png" imageanchor="1" ><img border="0" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEjndImnjrmOyBdF-yhqKSjHEzzsP-umWkzmYyvBmwS9u9Mk1HuMmWbiScA6xXdgM7Ap0buk6PEh4KoCZyqjSJzHP8Ue7NeLQTVYqJtxeAp8nVAEWoQAmFHm6lqps5fv-17e1DF00eiWYM8/s320/sq03.png" width="320" height="154" data-original-width="934" data-original-height="449" /></a> ## .gitlab-ci.yml の作成  GitLab と SonarQube の設定が完了したら、.gitlab-ci.yml を作成します。  SonarQube のコード解析の部分だけのサンプルですが、例えば以下のような感じです。  ```xml variables:   SONARSCANNER: "C:\\SonarQube\\sonar-scanner-msbuild-4.0.0.821\\MSBuild.SonarQube.Runner.exe"   SONARHOST: "http://localhost:9000"   SONARKEY: "projectkey"   REPORT: "coverage.xml" stages:   - test Job1:   stage: test   script:     # GitLab のコンソールログでの文字化け対策     - chcp 65001     # SonarQube による解析(環境変数を先頭に置くと yaml パーサーでエラーになるので call をつけている)     - call %SONARSCANNER% begin /d:sonar.host.url=%SONARHOST% /k:%SONARKEY% /v:"1.0" /d:sonar.analysis.mode=preview /d:sonar.cs.opencover.reportsPaths=%REPORT% /d:sonar.gitlab.commit_sha=%CI_COMMIT_SHA% /d:sonar.gitlab.project_id=%CI_PROJECT_ID% /d:sonar.gitlab.ref_name=%CI_COMMIT_REF_NAME%     - dotnet build     - call .\OpenCover.bat %REPORT%     - call %SONARSCANNER% end   tags:     - windows ```  OpenCover の解析部分はバッチファイルにしていますが、中身については以下の記事を参考にしてください。  - [[C#] OpenCover でコードカバレッジを計測する](http://kuttsun.blogspot.jp/2017/12/opencover.html)  SonarQube の解析も、後述するように SonarQube Server と GitLab の通知のために２回行うことを前提にするならば、バッチファイルにして処理を共通化したほうが良いかなと思います。  まぁそれはともかく、とりあえずこれで全て完了です。 これで以下のように動作します。  - GitLab に Push したタイミングで GitLab CI の機能により、最新コミットのコード解析が行われる - SonarQube での解析結果が GitLab に通知される - 解析を行ったコミットが含まれるマージリクエストに指摘事項が表示される  マージリクエストの画面にはこんな感じで表示されます。  <a href="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEgLjUtJ56KBW7f09r0Ar6rzHePUa-I_dljMNj1NHH8DI3EGTcHM3fNyG3ZN7ykBkYR-xvdrEILUTOX2b8BjLwUm-XxJx2WbW_9mLnXbmEcSJNnD_qdHzv6zFzqGtT8HGBc-Pd3Wh_SQGDU/s1600/sq04.png" imageanchor="1" ><img border="0" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEgLjUtJ56KBW7f09r0Ar6rzHePUa-I_dljMNj1NHH8DI3EGTcHM3fNyG3ZN7ykBkYR-xvdrEILUTOX2b8BjLwUm-XxJx2WbW_9mLnXbmEcSJNnD_qdHzv6zFzqGtT8HGBc-Pd3Wh_SQGDU/s320/sq04.png" width="320" height="226" data-original-width="1206" data-original-height="851" /></a> SonarQube Scanner for MSBuild のパラメータの一覧は以下を参照してください。  - https://gitlab.talanlabs.com/gabriel-allaigre/sonar-gitlab-plugin  .gitlab-ci.yml で使用できる環境変数の一覧は以下を参照してください。  - https://docs.gitlab.com/ee/ci/variables/README.html  今回使用しているパラメータについては以下に簡単に説明します。  **sonar.analysis.mode**  デフォルトは `publish` で、この場合、解析結果が SonarQube Server にアップロードされます。   GitLab に通知したい場合は、`preview` を指定する必要があります。  SonarQube Server と GitLab の両方に通知したい場合は、面倒ですが `sonar.analysis.mode` の値を変えて２回解析を実行する必要があります。   尚、`publish` の場合に後述の GitLab 関連のオプションを設定していると解析に失敗するので注意です。  **sonar.host.url**  SonarQube Server の URL を指定します。    **sonar.cs.opencover.reportsPaths**  OpenCover の出力ファイルを指定します。  **sonar.gitlab.commit_sha**  解析対象の Git のコミットのハッシュ値を指定します。  **sonar.gitlab.project_id**  GitLab のプロジェクト ID を指定します。   SonarQube のプロジェクト設定で設定済みの場合は不要っぽいです。  **sonar.gitlab.ref_name**  ブランチ名を指定します。  **sonar.gitlab.user_token**  GitLab に通知する際のユーザーのトークンを指定します。   SonarQube で設定済みの場合は不要っぽいです。  ## はまったところ  何度見直しても正しく設定しているはずなのに、解析結果が GitLab に通知されずずっと悩んでいました。  解析ログをよく見ると、以下の警告が表示されていました。  ``` The project does not have a valid "ProjectGuid." ```  `ProjectGuid` が何なのかわからないまま調べてみると、どうやら .NET Core の ProjectGuid 変更になったらしく、これを手動で追加すると解析結果が GitLab に通知されるようになりました。     詳細は以下の記事を参照してください。  - http://kuttsun.blogspot.jp/2017/12/net-core-projectguid.html  ## 参考 URL  - http://codeout.hatenablog.com/entry/2015/08/21/012706 - https://qiita.com/bremen/items/f47f383b9931a840a25c - https://gitlab.talanlabs.com/gabriel-allaigre/sonar-gitlab-plugin - https://qiita.com/ynott/items/1ff698868ef85e50f5a1 - https://eliot-jones.com/2017/12/configure-gitlab-sonarqube-teamcity - https://docs.gitlab.com/ce/ci/variables/README.html#using-the-ci-variables-in-your-job-scripts - http://blog.applibot.co.jp/blog/2017/09/14/static-code-analysis-with-sonarqube/ - https://github.com/gabrie-allaigre/sonar-gitlab-plugin/issues/75 - https://github.com/mibexsoftware/sonar-bitbucket-plugin/issues/25 - https://qiita.com/teradonburi/items/776e4735395af872320a - https://qiita.com/ijoji/items/f7dce812c84a5cfa91cf

2017/12/20

NO IMAGE

[C#] SonarQube で .NET アプリケーションのコード解析を行う

.NET Core C# SonarQube

## 概要  コードカバレッジの計測自体は OpenCover を使って行い、その出力結果を SonarQube にインポートします。   詳細は以下のページで解説されています。  - [SonarC#](https://docs.sonarqube.org/pages/viewpage.action?pageId=1441900)  ## 環境  - Visual Studio 2017 - .NET Core 2.0 - SonarQube 6.7 - SonarQube Scanner for MSBuild 4.0  今回は .NET Core を使って試しましたが、Windows 環境なので .NET Framework であっても同じようにできるはずです。  ## SonarQube Server の準備  SonarQube Server をあらかじめ用意しておく必要があります。   Docker を使った構築については以下を参照してください。  - [SonarQube を docker-compose で動かしてみる](http://kuttsun.blogspot.jp/2017/12/sonarqube-docker-compose.html)  その後、プロジェクトを作成して、 API キーを発行しておいてください。  ## SonarQube Scanner for MSBuild のダウンロード  OpenCover の解析結果を SonarQube にインポートするには SonarQube Scanner が必要です。  - https://docs.sonarqube.org/display/SCAN    ここでは SonarQube Scanner for MSBuild を使用します。  ## 実行  以下のようなバッチファイルを作成して実行しました。  ```sh rem SonarQube Scanner fo MSBuild のインストール先 set SONARQUBE=C:\SonarQube\MSBuild.SonarQube.Runner.exe  %SONARQUBE% begin /d:sonar.host.url=http://localhost:9000 /k:"hogehoge" /n:"MyApplication" /v:"1.0" /d:sonar.cs.opencover.reportsPaths="coverage.xml" dotnet build call OpenCover.bat %SONARQUBE% end ```  `MSBuild.SonarQube.Runner.exe begin` で解析を開始します。   ここでいくつかパラメータを指定する必要があります。  - `/d:sonar.host.url=` で SonarQube Server の URL を指定 - `/k:` でプロダクトキーを指定 - `/n:` でプロジェクト名を指定 - `/v:` でバージョンを指定 - `/d:sonar.cs.opencover.reportsPaths=` で解析結果のレポートを指定（これは後述するように OpenCover の出力結果を与えます）  解析を開始したら、まずビルドを行います。   今回は .NET Core なので、`dotnet build` を指定します。  次にカバレッジの計測を行います。   今回は OpenCover を使って計測するので、そこを別途バッチファイルに記述しています。   このバッチファイルの中身については以下の記事を参考にしてください。  - [OpenCover でコードカバレッジを計測する](http://kuttsun.blogspot.jp/2017/12/opencover.html)  ビルドとカバレッジ計測が終わったら、`MSBuild.SonarQube.Runner.exe end` で解析を終了します。  正常に解析が完了していれば、SonarQube で結果を確認することができます。  尚、今回は OpenCover しか使っていませんが、他のいろいろツールを併用することもできます。  - https://docs.sonarqube.org/pages/viewpage.action?pageId=6389770#CodeCoverageResultsImport(C#,VB.NET)-OpenCover  ## 継続的インテグレーション  とりあえず解析自体は出来ましたが、こういうのはやはり自動化して継続的に行いたいものです。  これについてはまた別途書きます。   ## 参考 URL  - https://docs.sonarqube.org/pages/viewpage.action?pageId=1441900 - http://d.hatena.ne.jp/pneumaster/20151230/1451480090 - http://posaune.hatenablog.com/entry/2013/12/04/083834 - https://blog.nijohando.jp/post/gitlab-merge-request-sonarqube/ - https://budougumi0617.github.io/post/2017/07/13/opencover-to-vs2017/

2017/12/06

NO IMAGE

SonarQube を docker-compose で動かしてみる

Docker SonarQube

尚、いつもの通り Docker を使ってインストールします。   （Docker に慣れてくると全て Docker で構築したくなってきます。）  ## 環境  - Docker for Windows  ## docker-compose.yml  作成した `docker-compose.yml` は以下のような感じです。   SonarQube は公式のイメージがあるのでそれを使用します。  ```sh version: '2' services:   sonarqube:     image: sonarqube     container_name: sonarqube     restart: always     ports:       - 9000:9000     environment:       - SONARQUBE_JDBC_URL=jdbc:postgresql://sonarqube_db:5432/sonar     volumes:       - conf:/opt/sonarqube/conf       - data:/opt/sonarqube/data       - extensions:/opt/sonarqube/extensions       - bundled-plugins:/opt/sonarqube/lib/bundled-plugins    sonarqube_db:     image: postgres     container_name: sonarqube_db     restart: always     environment:       - POSTGRES_USER=sonar       - POSTGRES_PASSWORD=sonar     volumes:       - postgresql:/var/lib/postgresql       # This needs explicit mapping due to https://github.com/docker-library/postgres/blob/4e48e3228a30763913ece952c611e5e9b95c8759/Dockerfile.template#L52       - postgresql_data:/var/lib/postgresql/data  volumes:   conf:   data:   extensions:   bundled-plugins:   postgresql:   postgresql_data: ```  ## 管理者でログイン  起動したら以下の管理者 ID でログインできます。  - Username : admin - Password : admin  ## SonarQube の設定  SonarQube の設定は `/opt/sonarqube/conf/sonar.properties` に記述します。  ### プロキシの設定  プロキシ環境下ではプロキシ設定を行っておかないとプラグインのインストールなどができません。  - https://docs.sonarqube.org/display/SONAR/Marketplace  `sonar.properties` の以下の行のコメントアウトを解除して設定します。  ```sh # HTTP proxy (default none) http.proxyHost=xxx.xxx.xxx.xxx http.proxyPort=8080 # HTTPS proxy (defaults are values of http.proxyHost and http.proxyPort) https.proxyHost=xxx.xxx.xxx.xxx https.proxyPort=8080 ```  ### LDAP 認証の設定  社内の Active Directory で LDAP 認証を行うための設定を行います。  まずは LDAP Plugin をインストールします。    プロキシ設定を適切に行っていれば [Administration] > [Marketplace] からインストールできます。  - https://docs.sonarqube.org/display/PLUG/LDAP+Plugin  `sonar.properties` に以下を追記します。   内容は環境に応じて適宜変更します。  ```sh # LDAP sonar.security.realm=LDAP ldap.url=ldap://example.com:389 ldap.bindDn=hoge@example.com ldap.bindPassword=xxxxxxxx  ldap.user.baseDn=dc=example,dc=com ldap.user.request=(&(objectClass=user)(sAMAccountName={login})) ldap.user.realNameAttribute=cn ldap.user.emailAttribute=mail ```  ### SMTP の設定  管理者アカウントでログインします。   [Administration] > [Configuration] > [General] の [Email] で設定します。  ## 参考 URL  - https://qiita.com/ot-aoyagi/items/d97b2431fefbf5635e93 - https://qiita.com/teradonburi/items/776e4735395af872320a - https://qiita.com/yo1000/items/0af36c8bc5e944c1e42a - https://github.com/SonarSource/docker-sonarqube/blob/master/recipes.md - https://qiita.com/okamu_/items/1c8e5fde742ca165fa12#sonarqube - http://blog.applibot.co.jp/blog/2017/09/14/static-code-analysis-with-sonarqube/

テンプレートテスト

2018/04/29

SonarQube で LDAP 認証を行う

2018/04/28

SonarQube のプロキシ設定

2017/12/28

[C#] GitLab CI と SonarQube で .NET アプリケーションの CI を行う

2017/12/20

[C#] SonarQube で .NET アプリケーションのコード解析を行う

2017/12/06

SonarQube を docker-compose で動かしてみる

Translate

Popular Posts

Labels

Blog Archive