FileUtilsTest.cs 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350
  1. using System.IO.Compression;
  2. namespace MeloongCore.Tests;
  3. public class FileUtilsTest : TestWithFolder {
  4. #region 压缩包
  5. [Theory]
  6. [InlineData("GB Encoding.zip")]
  7. [InlineData("UTF8 Encoding.zip")]
  8. public void OpenZip_Successful(string testFile) {
  9. using var archive = FileUtils.OpenZip(GetTestFile(testFile));
  10. Assert.Contains(archive.Entries, e => e.Name == "中文文件.txt");
  11. Assert.Contains(archive.Entries, e => e.Name == "fabricloader.log");
  12. Assert.DoesNotContain(archive.Entries, e => e.Name == "fabricloader.log2");
  13. }
  14. [Theory]
  15. [InlineData("Corrupted.zip")]
  16. [InlineData("Not zip.zip")]
  17. public void OpenZip_Corrupted(string testFile) {
  18. Assert.Throws<InvalidDataException>(() => FileUtils.OpenZip(GetTestFile(testFile)));
  19. }
  20. [Fact(DisplayName = nameof(ExtractToDirectory))]
  21. public void ExtractToDirectory() {
  22. //const string fileContent = "hello extract";
  23. //string zipPath = CreateZipWithEncoding("single.zip", new UTF8Encoding(false, true),
  24. // ("file.txt", fileContent));
  25. //string outDir = Path.Combine(_tempDir, "out_single");
  26. //
  27. //FileUtils.ExtractToDirectory(zipPath, outDir);
  28. //
  29. //string extractedFile = Path.Combine(outDir, "file.txt");
  30. //Assert.True(File.Exists(extractedFile));
  31. //Assert.Equal(fileContent, ReadFile(extractedFile));
  32. //
  33. //string zipPath = CreateZipWithEncoding("multi_extract.zip", new UTF8Encoding(false, true),
  34. // ("a.txt", "aaa"),
  35. // ("b.txt", "bbb"));
  36. //string outDir = Path.Combine(_tempDir, "out_multi");
  37. //
  38. //FileUtils.ExtractToDirectory(zipPath, outDir);
  39. //
  40. //Assert.True(File.Exists(Path.Combine(outDir, "a.txt")));
  41. //Assert.True(File.Exists(Path.Combine(outDir, "b.txt")));
  42. //
  43. //string zipPath = CreateZipWithEncoding("subdir.zip", new UTF8Encoding(false, true),
  44. // ("subdir/nested.txt", "nested content"));
  45. //string outDir = Path.Combine(_tempDir, "out_subdir");
  46. //
  47. //FileUtils.ExtractToDirectory(zipPath, outDir);
  48. //
  49. //string nestedFile = Path.Combine(outDir, "subdir", "nested.txt");
  50. //Assert.True(File.Exists(nestedFile));
  51. //Assert.Equal("nested content", ReadFile(nestedFile));
  52. //
  53. //string zipPath = CreateZipWithEncoding("autocreate.zip", new UTF8Encoding(false, true),
  54. // ("f.txt", "x"));
  55. //string outDir = Path.Combine(_tempDir, "nonexistent", "deep", "dir");
  56. //
  57. //FileUtils.ExtractToDirectory(zipPath, outDir);
  58. //
  59. //Assert.True(Directory.Exists(outDir));
  60. //
  61. //string zipPath = CreateZipWithEncoding("overwrite.zip", new UTF8Encoding(false, true),
  62. // ("f.txt", "new content"));
  63. //string outDir = Path.Combine(_tempDir, "out_overwrite");
  64. //Directory.CreateDirectory(outDir);
  65. //File.WriteAllText(Path.Combine(outDir, "f.txt"), "old content");
  66. //
  67. //FileUtils.ExtractToDirectory(zipPath, outDir);
  68. //
  69. //Assert.Equal("new content", ReadFile(Path.Combine(outDir, "f.txt")));
  70. //
  71. //// 手动构造一个包含路径穿越条目(../../evil.txt)的 zip
  72. //string zipPath = Path.Combine(_tempDir, "zipslip.zip");
  73. //using (var stream = File.Create(zipPath))
  74. //using (var archive = new ZipArchive(stream, ZipArchiveMode.Create, leaveOpen: false, new UTF8Encoding(false, true))) {
  75. // var entry = archive.CreateEntry("../../evil.txt");
  76. // using var writer = new StreamWriter(entry.Open());
  77. // writer.Write("pwned");
  78. //}
  79. //string outDir = Path.Combine(_tempDir, "out_zipslip");
  80. //Directory.CreateDirectory(outDir);
  81. //
  82. //Assert.Throws<UnauthorizedAccessException>(() => FileUtils.ExtractToDirectory(zipPath, outDir));
  83. //
  84. //const string innerContent = "gzip content";
  85. //const string innerFileName = "inner.txt";
  86. //string gzPath = CreateGzFile(innerFileName, innerContent);
  87. //string outDir = Path.Combine(_tempDir, "out_gz");
  88. //
  89. //FileUtils.ExtractToDirectory(gzPath, outDir);
  90. //
  91. //string extractedFile = Path.Combine(outDir, innerFileName);
  92. //Assert.True(File.Exists(extractedFile));
  93. //Assert.Equal(innerContent, ReadFile(extractedFile));
  94. //
  95. //// jar 文件实际上是 zip 格式
  96. //string zipPath = CreateZipWithEncoding("app.jar", new UTF8Encoding(false, true),
  97. // ("META-INF/MANIFEST.MF", "Manifest-Version: 1.0\r\n"));
  98. //string outDir = Path.Combine(_tempDir, "out_jar");
  99. //
  100. //FileUtils.ExtractToDirectory(zipPath, outDir);
  101. //
  102. //Assert.True(File.Exists(Path.Combine(outDir, "META-INF", "MANIFEST.MF")));
  103. }
  104. #endregion
  105. /*
  106. #region 辅助方法
  107. /// <summary>
  108. /// 创建一个包含若干文件的临时文件夹,并返回该文件夹路径。
  109. /// </summary>
  110. private string CreateSourceDirectory(params (string relativePath, string content)[] files) {
  111. string dir = Path.Combine(_tempDir, "src_" + Guid.NewGuid().ToString("N"));
  112. Directory.CreateDirectory(dir);
  113. foreach (var (relativePath, content) in files) {
  114. string fullPath = Path.Combine(dir, relativePath);
  115. Directory.CreateDirectory(Path.GetDirectoryName(fullPath)!);
  116. File.WriteAllText(fullPath, content, Encoding.UTF8);
  117. }
  118. return dir;
  119. }
  120. #endregion
  121. #region CreateZipFromDirectory 测试
  122. public void CreateZipFromDirectory_SingleFile_ZipContainsFile() {
  123. string srcDir = CreateSourceDirectory(("hello.txt", "hello world"));
  124. string outZip = Path.Combine(_tempDir, "from_dir.zip");
  125. FileUtils.CreateZipFromDirectory(outZip, srcDir);
  126. Assert.True(File.Exists(outZip));
  127. using var archive = ZipFile.OpenRead(outZip);
  128. Assert.Single(archive.Entries);
  129. Assert.Equal("hello.txt", archive.Entries[0].Name);
  130. }
  131. public void CreateZipFromDirectory_MultipleFiles_AllFilesIncluded() {
  132. string srcDir = CreateSourceDirectory(
  133. ("a.txt", "aaa"),
  134. ("b.txt", "bbb"),
  135. ("c.txt", "ccc"));
  136. string outZip = Path.Combine(_tempDir, "from_dir_multi.zip");
  137. FileUtils.CreateZipFromDirectory(outZip, srcDir);
  138. using var archive = ZipFile.OpenRead(outZip);
  139. Assert.Equal(3, archive.Entries.Count);
  140. }
  141. public void CreateZipFromDirectory_SubdirectoryFiles_StructurePreserved() {
  142. string srcDir = CreateSourceDirectory(
  143. ("sub/file.txt", "nested"),
  144. ("root.txt", "root"));
  145. string outZip = Path.Combine(_tempDir, "from_dir_sub.zip");
  146. FileUtils.CreateZipFromDirectory(outZip, srcDir);
  147. using var archive = ZipFile.OpenRead(outZip);
  148. var names = archive.Entries.Select(e => e.FullName.Replace('\\', '/')).ToList();
  149. Assert.Contains(names, n => n.Contains("sub/file.txt"));
  150. Assert.Contains(names, n => n.Contains("root.txt"));
  151. }
  152. public void CreateZipFromDirectory_OverwritesExistingZip() {
  153. string srcDir = CreateSourceDirectory(("new.txt", "new content"));
  154. string outZip = Path.Combine(_tempDir, "overwrite_dir.zip");
  155. // 先创建一个旧 zip
  156. string oldSrcDir = CreateSourceDirectory(("old.txt", "old content"));
  157. FileUtils.CreateZipFromDirectory(outZip, oldSrcDir);
  158. // 再用新目录覆盖
  159. FileUtils.CreateZipFromDirectory(outZip, srcDir);
  160. using var archive = ZipFile.OpenRead(outZip);
  161. Assert.Single(archive.Entries);
  162. Assert.Equal("new.txt", archive.Entries[0].Name);
  163. }
  164. public void CreateZipFromDirectory_OutputDirectoryAutoCreated() {
  165. string srcDir = CreateSourceDirectory(("f.txt", "x"));
  166. string outZip = Path.Combine(_tempDir, "newdir", "nested.zip");
  167. FileUtils.CreateZipFromDirectory(outZip, srcDir);
  168. Assert.True(File.Exists(outZip));
  169. }
  170. #endregion
  171. #region CreateZipFromFiles(params 版)测试
  172. public void CreateZipFromFiles_Params_SingleFile_ZipContainsFile() {
  173. string srcFile = Path.Combine(_tempDir, "single.txt");
  174. File.WriteAllText(srcFile, "content");
  175. string outZip = Path.Combine(_tempDir, "from_files_single.zip");
  176. FileUtils.CreateZipFromFiles(outZip, srcFile);
  177. using var archive = ZipFile.OpenRead(outZip);
  178. Assert.Single(archive.Entries);
  179. Assert.Equal("single.txt", archive.Entries[0].Name);
  180. }
  181. public void CreateZipFromFiles_Params_MultipleFiles_AllIncluded() {
  182. string file1 = Path.Combine(_tempDir, "f1.txt");
  183. string file2 = Path.Combine(_tempDir, "f2.txt");
  184. File.WriteAllText(file1, "1");
  185. File.WriteAllText(file2, "2");
  186. string outZip = Path.Combine(_tempDir, "from_files_multi.zip");
  187. FileUtils.CreateZipFromFiles(outZip, file1, file2);
  188. using var archive = ZipFile.OpenRead(outZip);
  189. Assert.Equal(2, archive.Entries.Count);
  190. var names = archive.Entries.Select(e => e.Name).ToHashSet();
  191. Assert.Contains("f1.txt", names);
  192. Assert.Contains("f2.txt", names);
  193. }
  194. public void CreateZipFromFiles_Params_DuplicateFileNames_ThrowsArgumentException() {
  195. string file1 = Path.Combine(_tempDir, "dup", "a", "same.txt");
  196. string file2 = Path.Combine(_tempDir, "dup", "b", "same.txt");
  197. Directory.CreateDirectory(Path.GetDirectoryName(file1)!);
  198. Directory.CreateDirectory(Path.GetDirectoryName(file2)!);
  199. File.WriteAllText(file1, "1");
  200. File.WriteAllText(file2, "2");
  201. string outZip = Path.Combine(_tempDir, "dup_names.zip");
  202. Assert.Throws<ArgumentException>(() => FileUtils.CreateZipFromFiles(outZip, file1, file2));
  203. }
  204. public void CreateZipFromFiles_Params_OverwritesExistingZip() {
  205. string oldFile = Path.Combine(_tempDir, "old.txt");
  206. string newFile = Path.Combine(_tempDir, "new.txt");
  207. File.WriteAllText(oldFile, "old");
  208. File.WriteAllText(newFile, "new");
  209. string outZip = Path.Combine(_tempDir, "overwrite_files.zip");
  210. FileUtils.CreateZipFromFiles(outZip, oldFile);
  211. FileUtils.CreateZipFromFiles(outZip, newFile);
  212. using var archive = ZipFile.OpenRead(outZip);
  213. Assert.Single(archive.Entries);
  214. Assert.Equal("new.txt", archive.Entries[0].Name);
  215. }
  216. #endregion
  217. #region CreateZipFromFiles(IDictionary 版)测试
  218. public void CreateZipFromFiles_Dict_CustomEntryPath_EntryNameMatchesDictKey() {
  219. string srcFile = Path.Combine(_tempDir, "source.txt");
  220. File.WriteAllText(srcFile, "data");
  221. string outZip = Path.Combine(_tempDir, "from_dict.zip");
  222. var sources = new Dictionary<string, string> {
  223. ["custom/path/file.txt"] = srcFile
  224. };
  225. FileUtils.CreateZipFromFiles(outZip, sources);
  226. using var archive = ZipFile.OpenRead(outZip);
  227. Assert.Single(archive.Entries);
  228. Assert.Equal("custom/path/file.txt", archive.Entries[0].FullName);
  229. }
  230. public void CreateZipFromFiles_Dict_MultipleEntries_AllIncluded() {
  231. string f1 = Path.Combine(_tempDir, "d1.txt");
  232. string f2 = Path.Combine(_tempDir, "d2.txt");
  233. File.WriteAllText(f1, "1");
  234. File.WriteAllText(f2, "2");
  235. string outZip = Path.Combine(_tempDir, "from_dict_multi.zip");
  236. var sources = new Dictionary<string, string> {
  237. ["a/one.txt"] = f1,
  238. ["b/two.txt"] = f2
  239. };
  240. FileUtils.CreateZipFromFiles(outZip, sources);
  241. using var archive = ZipFile.OpenRead(outZip);
  242. Assert.Equal(2, archive.Entries.Count);
  243. var fullNames = archive.Entries.Select(e => e.FullName).ToHashSet();
  244. Assert.Contains("a/one.txt", fullNames);
  245. Assert.Contains("b/two.txt", fullNames);
  246. }
  247. public void CreateZipFromFiles_Dict_FileContentPreserved() {
  248. const string expectedContent = "preserved content";
  249. string srcFile = Path.Combine(_tempDir, "preserve.txt");
  250. File.WriteAllText(srcFile, expectedContent, Encoding.UTF8);
  251. string outZip = Path.Combine(_tempDir, "from_dict_content.zip");
  252. var sources = new Dictionary<string, string> { ["entry.txt"] = srcFile };
  253. FileUtils.CreateZipFromFiles(outZip, sources);
  254. string outDir = Path.Combine(_tempDir, "dict_content_out");
  255. Directory.CreateDirectory(outDir);
  256. using var archive = ZipFile.OpenRead(outZip);
  257. using var entryStream = archive.Entries[0].Open();
  258. using var reader = new StreamReader(entryStream, Encoding.UTF8);
  259. Assert.Equal(expectedContent, reader.ReadToEnd());
  260. }
  261. public void CreateZipFromFiles_Dict_BackslashInKey_NormalizedToForwardSlash() {
  262. string srcFile = Path.Combine(_tempDir, "bs.txt");
  263. File.WriteAllText(srcFile, "x");
  264. string outZip = Path.Combine(_tempDir, "backslash.zip");
  265. var sources = new Dictionary<string, string> {
  266. [@"dir\sub\file.txt"] = srcFile
  267. };
  268. FileUtils.CreateZipFromFiles(outZip, sources);
  269. using var archive = ZipFile.OpenRead(outZip);
  270. // 条目路径中的反斜杠应被规范化为正斜杠
  271. Assert.Equal("dir/sub/file.txt", archive.Entries[0].FullName);
  272. }
  273. #endregion
  274. */
  275. }