初心者向けのTeamCityセットアップ

この記事は、ASP.NET、C＃、NUnit、Selenium 2、git、MSBuildなど、私たちのチームと同じテクノロジースタックを使用する人にとって主に役立ちます。 gitとの統合、C＃プロジェクトのアセンブリ、NUnitテスト（ユニットテストとUIテストの両方）、サーバーへの展開などのタスクが考慮されます。 ただし、おそらくこの問題で犬を食べることを除いて、他のユーザーにとって興味深いことがあるでしょう。 ただし、記事のエラーに注意を向けたり、何かをアドバイスしたりすることもできます。たとえば、展開フェーズを最適化する方法などです。



こことここで完全に説明されている「継続的統合」とは、このトピックを100回繰り返す必要はほとんどありません。



さて、初心者向け-TeamCityでできること（以下、単にTC） または、次のような場合があります：リポジトリの指定されたブランチ（または他のイベント）に変更が表示されたら、たとえば、アプリケーションのビルド、テストの実行、他のスクリプトの実行、リモートサーバーへのファイルのアップロードなどを含むスクリプトを実行します



重要な点は、「統合サーバー」と「このプロセスが行われるマシン」は通常（必ずしもではない）異なるサーバーであることです。 さらに、アセンブリやテストが実行されるマシンが複数、さらには多くあり、すべてが異なるOS上に存在する可能性があります。一般に、展開する場所があります。



アセンブリプロセスを開始するには、TCサーバーからのコマンドを受け付けるエージェントプログラムを使用します;メインOS（Javaマルチプラットフォームの栄光）で実行できます。 1台のコンピューターに複数のエージェントをインストールして並行して実行できますが、1つのエージェントが一度に処理できるプロジェクトは1つだけであることに注意してください。 タスクが開始されると、TCは最初の適切な非占有エージェントを選択し、「フィルター」を設定できます。たとえば、Windowsのみ、または4.0以上がインストールされた.NETバージョンのみなどのエージェントを選択できます。



次に、作業シナリオを考え出す必要があります。 私たちは仕事で次のブランチを使用します。

1. release-戦闘サーバーにある現在のコード、作業バージョンが含まれています。
2. dev-すべての新機能が組み込まれ、後でリリースにマージされます。
3. devから分割されてそこに戻る各機能の個別のブランチ 。

一般的には、ほぼ標準のgit-flowであり、これについては、たとえばこちらで詳細を確認できます 。



この点で、スクリプトは次のようになります。

1. devブランチのリポジトリから最新の変更を取得します。
2. プロジェクトをコンパイルします。
3. 前のステップですべてがうまくいった場合-単体テストを実行します。
4. 前のステップですべてがうまくいった場合-機能テストを実行します。
5. 前のステップですべてがうまくいった場合-テストサーバーに変更をアップロードします。

リリースブランチについても同じことを行いますが、新しいデータを入力する間、サーバーを一時停止してスタブを表示します。



さあ、先に進んでください-スクリプトを実装してください！

リポジトリから最新の変更をプルします

すべては、プロジェクトの簡単な作成から始まります。







後-「 ビルド構成 」を作成します 。 構成は、ビルドスクリプトを定義します。







構成を作成する2番目のステップでは、使用されているVCSについて尋ねられるので、ここにgitがあると正直に答えます。 別のVCSがあります-迷子にならないでください。 新しいリポジトリを追加するには、[ 新しいVCSルートの作成と接続 ]ボタンを使用します 。







したがって、主要な設定：

• とにかく、 VCSルートID-一意のコードに触れることはできません。 空白のままにすると、自動的に生成されます。
• フェッチURL-リポジトリのコンテンツを取得するアドレス。
• デフォルトブランチ -情報が取得されるブランチ。
  
  
  
  
  
  
  
  
• 認証方法 -最も興味深いのは認証方法です。 キーとパスワードの両方で、認証なしでアクセスできる場合があります（たとえば、データが内部サーバー上にある場合）。 オプションごとに、追加のフィールドが独自のものになります。

残りのさまざまなオプションは、あなたの好みと色によるものです。



次に、タスクの自動起動を構成する必要があります。 Build Triggers （ビルド条件）に移動し、 VCS Trigger条件を選択します-デフォルト設定では、リポジトリに新しいコミットがあるかどうかを1分ごとに確認し、ある場合は実行するタスクを開始します。

プロジェクトをコンパイルする

Visual Studioのソリューションという形式のASP.NETプロジェクトがあるため、ここでもすべてが簡単でした。



