Week 12 - 阶段检查

边界和异常处理
-> UI 状态反馈
-> xUnit 测试固定规则
-> README 和用户手册说明操作
-> RELEASE_NOTES 说明版本变化
-> dotnet publish 生成发布目录
-> 验收清单记录操作、期望、实际、结论
-> 最终交付包

dotnet new console -n ReleaseAudit
cd ReleaseAudit

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text.Json;
 
string releaseRoot = Path.Combine(
    Environment.CurrentDirectory,
    "release",
    "ProductManager-1.0.0");
 
PrepareSampleReleasePackage(releaseRoot);
 
List<CheckResult> results = new()
{
    CheckFileExists(releaseRoot, "app/ProductManager.dll"),
    CheckFileExists(releaseRoot, "docs/README.md"),
    CheckFileExists(releaseRoot, "docs/USER_GUIDE.md"),
    CheckFileExists(releaseRoot, "docs/TROUBLESHOOTING.md"),
    CheckFileExists(releaseRoot, "docs/RELEASE_NOTES_1.0.0.md"),
    CheckFileExists(releaseRoot, "sample-data/products.json"),
    CheckFileExists(releaseRoot, "checks/ACCEPTANCE_TEST.md"),
    CheckFileExists(releaseRoot, "checks/ACCEPTANCE_RESULT.md"),
    CheckTextContains(releaseRoot, "docs/README.md", "dotnet run"),
    CheckJsonArray(releaseRoot, "sample-data/products.json", 3),
    CheckTextContains(releaseRoot, "checks/ACCEPTANCE_RESULT.md", "验收结论：允许交付")
};
 
PrintResults(results);
 
int passedCount = results.Count(result => result.Passed);
Console.WriteLine();
Console.WriteLine($"通过：{passedCount}/{results.Count}");
Console.WriteLine(passedCount == results.Count ? "结论：允许交付" : "结论：暂不交付");
 
static void PrepareSampleReleasePackage(string releaseRoot)
{
    WriteFile(releaseRoot, "app/ProductManager.dll", "fake app file for audit practice");
    WriteFile(releaseRoot, "docs/README.md", "# ProductManager\n\n启动命令：dotnet run\n");
    WriteFile(releaseRoot, "docs/USER_GUIDE.md", "# 用户手册\n\n新增、编辑、删除、搜索商品。\n");
    WriteFile(releaseRoot, "docs/TROUBLESHOOTING.md", "# 常见问题\n\n启动失败时先执行 dotnet --version。\n");
    WriteFile(releaseRoot, "docs/RELEASE_NOTES_1.0.0.md", "# ProductManager 1.0.0 发布说明\n\n发布日期：2026-06-12\n");
    WriteFile(releaseRoot, "checks/ACCEPTANCE_TEST.md", "# 验收清单\n\n- [ ] 新增商品\n- [ ] 搜索商品\n");
    WriteFile(releaseRoot, "checks/ACCEPTANCE_RESULT.md", "# 验收结果\n\n验收结论：允许交付\n");
    WriteFile(
        releaseRoot,
        "sample-data/products.json",
        """
        [
          { "id": 1, "name": "Keyboard", "price": 199, "stock": 10 },
          { "id": 2, "name": "Mouse", "price": 99, "stock": 20 },
          { "id": 3, "name": "Monitor", "price": 899, "stock": 5 }
        ]
        """);
}
 
static void WriteFile(string releaseRoot, string relativePath, string content)
{
    string path = ToFullPath(releaseRoot, relativePath);
    Directory.CreateDirectory(Path.GetDirectoryName(path)!);
    File.WriteAllText(path, content);
}
 
static CheckResult CheckFileExists(string releaseRoot, string relativePath)
{
    string path = ToFullPath(releaseRoot, relativePath);
    bool exists = File.Exists(path);
 
    return new CheckResult(
        $"文件存在：{relativePath}",
        exists,
        exists ? "通过" : "文件不存在");
}
 
