File: m_files_test.cpp

package info (click to toggle)
eureka 2.1.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 7,912 kB
  • sloc: cpp: 84,842; python: 495; sh: 91; makefile: 21; ansic: 3
file content (846 lines) | stat: -rw-r--r-- 25,284 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
//------------------------------------------------------------------------
//
//  Eureka DOOM Editor
//
//  Copyright (C) 2022 Ioan Chera
//
//  This program is free software; you can redistribute it and/or
//  modify it under the terms of the GNU General Public License
//  as published by the Free Software Foundation; either version 2
//  of the License, or (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//------------------------------------------------------------------------

#include "testUtils/TempDirContext.hpp"

#include "m_files.h"
#include "m_loadsave.h"
#include "m_parse.h"
#include "m_streams.h"

#include "filesystem.hpp"
namespace fs = ghc::filesystem;

#include "gtest/gtest.h"

#define WAD_NAME "EurekaLump.wad"
#define IMMEDIATE_RESOURCE "Michael"
#define NESTED_RESOURCE "Jackson/George"

//
// Writing lump fixture
//
class EurekaLumpFixture : public TempDirContext
{
protected:
	LoadingData loaded;	// keep a convenient pointer to the LoadingData
};

TEST_F(EurekaLumpFixture, WriteEurekaLump)
{
	static const char wadpathbase[] = "first/wad.wad";
	fs::path wadpath(getSubPath(wadpathbase));
	// Set up a nested directory WAD so we can test relative paths to resources
	std::shared_ptr<Wad_file> wad = Wad_file::Open(wadpath, WadOpenMode::write);
	ASSERT_TRUE(wad);

	loaded.gameName = "Mood";	// just pick two random names
	loaded.portName = "Voom";
	loaded.resourceList.push_back(getSubPath(fs::path("first") / "res.png"));	// same path
	loaded.resourceList.push_back(getSubPath(fs::path("first") / "deep" / "call.txt"));	// child path
	loaded.resourceList.push_back(getSubPath("upper.txt"));		// upper path
	loaded.resourceList.push_back(getSubPath(fs::path("second") / "music.mid"));	// sibling path

	// In case of Windows, also check different drive letter
	fs::path wadpathobj = fs::path(wadpath.c_str());
	char otherdriveletter = '\0';
	if(wadpathobj.has_root_name())
	{
		char c = wadpathobj.u8string()[0];
		c = toupper(c) < 'Z' ? c + 1 : 'A';
		char otherpath[] = "C:\\other\\path";
		otherpath[0] = c;
		otherdriveletter = c;
		loaded.resourceList.push_back(otherpath);
	}

	loaded.writeEurekaLump(*wad.get());

	Lump_c *lump = wad->FindLump(EUREKA_LUMP);
	ASSERT_TRUE(lump);

	// Now read the data
	// Expected content is:
	SString expected =
		"# Eureka project info\n"
		"game Mood\n"
		"testing_command_line \"\"\n"
		"port Voom\n"
		"resource res.png\n"
		"resource deep/call.txt\n"
		"resource ../upper.txt\n"
		"resource ../second/music.mid\n"
	;
	if(wadpathobj.has_root_name())
	{
		expected += "resource ";
		expected += otherdriveletter;
		expected += ":/other/path\n";
	}
	SString content(reinterpret_cast<const char *>(lump->getData().data()), lump->Length());
	ASSERT_EQ(content, expected);

	// Now make a change: remove port and resources, see that the lump is updated (not deleted).
	// Add a couple of lumps before and after before doing it, to see how it gets updated alone.
	wad->InsertPoint(0);
	wad->AddLump("BEFORE");
	wad->InsertPoint();
	wad->AddLump("LAST");
	ASSERT_EQ(wad->NumLumps(), 3);

	loaded.portName.clear();
	loaded.resourceList.clear();
	loaded.writeEurekaLump(*wad.get());

	// Check we still have 3 lumps
	ASSERT_EQ(wad->NumLumps(), 3);
	ASSERT_EQ(wad->GetLump(0)->Name(), "BEFORE");
	ASSERT_EQ(wad->GetLump(1)->Name(), "LAST");
	ASSERT_EQ(wad->GetLump(2)->Name(), EUREKA_LUMP);	// moved to the end

	static const char expected2[] = {
		"# Eureka project info\n"
		"game Mood\n"
		"testing_command_line \"\"\n"
	};
	lump = wad->GetLump(2);
	content = SString(reinterpret_cast<const char *>(lump->getData().data()), lump->Length());
	ASSERT_EQ(content, expected2);
}

