AxioDL
/
PrimeWorldEditor
mirror of https://github.com/AxioDL/PrimeWorldEditor.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added commandline-operated test for verifying cooker output

This commit is contained in:
Aruki 2019-01-30 01:05:52 -07:00
parent 9d23d9550a
commit 1360202ee5
12 changed files with 273 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
externals/LibCommon vendored

@ -1 +1 @@
Subproject commit c7e755f3089b5c2cedbd5f9963220d784e137f8e
Subproject commit c98f4b3dcef68724627af91ac4103de7f28d2a2b

6
src/Core/Core.pro
View File

@ -255,7 +255,8 @@ HEADERS += \
Resource/Cooker/CStringCooker.h \
Resource/Scan/CScan.h \
Resource/Scan/SScanParametersMP1.h \
Resource/Scan/ELogbookCategory.h
Resource/Scan/ELogbookCategory.h \
NCoreTests.h
# Source Files
SOURCES += \
@ -372,7 +373,8 @@ SOURCES += \
Tweaks/CTweakLoader.cpp \
Tweaks/CTweakCooker.cpp \
Resource/Cooker/CStringCooker.cpp \
Resource/Scan/CScan.cpp
Resource/Scan/CScan.cpp \
NCoreTests.cpp
# Codegen
CODEGEN_DIR = $$EXTERNALS_DIR/CodeGen

4
src/Core/IUIRelay.h
View File

@ -6,8 +6,10 @@
class IUIRelay
{
public:
virtual void AsyncMessageBox(const TString& rkInfoBoxTitle, const TString& rkMessage) = 0;
virtual void ShowMessageBox(const TString& rkInfoBoxTitle, const TString& rkMessage) = 0;
virtual void ShowMessageBoxAsync(const TString& rkInfoBoxTitle, const TString& rkMessage) = 0;
virtual bool AskYesNoQuestion(const TString& rkInfoBoxTitle, const TString& rkQuestion) = 0;
virtual bool OpenProject(const TString& kPath = "") = 0;
};
extern IUIRelay *gpUIRelay;

200
src/Core/NCoreTests.cpp Normal file
View File

