Shuery/BakNRet
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
14 Commits 1 Branch 0 Tags
8d67a38fb7b512783b3c4517226bd4f7cc203726
Commit Graph
9 Commits
Author SHA1 Message Date
Shuery 8d67a38fb7 fix: Backup.ps1 与 Restore.ps1 并发撞车时互踩账本（加运行锁） 
问题：两个入口都会写 manifest.json，也都会在备份目录里用 <归档>.tmp 这个名字生成临时
归档。计划任务与手动运行撞在一起时，两边会互相覆盖对方的账本；更糟的是两边会把彼此的临时
归档当成自己的。计划任务的 -MultipleInstances IgnoreNew 只挡住"计划任务之间"，挡不住手动运行。

修法：备份目录上的一把跨进程锁，用**独占文件句柄**（FileShare.None）而不是命名互斥体：
  * 句柄由内核持有，进程被杀 / 崩溃时自动关闭，锁自动释放 —— 不会留下需要人工清理的陈旧锁；
    命名互斥体要跨会话（计划任务在另一个会话里跑）还得用 Global\ 前缀，那需要额外权限。
  * 它是文件系统的锁：不区分会话、不区分终端，计划任务与手动运行会互相看见。
  * 锁文件里写明持有进程（pid / 起始时间 / 主机 / 用户）—— "到底是谁占着"不该靠猜。
拿不到锁就直接失败（退出码 1 + 明确消息），不等待：单个条目压缩可能十几分钟，"等它跑完"
对用户来说和挂住没区别。

只读模式不取锁（Backup 的 -DryRun；Restore 的 -DryRun / -WhatIf / -VerifyOnly）：
它们一个字节都不写，没必要被正在跑的备份挡在外面。

踩到并记下的两个坑：
  1) catch [System.IO.IOException] 接不住 —— PowerShell 把 .NET 方法抛出的异常包成
     MethodInvocationException，按内层类型做的 catch 会漏。现在沿 InnerException 链找，
     不是 IOException 就把原异常抛回去（目录不可写是 UnauthorizedAccessException，那是真
     错误，不该伪装成"另一次运行在进行中"）。
  2) 锁文件是独占打开的，所以内容只能在**释放之后**读 —— 第一版断言在持锁时去 Get-Content，
     被自己的锁拒了；这条断言现在挪到释放之后。

跨进程证据（真跑，不是推理）：父进程持锁 → 另一个进程取锁得到 DENIED；持锁状态下跑
真实的 Backup.ps1 → 退出码 1、日志点名锁文件、manifest 的 SHA256 未变；释放后另一进程
得到 GOT。

验收：test.ps1 9/9 全绿（7 与 5.1）；tests\Run-RealSmoke.ps1 4/4 全绿。
 2026-09-27 09:18:49 +08:00
Shuery 79f83f6760 fix: manifest 先删后移会丢账本；5.1 拿不到原子替换；空目录让空间守卫静默失效 
四件事都在"原子替换与空间守卫"这条线上：

1) Write-BaknretManifest 自己写了"写 .tmp → 删旧 → Move-Item"。Move-Item 一失败，
   旧 manifest 就已经没了 —— 而 manifest 是"这块归档是谁的"的唯一账本。改成复用
   Write-BaknretAtomicText。

2) Write-BaknretAtomicText 原本也是走 Move-BaknretArchiveIntoPlace，而后者在 5.1 上
   必然退化成"先删后移"（三参数 File.Move 是 .NET Core 3.0+ 才有的重载）。现在目标存在时
   改用 File.Replace（ReplaceFile API）：要么换成新内容、要么保持旧内容，两个都不会消失。
   实测目标只读时替换失败、旧内容完好、.tmp 保留便于排查。

3) Move-BaknretArchiveIntoPlace 的 5.1 降级路径同样改成 File.Replace —— 之前那条
   "先删后移"会在中途失败时让归档消失（旧归档没了、新归档还在 .tmp 里）。
   注意第三个参数必须传 [NullString]::Value：PowerShell 会把 $null 转成空串，Replace 于是
   报"路径为空"（两个版本实测都这样，我第一版就踩了）。

4) Get-FolderSummary 对空目录返回的 TotalSize 是 $null 而不是 0（Measure-Object 空
   输入的行为，两版一致）。$null / 1GB 得 0，而备份前的空间守卫判的是 -gt 0 —— 空间不足时
   不再拦截，静默失效。现在补成 0。

回归断言（零依赖与 Pester 各一份）：空目录的摘要必须是整数 0；原子写成功时内容到位
且不留 .tmp、失败时旧内容完好（用只读目标强制失败）。

