[iThome第8屆鐵人賽 14]程式碼品質 - 介紹篇

我曾經聽過一個笑話，一個人到一家公司面試，面試官問他：「請問你如何保證/保持你的程式碼品質？」

這個年輕人回答：「我...我會在發現bug的時候把問題加班修好」。

其實這個有點悲哀，也說明了為什麼軟體工程師時常需要加班，因為當軟體越寫越複雜的時候，要保持程式的品質是需要一些事情，但是這些事情是什麼？有沒有可能進入到我們日常環境里？

這個就是接下來會介紹的部分，我們如何透過做CI把程式碼品質要做的事情整合進來。

• 如何保持程式碼品質？
  
  • 透過測試保證程式碼品質
    
    • 不需要每一個方法的涵蓋率都要100%
  • 程式碼分析
  
  
• 結語

[iThome第8屆鐵人賽 13]執行測試 4 - 重構

在之前幾篇已經介紹完了.Net常見的三種Test Framework（Xunit，Nunit 和 MSTest）整合方式之後，相信會發現到這三個task有很地方是重複邏輯。

這些重複邏輯我們都是用了copy 和 paste 的方式處理了，但是未來如果要維護這個build script，甚至要把它變成一個常用/通用的script，這種方式是非常不好

所以，就像任何好的工程師會做的事情一樣，我們也要重構我們的Script。

這篇將會介紹重構什麼，和如何重構。

sample 程式在 github devops-psake sample/chapter13

• 可以重構什麼？
  
• 如何重構？
  
• 重構 - 從package找到要執行的exe
  
• 重構 - 從建制結果找到需要被執行測試的專案路徑
  
• 重構 - 取得要執行測試的assembly路徑字串
  
• 結語
  

[iThome第8屆鐵人賽 12]執行測試 3 - MSTest

在介紹完Xunit和Nunit測試之後，這篇將要來看最後一個常見的測試Framework，Visual Studio內建的MSTest。

sample 程式在 github devops-psake sample/chapter12

• MSTest 和其他測試有和不同？
  
• 準備測試專案
  
• 準備build script - task定義
  
  • 1. 定義Task
    
  • 2. 準備build script - 參數定義
    
  • 3. 準備執行 MSTest
  
  
• 執行MSTest的測試
  
• 結語

[iThome第8屆鐵人賽 11]執行測試 2 - NUnit .Net

在上篇介紹完如何整合Xunit做測試之後，在這篇我們將會看看在.Net世界裡面另外一個常用的測試Framework，NUnit。

sample 程式在 github devops-psake sample/chapter11

• Nunit和Xunit有和不同？
  
• 準備Nunit測試專案
  
• 準備build script - task 定義
  
  • 1. 在build專案安裝Nunit Console
    
  • 2. 定義NUnintTest的task
    
  • 3. 準備build script - 參數定義
    
  • 4. 準備執行 nunit console runner
  
  
• 執行Nunit測試
  
• 結語

[iThome第8屆鐵人賽 10]執行測試 1 - XUnit .Net

經過一段時間的介紹，相信對於使用psake來建制專案已經沒什麼問題了 - 我們就要開始進入建制的下個階段，也就是測試。

專案建制起來只是基本條件，但是單元測試是否有通過才是保證程式碼品質的一種方式，因此，不跑單元測試更本就不完整。

在接下來幾篇，將會介紹幾個常見的unit test的framework，先從xunit開始。

sample 程式在 github devops-psake sample/chapter10

• 準備Xunit 測試專案
  
• 準備測試的執行環境
  
  • 1. 在build專案安裝xunit的console runner
    
  • 2. 準備build script - task 定義
    
  • 3. 準備build script - 參數定義
    
  • 4. 準備執行 xunit console runner
  
  
  
• 執行Xunit的測試
  
• 結語

[iThome第8屆鐵人賽 09]建制失敗的處理 - 為什麼失敗了但是build server還是認為成功

在進入下個階段之前（也就是開始執行Unit Test），有個部分一直沒有碰到，那就是當建制失敗的時候會發生什麼事情。

整個CI的概念就是盡早發現建制有問題好去做一些處理，但是如果出錯了都發現不到，不就等於沒有意義了？

這篇我們將會看看這方面的處理。

sample 程式在 github devops-psake sample/chapter9

[iThome第8屆鐵人賽 08]建制結果問題 - 方法2 透過MSBuild的Target

• 拆解WebApplication1.csproj
  
• 建立console用到的target
  
  • 1. target檔案和資料夾名稱參數的產生
    
  • 2. 註冊執行的動作
    
  • 3. 是定義執行的動作
    
  • 4. 把剛剛定義的target放到Console的csproj
    
  • 5. 執行結果
    
  
  
• 結語

在上篇了解到如果什麼都沒調整的情況下，建制出來的內容會放在一起，根本無法區分哪些內容屬於哪些專案。

也提到了.Ner 4.5能夠使用GenerateProjectSpecificOutputFolder，但是假設是.Net 4.5以下呢？

這篇我們會沿著這個思路，看看為什麼Asp .Net Mvc專案有個_PublishedWebsite，並且我們是否能夠使用這個資訊來做些處理。