//
// Fixture for parsing. Depends on TempDirContext due to technicalities.
//
class ParseEurekaLumpFixture : public TempDirContext
{
protected:
	void SetUp() override;
	void TearDown() override;
	void assertEmptyLoading() const;

	void prepareHomeDir();
	fs::path makeGamesDir();
	void makeGame(const fs::path &gamesDir, const char *ughName);

	std::shared_ptr<Wad_file> wad;
	LoadingData loading;

	fs::path home_dir, old_home_dir, install_dir;
	RecentKnowledge recent;
};

//
// Init WAD and other stuff
//
void ParseEurekaLumpFixture::SetUp()
{
	TempDirContext::SetUp();

	wad = Wad_file::Open(getSubPath("wad.wad"), WadOpenMode::write);
	ASSERT_TRUE(wad);
}

//
// Clear all globals
//
void ParseEurekaLumpFixture::TearDown()
{
	DLG_Notify_Override = nullptr;
	DLG_Confirm_Override = nullptr;

	TempDirContext::TearDown();
}

/*
 parseEurekaLump conditions:
 - Wad_file with written Eureka lump
	# test without lump
	- test with invalid syntax lines
 # global::home_dir, global::install_dir (must reset them)
	# test without any or both of them
 # base/<game>.ugh, base/<port>.ugh
	# test without that file, simulate dialog box
 # global::known_iwads (must reset it)
	# test without it
 - resource paths
	- try relative
	- try absolute
	- try inexistent resources
	- check that we don't add duplicate resources (SAME NAME RULE MAY NEED FIXING)
 */

//
// Common check we didn't load anything
//
void ParseEurekaLumpFixture::assertEmptyLoading() const
{
	ASSERT_TRUE(loading.gameName.empty());
	ASSERT_TRUE(loading.portName.empty());
	ASSERT_TRUE(loading.iwadName.empty());
	ASSERT_TRUE(loading.resourceList.empty());
}

//
// Prepares the home directory
//
void ParseEurekaLumpFixture::prepareHomeDir()
{
	home_dir = getSubPath("home");
	ASSERT_TRUE(FileMakeDir(home_dir));
	mDeleteList.push(home_dir);
}

//
// Make the games directory, which it returns
//
fs::path ParseEurekaLumpFixture::makeGamesDir()
{
	fs::path gamesDir = home_dir / "games";
	EXPECT_TRUE(FileMakeDir(gamesDir));
	mDeleteList.push(gamesDir);
	return gamesDir;
}

//
// Make the game definition in the directory
//
void ParseEurekaLumpFixture::makeGame(const fs::path &gamesDir, const char *ughName)
{
	fs::path ughPath = gamesDir / ughName;
	FILE *f = fopen(ughPath.u8string().c_str(), "wb");
	ASSERT_TRUE(f);
	fclose(f);
	mDeleteList.push(ughPath);
}

TEST_F(ParseEurekaLumpFixture, TryWithoutLump)
{
	// Safe on empty wad
	ASSERT_TRUE(loading.parseEurekaLump(home_dir, old_home_dir, install_dir, recent, wad.get()));
	assertEmptyLoading();

	// Safe on wad with some lumps
	Lump_c &lump1 = wad->AddLump("LUMP1");
	lump1.Printf("Data 1");

	Lump_c &lump2 = wad->AddLump("LUMP2");
	lump2.Printf("Data 2");

	ASSERT_EQ(wad->NumLumps(), 2);

	ASSERT_TRUE(loading.parseEurekaLump(home_dir, old_home_dir, install_dir, recent, wad.get()));
	assertEmptyLoading();
}