验收：test.ps1 9/9 全绿 —— 5.1 那一遍的通过同时证明了 File.Replace 这条新路径真的
在 5.1 上成立；tests\Run-RealSmoke.ps1 4/4 全绿。
 2026-09-26 22:47:14 +08:00
Shuery e17cdcda79 fix: 口令会随 -Verbose 落进日志（DEBUG 下打印整条命令行） 
缺陷：Invoke-ExternalCommand 在 DEBUG 级打印整条命令行，而 7z / RAR 只接受命令行
口令（-p<口令>），所以口令必然出现在参数表里。一旦 -Verbose（Backup.ps1 / Restore.ps1
都会因它打开 DEBUG），logs\*.log 里就是明文口令 —— 与 BackupConfig.psd1 和文档里
"口令不落盘、不写进仓库"的承诺直接冲突。

修法：打印前把 -p 参数换成占位符；真正执行的仍然是原参数。在**参数级别**替换而不是
对拼好的命令行做正则 —— 含空格的口令会被引号包起来（"-pmy pass"），正则在那种形态上
很容易漏掉，而漏掉的代价是口令明文入日志。

回归断言（零依赖与 Pester 各一份）：打开 DEBUG、把日志指向临时目录、带一个哨兵口令
跑一次外部命令，然后读日志文件断言哨兵不在里面、占位符在里面。另加一条"测试的测试"：
断言那行 DEBUG 记录确实写进去了 —— 否则前两条会在"压根没记录"时空跑通过。

断言有效性做了红绿证明：把遮蔽改回 $startInfo.Arguments 后断言变红并指名"口令明文
进了日志"，还原后转绿。

验收：test.ps1 9/9 全绿；tests\Run-RealSmoke.ps1 4/4 全绿。
 2026-09-26 22:41:52 +08:00
Shuery d32d4b511f fix: 暂存目录半途失败会留下指向真实数据的 junction 
缺陷：Backup.ps1 用 `$stagingRoot = $null` + try/finally 清理暂存目录，而
New-BaknretArchiveStaging 中途抛错时没有返回值 —— 赋值没发生，finally 拿到的还是 $null，
而 Remove-BaknretArchiveStaging 对 $null 直接 return。结果是已经建好的 junction 与临时
目录永久留在 %TEMP%，而那些 junction 指向真实数据；临时目录迟早会被某次
Remove-Item -Recurse 扫到，那一下就会走进真实数据。全仓唯一会伤到数据的缺陷。

修法：把清理责任放回函数自己身上 —— 循环包进 try，catch 先调
Remove-BaknretArchiveStaging 清掉已经建出来的东西，再 throw 原始错误。调用方的 finally
保持不动（它管的是"暂存建好之后下游才失败"那条路）。自清理失败时只告警并点名残留路径，
不覆盖真正的失败原因 —— 那才是排查需要的。

回归断言（零依赖与 Pester 各一份）：第一项走 junction 成功挂上，第二项因源文件不
存在必然抛错；然后断言沙盒里不留任何条目，尤其不留 junction。

断言的有效性做了红绿证明：把 catch 里那行清理临时停用后，同一段场景残留 1 个
junction（.\sandbox\stage\Good，指向真实目录）→ 断言变红；还原后文件哈希一致、断言转绿。
一个不会红的断言不算保护。

验收：test.ps1 9/9 全绿（7 与 5.1）；tests\Run-RealSmoke.ps1 4/4 全绿。
 2026-09-26 22:36:44 +08:00
Shuery 8736bb2c67 fix: 行首方向标记贴在目标上时失效（真实清单 29 条里 24 条被静默跳过） 
量到的事实：用真实清单只读干跑，28 个条目里 27 个被当成"源不存在"跳过、退出码 0，
只有不写方向标记的 Scoop 真的被备份 —— 磁盘上最新那份归档正是 Scoop.7z（4.6 GB / 09-24）。
修复后同一批条目：29 条全部分解出方向（26 仅备份 / 2 仅恢复 / 1 双向），零个标记残留。

原因：解析器只认"独立记号"形态的方向标记（+ Name），而清单里 24 条贴在目标上
（+WindowsTerminal）。后者被当成一个名叫 +WindowsTerminal 的软件名，名录里查不到就退回
当目录名，目录又不存在 → 静默记成 missing-source。它隐形的理由是两件本身正确的设计叠在
一起："源不存在只算跳过不算失败" 加上两种写法只差一个空格。

