Quality Gate 是 SonarQube 中的一個功能，旨在根據特定的程式碼質量指標來評估程式碼的質量和合規性。透過 Quality Gate，專案團隊可以確保程式碼符合一定的質量標準，避免程式碼中的潛在問題進入生產環境。它通常用於持續整合（CI）或持續交付（CD）流程中，作為程式碼合併或部署的一個質量檢查步驟。
1. Quality Gate 的定義
Quality Gate 是一組預定義的程式碼質量條件集合。它為專案的程式碼質量設定了“門檻”，如果程式碼未達到這些條件之一，那麼程式碼將“未透過”質量門檢查。Quality Gate 是 SonarQube 中的關鍵特性，用於定義程式碼的“健康狀態”。
在一個典型的開發流程中，Quality Gate 是在程式碼掃描後產生的，透過一系列指標判定程式碼是否達到了公司或團隊設定的質量標準，幫助開發人員及時發現並修復程式碼中的潛在問題。
2. Quality Gate 的核心指標
SonarQube 的 Quality Gate 可以包含多個指標，常見的標準包括以下幾類：
程式碼覆蓋率 (Code Coverage)
- 表示測試程式碼覆蓋到專案程式碼的比例，通常用於衡量單元測試的完整性。覆蓋率低的程式碼通常容易出錯。
- 例如，可以設定程式碼覆蓋率最低標準為 80%，未達到此標準則未透過 Quality Gate。
Bug 和漏洞 (Bugs and Vulnerabilities)
- Bug 是指程式碼中的錯誤，可能導致系統崩潰或邏輯錯誤。SonarQube 會根據嚴重性劃分 Bug 的等級，通常要求不能有高優先順序的 Bug 存在。
- 漏洞 是指程式碼中的安全缺陷，可能會造成資料洩露或安全問題。要求沒有高優先順序漏洞，或限制嚴重漏洞的數量。
技術債務 (Technical Debt)
- 技術債務是指專案中潛在的、待最佳化的程式碼量，通常以完成這些最佳化需要的工作量來衡量。
- Quality Gate 可以對技術債務的比例設限（如不能超過程式碼總量的 5%）。
程式碼重複率 (Code Duplication)
- 表示程式碼的重複程度。高重複率的程式碼容易導致維護困難並增加程式碼的冗餘。
- Quality Gate 可以限制程式碼重複率，如設定重複率不能超過 3%。
可維護性評級 (Maintainability Rating)
- 用於評估程式碼的可維護性等級，從 A 到 E 五個等級。D 或 E 級的程式碼表明需要大量重構，降低了程式碼的可讀性和易維護性。
- Quality Gate 可以設定要求程式碼達到 A 或 B 級別的可維護性。
安全評分 (Security Rating)
- 類似可維護性評級，SonarQube 將安全性分為 A 到 E 五個等級。可以限制程式碼的安全性評級，以確保程式碼符合一定的安全標準。
程式碼壞味道 (Code Smells)
- “壞味道”是指在程式碼結構和設計上的潛在問題，不會直接導致錯誤但會影響程式碼的可讀性和擴充套件性。通常，團隊會要求控制程式碼中的“壞味道”數量。
3. Quality Gate 的預設標準
SonarQube 提供了一個“Sonar Way”預設 Quality Gate 標準，常用的條件包括：
- 新程式碼的漏洞：應為零。
- 新程式碼的錯誤：應為零。
- 新程式碼的程式碼覆蓋率：通常要求達到 80%。
- 新程式碼的重複程式碼：要求低於一定比例（例如 3%）。
- 技術債務比例：保持在 5% 以下。
4. 自定義 Quality Gate
團隊也可以根據專案需求自定義 Quality Gate。例如，一個高安全性的專案可能會嚴格要求無漏洞，而對覆蓋率要求相對寬鬆；而一個關鍵業務系統則可能對 Bug 和程式碼覆蓋率有更高的要求。自定義方法如下：
- 在 SonarQube 中，進入 Administration > Quality Gates 頁面。
- 建立新的 Quality Gate 或編輯現有的規則，設定符合專案需求的各項指標和閾值。
- 將自定義的 Quality Gate 應用到特定專案上。
5. Quality Gate 的實際應用
Quality Gate 通常在 CI/CD 管道中自動執行。當程式碼質量不達標時，CI/CD 流程可以被中斷，防止不合規程式碼進入生產環境。例如：
- 在程式碼提交後，CI 工具（如 Jenkins 或 GitLab CI）會觸發 SonarQube 分析。
- 如果 Quality Gate 未透過，CI 流程會失敗並反饋給開發人員，提醒需要進行修改。
透過這種方式，Quality Gate 幫助開發團隊持續監控程式碼質量，並確保程式碼符合既定的標準，逐步提升程式碼的整體可維護性和安全性。
在sonar Qube 的指標中，Reliability 是指什麼？
在 SonarQube 中，Reliability（可靠性）是用於衡量程式碼在生產環境中是否穩定和可靠的一個指標。該指標透過檢查程式碼中的 Bug 來評估程式碼的錯誤風險，反映出程式碼在執行時出現錯誤或導致系統故障的可能性。因此，Reliability 越高，程式碼的穩定性和無錯誤執行的可能性就越大。
1. Reliability 的評估標準
Reliability 是透過檢測程式碼中的 Bug，並根據 Bug 的數量和嚴重性進行綜合評分。SonarQube 會將 Bug 按嚴重性分為多個等級，如下所示：
- 阻斷（Blocker）：極嚴重的問題，通常會導致系統崩潰或關鍵功能不可用。例如，陣列越界、空指標異常等。
- 關鍵（Critical）：嚴重影響系統功能的問題，可能會導致資料丟失或錯誤的業務邏輯。例如，錯誤的條件判斷、未處理的異常。
- 重要（Major）：中等嚴重性的問題，不會立即導致崩潰，但會影響功能的準確性或可維護性。
- 次要（Minor）：相對較輕的問題，但可能會增加程式碼維護難度。
- 提示（Info）：提示資訊，一般不影響系統功能，更多是程式碼風格或潛在的最佳化建議。
2. Reliability 的評分等級
SonarQube 將 Reliability 的評分分為五個等級，從 A 到 E，每個等級代表不同的程式碼可靠性情況：
- A 級：無 Bug，程式碼可靠性極高。
- B 級：輕微的 Bug，但不影響程式碼的總體可靠性。
- C 級：存在中等嚴重的 Bug，程式碼可靠性一般。
- D 級：存在嚴重 Bug，可靠性低，系統在執行中可能會出錯。
- E 級：有非常嚴重的 Bug，程式碼在生產環境中極不可靠，可能導致重大系統問題。
通常，SonarQube 預設要求專案達到 A 或 B 級別的 Reliability 評分，以確保程式碼的穩定性。
3. Reliability 與 Quality Gate 的關係
Reliability 是 Quality Gate 中的一個重要指標，通常企業會在 Quality Gate 中設定可靠性的最低要求。例如，專案需要至少達到 Reliability B 級才能透過質量門檢查，這樣可以在程式碼釋出前及時發現並解決嚴重 Bug，提升程式碼的穩定性。
4. Reliability 的實際應用
Reliability 指標幫助開發團隊識別和解決潛在的錯誤，使程式碼在生產環境中更為可靠。透過設定 Reliability 目標並在 CI/CD 流程中自動檢查程式碼，Reliability 指標可以有效減少系統在生產環境中出現意外錯誤的風險，提高使用者體驗和系統的整體穩定性。