TEST_F(ParseEurekaLumpFixture, TryGameAndPort)
{
	Lump_c &eureka = wad->AddLump(EUREKA_LUMP);
	eureka.Printf("game emag\n");	// have a game name there
	eureka.Printf("invalid syntax here\n");
	eureka.Printf("port trop\n");	// add something else to check how we go

	// Situation 1: home, install dir unset
	// Prerequisite: set the DLG_Confirm override
	int decision = 0;
	bool gameWarning = false, iwadWarning = false, portWarning = false;
	DLG_Confirm_Override = [&decision, &gameWarning, &iwadWarning](const std::vector<SString> &,
																   const char *message, va_list)
	{
		if(strstr(message, "game"))
			gameWarning = true;
		else if(strstr(message, "IWAD"))
			iwadWarning = true;
		return decision;
	};
	DLG_Notify_Override = [&portWarning](const char *message, va_list)
	{
		if(strstr(message, "port"))
			portWarning = true;
	};

	// Decide to keep trying, but nothing to get
	ASSERT_TRUE(loading.parseEurekaLump(home_dir, old_home_dir, install_dir, recent, wad.get()));
	ASSERT_TRUE(loading.iwadName.empty());
	ASSERT_TRUE(loading.portName.empty());
	ASSERT_TRUE(gameWarning);
	ASSERT_FALSE(iwadWarning);
	ASSERT_TRUE(portWarning);

	// Situation 2: same, but with cancelling
	decision = 1;
	ASSERT_FALSE(loading.parseEurekaLump(home_dir, old_home_dir, install_dir, recent, wad.get()));

	// Situation 3: add home dir
	prepareHomeDir();
	fs::path gamesDir = makeGamesDir();

	// but no emag.ugh: same problem
	decision = 0;	// no ignore
	gameWarning = portWarning = false;
	ASSERT_TRUE(loading.parseEurekaLump(home_dir, old_home_dir, install_dir, recent, wad.get()));
	ASSERT_TRUE(loading.iwadName.empty());
	ASSERT_TRUE(loading.portName.empty());
	ASSERT_TRUE(gameWarning);
	ASSERT_FALSE(iwadWarning);
	ASSERT_TRUE(portWarning);

	// Situation 4: add emag.ugh. But no known IWAD
	makeGame(gamesDir, "emag.ugh");

	gameWarning = iwadWarning = portWarning = false;
	ASSERT_TRUE(loading.parseEurekaLump(home_dir, old_home_dir, install_dir, recent, wad.get()));
	ASSERT_TRUE(loading.iwadName.empty());
	ASSERT_TRUE(loading.portName.empty());
	ASSERT_FALSE(gameWarning);
	ASSERT_TRUE(iwadWarning);
	ASSERT_TRUE(portWarning);

	// Situation 5: now add the IWAD
	fs::path iwadPath = getSubPath("emag.wad");
	recent.addIWAD(iwadPath);	// NOTE: no need to add file

	decision = 0;
	gameWarning = iwadWarning = portWarning = false;
	ASSERT_TRUE(loading.parseEurekaLump(home_dir, old_home_dir, install_dir, recent, wad.get()));
	ASSERT_EQ(loading.iwadName, iwadPath);
	ASSERT_TRUE(loading.portName.empty());
	ASSERT_FALSE(gameWarning);
	ASSERT_FALSE(iwadWarning);
	ASSERT_TRUE(portWarning);

	// Situation 6: now remove the home dir to see it won't be found
	fs::path goodHomeDir = home_dir;
	home_dir.clear();
	decision = 1;
	gameWarning = iwadWarning = portWarning = false;
	ASSERT_FALSE(loading.parseEurekaLump(home_dir, old_home_dir, install_dir, recent, wad.get()));

	// Situation 7: set the install dir instead
	install_dir = goodHomeDir;
	decision = 0;
	gameWarning = iwadWarning = portWarning = false;
	ASSERT_TRUE(loading.parseEurekaLump(home_dir, old_home_dir, install_dir, recent, wad.get()));
	ASSERT_EQ(loading.iwadName, iwadPath);
	ASSERT_TRUE(loading.portName.empty());
	ASSERT_FALSE(gameWarning);
	ASSERT_FALSE(iwadWarning);
	ASSERT_TRUE(portWarning);

	// Situation 8: add port
	home_dir = install_dir;
	fs::path portsDir = home_dir / "ports";
	ASSERT_TRUE(FileMakeDir(portsDir));
	mDeleteList.push(portsDir);
	fs::path tropPath = portsDir / "trop.ugh";
	FILE *f = fopen(tropPath.u8string().c_str(), "wb");
	ASSERT_TRUE(f);
	fclose(f);
	mDeleteList.push(tropPath);
	decision = 0;
	gameWarning = iwadWarning = portWarning = false;
	ASSERT_TRUE(loading.parseEurekaLump(home_dir, old_home_dir, install_dir, recent, wad.get()));
	ASSERT_EQ(loading.iwadName, iwadPath);
	ASSERT_EQ(loading.portName, "trop");
	ASSERT_FALSE(gameWarning);
	ASSERT_FALSE(iwadWarning);
	ASSERT_FALSE(portWarning);
}