README 的方向标记表格写的是"行首 + / -"，并没有要求标记后面跟空格；要求带空白的是
修饰符（:: / :- / :+ / @）那一节。所以让解析器接受行首贴在一起的形态，而不是去改清单。
只放宽"行首"这一个位置：记号中间的 + / - 仍是普通字符（C:\a:-b 那条断言继续盯着）。

新增 tests\Run-RealSmoke.ps1：真实清单 + 真实归档上的只读冒烟。它存在的理由就是这个
缺陷 —— 夹具测试全绿，只有拿真实清单跑才看得见。它检查四件事：方向标记全部被剥掉、没有
软件名退化成"名录里没有"、两个只读模式退出 0、manifest.json 的 SHA256 前后不变。

验收：test.ps1 9/9 全绿（7 与 5.1）；tests\Run-RealSmoke.ps1 4/4 全绿。
 2026-09-26 22:26:45 +08:00
Shuery e10503be76 fix: 让 5.1 真正可用（显式编码 + 原生 stderr 处理 + .psd1 夹具带 BOM） 
上一提交让 5.1 能解析源码，但 Unit 与 Smoke 在 5.1 上仍然是红的。根因是三类彼此
无关的 5.1/7 行为差，全部实测确认：

1) 不写 -Encoding 时，5.1 的 Get-Content / Set-Content 默认是 ANSI，7 是 UTF-8。
   症状是 UTF-8 字节被按 GBK 解出「璇存槑」这类乱码。62 处补上显式 -Encoding UTF8。
   用 AST 而不是正则定位，避免把注释里的散文也改掉。

2) .psd1 夹具用无 BOM 写，而引擎的 .psd1 读取器（Import-PowerShellDataFile）只能靠
   BOM 判断编码、没有参数可传，于是 5.1 按 ANSI 解。40 处夹具改为带 BOM 写 —— 这正是
   .editorconfig 里 [*.psd1] charset = utf-8-bom 本来就要求的，是夹具违反了自己的约定。
   .cmd 批次文件刻意保持无 BOM：cmd.exe 会被 BOM 弄坏。

3) 5.1 在 $ErrorActionPreference = Stop 下会把原生命令写到 stderr 的内容升级成终止性
   NativeCommandError，7 改了这条。takeown/icacls 的 ACL 复位调用、以及 test.ps1 自己
   调子进程的地方，都需要在 Continue 下跑。

验收：test.ps1 9/9 全绿（Encode + Parse + Unit + Smoke + E2E，在 7 与 5.1 上各跑一遍）。

