Merge branch 'updater_tests' of https://github.com/02JanDal/MultiMC5 into develop

4 files changed, 127 insertions, 86 deletions

diff --git a/logic/updater/DownloadUpdateTask.cpp b/logic/updater/DownloadUpdateTask.cpp
index d9aab826..d72cfcf6 100644
--- a/logic/updater/DownloadUpdateTask.cpp
+++ b/logic/updater/DownloadUpdateTask.cpp
@@ -45,55 +45,54 @@ void DownloadUpdateTask::executeTask()
 	findCurrentVersionInfo();
 }
 
-void DownloadUpdateTask::findCurrentVersionInfo()
+void DownloadUpdateTask::processChannels()
 {
-	setStatus(tr("Finding information about the current version."));
-
 	auto checker = MMC->updateChecker();
 
-	// This runs after we've tried loading the channel list.
-	// If the channel list doesn't need to be loaded, this will be called immediately.
-	// If the channel list does need to be loaded, this will be called when it's done.
-	auto processFunc = [this, &checker] () -> void
+	// Now, check the channel list again.
+	if (!checker->hasChannels())
 	{
-		// Now, check the channel list again.
-		if (checker->hasChannels())
-		{ 
-			// We still couldn't load the channel list. Give up. Call loadVersionInfo and return.
-			QLOG_INFO() << "Reloading the channel list didn't work. Giving up.";
-			loadVersionInfo();
-			return;
-		}
+		// We still couldn't load the channel list. Give up. Call loadVersionInfo and return.
+		QLOG_INFO() << "Reloading the channel list didn't work. Giving up.";
+		loadVersionInfo();
+		return;
+	}
 
-		QList<UpdateChecker::ChannelListEntry> channels = checker->getChannelList();
-		QString channelId = MMC->version().channel;
+	QList<UpdateChecker::ChannelListEntry> channels = checker->getChannelList();
+	QString channelId = MMC->version().channel;
 
-		// Search through the channel list for a channel with the correct ID.
-		for (auto channel : channels)
+	// Search through the channel list for a channel with the correct ID.
+	for (auto channel : channels)
+	{
+		if (channel.id == channelId)
 		{
-			if (channel.id == channelId)
-			{
-				QLOG_INFO() << "Found matching channel.";
-				m_cRepoUrl = channel.url;
-				break;
-			}
+			QLOG_INFO() << "Found matching channel.";
+			m_cRepoUrl = preparePath(channel.url);
+			break;
 		}
+	}
 
-		// Now that we've done that, load version info.
-		loadVersionInfo();
-	};
+	// Now that we've done that, load version info.
+	loadVersionInfo();
+}
+
+void DownloadUpdateTask::findCurrentVersionInfo()
+{
+	setStatus(tr("Finding information about the current version."));
 
-	if (checker->hasChannels())
+	auto checker = MMC->updateChecker();
+
+	if (!checker->hasChannels())
 	{
 		// Load the channel list and wait for it to finish loading.
 		QLOG_INFO() << "No channel list entries found. Will try reloading it.";
 
-		QObject::connect(checker.get(), &UpdateChecker::channelListLoaded, processFunc);
+		QObject::connect(checker.get(), &UpdateChecker::channelListLoaded, this, &DownloadUpdateTask::processChannels);
 		checker->updateChanList();
 	}
 	else
 	{
-		processFunc();
+		processChannels();
 	}
 }
 
@@ -152,12 +151,24 @@ void DownloadUpdateTask::parseDownloadedVersionInfo()
 {
 	setStatus(tr("Reading file lists."));
 
-	parseVersionInfo(NEW_VERSION, &m_nVersionFileList);
+	setStatus(tr("Reading file list for new version."));
+	QLOG_DEBUG() << "Reading file list for new version.";
+	QString error;
+	if (!parseVersionInfo(std::dynamic_pointer_cast<ByteArrayDownload>(
+							  m_vinfoNetJob->first())->m_data, &m_nVersionFileList, &error))
+	{
+		emitFailed(error);
+		return;
+	}
 
 	// If there is a second entry in the network job's list, load it as the current version's info.
 	if (m_vinfoNetJob->size() >= 2 && m_vinfoNetJob->operator[](1)->m_status != Job_Failed)
 	{
-		parseVersionInfo(CURRENT_VERSION, &m_cVersionFileList);
+		setStatus(tr("Reading file list for current version."));
+		QLOG_DEBUG() << "Reading file list for current version.";
+		QString error;
+		parseVersionInfo(std::dynamic_pointer_cast<ByteArrayDownload>(
+							 m_vinfoNetJob->operator[](1))->m_data, &m_cVersionFileList, &error);
 	}
 
 	// We don't need this any more.
@@ -167,26 +178,15 @@ void DownloadUpdateTask::parseDownloadedVersionInfo()
 	processFileLists();
 }
 