sample 程式在 github devops-psake sample/chapter8

[iThome第8屆鐵人賽 07]建制結果問題 - 說明 和 處理方法 1

• Build結果有什麼
  
• 加入Library和Console專案
  
• 解決方法 1 - .Net 4.5 以上的專案 - GenerateProjectSpecificOutputFolder
  
  • 解決方法1的缺點
• 解決方案 2 - 使用Asp.Net Mvc的概念產生出 _PublishedXXX
  
• 結語

上篇我們提到了用psake來建制一個asp .net mvc的專案，並且修正了psake執行時候呈現的內容，在這篇，我們將進一步延伸來看一下，buid結束產生的內容是什麼和 加入另外兩種常見的.Net專案：

1. Console Project
   
2. Library Project

sample 程式在 github devops-psake sample/chapter7

[iThome第8屆鐵人賽 06]開始建制一個Asp .Net Mvc專案

• MSBuild和Psake的關係
  
• 準備程式用於做建制測試
  
• 開始建制我們的專案
  
• 修正Compile時候出現的幾個小問題
  
  • MSBuild使用的.Net版本錯了
    
  • Console看不出哪段是psake在執行
  
  
• 結語

經過了幾天的理論介紹，我們開始要進入建制專案的部分。

我們會先拿一個Asp .net Mvc的網站作為第一個要建制的專案，所以我們會先建立出來，然後在使用MSBuild帶來的幫助，幫我們快速建立專案

這次的建制我們都是focus在.net Framework的部分，或許.net core會有所不同，但是概念是一樣。

（之後下面提到的code都可以從這邊看到內容：github repo，這篇會是tag sample/chapter6）

[iThome第8屆鐵人賽 05]準備建制專案環境的Task

• 建制結果的資料夾結構
  
  • 準備Init task
  • parameter
  • 建制資料夾的邏輯區分開來
• Clean Task 調整
• 結語

在上篇對於psake有些了解以後，我們開始把所學的東西用於如何搭配方便建制專案。

在這篇，我們會定義當專案建制的時候，我們的資料夾結構和先把那些資料夾環境準備好

[iThome第8屆鐵人賽 04]開始了解如何使用psake

• 開始使用psake
  
  • psake基本資訊
• 準備好測試專案
  
  • 第一步 - 建立C# Library Project和安裝psake nuget
    
  • 第二步 - 產生default.ps1檔案
    
  • 第三步 - 執行我們定義的Task
  
  
• 介紹psake的task寫法
  
  • 檔案default.ps1
    
  • task的定義
    
  • task其他參數
    • 預設Task
      
    • 增加Task的描述
      
    • Task參數化
      
    • 在執行Task之前先檢查是否有提供某個參數
    
    
• 增加方便執行psake的build.ps1檔案
  
• 結語

在上一篇了解了如何建制一個專案之後，和我們之後要使用psake作為build tool，在這篇我們將會看到底怎麼開始使用psake，和建立出我們之後會一直使用的專案。

（之後下面提到的code都可以從這邊看到內容：github repo，這篇會是tag sample/chapter4）

[iThome第8屆鐵人賽 03]CI - VS是如何建制(Build) .Net專案

• VS到底如何建制專案
  
  • 如何編譯CS程式碼
• 什麼是Build Tool
  
• 到底應該用什麼build tool？
  
  • 為什麼不直接用MSBuild？
• psake到底是什麼？
  
• 結語

在上篇了解到說什麼是DevOps之後，我們就開始探討第一個部分，也就是Continous Integration (CI)。

CI最基本的核心就是build專案 - 所以我們需要了解一下到底VS是如何build專案的，只有了解之後我們才能夠把它腳本化，也才有可能自動化。

因此，這篇將會介紹：

1. VS到底如何建制專案
   
2. 什麼是build tool
   
3. 為什麼接下來系列會選擇使用psake作為build tool

[iThome第8屆鐵人賽 02]什麼是DevOps？

• DevOps是什麼？
• 這個系列對於DevOps的關注點
• 到底什麼是Continuous Integration (CI)
• 到底什麼是Continuous Delivery（CD）
• 到底什麼是Continouous Deployment（CD）
• 結語

DevOps到底是一個什麼概念？對於工程師來說指的是什麼？為什麼DevOps最近這麼夯是我們在這篇所要討論的事情。

[iThome第8屆鐵人賽 01]開篇 - 為什麼要寫這個主題

• 為什麼寫這個主題
  
• 適合什麼人看
  
• 使用到的工具
  
• 結語
  

又到了新的一屆鐵人賽，針對這次是否要參賽其實非常的糾結：一方面因為工作的關係，額外的時間越來越少，但是一方面又想把寫日誌的習慣找回來，在這種糾結的心情中，最後，還是想寫戰勝了不想寫。

這已經是第三次參加鐵人賽了，對我來說，每一年的主題都比上一年的更加困難，今年選擇的主題更是我這兩年想做但是一直沒有做的部分，也就是如何在日常生活中把DevOps引進來，並且提升日常工作效率。

同去年一樣，今年很多東西會是邊執行並且邊研究和邊記錄，希望大家能夠在這個系列學習到東西。