[ ビルドステップ ]メニューに移動し、 ランナーの種類を選択し（実際には多数あります）、 MSBuildで停止します。 なぜ正確に？ アセンブリプロセスを記述するための非常に簡単な方法を提供し、単純なXMLファイルでさまざまなステップを追加または削除することで十分に複雑になります。











さらに、すべてが基本です。







ビルドファイルパス -slnファイルへのパス。

プロジェクトの要件に合わせて 、 MSBuildバージョン 、 MSBuild ToolsVersion 、およびRunプラットフォーム を選択します。



プロジェクトに複数の構成がある場合は、 コマンドラインパラメーターオプションを使用してこのキーのようなものを入力できます。

/p:Configuration=Production
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

Productionは目的の構成に置き換えられます。

NuGetパッケージのダウンロードを有効にする

NuGetパッケージを使用する場合の重要なポイント。 そうでない場合は、次の項目に直接移動できます。



NuGetパッケージは非常に重く、特別な必要なしにライブラリバイナリをリポジトリに保存したくないので、素晴らしいNuGet Package Restoreオプションを使用できます。







この状況では、ライブラリバイナリはリポジトリに含まれませんが、ビルドプロセス中に必要に応じてダウンロードされます。



しかし、 MSBuildは本物の紳士であり、許可なく不必要なジェスチャーを行うことはないため、そのようなパッケージをダウンロードすることはできません。このプロセスを許可する必要があります。 これを行うには、クライアントで[ NuGetパッケージの復元を有効にする]環境変数をtrueに設定するか、[ ビルドパラメーター ]メニューに移動して設定する必要があります。

ドライブユニットテスト

単体テストは、ソリューション内の独立したプロジェクトです。 そのため、前のステップで既にコンパイルされています-それらを実行するために残っています。



新しいステップを追加します 。 ランナーのみがNUnitになりました 。 Execute stepパラメーターに注意してください。これは、 ステップを実行する条件を示し、4つの値があります。

• 前のすべてのステップが正常に終了した場合（終了コードがゼロ） -前のすべてのステップがエラーなしで完了した場合。 この場合、チェックは純粋にエージェントで実行されます。
• ビルドステータスが成功した場合のみ -前のビルドステータスと同様ですが、同時に、エージェントはTCサーバーのビルドステータスも明確にします。 特定のステップのゼロリターンコードがエラーである場合など、タスクのロジックをより細かく制御する必要があります。
• 前の手順の一部が失敗した場合でも、前の手順のいずれかが失敗した場合でも。
• ビルド停止コマンドが発行された場合でも、常に -アセンブリをキャンセルするコマンドが発行された場合でも、ステップを実行します。

ここで最も重要なことは、[テストの実行]列でプロジェクト内のテストを使用して、アセンブリへの正しいパスを示すことです。 ここでは、たとえば、次のようになります。

 %teamcity.build.checkoutDir%\project\project.FuncTests\bin\Dev\project.FuncTests.dll
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

％teamcity.build.checkoutDir％は、リポジトリからデータがダウンロードされるフォルダーを指す変数です。 原則として、以下を示す必要はありません。 デフォルトでは、パスはこのディレクトリを基準にしているため、パスは次のように短縮できます。

 project\project.FuncTests\bin\Dev\project.FuncTests.dll
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

[ 最近失敗したテストを最初に実行 ]オプションに別途注意します。前回の実行で一部のテストが失敗した場合、次の実行でそれらが最初に開始され、最新の変更の成功がすぐにわかります。

インターフェイステストを実行します（機能テスト）

ここでのすべては、単体テストよりもはるかに興味深いものです。 ここでの上限は、ブラウザでプロジェクトをテストするために、つまり、 プロジェクトを立ち上げる必要があります。 しかし、ここでは、Seleniumのテストコードから直接Webサーバーを起動して、不正行為を行いました。

  [SetUpFixture] class ServerInit { private const string ApplicationName = "justtest"; private Process _iisProcess; private string GetApplicationPath(string applicationName) { var tmpDirName=AppDomain.CurrentDomain.BaseDirectory.TrimEnd('\\'); var solutionFolder = Path.GetDirectoryName(Path.GetDirectoryName(Path.GetDirectoryName(tmpDirName))); string result = Path.Combine(solutionFolder, applicationName); return result; } [SetUp] public void RunBeforeAnyTests() { […] var applicationPath = GetApplicationPath(ApplicationName); var programFiles = Environment.GetFolderPath(Environment.SpecialFolder.ProgramFiles); _iisProcess = new Process { StartInfo = { FileName = string.Format("{0}/IIS Express/iisexpress.exe", programFiles), Arguments = string.Format("/path:\"{0}\" /port:{1}", applicationPath, UrlProvider.Port) } }; _iisProcess.Start(); } [TearDown] public void RunAfterAnyTests() { […] if (_iisProcess.HasExited == false) { _iisProcess.Kill(); } } }]
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