-void DownloadUpdateTask::parseVersionInfo(VersionInfoFileEnum vfile, VersionFileList* list)
+bool DownloadUpdateTask::parseVersionInfo(const QByteArray &data, VersionFileList* list, QString *error)
 {
-	if (vfile == CURRENT_VERSION)  setStatus(tr("Reading file list for current version."));
-	else if (vfile == NEW_VERSION) setStatus(tr("Reading file list for new version."));
-
-	QLOG_DEBUG() << "Reading file list for" << (vfile == NEW_VERSION ? "new" : "current") << "version.";
-	
-	QByteArray data;
-	{
-		ByteArrayDownloadPtr dl = std::dynamic_pointer_cast<ByteArrayDownload>(
-				vfile == NEW_VERSION ? m_vinfoNetJob->first() : m_vinfoNetJob->operator[](1));
-		data = dl->m_data;
-	}
-
 	QJsonParseError jsonError;
 	QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &jsonError);
 	if (jsonError.error != QJsonParseError::NoError)
 	{
-		QLOG_ERROR() << "Failed to parse version info JSON:" << jsonError.errorString() << "at" << jsonError.offset;
-		return;
+		*error = QString("Failed to parse version info JSON: %1 at %2").arg(jsonError.errorString()).arg(jsonError.offset);
+		QLOG_ERROR() << error;
+		return false;
 	}
 
 	QJsonObject json = jsonDoc.object();
@@ -213,11 +213,11 @@ void DownloadUpdateTask::parseVersionInfo(VersionInfoFileEnum vfile, VersionFile
 			QString type = sourceObj.value("SourceType").toString();
 			if (type == "http")
 			{
-				file.sources.append(FileSource("http", sourceObj.value("Url").toString()));
+				file.sources.append(FileSource("http", preparePath(sourceObj.value("Url").toString())));
 			}
 			else if (type == "httpc")
 			{
-				file.sources.append(FileSource("httpc", sourceObj.value("Url").toString(), sourceObj.value("CompressionType").toString()));
+				file.sources.append(FileSource("httpc", preparePath(sourceObj.value("Url").toString()), sourceObj.value("CompressionType").toString()));
 			}
 			else
 			{
@@ -229,18 +229,41 @@ void DownloadUpdateTask::parseVersionInfo(VersionInfoFileEnum vfile, VersionFile
 
 		list->append(file);
 	}
+
+	return true;
 }
 
 void DownloadUpdateTask::processFileLists()
 {
+	// Create a network job for downloading files.
+	NetJob* netJob = new NetJob("Update Files");
+
+	processFileLists(netJob, m_cVersionFileList, m_nVersionFileList, m_operationList);
+
+	// Add listeners to wait for the downloads to finish.
+	QObject::connect(netJob, &NetJob::succeeded, this, &DownloadUpdateTask::fileDownloadFinished);
+	QObject::connect(netJob, &NetJob::progress, this, &DownloadUpdateTask::fileDownloadProgressChanged);
+	QObject::connect(netJob, &NetJob::failed, this, &DownloadUpdateTask::fileDownloadFailed);
+
+	// Now start the download.
+	setStatus(tr("Downloading %1 update files.").arg(QString::number(netJob->size())));
+	QLOG_DEBUG() << "Begin downloading update files to" << m_updateFilesDir.path();
+	m_filesNetJob.reset(netJob);
+	netJob->start();
+
+	writeInstallScript(m_operationList, PathCombine(m_updateFilesDir.path(), "file_list.xml"));
+}
+
+void DownloadUpdateTask::processFileLists(NetJob *job, const VersionFileList &currentVersion, const VersionFileList &newVersion, DownloadUpdateTask::UpdateOperationList &ops)
+{
 	setStatus(tr("Processing file lists. Figuring out how to install the update."));
 
 	// First, if we've loaded the current version's file list, we need to iterate through it and 
 	// delete anything in the current one version's list that isn't in the new version's list.
-	for (VersionFileEntry entry : m_cVersionFileList)
+	for (VersionFileEntry entry : currentVersion)
 	{
 		bool keep = false;
-		for (VersionFileEntry newEntry : m_nVersionFileList)
+		for (VersionFileEntry newEntry : newVersion)
 		{
 			if (newEntry.path == entry.path)
 			{
@@ -251,14 +274,11 @@ void DownloadUpdateTask::processFileLists()
 		}
 		// If the loop reaches the end and we didn't find a match, delete the file.
 		if(!keep)
-			m_operationList.append(UpdateOperation::DeleteOp(entry.path));
+			ops.append(UpdateOperation::DeleteOp(entry.path));
 	}
 
-	// Create a network job for downloading files.
-	NetJob* netJob = new NetJob("Update Files");
-
 	// Next, check each file in MultiMC's folder and see if we need to update them.
-	for (VersionFileEntry entry : m_nVersionFileList)
+	for (VersionFileEntry entry : newVersion)
 	{
 		// TODO: Let's not MD5sum a ton of files on the GUI thread. We should probably find a way to do this in the background.
 		QString fileMD5;
@@ -285,34 +305,24 @@ void DownloadUpdateTask::processFileLists()
 					// Download it to updatedir/<filepath>-<md5> where filepath is the file's path with slashes replaced by underscores.
 					QString dlPath = PathCombine(m_updateFilesDir.path(), QString(entry.path).replace("/", "_"));
 
-					// We need to download the file to the updatefiles folder and add a task to copy it to its install path.
-					auto download = MD5EtagDownload::make(source.url, dlPath);
-					download->m_check_md5 = true;
-					download->m_expected_md5 = entry.md5;
-					netJob->addNetAction(download);
+					if (job)
+					{
+						// We need to download the file to the updatefiles folder and add a task to copy it to its install path.
+						auto download = MD5EtagDownload::make(source.url, dlPath);
+						download->m_check_md5 = true;
+						download->m_expected_md5 = entry.md5;
+						job->addNetAction(download);
+					}
 
 					// Now add a copy operation to our operations list to install the file.
-					m_operationList.append(UpdateOperation::CopyOp(dlPath, entry.path, entry.mode));
+					ops.append(UpdateOperation::CopyOp(dlPath, entry.path, entry.mode));
 				}
 			}
 		}
 	}
