在 ASP.NET Core Web API 集成測試一文中, 我介紹了ASP.NET Core Web API的集成測試.
在那里我使用了測試專用的Startup類, 里面的配置和開發時有一些區別, 例如里面去掉了用戶身份驗證相關的中間件.
但是有些被測試的行為里面需要用到身份/授權信息.
所以本文就介紹一下在API集成測試中發送請求時使用Bearer Token作為Authorization Header的情況.
集成測試中使用Bearer Token
我這個項目里生產時使用的是Identity Server 4, 而進行集成測試時使用Identity Server 4可能會不太方便, 所以我決定簡化一下, 把這項工作就僅限制在API和測試項目這兩個項目里.
首先為被測試系統添加授權/身份驗證中間件, 修改StartupIntegrationTest:
在ConfigureServices()方法里, 首先添加一個權限策略, 要求所有的MVC Controller只有授權的用戶才能訪問.
隨后使用AddAuthentication()添加身份驗證中間件, 並設置Bearer作為方案, 通過AddJwtBearer()進行一些參數配置.
這里需要用到一個secret, 因為測試項目會用到, 所以暫時我把它弄成靜態屬性了.
最后在Configure()方法里使用該中間件即可.
來到集成測試項目的TestServerFixture類, 先要要做的就是使用上面的secret生成token, 並在HttpClient里設置Authorization Header即可:
生成token的代碼里可以設置Identity Claims. 這里我只添加了Name和Role.
然后我們試試, 找一個集成測試進行調試, 我使用的是VSCode, 點擊方法上面的debug:
我在被測試方法里添加了一些傻代碼, 以便調試用戶信息:
查看Claims:
可以看到在測試代碼里設置了Identity Claims了, 說明使用Bearer Token成功了.
測試身份驗證中間件
被測試系統使用了身份中間件: app.UserAnthentication(), 我們也可以測試一下這個中間件的功能, 如果Token不正確的話, 就應該返回401 UnAuthorized狀態碼:
這個測試代碼很簡單, 就是設置了一個不正確的token, 並Assert返回狀態碼是401.
該測試會通過:
文章略短, 就介紹到這.