Ui5 Best Practices Qunit

作者 UI5a99b882ce364無授權條款收錄於 2026年10月8日更新於 2026年10月8日

Use when the user asks to "write a QUnit test", "fix a failing QUnit test", "add a QUnit module", "modernize QUnit tests", "migrate from QUnit 1", or mentions QUnit-specific constructs such as assert.async, nextUIUpdate, Core.applyChanges, sinon sandbox, asyncTest, or QUnit.module. Covers coding standards for OpenUI5/SAPUI5 unit test files: const/let over var, arrow functions over .bind(this), async/await over assert.async(), assert.expect() in every async test, sinon.createSandbox(), descriptive test names, beforeEach/afterEach module isolation, nextUIUpdate vs Core.applyChanges rules, try/finally teardown in helpers, QUnit 1 to QUnit 2 globals migration, and non-ASCII character avoidance.

AI 產生的概覽

用於撰寫、修正與現代化 OpenUI5/SAPUI5 QUnit 單元測試的程式碼規範。

功能
此技能為 OpenUI5/SAPUI5 專案中的 QUnit 測試檔案撰寫與審查提供規則與參考指引。內容涵蓋程式碼風格慣例,例如以 const/let 取代 var、以箭頭函式取代 .bind(this)、以 async/await 取代 assert.async()、非同步測試中使用 assert.expect()、sinon.createSandbox()、具描述性的測試名稱、beforeEach/afterEach 隔離、try/finally 清理、nextUIUpdate 與 Core.applyChanges 的取捨,以及 QUnit 1 到 QUnit 2 的移轉。它也會引導代理查閱三份隨附參考文件,分別涉及撰寫新測試、現代化現有測試與非同步模式。
適用情境
當被要求撰寫 QUnit 測試、修正失敗的 QUnit 測試、新增 QUnit 模組、現代化或移轉 QUnit 測試時使用,或在出現 assert.async、nextUIUpdate、Core.applyChanges、sinon sandbox、asyncTest、QUnit.module 等 QUnit 專有建構時使用。它面向 UI5 單元測試程式碼,而非應用程式碼。
執行需求
不含指令碼,僅包含說明與三份 Markdown 參考文件。代理應在產生輸出前載入相關參考文件。目標專案預期使用 QUnit、Sinon 與 OpenUI5/SAPUI5,並搭配 ESLint。

QUnit Test Best Practices for UI5

When to load each reference

TriggerLoad
Writing a new QUnit test file or module from scratchreferences/writing-new-tests.md [blocked]
Modernizing, refactoring, or reviewing existing test codereferences/modernizing-tests.md [blocked]
Migrating from QUnit 1 (globals: test, asyncTest, ok, stop, start) to QUnit 2references/modernizing-tests.md [blocked]
Any test touches nextUIUpdate, Core.applyChanges, assert.async, fake timers, or event-based asyncreferences/async-patterns.md [blocked]

Load the reference before producing any output. Do not work from memory.


Core rules (always apply)

RuleDetail
No varUse const or let. One declaration per line - no comma chains.
No .bind(this)Use arrow functions for callbacks that do not need their own this.
assert.expect(N) in every async testGuards against silent passes when async callbacks never fire. Not required for sync tests.
sinon.createSandbox()sinon.sandbox.create() emits a runtime deprecation warning in Sinon 5+ - prefer sinon.createSandbox(). Alternatively use the QUnit-sinon bridge (this.stub(), this.spy(), this.mock(); this.clock only when sinon.config.useFakeTimers is truthy). Do not mix both approaches in the same module.
Descriptive test namesSentence describing behavior. Never start with "it should". Unique within each module.
beforeEach / afterEach in every moduleCreate all controls in beforeEach, destroy them in afterEach. No shared mutable state between tests.
try/finally in helper-created controlsHelpers that create a control must destroy it in finally so it is cleaned up even when assertions throw.
No non-ASCII charactersNo non-ASCII characters in comments, strings, or JSDoc. Use plain ASCII hyphens, not em dashes. UTF-8 is required, but non-ASCII in comments has historically caused encoding issues.
ESLint - 0 errorsWarnings for pre-existing patterns (max-nested-callbacks, no-use-before-define, valid-jsdoc) are acceptable.

Quick-reference checklist

Use when authoring or reviewing a QUnit test file:

  • No var - use const or let; one declaration per line (no comma chains)
  • No .bind(this) - use arrow functions for callbacks that do not need their own this
  • No assert.async() in simple cases - use async function + await new Promise(...)
  • Every async test has assert.expect(N)
  • No sinon.sandbox.create() in new code - use sinon.createSandbox() or the bridge (this.stub(), this.spy(), this.mock()); this.clock only when fake timers are enabled
  • No "it should..." test titles - use descriptive sentences
  • Every QUnit.module has beforeEach / afterEach that create and destroy all controls
  • With fake timers: prefer await nextUIUpdate(this.clock) over Core.applyChanges(); only keep Core.applyChanges() when nextUIUpdate(clock) cannot handle the case
  • Helper functions that create controls destroy them in try/finally
  • No non-ASCII characters in comments or strings (UTF-8 required, but non-ASCII causes encoding issues)

來源與署名

來源:UI5/plugins-coding-agents位於plugins/ui5/skills/ui5-best-practices-qunit提交a99b882

授權條款: 無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架