12月 2017

Home › Archives for 12月 2017

2017/12/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/27

NO IMAGE

.NET Core の ProjectGUID

.NET Core Visual Studio

2017/12/24

NO IMAGE

IIS に AdminScripts フォルダがないのでインストールする方法

IIS

2017/12/23

NO IMAGE

IIS をコマンドで操作する

IIS

2017/12/22

NO IMAGE

Windows 7 に OpenSSH をインストールする

Windows

基本的なやり方は[公式ページ](https://github.com/PowerShell/Win32-OpenSSH/wiki/Install-Win32-OpenSSH)で解説されています。  ## 環境  - Windows 7 Professional 32bit - [Win32-OpenSSH](https://github.com/PowerShell/Win32-OpenSSH) 0.0.24.0  ## インストール方法  ### ダウンロード  以下から `OpenSSH-Win32.zip` をダウンロードします。  - https://github.com/PowerShell/Win32-OpenSSH/releases  ダウンロードしたら展開して適当な場所に置きます。   今回は `C:\OpenSSH` に置きました。  ### インストール  PowerShell を管理者権限で起動します。  ディレクトリを移動します。  ```sh > cd C:\OpenSSH ```  `sshd` と `ssh-agent` をインストールします。  ```sh > powershell -ExecutionPolicy Bypass -File install-sshd.ps1 ```  鍵を作成します。  ```sh > .\ssh-keygen.exe -A > powershell -ExecutionPolicy Bypass '.\FixHostFilePermissions.ps1 -Confirm:$false' ```  ### 設定  #### ファイアウォールの設定  TCP の 22 番ポートを開け、SSH で接続できるようにします。  ```sh > netsh advfirewall firewall add rule name=SSHPort dir=in action=allow protocol=TCP localport=22 ```  #### サービスの自動起動   `sshd` と `ssh-agent` を自動で起動するように設定します。  ```sh > Set-Service sshd -StartupType Automatic > Set-Service ssh-agent -StartupType Automatic ```  `sshd` と `ssh-agent` を開始します。  ```sh > net start sshd ```  以上で完了です。   他の端末から SSH でアクセスできるか試してみましょう。  ## アンインストール方法  現時点の Windows 版 OpenSSH まだ正式リリース前のものなので、アンインストール方法も一応書いておきます。  PowerShell を管理者権限で起動します。  ディレクトリを移動します。  ```sh > cd C:\OpenSSH ```   アンインストールスクリプトを実行します。  ```sh > powershell.exe -ExecutionPolicy Bypass -File uninstall-sshd.ps1 ```  ## 参考 URL  - https://github.com/PowerShell/Win32-OpenSSH/wiki/Install-Win32-OpenSSH - http://www.mcclellandlegge.com/2017-02-24-installsshd/

2017/12/20

NO IMAGE

.gitlab-ci.yml で変数を使う（ただし Windows 環境で）

GitLab

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/19

NO IMAGE

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

GitLab

2017/12/18

NO IMAGE

GitLab Runner を Windows で動かす

GitLab Windows

基本的に以下の公式ページで全て解説されています。  - https://docs.gitlab.com/runner/install/windows.html  ## 環境  - gitlab-runner 10.2.0  ホストは以下の２つで試しました。  - Windows 7 Professional (32 bit) - Windows 10 Pro (64 bit)   ## ダウンロード  [公式サイト](https://docs.gitlab.com/runner/install/windows.html)からダウンロードできます。  ダウンロードしたら適当なフォルダに配置します。   今回は公式に合わせて `C:\GitLab-Runner` に配置しました。  配置したらファイル名を `gitlab-runner.exe` にリネームします。  ## 環境変数の設定  環境変数の `PATH` に `C:\GitLab-Runner` を追加します。   これでコマンドプロンプトから `gitlab-runner` コマンドが使えるようになります。  ## インストール  まずはコマンドプロンプトを管理者として起動します。 `Win` キーを押し、`cmd` を検索し、右クリックで [管理者として実行] を選択します。  以下のコマンドを入力して Windows サービスとして gitlab-runner を動作させます。  ```sh > gitlab-runner install > gitlab-runner start ```  しかし、これだと root で実行されてしまうため、実際に GitLab CI として動作させるときにコマンドが実行されなかったりしました。   なので、ユーザーを指定してインストールします。  [こちらの記事](http://hr-sano.net/blog/2016/01/25/gitlab-ci-runner-for-windows/)にあるとおり、ユーザー名を指定すると上手くいかないので、パスワードだけ指定し、現在ログイン中のユーザーでインストールします。  ```sh > gitlab-runner install --password パスワード > gitlab-runner start ```  しかし、私の環境では `%USERPROFILE%` などのパスが root のままだったので、以下の設定を行いました。  - [コントロールパネル] > [管理ツール] > [サービス] を起動 - 一覧から `gitlab-runner` を探し、右クリックしてプロパティを選択 - [ログオン] タブで [アカウント] を選択し、ユーザーアカウントを入力 - [サービス] の画面で `gitlab-runner` を右クリックして再起動する  ## GitLab への登録  gitlab-runner のインストールが完了したら、GitLab にタスクランナーとして登録します。   基本的には Linux の場合と同様ですが、executor は `shell` を指定します。   あとは description や tag で Windows であることがわかるようにするくらいですね。  ```sh >gitlab-runner register  Please enter the gitlab-ci coordinator URL (e.g. https://gitlab.com ) https://gitlab.com  Please enter the gitlab-ci token for this runner xxx  Please enter the gitlab-ci description for this runner [hostame] windows  Please enter the gitlab-ci tags for this runner (comma separated): windows  Whether to run untagged jobs [true/false]: [false]: true  Whether to lock Runner to current project [true/false]: [true]: false  Please enter the executor: ssh, docker+machine, docker-ssh+machine, kubernetes, docker, parallels, virtualbox, docker-ssh, shell: shell ```  設定が完了したら GitLab の [Admin Area] > [Overview] > [Runners] でランナーが登録されていることを確認します。  ## アンインストール  ```sh gitlab-runner stop gitlab-runner uninstall ```  最後に GitLab-Runner のフォルダを削除すれば OK です。  ## 参考 URL  - https://docs.gitlab.com/runner/install/windows.html - https://muunyblue.github.io/2d5b53f80151aea5fef0722f8b1edf99.html - http://hr-sano.net/blog/2016/01/25/gitlab-ci-runner-for-windows/

2017/12/14

NO IMAGE

ASP.NET Core で DataAnnotations の多言語対応を行う

ASP.NET Core C#

ASP.NET Core の多言語対応の基本は以下の記事を参考にしてください。  - https://kuttsun.blogspot.jp/2017/09/aspnet-core.html  ## 環境  - Visual Studio 2017 - ASP.NET Core 2.0  ## 準備  リソースファイルは ViewModel ごとに作成してもよいですが、ここでは DataAnnotations 共通で１つのものを使います。  `Startup.cs` の `ConfigureServices` で以下のように `AddDataAnnotationsLocalization` を追加します。  ```cs services.AddMvc(opts =>    .AddViewLocalization(         LanguageViewLocationExpanderFormat.Suffix,         opts => { opts.ResourcesPath = "Resources"; })     .AddDataAnnotationsLocalization(options =>    {         // DataAnnotation を使ったときのメッセージは SharedResource に集約する         options.DataAnnotationLocalizerProvider = (type, factory) => factory.Create(typeof(SharedResource));     }); ```  ここでは DataAnnotations は `SharedResource` という共通のリソースファイルを使用するように設定しています。  ## Attributes の追加  ViewModel に対して以下のように Attribute を追加します。  ``` public class Account {     [Required(ErrorMessage = "RequiredUsername")]     [Display(Name = "Username")]     public string Username { get; set; }      [Required(ErrorMessage = "RequiredPassword")]     [Display(Name = "Password")]     public string Password { get; set; } } ```  ## リソースファイル  共通で使用するリソースファイル `SharedResource` を作成します。   リソースファイルの作成自体は以下を参考にしてください。  - [多言語対応のための共通のリソースファイルの作成](http://kuttsun.blogspot.jp/2017/12/blog-post.html)   リソースファイルを作成したら、以下のような感じで名前と値をリソースファイルに定義します。  **SharedResource.resx**  |名前|値| |---|---| |RequiredUsername|The Username field is required.| |RequiredPassword|The Passowrd field is required.| |Username|Username| |Password|Password|  **SharedResource.ja.resx**  |名前|値| |---|---| |RequiredUsername|ユーザー名を入力してください。| |RequiredPassword|パスワードを入力してください。| |Username|ユーザー名| |Password|パスワード|  以上で DataAnnotations による Validation を行うと、`Required` 属性の `ErrorMessage` で指定した名前をキーとして、ローカライズされたメッセージが表示されます。   `Display` 属性で指定した値は、例えば HTML ヘルパーを使い、View で以下のように記述すると、ローカライズされたメッセージが表示されます。  ```xml @Html.DisplayNameFor(model => model.Username) ```   ## 参考 URL  - https://andrewlock.net/adding-localisation-to-an-asp-net-core-application/ - http://blog.livedoor.jp/monthly_check/archives/70915210.html - https://joonasw.net/view/aspnet-core-localization-deep-dive

2017/12/13

NO IMAGE

多言語対応のための共通のリソースファイルの作成

ASP.NET Core C#

例えば、DataAnnotations で Validation を行った場合のメッセージとか、メッセージ系は特に共通で使用したいと思うことが多いと思います。   ということで、試してみました。   尚、多言語対応の基本については以下の過去記事を参考にしてみてください。  - [ASP.NET Core における多言語対応](http://kuttsun.blogspot.jp/2017/09/aspnet-core.html)  ## 環境  - Visual Studio 2017 - ASP.NET Core 2.0  ## 前提  基本的な設定は済んでいるという前提です。   以下の記事を参考にしてください。   ## 準備  ### リソースファイルの作成 リソースファイルを置く場所として指定したパス (ここでは `Resource` フォルダとします) にカルチャー毎のリソースファイルを作成します。   リソースファイルの名前は `SharedResource` とします。  英語だと `SharedResource.en.resx`、日本語だと `SharedResource.ja.resx` というような感じです。  ### ダミークラスの作成  共通のリソースファイルを使用するためには、それをまとめるためのダミークラスを作成する必要があるみたいです。   `Resource` フォルダに `SharedResource.cs` というダミークラスを作成し、以下のようなコードを書きます。  ```cs // Dummy class to group shared resources namespace プロジェクト名 {     public class SharedResource     {     } } ```  `namespace` が違うと上手くローカライズされないので注意です。  ## 使用方法  基本的に DI するだけで使用できます。  ### コントローラーでの使用方法  Controller では以下のように使用します。    ```cs private readonly IStringLocalizer<HomeController> localizer; private readonly IStringLocalizer<SharedResource> sharedLocalizer;  public HomeController(IStringLocalizer<HomeController> localizer, IStringLocalizer<SharedResource> sharedLocalizer) {     this.localizer = localizer;     this.sharedLocalizer = sharedLocalizer; }  public IActionResult Index() {     ViewData["Message"] = localizer["hoge"];     ViewData["Common"] = sharedLocalizer["piyo"];      return View(); } ```  ### View での使用方法  View では以下のように使用します。  ```cs @using Microsoft.AspNetCore.Mvc.Localization @inject IHtmlLocalizer<SharedResource> sharedLocalizer;   <p>© 2017 - @sharedLocalizer["foo"]</p>```  ## 参考 URL

2017/12/08

NO IMAGE

[C#] AppVeyor と Codecov でカバレッジを計測する

.NET Framework AppVeyor C# Codecov

## 環境  - Visual Studio 2017  ## 事前準備  C# の場合、コードカバレッジ自体は OpenCover を使って計測し、Codecov にはレポートを渡すだけになります。   OpenCover を使用したカバレッジ計測については以下の記事を参考にしてください。  - [OpenCover でコードカバレッジを計測する](http://kuttsun.blogspot.jp/2017/12/opencover.html)  また、AppVeyor と Codecov へのリポジトリの登録は済んでいる前提です。  ## 実行方法  Codecov へのレポート出力について、C# でのやり方は以下で説明されています。  - https://github.com/codecov/example-csharp  やり方はいろいろあるみたいですが、主に `codecov` というツールのインストール方法が違うようです。  とりあえず作成した `appveyor.yml` は以下です。  ```sh image: Visual Studio 2017 configuration: Release before_build:   - nuget restore build:   parallel: true   project: MyApplication.sln test_script:   # OpenCover でカバレッジを計測   - OpenCover.bat vstest.console.exe "coverage.xml"   # Codecov へカバレッジ結果を渡す   - "SET PATH=C:\\Python34;C:\\Python34\\Scripts;%PATH%"   - pip install codecov   - codecov -f "coverage.xml" ```  OpenCover でのカバレッジ計測はローカルでもできるようにバッチファイル化しています。   `OpenCover.bat` の内容自体は以前の記事を参考にしてください。  - [OpenCover でコードカバレッジを計測する](http://kuttsun.blogspot.jp/2017/12/opencover.html)  第１引数で vstest のパスを指定しますが、AppVeyor ではパスが設定されているのか、`vstest.console.exe` だけで実行可能です。   第２引数は出力ファイル名です。  `codecov` は NuGet でもインストール可能ですが、ローカルで実行しないのであればわざわざ NuGet でインストールするメリットもないかなと思うので、Python でインストールして実行しています。

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/

2017/12/05

NO IMAGE

[C#] OpenCover でコードカバレッジを計測する

.NET Core .NET Framework C#

## 環境  - Visual Studio 2017 Community - [OpenCover](https://github.com/OpenCover/opencover) 4.6.519 - ReportGenerator 3.0.2 - .NET Framework 4.6.1 - .NET Core 2.0  ## 準備  ### OpenCover のインストール  NuGet でインストールします。  ```sh PM> Install-Package OpenCover ```  ### ReportGenerator のインストール  OpenCover で出力された xml を html に変換するため、ReportGenerator をインストールします。   こちらも NuGet でインストールします。  ```sh PM> Install-Package ReportGenerator ```  ### NuGet でインストールしたパッケージの場所  .NET Framework ではソリューションルートの `package` の中にあります。  .NET Core の場合、Windows 環境ではユーザーディレクトリ配下の以下の場所にあります。  `%USERPROFILE%\.nuget\packages`  Windows 環境以外では試していないのでよくわかりません。    ## OpenCover によるカバレッジ計測の実行  OpenCover は CLI で動作するツールです。   基本的な使い方は以下に記載されています。  - https://github.com/OpenCover/opencover/wiki/Usage  OpenCover の出力形式は xml なので、カバレッジ計測後は ReportGenerator で HTML へ変換します。   しかし、codecov などと連携させる場合は ReportGenerator は不要なので、OpenCover と ReportGenerator とでバッチファイルを分けて、個別に実行できるようにしています。  ### MSTest の場合  MSTest を使用している場合、テストは MSTest を直接実行するのではなく、vstest をコールして実行します。    - https://qiita.com/kondoumh/items/4afe2cc737ad113a5e80  Visual Studio 2017 では vstest は以下にありました。  `C:\Program Files (x86)\Microsoft Visual Studio\2017\Professional\Common7\IDE\CommonExtensions\Microsoft\TestWindow\vstest.console.exe`  それを踏まえて、OpenCover でカバレッジを計測する場合、以下のように実行します。  ```sh rem OpenCover.bat rem ソリューションルートで実行すること  rem MSTEST のインストール先 set MSTEST="C:\Program Files (x86)\Microsoft Visual Studio\2017\Professional\Common7\IDE\CommonExtensions\Microsoft\TestWindow\vstest.console.exe"  rem OpenCover のインストール先 set OPENCOVER=%1  rem 実行するテストのアセンブリ set TARGET_TEST="MyApplication.Tests.dll"  rem 実行するテストのアセンブリの格納先 set TARGET_DIR=".\MyApplication.Tests\bin\Release"  rem OpenCover の出力ファイル set OUTPUT=%2  rem カバレッジ計測対象の指定 rem set FILTERS="+[OpenCoverSample]*" set FILTERS="+[*]*"  rem OpenCover の実行 %OPENCOVER% -register:user -target:%MSTEST% -targetargs:%TARGET_TEST% -targetdir:%TARGET_DIR% -filter:%FILTERS% -output:%OUTPUT% ```  `OpenCover.bat "packages\OpenCover.4.6.519\tools\OpenCover.Console.exe" "coverage.xml"`  ### .NET Core + xUnit の場合  .NET Core の場合、`dotnet test` で簡単にテスト可能なので、もうちょっとシンプルに書けました。  ```sh rem OpenCover.bat  rem OpenCover のインストール先 set OPENCOVER="%USERPROFILE%\.nuget\packages\opencover\4.6.519\tools\OpenCover.Console.exe"  rem テストコマンド set TARGET="dotnet.exe"  rem テストコマンド引数 set TARGET_TEST="test MyApplication.Tests\MyApplication.Tests.csproj"  rem OpenCover の出力ファイル set OUTPUT="coverage.xml"  rem カバレッジ計測対象の指定 set FILTERS="+[*]*"  rem OpenCover の実行 %OPENCOVER% -register:user -target:%TARGET% -targetargs:%TARGET_TEST% -filter:%FILTERS% -oldstyle -output:%OUTPUT% ```  ### Visual Studio 2017 の場合  Visual Studio 2017 でビルドした .NET Core および .NET Standard プロジェクトのコードカバレッジを計測したいときは、.csproj ファイルの `PropertyGroup` に `<DebugType>full</DebugType>` を追加する必要があるらしいです。  - http://ufcpp.net/blog/2017/5/newcsproj/   ## ReportGenerator で HTML へ変換  OpenCover の出力は xml なので、HTML へ変換します。   ```sh rem ReportGenerator.bat rem ソリューションルートで実行すること  rem ReportGenerator のインストール先 set REPORTGEN="packages\ReportGenerator.3.0.2\tools\ReportGenerator.exe"  rem OpenCover の出力ファイル set OUTPUT="coverage.xml"  rem ReportGenerator の HTML 出力先 set OUTPUT_DIR="Coverage"  rem レポートの生成 (xml から html へ変換) %REPORTGEN% -reports:%OUTPUT% -targetdir:%OUTPUT_DIR% ```  これを実行すると、`Coverage` に HTML ファイルが出力されます。  ## CI との連携  以下を参照してください。  - [[C#] AppVeyor と Codecov でカバレッジを計測する](http://kuttsun.blogspot.jp/2017/12/c-appveyor-codecov.html) - [[C#] GitLab CI と SonarQube で .NET アプリケーションの CI を行う](http://kuttsun.blogspot.jp/2017/12/gitlab-ci-sonarqube-net-c-ci.html)  ## 参考 URL  - https://qiita.com/budougumi0617/items/a95e1d01807049ef42ff - http://mamori017.hatenablog.com/entry/2017/03/31/182655 - https://yoshinorin.net/2016/09/21/appveyor-codecov-csharp/ - https://budougumi0617.github.io/post/2017/07/13/opencover-to-vs2017/

テンプレートテスト

2017/12/28

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

2017/12/27

.NET Core の ProjectGUID

2017/12/24

IIS に AdminScripts フォルダがないのでインストールする方法

2017/12/23

IIS をコマンドで操作する

2017/12/22

Windows 7 に OpenSSH をインストールする

2017/12/20

.gitlab-ci.yml で変数を使う（ただし Windows 環境で）

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

2017/12/19

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

2017/12/18

GitLab Runner を Windows で動かす

2017/12/14

ASP.NET Core で DataAnnotations の多言語対応を行う

2017/12/13

多言語対応のための共通のリソースファイルの作成

2017/12/08

[C#] AppVeyor と Codecov でカバレッジを計測する

2017/12/06

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

2017/12/05

[C#] OpenCover でコードカバレッジを計測する

Translate

Popular Posts

Labels

Blog Archive