TEST_F(ParseEurekaLumpFixture, TryResources)
{
	Lump_c &eureka = wad->AddLump(EUREKA_LUMP);
	eureka.Printf("game doom\n");
	eureka.Printf("resource samepath.wad\n");
	eureka.Printf("resource samepath.wad\n");	// repeat so we check we don't add it again
	eureka.Printf("resource bogus/subpath.wad\n");
	eureka.Printf("resource iwadpath.wad\n");
	eureka.Printf("resource nopath.wad\n");
	eureka.Printf("resource %s\n", getSubPath(fs::path("abs") / "abspath.wad").u8string().c_str());
	eureka.Printf("resource \n");	// add something else to check how we go

	auto makesubfile = [this](const char *path)
	{
		fs::path filepath = getSubPath(path);
		FILE *f = fopen(filepath.u8string().c_str(), "wb");
		ASSERT_TRUE(f);
		fclose(f);
		mDeleteList.push(filepath);
	};

	makesubfile("samepath.wad");
	makesubfile("subpath.wad");

	// Prepare the IWAD
	fs::path path = getSubPath("iwad");
	ASSERT_TRUE(FileMakeDir(path));
	mDeleteList.push(path);
	recent.addIWAD(getSubPath(fs::path("iwad") / "doom.wad"));

	// Prepare the 'game' for the IWAD
	prepareHomeDir();
	makeGame(makeGamesDir(), "doom.ugh");

	// Add the resource at the IWAD path
	makesubfile("iwad/iwadpath.wad");

	// And add the absolute subpath
	path = getSubPath("abs");
	ASSERT_TRUE(FileMakeDir(path));
	mDeleteList.push(path);
	makesubfile("abs/abspath.wad");

	// Prepare the error message
	int errorcount = 0;
	SString errmsg;
	DLG_Notify_Override = [&errorcount, &errmsg](const char *message, va_list ap)
	{
		++errorcount;
		errmsg = SString::vprintf(message, ap);
	};

	loading.parseEurekaLump(home_dir, old_home_dir, install_dir, recent, wad.get());

	// Check that the sole error message we get is about nopath.wad
	ASSERT_EQ(errorcount, 1);
	ASSERT_NE(errmsg.find("nopath.wad"), SString::npos);

	// Check the resource content
	ASSERT_EQ(loading.resourceList.size(), 4);
	const auto &res = loading.resourceList;

	// Now check we have the resources, with their correct paths
	ASSERT_NE(std::find(res.begin(), res.end(), getSubPath("samepath.wad")), res.end());
	ASSERT_NE(std::find(res.begin(), res.end(), getSubPath("subpath.wad")), res.end());
	ASSERT_NE(std::find(res.begin(), res.end(), getSubPath(fs::path("iwad") / "iwadpath.wad")), res.end());
	ASSERT_NE(std::find(res.begin(), res.end(), getSubPath(fs::path("abs") / "abspath.wad")), res.end());
}

