Initial commit

engines/testbed/fs.cpp

@@ -0,0 +1,240 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * 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 3 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.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include "common/config-manager.h"
+#include "common/file.h"
+#include "common/stream.h"
+#include "common/util.h"
+
+#include "testbed/fs.h"
+
+namespace Testbed {
+
+/**
+ * This test does the following:
+ * 1) acquires the game-data path
+ * 2) In the game-root it navigates to "directory" and opens the file "file"
+ *
+ * The code accesses the appropriate file using the fileSystem API, creates a read stream of it and
+ * compares the message contained in it, with what it expects.
+ *
+ */
+bool FStests::readDataFromFile(Common::FSDirectory *directory, const char *file) {
+
+	if (!SearchMan.isPathDirectory(directory->getFSNode().getPath())) {
+		SearchMan.addDirectory(directory->getFSNode().getPath(), 0, 1, false);
+	}
+
+	Common::ScopedPtr<Common::File> f(new Common::File());
+	if (!f->open(file)) {
+		Testsuite::logDetailedPrintf("Can't open game file\n");
+		return false;
+	}
+	
+	Common::SeekableReadStream *readStream = f.release();
+	if (!readStream) {
+		Testsuite::logDetailedPrintf("Can't open game file for reading\n");
+		return false;
+	}
+
+	Common::String msg = readStream->readLine();
+	delete readStream;
+
+	Testsuite::logDetailedPrintf("Message Extracted from %s/%s : %s\n", directory->getFSNode().getName().c_str(), file, msg.c_str());
+
+	Common::String expectedMsg = "It works!";
+
+	if (!msg.equals(expectedMsg)) {
+		Testsuite::logDetailedPrintf("Can't read Correct data from file\n");
+		return false;
+	}
+
+	return true;
+}
+
+TestExitStatus FStests::testReadFile() {
+	const Common::Path &path = ConfMan.getPath("path");
+	Common::FSDirectory gameRoot(path);
+	int numFailed = 0;
+
+	if (!gameRoot.getFSNode().exists() || !gameRoot.getFSNode().isDirectory()) {
+		Testsuite::logDetailedPrintf("game Path should be an existing directory");
+		return kTestFailed;
+	}
+
+	const char *dirList[] = {"test1", "Test2", "TEST3", "tEST4", "test5"};
+	const char *file[] = {"file.txt", "File.txt", "FILE.txt", "fILe.txt", "file"};
+
+	for (unsigned int i = 0; i < ARRAYSIZE(dirList); i++) {
+		Common::String dirName = dirList[i];
+		Common::String fileName = file[i];
+		Common::FSDirectory *directory = gameRoot.getSubDirectory(Common::Path(dirName));
+
+		if (!directory) {
+			Testsuite::logDetailedPrintf("Failed to open directory %s during FS tests\n", dirName.c_str());
+			return kTestFailed;
+		}
+
+		if (!readDataFromFile(directory, fileName.c_str())) {
+			Testsuite::logDetailedPrintf("Reading from %s/%s failed\n", dirName.c_str(), fileName.c_str());
+			numFailed++;
+		}
+
+		dirName.toLowercase();
+		fileName.toLowercase();
+		delete directory;
+		directory = gameRoot.getSubDirectory(Common::Path(dirName));
+
+		if (!directory) {
+			Testsuite::logDetailedPrintf("Failed to open directory %s during FS tests\n", dirName.c_str());
+			return kTestFailed;
+		}
+
+		if (!readDataFromFile(directory, fileName.c_str())) {
+			Testsuite::logDetailedPrintf("Reading from %s/%s failed\n", dirName.c_str(), fileName.c_str());
+			numFailed++;
+		}
+
+		dirName.toUppercase();
+		fileName.toUppercase();
+		delete directory;
+		directory = gameRoot.getSubDirectory(Common::Path(dirName));
+
+		if (!directory) {
+			Testsuite::logDetailedPrintf("Failed to open directory %s during FS tests\n", dirName.c_str());
+			return kTestFailed;
+		}
+
+		if (!readDataFromFile(directory, fileName.c_str())) {
+			Testsuite::logDetailedPrintf("Reading from %s/%s failed\n", dirName.c_str(), fileName.c_str());
+			numFailed++;
+		}
+		delete directory;
+	}
+
+	Testsuite::logDetailedPrintf("Failed %d out of 15\n", numFailed);
+	if (numFailed) {
+		return kTestFailed;
+	} else {
+		return kTestPassed;
+	}
+}
+
+/**
+ * This test creates a file testbed.out, writes a sample data and confirms if
+ * it is same by reading the file again.
+ */
+TestExitStatus FStests::testWriteFile() {
+	Common::FSNode testDirectory(ConfMan.getPath("path"));
+	if (!testDirectory.isWritable()) {
+		// redirect to savepath if game-data directory is not writable.
+		testDirectory = Common::FSNode(ConfMan.getPath("savepath"));
+	}
+	if (!testDirectory.exists()) {
+		Testsuite::logPrintf("Couldn't open the game data directory %s",
+				testDirectory.getPath().toString(Common::Path::kNativeSeparator).c_str());
+		 return kTestFailed;
+	}
+
+	Common::FSNode fileToWrite = testDirectory.getChild("testbed.out");
+
+	Common::WriteStream *ws = fileToWrite.createWriteStream();
+
+	if (!ws) {
+		Testsuite::logDetailedPrintf("Can't open writable file in game data dir\n");
+		return kTestFailed;
+	}
+
+	ws->writeString("ScummVM Rocks!");
+	ws->flush();
+	delete ws;
+
+	Common::SeekableReadStream *rs = fileToWrite.createReadStream();
+	if (!rs) {
+		Testsuite::logDetailedPrintf("Can't open recently written file testbed.out in game data dir\n");
+		return kTestFailed;
+	}
+	Common::String readFromFile = rs->readLine();
+	delete rs;
+
+	if (readFromFile.equals("ScummVM Rocks!")) {
+		// All good
+		Testsuite::logDetailedPrintf("Data written and read correctly\n");
+		return kTestPassed;
+	}
+
+	return kTestFailed;
+}
+
+/**
+ * This test creates a directory testbed.dir, and confirms if the directory is created successfully
+ */
+TestExitStatus FStests::testCreateDir() {
+	Common::FSNode testDirectory(ConfMan.getPath("path"));
+	if (!testDirectory.isWritable()) {
+		// redirect to savepath if game-data directory is not writable.
+		testDirectory = Common::FSNode(ConfMan.getPath("savepath"));
+	}
+	if (!testDirectory.exists()) {
+		Testsuite::logPrintf("Couldn't open the game data directory %s",
+				testDirectory.getPath().toString(Common::Path::kNativeSeparator).c_str());
+		 return kTestFailed;
+	}
+
+	Common::FSNode dirToCreate = testDirectory.getChild("testbed.dir");
+
+	// TODO: Delete the directory after creating it
+	if (dirToCreate.exists()) {
+		Testsuite::logDetailedPrintf("Directory already exists in game data dir\n");
+		return kTestSkipped;
+	}
+
+	if (!dirToCreate.createDirectory()) {
+		Testsuite::logDetailedPrintf("Can't create directory in game data dir\n");
+		return kTestFailed;
+	}
+
+	Testsuite::logDetailedPrintf("Directory created successfully\n");
+	return kTestPassed;
+}
+
+FSTestSuite::FSTestSuite() {
+	// FS tests depend on Game Data files.
+	// If those are not found. Disable this testsuite.
+	const Common::Path &path = ConfMan.getPath("path");
+	Common::FSNode gameRoot(path);
+
+	Common::FSNode gameIdentificationFile = gameRoot.getChild("TESTBED");
+	if (!gameIdentificationFile.exists()) {
+		logPrintf("WARNING! : Game Data not found. Skipping FS tests\n");
+		ConfParams.setGameDataFound(false);
+		Testsuite::enable(false);
+	}
+	addTest("ReadingFile", &FStests::testReadFile, false);
+	addTest("WritingFile", &FStests::testWriteFile, false);
+	addTest("CreateDir",   &FStests::testCreateDir, false);
+}
+
+void FSTestSuite::enable(bool flag) {
+	Testsuite::enable(ConfParams.isGameDataFound() ? flag : false);
+}
+
+} // End of namespace Testbed