static CheckResult CheckTextContains(string releaseRoot, string relativePath, string expectedText)
{
    string path = ToFullPath(releaseRoot, relativePath);
 
    if (!File.Exists(path))
    {
        return new CheckResult(
            $"文本包含：{relativePath}",
            false,
            "文件不存在");
    }
 
    string content = File.ReadAllText(path);
    bool contains = content.Contains(expectedText, StringComparison.OrdinalIgnoreCase);
 
    return new CheckResult(
        $"文本包含：{relativePath} -> {expectedText}",
        contains,
        contains ? "通过" : "没有找到指定文字");
}
 
static CheckResult CheckJsonArray(string releaseRoot, string relativePath, int minimumCount)
{
    string path = ToFullPath(releaseRoot, relativePath);
 
    if (!File.Exists(path))
    {
        return new CheckResult(
            $"JSON 数组：{relativePath}",
            false,
            "文件不存在");
    }
 
    try
    {
        string json = File.ReadAllText(path);
        using JsonDocument document = JsonDocument.Parse(json);
 
        if (document.RootElement.ValueKind != JsonValueKind.Array)
        {
            return new CheckResult(
                $"JSON 数组：{relativePath}",
                false,
                "根节点不是数组");
        }
 
        int count = document.RootElement.GetArrayLength();
        bool enoughRows = count >= minimumCount;
 
        return new CheckResult(
            $"JSON 数组：{relativePath}",
            enoughRows,
            enoughRows ? $"通过，数据 {count} 条" : $"数据只有 {count} 条");
    }
    catch (JsonException ex)
    {
        return new CheckResult(
            $"JSON 数组：{relativePath}",
            false,
            $"JSON 格式错误：{ex.Message}");
    }
}
 
static string ToFullPath(string releaseRoot, string relativePath)
{
    string normalizedPath = relativePath.Replace('/', Path.DirectorySeparatorChar);
    return Path.Combine(releaseRoot, normalizedPath);
}
 
static void PrintResults(IEnumerable<CheckResult> results)
{
    foreach (CheckResult result in results)
    {
        string status = result.Passed ? "通过" : "失败";
        Console.WriteLine($"{status} - {result.Name} - {result.Message}");
    }
}
 
public sealed record CheckResult(
    string Name,
    bool Passed,
    string Message);

dotnet run

通过：11/11
结论：允许交付

WriteFile(releaseRoot, "docs/README.md", "# ProductManager\n\n启动命令：dotnet run\n");

WriteFile(releaseRoot, "docs/README.md", "# ProductManager\n\n启动命令：启动应用\n");

dotnet run

# Week 12 最终交付复盘
 
## 1. 本周完成的收尾工作
 
- 补齐边界处理：商品名称、价格、库存、文件缺失。
- 补齐体验状态：空列表、保存中、错误提示、保存成功。
- 补齐测试：商品规则测试、商品服务测试。
- 补齐文档：README、用户手册、排错文档、发布检查清单。
- 补齐版本材料：VERSION、CHANGELOG、RELEASE_NOTES。
- 补齐交付材料：示例数据、验收清单、验收结果、交接说明。
 
## 2. 已通过内容
 
- 商品名称为空会被拦截。
- 价格小于等于 0 会被拦截。
- 库存小于 0 会被拦截。
- 保存中按钮不可重复点击。
- xUnit 测试能验证商品规则。
- README 写清运行环境和启动步骤。
- Release 发布目录能生成。
- 交付包包含程序、文档、示例数据和验收记录。
 
## 3. 还需要继续改的内容
 
- CSV 导入失败时，后续显示失败行号。
- 删除商品后，后续增加撤销能力。
- JSON 保存后续可以升级成 SQLite。
- 桌面端后续可以改为调用 Web API。
 
## 4. 当前版本是否能交付
 
允许交付。
 
原因：
 
- 主流程已经跑通。
- 关键错误输入已经处理。
- 测试、文档、版本、发布和验收材料已经补齐。
- 已知问题不阻塞当前版本使用，并且已经写入文档。
 
## 5. 下一步计划
 
1. 重做商品管理项目，确认基础能力稳定。
2. 把 JSON 保存换成 SQLite。
3. 用 ASP.NET Core 做商品 Web API。
4. 让 Avalonia 桌面端调用 Web API。