TEST_F(ParseEurekaLumpFixture, ResourcesAreUniqueByFileNameNoCase)
{
	Lump_c &eureka = wad->AddLump(EUREKA_LUMP);
	eureka.Printf("game doom\n");
	eureka.Printf("resource samename.wad\n");
	eureka.Printf("resource sub/SameName.Wad\n");	// repeat so we check we don't add it again
	eureka.Printf("resource othername.wad\n");

	// Make the files
	std::ofstream stream;
	fs::path path = getSubPath("samename.wad");
	stream.open(path);
	ASSERT_TRUE(stream.is_open());
	stream.close();
	mDeleteList.push(path);
	path = getSubPath("sub");
	ASSERT_TRUE(FileMakeDir(path));
	mDeleteList.push(path);
	path = getSubPath("sub/SameName.Wad");
	stream.open(path);
	ASSERT_TRUE(stream.is_open());
	stream.close();
	mDeleteList.push(path);
	path = getSubPath("othername.wad");
	stream.open(path);
	ASSERT_TRUE(stream.is_open());
	stream.close();
	mDeleteList.push(path);
	stream.close();

	// Prepare the IWAD
	path = getSubPath("iwad");
	ASSERT_TRUE(FileMakeDir(path));
	mDeleteList.push(path);
	recent.addIWAD(getSubPath("iwad/doom.wad"));

	// Prepare the 'game' for the IWAD
	prepareHomeDir();
	makeGame(makeGamesDir(), "doom.ugh");

	loading.parseEurekaLump(home_dir, old_home_dir, install_dir, recent, wad.get());
	ASSERT_EQ(loading.resourceList.size(), 2);
	ASSERT_EQ(loading.resourceList[0], getSubPath("samename.wad"));	// not the second one too
	ASSERT_EQ(loading.resourceList[1], getSubPath("othername.wad"));
}

TEST_F(ParseEurekaLumpFixture, TryResourcesParentPath)
{
	// Re-create wad to be from a subpath
	ASSERT_TRUE(FileMakeDir(getSubPath("sub")));
	mDeleteList.push(getSubPath("sub"));
	wad = Wad_file::Open(getSubPath(fs::path("sub") / "wad.wad"), WadOpenMode::write);
	ASSERT_TRUE(wad);

	// Create a parent path resource
	FILE *f = fopen(getSubPath("res.wad").u8string().c_str(), "wb");
	ASSERT_TRUE(f);
	fclose(f);
	mDeleteList.push(getSubPath("res.wad"));

	// Prepare the lump
	Lump_c &eureka = wad->AddLump(EUREKA_LUMP);

	// Try to use just path: won't be found
	eureka.Printf("resource res.wad\n");

	int errorcount = 0;
	DLG_Notify_Override = [&errorcount](const char *message, va_list ap)
	{
		++errorcount;
	};

	loading.parseEurekaLump(home_dir, old_home_dir, install_dir, recent, wad.get());

	ASSERT_EQ(errorcount, 1);
	ASSERT_TRUE(loading.resourceList.empty());

	// Now change content and add a relative path
	eureka.clearData();
	eureka.Printf("resource ../res.wad\n");
	loading.parseEurekaLump(home_dir, old_home_dir, install_dir, recent, wad.get());

	ASSERT_EQ(errorcount, 1);
	ASSERT_EQ(loading.resourceList.size(), 1);
	ASSERT_EQ(loading.resourceList[0], getSubPath("res.wad"));
}

// Recent files

TEST(RecentFiles, StartEmpty)
{
	RecentFiles_c files;
	ASSERT_EQ(files.getSize(), 0);

	// Clear it: still empty
	files.clear();
	ASSERT_EQ(files.getSize(), 0);
}