@ -0,0 +1,200 @@
#include "NCoreTests.h"
#include "IUIRelay.h"
#include "Core/GameProject/CGameProject.h"
#include "Core/GameProject/CResourceEntry.h"
#include "Core/GameProject/CResourceIterator.h"
#include "Core/Resource/Cooker/CResourceCooker.h"
namespace NCoreTests
{
/** Checks for a parameter in the commandline stream */
const char* ParseParameter(const char* pkParmName, int argc, char* argv[])
{
const uint kParmLen = strlen(pkParmName);
for (int i=0; i<argc; i++)
{
if( strncmp(argv[i], pkParmName, kParmLen) == 0 )
{
// Found the parameter. Make sure there is enough space in the
// string for the parameter value before returning it.
if( strlen(argv[i]) >= kParmLen+2 &&
argv[i][kParmLen] == '=')
{
return &argv[i][kParmLen+1];
}
}
}
// Couldn't find the parameter.
return nullptr;
}
/** Checks for the existence of a token in the commandline stream */
bool ParseToken(const char* pkToken, int argc, char* argv[])
{
for (int i=0; i<argc; i++)
{
if( strcmp(argv[i], pkToken) == 0 )
{
return true;
}
}
// Couldn't find the token.
return false;
}
/** Check commandline input to see if the user is running a test */
bool RunTests(int argc, char* argv[])
{
if( ParseToken("ValidateCooker", argc, argv) )
{
// Fetch parameters
const char* pkType = ParseParameter("-type", argc, argv);
EResourceType Type = TEnumReflection<EResourceType>::ConvertStringToValue(pkType);
bool AllowDump = ParseToken("-allowdump", argc, argv);
if( Type == EResourceType::Invalid )
{
gpUIRelay->ShowMessageBox("ValidateCooker", "Usage: ValidateCooker -type=<ResourceType> [-allowdump] [-project=<Project>]");
}
else if( gpUIRelay->OpenProject(ParseParameter("-project", argc, argv)) )
{
ValidateCooker(Type, AllowDump);
}
return true;
}
// No test being run.
return false;
}
/** Validate all cooker output for the given resource type matches the original asset data */
bool ValidateCooker(EResourceType ResourceType, bool DumpInvalidFileContents)
{
debugf( "Validating output of %s cooker...",
TEnumReflection<EResourceType>::ConvertValueToString(ResourceType) );
// There must be a project loaded
CResourceStore* pStore = gpResourceStore;
CGameProject* pProject = (pStore ? pStore->Project() : nullptr);
if (!pProject)
{
errorf("Cooker unit test failed; no project loaded");
return false;
}
TString ResourcesDir = pProject->ResourcesDir(false);
uint NumValid = 0, NumInvalid = 0;
// Iterate through all resources
for (CResourceIterator It(pStore); It; ++It)
{
if (It->ResourceType() != ResourceType || !It->HasCookedVersion())
continue;
// Get original cooked data
TString CookedPath = It->CookedAssetPath(true);
CFileInStream FileStream(ResourcesDir / CookedPath, EEndian::BigEndian);
if (!FileStream.IsValid())
continue;
std::vector<uint8> OriginalData( FileStream.Size() );
FileStream.ReadBytes(OriginalData.data(), OriginalData.size());
FileStream.Close();
// Generate new cooked data
std::vector<char> NewData;
CVectorOutStream MemoryStream(&NewData, EEndian::BigEndian);
CResourceCooker::CookResource(*It, MemoryStream);
// Start our comparison by making sure the sizes match up
const uint kAlignment = (It->Game() >= EGame::Corruption ? 64 : 32);
const uint kAlignedOriginalSize = ALIGN( (uint) OriginalData.size(), kAlignment );
const uint kAlignedNewSize = ALIGN( (uint) NewData.size(), kAlignment );
const char* pkInvalidReason = "";
bool IsValid = false;
if( kAlignedOriginalSize == kAlignedNewSize &&
OriginalData.size() >= NewData.size() )
{
// Compare actual data. Note that the original asset can have alignment padding
// at the end, which is applied by the pak but usually preserved in extracted
// files. We do not include this in the comparison as missing padding does not
// indicate malformed data.
uint DataSize = Math::Min(OriginalData.size(), NewData.size());
if( memcmp(OriginalData.data(), NewData.data(), DataSize) == 0 )
{
// Verify any missing data at the end is padding.
bool MissingData = false;
if( OriginalData.size() > NewData.size() )
{
for( uint i=DataSize; i<OriginalData.size(); i++ )
{
if( OriginalData[i] != 0xFF )
{
MissingData = true;
break;
}
}
}
if( !MissingData )
{
// All tests passed!
IsValid = true;
}
else
{
pkInvalidReason = "missing data";
}
}
else
{
pkInvalidReason = "data mismatch";
}
}
else
{
pkInvalidReason = "size mismatch";
}
// Print test results
if( IsValid )
{
debugf( "[SUCCESS] %s", *CookedPath );
NumValid++;
}
else
{
debugf( "[FAILED: %s] %s", pkInvalidReason, *CookedPath );
NumInvalid++;
}
if( DumpInvalidFileContents )
{
TString DumpPath = "dump" / CookedPath;
FileUtil::MakeDirectory( DumpPath.GetFileDirectory() );
CFileOutStream DumpFile(DumpPath, EEndian::BigEndian);
DumpFile.WriteBytes( NewData.data(), NewData.size() );
DumpFile.Close();
}
}
// Test complete
bool TestSuccess = (NumInvalid == 0);
debugf( "Test %s; checked %d resources, %d passed, %d failed",
TestSuccess ? "SUCCEEDED" : "FAILED",
NumValid + NumInvalid, NumValid, NumInvalid );
return TestSuccess;
}
} // end namespace NCoreTests

18
src/Core/NCoreTests.h Normal file
View File

@ -0,0 +1,18 @@
#ifndef NCORETESTS_H
#define NCORETESTS_H
#include "Core/Resource/EResType.h"
/** Unit tests for Core */
namespace NCoreTests
{
/** Check commandline input to see if the user is running a unit test */
bool RunTests(int argc, char *argv[]);
/** Validate all cooker output for the given resource type matches the original asset data */
bool ValidateCooker(EResourceType ResourceType, bool DumpInvalidFileContents);
}
#endif // NCORETESTS_H

2
src/Core/Resource/Script/Property/CPropertyNameGenerator.cpp
View File