-
-	// Add listeners to wait for the downloads to finish.
-	QObject::connect(netJob, &NetJob::succeeded, this, &DownloadUpdateTask::fileDownloadFinished);
-	QObject::connect(netJob, &NetJob::progress, this, &DownloadUpdateTask::fileDownloadProgressChanged);
-	QObject::connect(netJob, &NetJob::failed, this, &DownloadUpdateTask::fileDownloadFailed);
-
-	// Now start the download.
-	setStatus(tr("Downloading %1 update files.").arg(QString::number(netJob->size())));
-	QLOG_DEBUG() << "Begin downloading update files to" << m_updateFilesDir.path();
-	m_filesNetJob.reset(netJob);
-	netJob->start();
-
-	writeInstallScript(m_operationList, PathCombine(m_updateFilesDir.path(), "file_list.xml"));
 }
 
-void DownloadUpdateTask::writeInstallScript(UpdateOperationList& opsList, QString scriptFile)
+bool DownloadUpdateTask::writeInstallScript(UpdateOperationList& opsList, QString scriptFile)
 {
 	// Build the base structure of the XML document.
 	QDomDocument doc;
@@ -377,7 +387,15 @@ void DownloadUpdateTask::writeInstallScript(UpdateOperationList& opsList, QStrin
 	else
 	{
 		emitFailed(tr("Failed to write update script file."));
+		return false;
 	}
+
+	return true;
+}
+
+QString DownloadUpdateTask::preparePath(const QString &path)
+{
+	return QString(path).replace("$PWD", qApp->applicationDirPath());
 }
 
 void DownloadUpdateTask::fileDownloadFinished()
diff --git a/logic/updater/DownloadUpdateTask.h b/logic/updater/DownloadUpdateTask.h
index f5b23d12..8530be77 100644
--- a/logic/updater/DownloadUpdateTask.h
+++ b/logic/updater/DownloadUpdateTask.h
@@ -34,7 +34,8 @@ public:
 	 */
 	QString updateFilesDir();
 	
-protected:
+public:
+
 	// TODO: We should probably put these data structures into a separate header...
 
 	/*!
@@ -53,7 +54,6 @@ protected:
 		QString url;
 		QString compressionType;
 	};
-
 	typedef QList<FileSource> FileSourceList;
 
 	/*!
@@ -66,10 +66,8 @@ protected:
 		FileSourceList sources;
 		QString md5;
 	};
-
 	typedef QList<VersionFileEntry> VersionFileList;
 
-
 	/*!
 	 * Structure that describes an operation to perform when installing updates.
 	 */
@@ -100,9 +98,12 @@ protected:
 
 		// Yeah yeah, polymorphism blah blah inheritance, blah blah object oriented. I'm lazy, OK?
 	};
