New name.

tools/nitpick/src/TestCreator.h

@@ -0,0 +1,170 @@
+//
+//  TestCreator.h
+//
+//  Created by Nissim Hadar on 2 Nov 2017.
+//  Copyright 2013 High Fidelity, Inc.
+//
+//  Distributed under the Apache License, Version 2.0.
+//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
+//
+
+#ifndef hifi_testCreator_h
+#define hifi_testCreator_h
+
+#include <QtWidgets/QFileDialog>
+#include <QtWidgets/QMessageBox>
+#include <QtCore/QRegularExpression>
+#include <QProgressBar>
+
+#include "AWSInterface.h"
+#include "ImageComparer.h"
+#include "Downloader.h"
+#include "MismatchWindow.h"
+#include "TestRailInterface.h"
+
+class Step {
+public:
+	QString text;
+	bool takeSnapshot;
+};
+
+using StepList = std::vector<Step*>;
+
+class ExtractedText {
+public:
+    QString title;
+    StepList stepList;
+};
+
+enum TestRailCreateMode {
+    PYTHON,
+    XML
+};
+
+class TestCreator {
+public: 
+    TestCreator(QProgressBar* progressBar, QCheckBox* checkBoxInteractiveMode);
+
+    void startTestsEvaluation(const bool isRunningFromCommandLine,
+                              const bool isRunningInAutomaticTestRun, 
+                              const QString& snapshotDirectory = QString(),
+                              const QString& branchFromCommandLine = QString(),
+                              const QString& userFromCommandLine = QString());
+
+    void finishTestsEvaluation();
+
+    void createTests(const QString& clientProfile);
+
+    void createTestsOutline();
+
+    bool createFileSetup();
+    bool createAllFilesSetup();
+
+    void createMDFile();
+    void createAllMDFiles();
+    bool createMDFile(const QString& directory);
+
+    void createTestAutoScript();
+    void createAllTestAutoScripts();
+    bool createTestAutoScript(const QString& directory);
+
+    void createTestRailTestCases();
+    void createTestRailRun();
+
+    void updateTestRailRunResult();
+
+    void createAllRecursiveScripts();
+    void createAllRecursiveScripts(const QString& directory);
+
+    void createRecursiveScript();
+    void createRecursiveScript(const QString& directory, bool interactiveMode);
+
+    int compareImageLists();
+    int checkTextResults();
+
+    QStringList createListOfAll_imagesInDirectory(const QString& imageFormat, const QString& pathToImageDirectory);
+
+    bool isInSnapshotFilenameFormat(const QString& imageFormat, const QString& filename);
+
+    void includeTest(QTextStream& textStream, const QString& testPathname);
+
+    void appendTestResultsToFile(TestResult testResult, QPixmap comparisonImage, bool hasFailed);
+    void appendTestResultsToFile(QString testResultFilename, bool hasFailed);
+
+    bool createTestResultsFolderPath(const QString& directory);
+    QString zipAndDeleteTestResultsFolder();
+
+    static bool isAValidDirectory(const QString& pathname);
+	QString extractPathFromTestsDown(const QString& fullPath);
+    QString getExpectedImageDestinationDirectory(const QString& filename);
+    QString getExpectedImagePartialSourceDirectory(const QString& filename);
+
+    ExtractedText getTestScriptLines(QString testFileName);
+
+    void setTestRailCreateMode(TestRailCreateMode testRailCreateMode);
+
+    void createWebPage(QCheckBox* updateAWSCheckBox, QLineEdit* urlLineEdit);
+
+private:
+    QProgressBar* _progressBar;
+    QCheckBox* _checkBoxInteractiveMode;
+
+    bool _isRunningFromCommandLine{ false };
+    bool _isRunningInAutomaticTestRun{ false };
+
+    const QString TEST_FILENAME{ "test.js" };
+    const QString TEST_RECURSIVE_FILENAME{ "testRecursive.js" };
+    const QString TEST_RESULTS_FOLDER { "TestResults" };
+    const QString TEST_RESULTS_FILENAME { "TestResults.txt" };
+
+    const double THRESHOLD{ 0.965 };
+
+    QDir _imageDirectory;
+
+    MismatchWindow _mismatchWindow;
+
+    ImageComparer _imageComparer;
+
+    QString _testResultsFolderPath;
+    int _failureIndex{ 1 };
+    int _successIndex{ 1 };
+
+    // Expected images are in the format ExpectedImage_dddd.jpg (d == decimal digit)
+    const int NUM_DIGITS { 5 };
+    const QString EXPECTED_IMAGE_PREFIX { "ExpectedImage_" };
+
+    // We have two directories to work with.
+    // The first is the directory containing the test we are working with
+    // The second is the root directory of all tests
+    // The third contains the snapshots taken for test runs that need to be evaluated
+    QString _testDirectory;
+    QString _testsRootDirectory;
+    QString _snapshotDirectory;
+
+    QStringList _expectedImagesFilenames;
+    QStringList _expectedImagesFullFilenames;
+    QStringList _resultImagesFullFilenames;
+
+    // Used for accessing GitHub
+    const QString GIT_HUB_DEFAULT_USER{ "highfidelity" };
+    const QString GIT_HUB_DEFAULT_BRANCH{ "master" };
+    const QString GIT_HUB_REPOSITORY{ "hifi_tests" };
+
+    const QString DATETIME_FORMAT{ "yyyy-MM-dd_hh-mm-ss" };
+
+    // NOTE: these need to match the appropriate var's in nitpick.js
+    //    var advanceKey = "n";
+    //    var pathSeparator = ".";
+    const QString ADVANCE_KEY{ "n" };
+    const QString PATH_SEPARATOR{ "." };
+
+    bool _exitWhenComplete{ false };
+
+    TestRailInterface* _testRailInterface;
+    TestRailCreateMode _testRailCreateMode { PYTHON };
+
+    AWSInterface* _awsInterface;
+    Downloader* _downloader;
+};
+
+#endif