@ -218,7 +218,7 @@ void CPropertyNameGenerator::Generate(const SPropertyNameGenerationParameters& r
// If we have too many saved results, then to avoid crashing we will force enable log output.
if (mGeneratedNames.size() > 9999)
{
gpUIRelay->AsyncMessageBox("Warning", "There are over 10,000 results. Results will no longer print to the screen. Check the log for the remaining output.");
gpUIRelay->ShowMessageBoxAsync("Warning", "There are over 10,000 results. Results will no longer print to the screen. Check the log for the remaining output.");
WriteToLog = true;
SaveResults = false;
}

5
src/Editor/CEditorApplication.cpp
View File

@ -21,6 +21,7 @@ CEditorApplication::CEditorApplication(int& rArgc, char **ppArgv)
, mpActiveProject(nullptr)
, mpWorldEditor(nullptr)
, mpProjectDialog(nullptr)
, mInitialized(false)
{
mLastUpdate = CTimer::GlobalTime();
@ -40,10 +41,14 @@ void CEditorApplication::InitEditor()
mpWorldEditor = new CWorldEditor();
mpProjectDialog = new CProjectSettingsDialog(mpWorldEditor);
mpWorldEditor->showMaximized();
mInitialized = true;
}
bool CEditorApplication::CloseAllEditors()
{
if (!mInitialized)
return true;
// Close active editor windows.
foreach (IEditor *pEditor, mEditorWindows)
{

1
src/Editor/CEditorApplication.h
View File

@ -25,6 +25,7 @@ class CEditorApplication : public QApplication
CProjectSettingsDialog *mpProjectDialog;
QVector<IEditor*> mEditorWindows;
QMap<CResourceEntry*,IEditor*> mEditingMap;
bool mInitialized;
QTimer mRefreshTimer;
double mLastUpdate;

29
src/Editor/CUIRelay.h
View File

@ -25,9 +25,16 @@ public:
// Note: All function calls should be deferred with QMetaObject::invokeMethod to ensure
// that they run on the UI thread instead of whatever thread we happen to be on.
virtual void AsyncMessageBox(const TString& rkInfoBoxTitle, const TString& rkMessage)
virtual void ShowMessageBox(const TString& rkInfoBoxTitle, const TString& rkMessage)
{
QMetaObject::invokeMethod(this, "AsyncMessageBoxSlot", Qt::QueuedConnection,
QMetaObject::invokeMethod(this, "MessageBoxSlot", GetConnectionType(),
Q_ARG(QString, TO_QSTRING(rkInfoBoxTitle)),
Q_ARG(QString, TO_QSTRING(rkMessage)) );
}
virtual void ShowMessageBoxAsync(const TString& rkInfoBoxTitle, const TString& rkMessage)
{
QMetaObject::invokeMethod(this, "MessageBoxSlot", Qt::QueuedConnection,
Q_ARG(QString, TO_QSTRING(rkInfoBoxTitle)),
Q_ARG(QString, TO_QSTRING(rkMessage)) );
}
@ -42,8 +49,17 @@ public:
return RetVal;
}
public slots:
void AsyncMessageBoxSlot(const QString& rkInfoBoxTitle, const QString& rkMessage)
virtual bool OpenProject(const TString& kPath = "")
{
bool RetVal;
QMetaObject::invokeMethod(this, "OpenProjectSlot", GetConnectionType(),
Q_RETURN_ARG(bool, RetVal),
Q_ARG(QString, TO_QSTRING(kPath)) );
return RetVal;
}
private slots:
void MessageBoxSlot(const QString& rkInfoBoxTitle, const QString& rkMessage)
{
UICommon::InfoMsg(gpEdApp->WorldEditor(), rkInfoBoxTitle, rkMessage);
}
@ -52,6 +68,11 @@ public slots:
{
return UICommon::YesNoQuestion(gpEdApp->WorldEditor(), rkInfoBoxTitle, rkQuestion);
}
bool OpenProjectSlot(const QString& kPath)
{
return !kPath.isEmpty() ? gpEdApp->OpenProject(kPath) : UICommon::OpenProject();
}
};
#endif // CUIRELAY_H

7
src/Editor/UICommon.h
View File

@ -141,6 +141,13 @@ inline bool YesNoQuestion(QWidget *pParent, QString InfoBoxTitle, QString Questi
return Button == QMessageBox::Yes;
}
inline bool OpenProject()
{
QWidget* pMainWindow = (QWidget*) gpEdApp->WorldEditor();
QString ProjPath = UICommon::OpenFileDialog(pMainWindow, "Open Project", "Game Project (*.prj)");
return ProjPath.isEmpty() ? false : gpEdApp->OpenProject(ProjPath);
}
// Constants
const QColor kImportantButtonColor(36, 100, 100);

3
src/Editor/WorldEditor/CWorldEditor.cpp
View File

@ -408,8 +408,7 @@ void CWorldEditor::Paste()
void CWorldEditor::OpenProject()
{
QString ProjPath = UICommon::OpenFileDialog(this, "Open Project", "Game Project (*.prj)");
if (!ProjPath.isEmpty()) gpEdApp->OpenProject(ProjPath);
UICommon::OpenProject();
}
void CWorldEditor::OpenRecentProject()

7
src/Editor/main.cpp
View File

@ -3,6 +3,7 @@
#include "UICommon.h"
#include <Common/Log.h>
#include <Core/NCoreTests.h>
#include <Core/Resource/Script/NGameList.h>
#include <QApplication>
@ -60,6 +61,12 @@ public:
gpEditorStore->ConditionalSaveStore();
}
// Check for unit tests being run
if ( NCoreTests::RunTests(argc, argv) )
{
return 0;
}
// Execute application
App.InitEditor();
return App.exec();