また、起動自体は、単体テストのステップとまったく同じに見えます。

変更をテストサーバーにアップロードする

TCエージェントが存在するサーバーとIISがインストールされているサーバーは異なるサーバーであり、さらに、それらは異なるネットワークに配置されています。 したがって、ファイルは何らかの方法で宛先サーバーに配信する必要があります。 そして、ここでは、非常にエレガントではないかもしれませんが、非常にシンプルなソリューションが選択されています。 FTP経由のアップロードを使用し、 MSBuildはこれを行います。



スキームは次のとおりです。

1. FTPサーバーでファイルをアップロードするためのアカウントを設定します。 セキュリティを強化するために、TCサーバーが内部ネットワーク上にある場合、内部IPを除くすべてのIPの入力を禁止できます。
2. FTPアップロードタスクを使用できるようにするには、エージェントMSBuild Community Tasksにインストールします。 ここからダウンロードしてください 。
3. MSBuild用のスクリプトファイルを準備します。これにより、次のアクションが実行されます。
   
   
   1. 一時フォルダーにアプリケーションをビルドします
   2. 構成ファイルのなりすまし;
   3. FTP経由でファイルをアップロードします。

そして-彼を呼び出すタスク：







このソリューションの欠点は、変更された新しいファイルだけでなく、すべてのファイルがアップロードされることです。 多数のレイアウトファイルまたは多数のモジュールがあるプロジェクトでは、時間を埋めるために時間がかかるため、これが問題になる可能性があります。



もう1つの欠点は、ファイルの名前にラテン文字以外の文字が含まれていると、エラーが発生することです。 ラテンおよび文字/数字は通常通り処理されます。 この問題の脚はFTPプロトコルの仕様から発展しているようです。ASCIIに基づいていますが、非ASCII文字のエンコード方法については説明しておらず、「サーバーが理解できるように行う」ことを示唆しています。 したがって、スキームを変更せずに問題を解決するには、 ソースが開いているため、MSBuildコミュニティタスクにパッチを適用する必要があります 。 さて、または、WinSCPなどを使用して、ファイルをアップロードする別の方法を使用します。

リリーススクリプトのサーバーを停止して起動します

少しワイルドでかわいい方法で解決します。 IISには特殊性があります。サイトのルートにapp_offline.htmlという名前のファイルを配置すると、サイトが切断され、すべてのファイルにアクセスすると、このファイルの内容が表示されます 。



マイナス-静的なファイルを含むすべてのファイルに魅力があります。 したがって、デザイン、CSS、およびイメージを使用してスタブを作成する場合は、インラインスタイルとデータを使用します。url、well、またはオプションとして、それらを別のサーバーに配置します。



ここでは、WinSCPスクリプトとそのようなファイルを使用してサーバーを有効/無効にします。











つまり、最初はファイルはルートにあり、 _app_offline.htmlという名前です。 更新中にアクセスをブロックする必要がある場合、名前をapp_offline.htmlに変更します 。 ファイルをアップロードすると、新しい_app_offline.htmlファイルがアップロードされ 、終了後にapp_offline.htmlファイルが削除されます。 そして、元の状態を正確に取得します。



スタブページのテキストでは、ページを定期的に更新する更新メタタグの使用を強くお勧めします。 更新プロセスがこの時間までに完了すると、ユーザーはサービスに戻ります。



スクリプトを呼び出してスタブを有効にします（スタブの無効化も同様です）：







はい、 WinCSPはリポジトリ内で直接生成されます。 はい、クリアテキストのパスワードはファイルにあります。 はい、最もエレガントなソリューションではありませんが、私たちのチームの開発者のみがリポジトリとエージェントを備えた仮想マシンにアクセスできるので、なぜですか？ はい。たとえば、パスワードを含むファイルをエージェントに直接保存することは可能ですが、基本的にはセキュリティは向上しませんが、たとえば新しいエージェントの展開は遅くなります。



これらの設定を約6か月使用しましたが、これまでのところ問題は発生していません。すべてが時計のように機能します。これは朗報です。



それだけです これらの手順を改善するためのコメントとアドバイス、および自宅で使用するTC機能に関するストーリーをお聞かせください。



2014年11月3日の更新。

ランナータイプ「コマンドライン」を選択する場合、スペースをエスケープする方法は必要ありません。TeamCityが独自に処理します。