Cursor rule

1---
2description: CodeSpirit 测试开发规范 - 单元测试、集成测试、测试项目结构和Mock使用
3globs: 
4  - "*Test.cs"
5  - "*Tests.cs"
6  - "**/Tests/**/*.cs"
7alwaysApply: false
8---
9 
10# 测试开发规范
11 
12## 测试项目结构
13 
14```
15Tests/
16├── ApiServices/              # API服务测试
17│   ├── CodeSpirit.ExamApi.Tests/
18│   └── CodeSpirit.IdentityApi.Tests/
19├── Components/               # 组件测试
20│   ├── CodeSpirit.Amis.Tests/
21│   └── CodeSpirit.LLM.Tests/
22├── Infrastructure/           # 基础设施测试
23└── Shared/                   # 共享测试工具
24```
25 
26## 测试命名约定
27 
28### 测试类命名
29- 格式：`{被测试类名}Tests`
30- 示例：`UserServiceTests`、`QuestionsControllerTests`
31 
32### 测试方法命名
33- 格式：`{方法名}_{场景}_{预期结果}`
34- 使用 `[Fact]` 或 `[Theory]` 特性
35- 示例：
36```csharp
37  [Fact]
38  public async Task GetByIdAsync_ValidId_ReturnsUserDto()
39  {
40      // Arrange
41      // Act
42      // Assert
43  }
44  
45  [Theory]
46  [InlineData(1)]
47  [InlineData(2)]
48  public async Task GetByIdAsync_InvalidId_ThrowsNotFoundException(long id)
49  {
50      // Arrange
51      // Act & Assert
52  }
53```
54 
55## 测试框架
56 
57- **单元测试**: xUnit
58- **Mock框架**: Moq 或 NSubstitute
59- **断言**: FluentAssertions（推荐）或 xUnit 内置断言
60 
61## 单元测试示例
62 
63```csharp
64using Xunit;
65using FluentAssertions;
66using Moq;
67using CodeSpirit.ExamApi.Services;
68using CodeSpirit.ExamApi.Services.Interfaces;
69 
70namespace CodeSpirit.ExamApi.Tests.Services;
71 
72/// <summary>
73/// 题目服务测试
74/// </summary>
75public class QuestionServiceTests
76{
77    private readonly Mock<IRepository<Question>> _repositoryMock;
78    private readonly Mock<IMapper> _mapperMock;
79    private readonly QuestionService _service;
80    
81    public QuestionServiceTests()
82    {
83        _repositoryMock = new Mock<IRepository<Question>>();
84        _mapperMock = new Mock<IMapper>();
85        _service = new QuestionService(_repositoryMock.Object, _mapperMock.Object);
86    }
87    
88    [Fact]
89    public async Task GetQuestionAsync_ValidId_ReturnsQuestionDto()
90    {
91        // Arrange
92        var questionId = 1L;
93        var question = new Question { Id = questionId, Content = "测试题目" };
94        var questionDto = new QuestionDto { Id = questionId, Content = "测试题目" };
95        
96        _repositoryMock.Setup(r => r.GetByIdAsync(questionId))
97            .ReturnsAsync(question);
98        _mapperMock.Setup(m => m.Map<QuestionDto>(question))
99            .Returns(questionDto);
100        
101        // Act
102        var result = await _service.GetQuestionAsync(questionId);
103        
104        // Assert
105        result.Should().NotBeNull();
106        result.Id.Should().Be(questionId);
107        result.Content.Should().Be("测试题目");
108        _repositoryMock.Verify(r => r.GetByIdAsync(questionId), Times.Once);
109    }
110    
111    [Fact]
112    public async Task GetQuestionAsync_InvalidId_ThrowsNotFoundException()
113    {
114        // Arrange
115        var questionId = 999L;
116        _repositoryMock.Setup(r => r.GetByIdAsync(questionId))
117            .ReturnsAsync((Question?)null);
118        
119        // Act & Assert
120        await Assert.ThrowsAsync<BusinessException>(() => 
121            _service.GetQuestionAsync(questionId));
122    }
123}
124```
125 
126## 集成测试示例
127 
128```csharp
129using Xunit;
130using Microsoft.AspNetCore.Mvc.Testing;
131using CodeSpirit.ExamApi;
132using System.Net.Http;
133using System.Threading.Tasks;
134 
135namespace CodeSpirit.ExamApi.Tests.Integration;
136 
137/// <summary>
138/// 题目API集成测试
139/// </summary>
140public class QuestionsControllerIntegrationTests : IClassFixture<WebApplicationFactory<Program>>
141{
142    private readonly HttpClient _client;
143    
144    public QuestionsControllerIntegrationTests(WebApplicationFactory<Program> factory)
145    {
146        _client = factory.CreateClient();
147    }
148    
149    [Fact]
150    public async Task GetQuestions_ReturnsSuccessStatusCode()
151    {
152        // Arrange
153        var request = new HttpRequestMessage(HttpMethod.Get, "/exam/api/Questions");
154        
155        // Act
156        var response = await _client.SendAsync(request);
157        
158        // Assert
159        response.EnsureSuccessStatusCode();
160        var content = await response.Content.ReadAsStringAsync();
161        content.Should().NotBeNullOrEmpty();
162    }
163}
164```
165 
166## Mock 使用规范
167 
168### 使用 Moq
169 
170```csharp
171// 设置返回值
172_mockService.Setup(s => s.GetByIdAsync(It.IsAny<long>()))
173    .ReturnsAsync(new UserDto { Id = 1 });
174 
175// 验证调用
176_mockService.Verify(s => s.GetByIdAsync(1), Times.Once);
177 
178// 设置异常
179_mockService.Setup(s => s.GetByIdAsync(It.IsAny<long>()))
180    .ThrowsAsync(new BusinessException("用户不存在"));
181```
182 
183### 使用 NSubstitute
184 
185```csharp
186// 设置返回值
187_substituteService.GetByIdAsync(Arg.Any<long>())
188    .Returns(new UserDto { Id = 1 });
189 
190// 验证调用
191_substituteService.Received(1).GetByIdAsync(1);
192 
193// 设置异常
194_substituteService.GetByIdAsync(Arg.Any<long>())
195    .ThrowsAsync(new BusinessException("用户不存在"));
196```
197 
198## 测试数据准备
199 
200### 使用 Fixture
201 
202```csharp
203public class QuestionFixture
204{
205    public static Question CreateValidQuestion()
206    {
207        return new Question
208        {
209            Id = 1,
210            Content = "测试题目",
211            Type = QuestionType.SingleChoice,
212            CreatedAt = DateTime.UtcNow
213        };
214    }
215    
216    public static CreateQuestionDto CreateValidCreateDto()
217    {
218        return new CreateQuestionDto
219        {
220            Content = "测试题目",
221            Type = QuestionType.SingleChoice
222        };
223    }
224}
225```
226 
227## 异步测试
228 
229```csharp
230[Fact]
231public async Task CreateQuestionAsync_ValidDto_ReturnsQuestionDto()
232{
233    // Arrange
234    var dto = QuestionFixture.CreateValidCreateDto();
235    
236    // Act
237    var result = await _service.CreateQuestionAsync(dto);
238    
239    // Assert
240    result.Should().NotBeNull();
241    result.Content.Should().Be(dto.Content);
242}
243```
244 
245## 测试覆盖率要求
246 
247- **核心业务逻辑**: 覆盖率 ≥ 80%
248- **服务层**: 覆盖率 ≥ 70%
249- **控制器**: 覆盖率 ≥ 60%（重点测试业务逻辑，不测试框架功能）
250 
251## 注意事项
252 
253- ✅ 每个测试方法应该独立，不依赖其他测试的执行顺序
254- ✅ 使用 `[Fact]` 进行独立测试，使用 `[Theory]` 进行参数化测试
255- ✅ 测试方法应遵循 AAA 模式（Arrange-Act-Assert）
256- ✅ Mock 对象应在测试类构造函数或 `[SetUp]` 方法中初始化
257- ✅ 使用有意义的测试数据，避免魔法数字和字符串
258- ✅ 测试异常场景，确保错误处理正确
259- ❌ 不要测试框架功能（如 EF Core、AutoMapper 等）
260- ❌ 不要编写过于复杂的测试，保持测试简单清晰
261 
262## 参考文档
263 
264- xUnit 文档: https://xunit.net/
265- Moq 文档: https://github.com/moq/moq4
266- FluentAssertions 文档: https://fluentassertions.com/
267