TEST(RecentFiles, InsertAndLookup)
{
	RecentFiles_c files;
	files.insert("Wad1.wad", "MAP01");
	files.insert("Sub/Doo.wad", "E3M6");
	files.insert("SomeOther.wad", "E4M4");
	files.insert("Jack.wad", "H5M5");
	files.insert("Other/Jack.wad", "H5M6");	// will override previous map
	files.insert("Doo.wad", "MAP03");	// this will override second map

	// Size must be 3
	ASSERT_EQ(files.getSize(), 4);	// Five made it

	RecentMap recentMap;

	recentMap = files.Lookup(0);
	ASSERT_EQ(recentMap.file, "Doo.wad");
	ASSERT_EQ(recentMap.map, "MAP03");

	recentMap = files.Lookup(1);
	ASSERT_EQ(recentMap.file, "Other/Jack.wad");
	ASSERT_EQ(recentMap.map, "H5M6");

	recentMap = files.Lookup(2);
	ASSERT_EQ(recentMap.file, "SomeOther.wad");
	ASSERT_EQ(recentMap.map, "E4M4");

	recentMap = files.Lookup(3);
	ASSERT_EQ(recentMap.file, "Wad1.wad");
	ASSERT_EQ(recentMap.map, "MAP01");

	// See one format
	SString text = files.Format(1);
	ASSERT_EQ(text, "  &2:  Jack.wad");

	// Get one data
	RecentMap vdata = files.Lookup(1);
	ASSERT_EQ(vdata.file, "Other/Jack.wad");
	ASSERT_EQ(vdata.map, "H5M6");

	// Test clearing it
	files.clear();
	ASSERT_EQ(files.getSize(), 0);
}

TEST(RecentFiles, InsertPastCap)
{
	RecentFiles_c files;
	for(int i = 0; i < MAX_RECENT + 3; ++i)
	{
		files.insert(fs::path("sub") / SString::printf("Wad%d.wad", i).get(), SString::printf("MAP%d", i));
	}

	// Still max recent entries
	ASSERT_EQ(files.getSize(), MAX_RECENT);

	// Check that the latest recent are there
	for(int i = 0; i < MAX_RECENT; ++i)
	{
		RecentMap recentMap = files.Lookup(i);
		ASSERT_EQ(SString(recentMap.file.generic_u8string()), SString::printf("sub/Wad%d.wad", MAX_RECENT + 3 - i - 1));
		ASSERT_EQ(recentMap.map, SString::printf("MAP%d", MAX_RECENT + 3 - i - 1));
	}

	// Test formatting when larger than 9
	SString text;
	for(int i = 0; i < 9; ++i)
	{
		text = files.Format(i);
		ASSERT_EQ(text, SString::printf("  &%d:  Wad%d.wad", i + 1, MAX_RECENT + 3 - i - 1));
	}
	for(int i = 9; i < MAX_RECENT; ++i)
	{
		text = files.Format(i);
		ASSERT_EQ(text, SString::printf("%d:  Wad%d.wad", i + 1, MAX_RECENT + 3 - i - 1));
	}
}

class RecentFilesFixture : public TempDirContext
{
protected:
	void testLoadRecent(const fs::path &homePath, const fs::path &oldHomePath, const fs::path &miscPath);
};

TEST_F(RecentFilesFixture, WriteFile)
{
	RecentFiles_c files;
	files.insert("Wad1.wad", "MAP01");
	files.insert("Sub/Doo.wad", "E3M6");
	files.insert("SomeOther.wad", "E4 M4");
	files.insert("Jack.wad", "H5M5");
	files.insert("Oth er/Jack.wad", "H5M6");	// will override previous map
	files.insert("Doo.wad", "MAP03");	// this will override second map

	fs::path datapath = getSubPath("data.ini");

	std::ofstream os(datapath);
	ASSERT_TRUE(os.is_open());
	mDeleteList.push(datapath);

	files.Write(os);

	os.close();

	std::ifstream stream(datapath);
	ASSERT_TRUE(stream.is_open());

	std::string keyword, map, file;
	stream >> keyword >> map >> file;
	ASSERT_EQ(keyword, "recent");
	ASSERT_EQ(map, "MAP01");
	ASSERT_EQ(file, "Wad1.wad");
	std::string line;
	std::getline(stream, line);	// get past current line
	std::getline(stream, line);
	ASSERT_EQ(line, "recent \"E4 M4\" SomeOther.wad");
	std::getline(stream, line);
	ASSERT_EQ(line, "recent H5M6 \"Oth er/Jack.wad\"");
	stream >> keyword >> map >> file;
	ASSERT_EQ(keyword, "recent");
	ASSERT_EQ(map, "MAP03");
	ASSERT_EQ(file, "Doo.wad");

	ASSERT_FALSE(stream.eof());
	stream >> keyword;
	ASSERT_TRUE(stream.eof());

	stream.close();
}