-
 	typedef QList<UpdateOperation> UpdateOperationList;
 
+protected:
+	friend class DownloadUpdateTaskTest;
+
+
 	/*!
 	 * Used for arguments to parseVersionInfo and friends to specify which version info file to parse.
 	 */
@@ -120,6 +121,13 @@ protected:
 	virtual void findCurrentVersionInfo();
 
 	/*!
+	 * This runs after we've tried loading the channel list.
+	 * If the channel list doesn't need to be loaded, this will be called immediately.
+	 * If the channel list does need to be loaded, this will be called when it's done.
+	 */
+	void processChannels();
+
+	/*!
 	 * Downloads the version info files from the repository.
 	 * The files for both the current build, and the build that we're updating to need to be downloaded.
 	 * If the current version's info file can't be found, MultiMC will not delete files that 
@@ -142,20 +150,25 @@ protected:
 	/*!
 	 * Loads the file list from the given version info JSON object into the given list.
 	 */
-	virtual void parseVersionInfo(VersionInfoFileEnum vfile, VersionFileList* list);
+	virtual bool parseVersionInfo(const QByteArray &data, VersionFileList* list, QString *error);
 
 	/*!
 	 * Takes a list of file entries for the current version's files and the new version's files
 	 * and populates the downloadList and operationList with information about how to download and install the update.
 	 */
+	virtual void processFileLists(NetJob *job, const VersionFileList &currentVersion, const VersionFileList &newVersion, UpdateOperationList &ops);
+
+	/*!
+	 * Calls \see processFileLists to populate the \see m_operationList and a NetJob, and then executes
+	 * the NetJob to fetch all needed files
+	 */
 	virtual void processFileLists();
 
 	/*!
 	 * Takes the operations list and writes an install script for the updater to the update files directory.
 	 */
-	virtual void writeInstallScript(UpdateOperationList& opsList, QString scriptFile);
+	virtual bool writeInstallScript(UpdateOperationList& opsList, QString scriptFile);
 
-	VersionFileList m_downloadList;
 	UpdateOperationList m_operationList;
 
 	VersionFileList m_nVersionFileList;
@@ -181,6 +194,11 @@ protected:
 	 */
 	QTemporaryDir m_updateFilesDir;
 
+	/*!
+	 * Substitutes $PWD for the application directory
+	 */
+	static QString preparePath(const QString &path);
+
 protected slots:
 	void vinfoDownloadFinished();
 	void vinfoDownloadFailed();
diff --git a/logic/updater/UpdateChecker.cpp b/logic/updater/UpdateChecker.cpp
index 5ff1898e..af56288c 100644
--- a/logic/updater/UpdateChecker.cpp
+++ b/logic/updater/UpdateChecker.cpp
@@ -44,7 +44,7 @@ QList<UpdateChecker::ChannelListEntry> UpdateChecker::getChannelList() const
 
 bool UpdateChecker::hasChannels() const
 {
-	return m_channels.isEmpty();
+	return !m_channels.isEmpty();
 }
 
 void UpdateChecker::checkForUpdate()
diff --git a/logic/updater/UpdateChecker.h b/logic/updater/UpdateChecker.h
index 59fb8e47..5b7efc05 100644
--- a/logic/updater/UpdateChecker.h
+++ b/logic/updater/UpdateChecker.h
@@ -27,6 +27,9 @@ public:
 	UpdateChecker();
 	void checkForUpdate();
 
+	void setCurrentChannel(const QString &channel) { m_currentChannel = channel; }
+	void setChannelListUrl(const QString &url) { m_channelListUrl = url; }
+
 	/*!
 	 * Causes the update checker to download the channel list from the URL specified in config.h (generated by CMake).
 	 * If this isn't called before checkForUpdate(), it will automatically be called.
@@ -70,6 +73,8 @@ private slots:
 	void chanListDownloadFailed();
 
 private:
+	friend class UpdateCheckerTest;
+
 	NetJobPtr indexJob;
 	NetJobPtr chanListJob;