こんにちは。 pregum_foxです。
今回は、前回の記事で作成したAzure DevOpsのアカウントを使って、Azure Reposに新しくレポジトリを作成し、自動ビルドから単体テストまでできるようにしてみました。
前回の記事の内容は以下をご覧ください。
CIとは関係ない、Nugetの仕組みを全然知らなかったことで数日悩まされていましたが、何とか単体テストまでこぎつけることができたので次回からは同じことを繰り返さないよう、残しておきます。
単体テストは基本的にこちらの記事を大変参考にさせて頂いたので、単体テストの部分だけ試したい！という方はそちらの方の記事をご覧ください。
目次です。
開発環境
| 項目 | 内容 |
|---|---|
| 言語 | C# + .Net Framework 4.7.2 |
| テスティングフレームワーク | xUnit 2.4.0 |
| IDE | Visual Studio 2019 |
| OS | Windows 10 |
| バージョン管理システム | Git |
大まかな流れ
今回やる作業は以下の手順で行っていきます。
1. Azure ReposにSSH接続用の公開鍵を作成し登録 2. Azure Reposでリポジトリ作成し、ローカルにpullを行う 3. 3. 作成したリポジトリにサンプル用プロジェクトとテスト用プロジェクトを追加し、Azure Reposにpushを行う 4. Azure Pipelinesで自動ビルドを実行するJobを登録 5. Azure PipelinesのJobに単体テストを行うtaskを追加し、正常に実行されていることを確認 6. 単体テストのテスト結果を集計するtaskを追加し、正常に実行されていることを確認
- は特筆することはないと思いますが、
私は鍵の作り方から忘れていたのでここにまとめておきます。。。
2.と3. は1. が正常に作業できていましたら問題なくできるかと思います。
4.と5.と6. は私は未知の世界でしたので、実験しながら作業していきました。
pipelineのazure-pipelines.ymlの変更に40回ぐらい失敗して不貞寝したことは秘密です。
それでは実際に単体テストまでの手順を記載していきます。
1. Azure ReposにSSH接続用の公開鍵を作成し登録する。
前回作成したProjectに接続する為に、SSH接続用の公開鍵と秘密鍵を作成します。
別の方法でProjectに接続する場合や既に分かっている方はこの手順は飛ばしてもらって大丈夫です。
例としてはこちらのサイトからダウンロードしたputtygen.exeを使用して公開鍵と秘密鍵を作成します。
適当なフォルダでputty.zipフォルダを解凍し、中からputtygen.exeを起動します。
すると、画面が立ち上がるので、鍵の強度が2048bitでない場合は2048bitに変更し、Generateボタンをクリックし 進捗バーが消えるまで適当にカーソルを動かします。
※ たまに上記の鍵の生成後表示されるKey fingerprint:が"ssh-rsa 2047 ..."の場合があり、その場合は"ssh-rsa 2048 ..."になるまで先程の手順を繰り返してください。
生成ができましたら、key passphraseを確認用も含め2回入力し、公開鍵と秘密鍵を保存します。
ファイル名はここでは
としておきます。
保存フォルダはWindowsキーを入力後、cmdと入力しコマンドプロンプトのデフォルトのフォルダに.sshというフォルダを作成し、そこに保存しました。
ブラウザでAzure DevOpsのSSH接続設定用画面を開き、先ほど作成した公開鍵を登録します。
設定画面に行くと、左下に"SSH public keys"という項目があるのでそこをクリックし、公開鍵の登録画面に移動します。
その画面で公開鍵の名前を任意で入力し、公開鍵の中身をテキストエディタ等でコピペし、Saveをクリックし登録処理を行います。
以上でSSH接続用の公開鍵の登録作業が完了しました。
次に登録するリポジトリを作成します。
2. Azure Reposでリポジトリ作成し、ローカルにpullを行う
Azure ReposにはGitHubからリポジトリをインポートすることができたりしますが、ここではAzure Reposで作成したリポジトリをクローンしてソースを追加していきます。
ここではSourcetreeを使用してリポジトリをクローンします。
コマンドラインで作成される方や他のGitのクライアントを使用される方は適宜置き換えてください。
Azure Repos側でリポジトリを作成します。
画像ではプロジェクト名が変わっていますが、記事用に作成しただけですので他の方は元のプロジェクトで問題ありません。
リポジトリが作成されるので、クローンを行います。
画面右上辺りにCloneと書かれている箇所があるのでボタンをクリックし、SSH接続の方はSSHに変更しコピーを行いローカルのgitクライアントのクローン先URLに設定し、クローンします。
無事クローンができたら、次の作業に移ります。
3. 作成したリポジトリにサンプル用プロジェクトとテスト用プロジェクトを追加し、Azure Reposにpushを行う
.Net Frameworkのサンプルプロジェクトとテストプロジェクトを追加します。
詳細は省略しますが以下の形でリポジトリに登録します。
/(リポジトリルート)
| .git
| .gitignore
| README.md
|
\---ConsoleAppProject
| ConsoleAppProject.sln
|
+---ConsoleAppProject
| | App.config
| | ConsoleAppProject.csproj
| | Program.cs
| |
| \---Properties
| AssemblyInfo.cs
|
+---packages # .gitignoreにpackagesフォルダを記入しておく。
|
\---UnitTestProject
| packages.config
| UnitTest1.cs
| UnitTestProject.csproj
|
+---bin
|
\---Properties
AssemblyInfo.cs
Program.csは以下の通りです
// /ConsoleAppProject/ConsoleAppProject/Program.cs namespace ConsoleAppProject { class Program { static void Main(string[] args) { } } public class SampleClass { public string Greeting() { return "Hello World."; } public int GetNine() { return 9; } public int Add(int a, int b) { return a + b; } } }
UnitTest1.csの中身は以下の通りです。
// /ConsoleAppProject/UnitTestProject/UnitTest1.cs using ConsoleAppProject; using Xunit; namespace UnitTestProject { public class UnitTest1 { [Fact(DisplayName ="Greetingメソッドのテスト")] public void GreetingTest() { var sample = new SampleClass(); Assert.Equal("Hello World.", sample.Greeting()); } [Fact(DisplayName ="GetNineメソッドのテスト")] public void GetNineTest() { var sample = new SampleClass(); Assert.Equal(9, sample.GetNine()); } [Theory(DisplayName ="Addメソッドのテスト")] [InlineData(1,2,3)] [InlineData(1,4,5)] [InlineData(-11,40,29)] public void AddTest(int a, int b, int sum) { var sample = new SampleClass(); Assert.Equal(sum, sample.Add(a, b)); } } }
xunitを使用したテストプロジェクトの作成方法はxUnitのGetting Startedをご覧ください。
Nugetは
- xunit 2.4.1
- xunit.runner.console 2.4.1
- xunit.runner.visualstudio 2.4.1
の2つのライブラリをTestUnitProjectに追加しています。
Azure Pipelinesで実施するテスト実行exeはxunit.runner.consoleをプロジェクトに追加していないと
使用できないので追加するようにしてください。
またTestUnitProjectの参照にConsoleAppProjectを追加します。
ローカルで単体テストが成功したことを確認したら、Azure Reposにコミット後、pushを行います。
pushが正常にできたら次の手順に移ります。
4. Azure Pipelinesで自動ビルドを実行するJobを登録
次にdevelopブランチにコミットされたタイミングで自動ビルドが動作するようにします。
Azure DevOpsで PipelinesのBuilds項目でNew pipelineをクリックします。
どのリポジトリか問われるので、Azure Repos Gitを選択し、3.で更新されたリポジトリを選択します。
次は、pipelineのテンプレートを問われるのでshow moreをクリックし、.NET Desktopの項目を
選択します。
pipelineの編集画面が表示されるので、右上のSave and runをクリックします。
ポップが出ますがそのまま右下のSave and runをクリックします。
するとPipelinesのBuilds項目をクリックすると先ほどのJobの実行状況がリストで表示され、クリックすると詳細が表示されます。
5. Azure PipelinesのJobに単体テストを行うtaskを追加し正常に実行されていることを確認
この作業は伊右衛門 (id:iyemon018)さんのこちらの記事を大変参考にさせて頂きました。 ありがとうございます。
PipelinesのBuilds項目をクリックして、右上のEditボタンをクリックしてazure-pipelines.ymlを編集する画面に移動します。
ではazure-pipelines.ymlの最後の辺りに書いているtask: VSTest@2のブロックを削除します。
右の検索バーに"command"を打ってCommand Lineをクリックします。 するとポップアップが右側から出てくるので、そのままAddをクリックします。
すると、azure-pipelines.ymlにcommand line用のtaskが追加されるので、script 以降に書かれている部分にxunitの単体テストを動作させるコマンドを記述します。
# task
- task: CmdLine@2
inputs:
script:
ConsoleAppProject\packages\xunit.runner.console.2.4.1\tools\net472\xunit.console.exe
$(System.DefaultWorkingDirectory)\ConsoleAppProject\UnitTestProject\bin\$(buildConfiguration)\UnitTestProject.dll
1行目のxunit.console.exeの後ろに半角スペースを入れる必要があるので注意してください。
また、上記のパスは私のフォルダ構成での例ですので ソリューションやプロジェクトのフォルダ名は適宜読み替えてください。
入力後、右上のSaveをクリックし、表示されたポップアップの右下のSaveをクリックするとJobが走ります。
PipelinesのBuilds項目をクリックし、Jobの実行状況を確認します。
※Jobの実行状況がHistoryに追加されていない場合、実行されていない為右上のEditをクリック後、右上のRunをクリックすれば、手動でJobを実行することができます。
Jobの詳細を確認するには、Jobの項目をクリックしてください。
Jobの項目でCmdLineと書かれているのが単体テストの実行taskです。
この項目が失敗している場合、コマンドが間違っている可能性が高いので、エラーメッセージで調べる等で修正する必要があります。
私の場合はpackageフォルダがリポジトリにコミットされておりNugetの復元ができていなかったことがあったのでで、そちらも確認してみるといいかもしれません。
一応単体テストを自動で実行できるようになりましたが、まだJobの詳細のTestsタブには単体テストの結果が表示されていません。
次の手順でここにテスト結果を表示させたいtaskを追加します。
6. 単体テストのテスト結果を集計するtaskを追加し、正常に実行されていることを確認
ではまた、azure-pipeline.ymlの編集画面に移動します。
- で追加した単体テスト実行コマンドを以下のように変更します。
# task
- task: CmdLine@2
inputs:
script:
ConsoleAppProject\packages\xunit.runner.console.2.4.1\tools\net472\xunit.console.exe
$(System.DefaultWorkingDirectory)\ConsoleAppProject\UnitTestProject\bin\$(buildConfiguration)\UnitTestProject.dll -xml ./test-results.xml
変更箇所はコマンドの最後に -xml ./test-reuslts.xmlを追加しただけです。
検索バーにtest と入力し、Publish Test Resultsの項目を選択します。
すると右からポップアップが表示され、テストのフォーマット等を聞かれるので、
- Test result formatをXUnit
- Test results files ./test-results
に変更し、Addをクリックしazure-pipelines.ymlに追加します。
azure-pipelines.ymlをSaveし、Jobの詳細のTestsタブにテスト結果が表示されていることを確認します。
Tips
SSH接続の代わりとなるpersonal access tokensがある
私自身もよくわかってはいませんが、Azure DevOpsにはUserに付与できるPersonal access tokensがあるようで、wikiの編集からリポジトリへのアクセスまで幅広い設定ができるようです。
参考
Azure Pipelinesの無料ビルドの時間の確認方法
Azure Pipelinesは5 ユーザーまでならCI/CD 用の 1 個のホスト ジョブ (1,800 分/月) および 1 個のセルフホスト ジョブが使用できます。
ただ、残り時間はどこを確認すればいいかわからなかったので調べたところ、どうやら左下の"Project settings"をクリックし、Parallel jobsの項目を選択すれば何分使用しているかがわかります。
雑感
思った以上に長くなりました。
とはいえまだできていないことがあるので(Job実行をmasterブランチ以外で行う、azure-pipelines.ymlの中身を理解する)、試してわかり次第書いていきたいなと思っています。
またBoardsやArtifacts等は全くわからないままなので、どういったことができるか等程度は理解しておき簡単な機能から試してみたいと思います。
ここまで見てくださってありがとうございました。