void RecentFilesFixture::testLoadRecent(const fs::path &homePath, const fs::path &oldHomePath,
		const fs::path &miscPath)
{
	fs::path home_dir = homePath;
	fs::path old_home_dir = oldHomePath;
	RecentKnowledge recent;

	fs::path path = miscPath;
	std::ofstream stream(path);
	ASSERT_TRUE(stream.is_open());
	mDeleteList.push(path);

	stream << "# Misc.cfg file" << std::endl;
	stream << "# recent E1M1 doom.wad" << std::endl;	// ignore comment
	stream << " " << std::endl;	// ignore blank line
	stream << "  # comment after line" << std::endl;	// ignore comment after space


	fs::path hticPath = getSubPath("htic.wad");
	fs::path doom3Path = getSubPath("doom3.wad");
	fs::path freedoomPath = getSubPath("freedoom.wad");
	fs::path deletedPath = getSubPath("deleted.wad");
	fs::path badPath = getSubPath("bad.wad");
	fs::path hereticPath = getSubPath("here tic.wad");

	stream << "recent MAP02 " << escape(doom3Path) << " # recent" << std::endl;
	stream << "recent H5M6 " << std::endl;	// malformed
	stream << "recent E1M1 " << escape(badPath) << std::endl;	// invalid wad
	stream << "recent E3M5 " << escape(hereticPath) << std::endl;
	stream << "recent \"E3 M5\" " << escape(hticPath) << std::endl;
	stream << "recent E7M7 " << escape(deletedPath) << std::endl;	// missing wad
	stream << "recent MAP03 " << escape(doom3Path) << std::endl;	// should overwrite the other Doom3 wad recent

	stream << "known_iwad heretic " << escape(hticPath) << std::endl;
	stream << "known_iwad mood " << std::endl;	// malformed
	stream << "known_iwad \"doom \"\"3\"\"\" " << escape(doom3Path) << std::endl;
	stream << "known_iwad FreeDoom " << escape(freedoomPath) << std::endl;	// ignore freedoom
	stream << "known_iwad inexistent " << escape(deletedPath) << std::endl;	// file not found
	stream << "known_iwad malformed " << escape(badPath) << std::endl;	// bad file (both cases should be "invalid"
	stream << "known_iwad heretic " << escape(hereticPath) << std::endl;	// overwrite

	stream << "port_path boom |/home/jillson/boom.wad" << std::endl;
	stream << "port_path zdoom |/home/jillson/zdoom.wad" << std::endl;
	stream << "port_path goom /home/jillson/goom.wad" << std::endl;	// malformed
	stream << "port_path zdoom | /home/jackson/zdoom.wad" << std::endl;	// overwrite

	stream.close();

	// Prepare the IWAD files
	for(const fs::path &path : { hticPath, doom3Path, freedoomPath, badPath, hereticPath })
	{
		std::ofstream wadstream(path, std::ios::binary);
		ASSERT_TRUE(wadstream.is_open());
		mDeleteList.push(path);
		if(path != badPath)
			wadstream.write("PWAD\0\0\0\0\x0c\0\0\0", 12);
		ASSERT_FALSE(wadstream.fail());
		wadstream.close();
	}

	recent.load(home_dir, old_home_dir);

	// Check the recent files
	ASSERT_EQ(recent.getFiles().getSize(), 3);
	RecentMap recentMap;

	recentMap = recent.getFiles().Lookup(0);
	ASSERT_EQ(recentMap.file, doom3Path);
	ASSERT_EQ(recentMap.map, "MAP03");

	recentMap = recent.getFiles().Lookup(1);
	ASSERT_EQ(recentMap.file, hticPath);
	ASSERT_EQ(recentMap.map, "E3 M5");

	recentMap = recent.getFiles().Lookup(2);
	ASSERT_EQ(recentMap.file, hereticPath);
	ASSERT_EQ(recentMap.map, "E3M5");

	// Check the known IWADs map
	ASSERT_TRUE(recent.queryIWAD("heretic"));
	ASSERT_EQ(*recent.queryIWAD("heretic"), hereticPath);
	ASSERT_TRUE(recent.queryIWAD("doom \"3\""));
	ASSERT_EQ(*recent.queryIWAD("doom \"3\""), doom3Path);

	// Check the port paths
	ASSERT_TRUE(recent.queryPortPath("zdoom"));
	ASSERT_EQ(*recent.queryPortPath("zdoom"), "/home/jackson/zdoom.wad");
	ASSERT_TRUE(recent.queryPortPath("boom"));
	ASSERT_EQ(*recent.queryPortPath("boom"), "/home/jillson/boom.wad");
}