已知未处理（留待后续提交）：tools/lab/** 里还有若干「原生命令 + 2>&1 + Stop」的同类
写法（takeown / icacls / scoop / code / Get-WimInfo）。它们要 Hyper-V 实验机才跑得到，
不在验收门槛内。
 2026-09-26 22:16:04 +08:00
Shuery 2d26f78d15 fix: 源文件改存 UTF-8 with BOM，让 Windows PowerShell 5.1 真正可用 
改造前：全仓 6/6 个源文件在 5.1 上解析失败（README 却承诺支持 5.1）。原因是文件是无 BOM 的
UTF-8，而 5.1 没有 BOM 就按 ANSI 代码页解码源码，中文变乱码、全角问号吃掉引号，整块语法塌掉。
现在 28/28 个文件在 5.1 与 7 上都解析零错误，E2E 36 项在 5.1 上全绿。

顺带修掉一个被 5.1 掩盖的缺陷：带 [CmdletBinding()] 的脚本在 5.1 上，param() 默认值里
拿不到 $PSScriptRoot（实测为空串，7 上正常）。于是 Backup.ps1 / Restore.ps1 在 5.1 上不传
路径参数就报错退出 —— 而计划任务恰恰不传。E2E 之所以看不见，是因为它总是显式传路径。
8 处默认值全部移到 param() 之后的解析段，沿用本仓库对 -BackupDir 一直在用的写法。

新增三条可重放的约定，让编码不再是一次性动作：
  .gitattributes 接管行尾（本机 core.autocrlf=true，会把工作区改成 CRLF 制造伪 diff）
  .editorconfig 用 charset = utf-8-bom 锁住 BOM
  tools\Set-SourceEncoding.ps1 是规范化脚本，tools\Invoke-* 之外的任何改动之后都能重放
  test.ps1 是唯一验收入口：Encode + Parse + Unit + Smoke + E2E，在 7 与 5.1 上各跑一遍

test.ps1 的 Encode 层直接检查"必须有 BOM"这条规则。加它的原因很实际：实测本仓库用的
编辑工具在保存时会悄悄去掉 BOM，而丢了 BOM 的文件只在 5.1 上出错、在 7 上完全正常，
没有这条检查就会一直漏过去。

已知未修（下一步处理）：5.1 上 Unit 有 6 项、Smoke 有 1 项失败，全部源于测试夹具写
临时文件时没指定编码（5.1 的 Set-Content 默认 ANSI），与产品代码无关。
 2026-09-26 22:05:42 +08:00
Shuery 2937eb6652 chore: 记录改造前基线 
改造开始前的完整状态，作为可回退的基点。此提交之后：Pester 175 项、零依赖套件 101 项全绿；PowerShell 5.1 尚不可用（源文件无 BOM）。

包含此前未提交的在制品：安全描述符套件、Hyper-V 实验环境（tools/lab）、agent 约定（AGENTS.md 与 docs/agents）。

.gitignore 增加 *.key / *.pfx：BackupConfig.psd1 的 PasswordFile 此前默认指向仓库内的 baknret.key，一次 git add -A 就会把口令提交进版本库。默认值在后续提交中改为空。
 2026-09-26 21:46:55 +08:00
Shuery e114cae8c8 P0-P3 全量重构：退出码 / 解析修复、manifest 与 7z t 校验、干跑、排除规则、日志、测试与计划任务 
P0 正确性
- 退出码：改用 .NET Process 直接启动、让子进程继承控制台，不再用 Start-Process -PassThru
  （在 7.7.0-preview.4 上 ExitCode 恒为 $null，会把成功的压缩判成失败）；
  7z / RAR / tar 三条解压分支统一走同一个取退出码的封装。
- BackupList 解析：先按第一个 :: 切段再处理引号（整行被一对引号包住的写法不再把排除表
  吞进路径）；排除表同时接受 , 与 ;（旧实现只认 ;，导致排除从未生效）；支持 :- / :+ / @flag。
- 补回 .ssh 与孤儿归档：.ssh 进清单；孤儿归档在备份端也做审计并点名；
  带 -Only / -Skip 时不再把未选中的归档误报成孤儿。
- Resolve-BackupEntry 里 $rootName 在赋值前被引用（会读到外层作用域残留值），已提前赋值。

P1 归档可靠性
- 每个条目写进 manifest.json：源、归档、时间、退出码、校验结果、失败原因，
  并区分 warnings（在位归档）与 attemptWarnings（本次尝试）。
- 归档后做 7z t 内容校验，先写 .tmp、校验通过再原子替换（File.Move overwrite）。
- manifest.roots 记录归档内**真实**的顶层条目名（原先记的是软件名，Edge 实际是 "User Data"）。

P2 可用性
- Restore 支持 -WhatIf / -DryRun / -VerifyOnly / -Only / -Skip；
  这三种"只看不写"的模式一个字节都不写（原先会写回 manifest.json）。
- Edge 等高缓存条目加排除规则并实测：1781 MB / 27961 项 -> 72 MB / 2294 项；
  书签、密码、Cookies、偏好、历史、IndexedDB、Local Storage 全部保留。
  普通模式是相对归档根目录锚定的，嵌套的那些（如 OneAuth\WebView2 里的 Crashpad）
  改用 ! 组件形式才会命中。
- 日志落盘 logs/<backup|restore>-<时间戳>.log；退出码按失败数返回。
- tools/Register-BackupTask.ps1 注册每日计划任务；tools/Rename-Archives.ps1 迁移旧归档名。
- root= 标记此前静默失效，现在明确告警（该功能尚未实现）。

P3 测试与验证
- tests/BakNRet.Tests.ps1：Pester 5 套件 62 项（含用子进程跑 Backup.ps1 / Restore.ps1
  的端到端与针对上述缺陷的回归）。
- tests/Run-Pester.ps1 + tools/Install-TestDependencies.ps1：把 Pester 装到仓库内 .tools/，
  不动机器上的全局模块（系统自带的 3.4.0 缺 Should -Be）。
- tests/Restore-Drill.ps1：真实归档恢复演练，明确区分"源在备份后变过"与"归档/解压有问题"。
- tests/Run-Tests.ps1（49 项，零依赖）与 tests/Run-E2E.ps1（23 项）继续可用；三套共 134 项全通过。

真实机器验证
- 生产归档 22/22 通过 7z t；-VerifyOnly 不再改动 manifest.json（SHA256 前后一致）。
- 真实恢复演练 12/12 通过，27,670 个文件与活源逐字节一致。
- 修复了生产 scoop-persist.7z：原先只有 90 字节（空归档）而源有 1.3 GB，
  重打包后 233 MB，恢复演练 26981/26981 全部一致。
 2026-09-21 23:02:47 +08:00