TEST_F(RecentFilesFixture, MLoadRecent)
{
	testLoadRecent(mTempDir, fs::path(), getSubPath("misc.cfg"));
}

TEST_F(RecentFilesFixture, MLoadRecentOldPath)
{
	fs::path home_dir = mTempDir;
	fs::path old_home_dir = getSubPath("old");
	ASSERT_TRUE(FileMakeDir(old_home_dir));
	mDeleteList.push(old_home_dir);

	testLoadRecent(home_dir, old_home_dir, old_home_dir / "misc.cfg");
}

TEST_F(RecentFilesFixture, MSaveRecent)
{
	RecentKnowledge recent;
	recent.addRecent("file1", "map1", mTempDir);
	recent.addRecent("file2", "map 2", mTempDir);
	recent.addRecent("file1/file 4", "map #", mTempDir);

	recent.addIWAD("path/doom1.wad");
	recent.addIWAD("path/doom #.wad");

	recent.setPortPath("foom", "port/foom.exe");
	recent.setPortPath("joom generation", "port/joom generation.exe");

	recent.save(mTempDir);
	mDeleteList.push(mTempDir / "misc.cfg");

	// Now check
	std::ifstream is(mTempDir / "misc.cfg");
	ASSERT_TRUE(is.is_open());

	SString line;
	RecentFiles_c readRecentFiles;
	std::map<SString, fs::path> readKnownIwads;
	std::map<SString, fs::path> readPortPaths;
	while(M_ReadTextLine(line, is))
	{
		TokenWordParse parse(line, true);
		SString keyword;
		if(!parse.getNext(keyword))
			continue;
		SString name;
		fs::path path;
		ASSERT_TRUE(parse.getNext(name));
		ASSERT_TRUE(parse.getNext(path));
		if(keyword == "recent")
		{
			readRecentFiles.insert(path, name);
			continue;
		}
		if(keyword == "known_iwad")
		{
			readKnownIwads[name] = path;
			continue;
		}
		if(keyword == "port_path")
		{
			ASSERT_EQ(path.u8string()[0], '|');
			if(path == "|")
			{
				ASSERT_TRUE(parse.getNext(path));
				readPortPaths[name] = path;
			}
			else
				readPortPaths[name] = fs::u8path(path.u8string().substr(1));
			continue;
		}
	}
	// Now check content
	ASSERT_EQ(readRecentFiles.getSize(), 3);
	for(int i = 0; i < readRecentFiles.getSize(); ++i)
	{
		SString readMap;
		fs::path readPath;
		RecentMap myRecentMap = recent.getFiles().Lookup(i);
		RecentMap readRecentMap = readRecentFiles.Lookup(i);
		ASSERT_EQ(myRecentMap.map, readRecentMap.map);
		ASSERT_EQ(myRecentMap.file, readRecentMap.file);
	}
	for(const auto &item : readKnownIwads)
	{
		ASSERT_TRUE(recent.queryIWAD(item.first));
		ASSERT_EQ(*recent.queryIWAD(item.first), item.second);
	}
	for(const auto &item : readPortPaths)
	{
		ASSERT_TRUE(recent.queryPortPath(item.first));
		ASSERT_EQ(*recent.queryPortPath(item.first), item.second);
	}
}