Merge pull request #14 from sandbox-science/testing

Init Unit Tests

Author: chrisdedman

CMakeLists.txt

@@ -1,7 +1,8 @@
 cmake_minimum_required(VERSION 3.16)
 
 # Project name
-set(TARGET_NAME CodeAstra)
+set(TARGET_NAME CodeAstraApp)
+set(EXECUTABLE_NAME CodeAstra)
 
 set(QT_MAJOR_VERSION 6)
 
@@ -47,11 +48,10 @@ endif()
 set(CMAKE_PREFIX_PATH ${Qt_DIR})
 
 # Find Qt Widgets
-find_package(Qt${QT_MAJOR_VERSION} COMPONENTS Widgets REQUIRED)
+find_package(Qt${QT_MAJOR_VERSION} COMPONENTS Widgets Test REQUIRED)
 
-# Add executable and source files
-add_executable(${TARGET_NAME}
-    src/main.cpp
+# Create the CodeAstra library
+add_library(${TARGET_NAME}
     src/MainWindow.cpp
     src/CodeEditor.cpp
     src/Syntax.cpp
@@ -65,29 +65,42 @@ add_executable(${TARGET_NAME}
     include/FileManager.h
 )
 
+# Create the executable for the application
+add_executable(${EXECUTABLE_NAME}
+    src/main.cpp
+)
+
+# Link the main executable with the CodeAstra library and Qt libraries
+target_link_libraries(${EXECUTABLE_NAME} PRIVATE ${TARGET_NAME} Qt${QT_MAJOR_VERSION}::Widgets)
+
+# Add the tests subdirectory
+add_subdirectory(tests)
+
+# Qt resource files
 qt_add_resources(APP_RESOURCES resources.qrc)
-target_sources(${TARGET_NAME} PRIVATE ${APP_RESOURCES})
+target_sources(${EXECUTABLE_NAME} PRIVATE ${APP_RESOURCES})
 
 # Compiler flags per OS
 if(MSVC)
-    target_compile_options(${TARGET_NAME} PRIVATE /W4 /WX)
+    target_compile_options(${EXECUTABLE_NAME} PRIVATE /W4 /WX)
 elseif(APPLE)
-    target_compile_options(${TARGET_NAME} PRIVATE -Wall -Wextra -pedantic -Werror)
-    set_target_properties(${TARGET_NAME} PROPERTIES MACOSX_BUNDLE TRUE)
+    target_compile_options(${EXECUTABLE_NAME} PRIVATE -Wall -Wextra -pedantic -Werror)
+    set_target_properties(${EXECUTABLE_NAME} PROPERTIES MACOSX_BUNDLE TRUE)
 else()
-    target_compile_options(${TARGET_NAME} PRIVATE -Wall -Wextra -pedantic -Werror)
+    target_compile_options(${EXECUTABLE_NAME} PRIVATE -Wall -Wextra -pedantic -Werror)
 endif()
 
 # Include directories
-target_include_directories(${TARGET_NAME} PRIVATE ${Qt${QT_MAJOR_VERSION}_INCLUDE_DIRS})
+target_include_directories(${EXECUTABLE_NAME} PRIVATE ${Qt${QT_MAJOR_VERSION}_INCLUDE_DIRS})
+target_include_directories(${EXECUTABLE_NAME} PRIVATE ${CMAKE_SOURCE_DIR}/include)
 target_include_directories(${TARGET_NAME} PRIVATE ${CMAKE_SOURCE_DIR}/include)
 
 # Set output names properly for Debug and Release
-set_target_properties(${TARGET_NAME} PROPERTIES 
+set_target_properties(${EXECUTABLE_NAME} PROPERTIES 
     RUNTIME_OUTPUT_DIRECTORY "${CMAKE_SOURCE_DIR}" 
-    DEBUG_OUTPUT_NAME "${TARGET_NAME}d" 
-    RELEASE_OUTPUT_NAME ${TARGET_NAME}
+    DEBUG_OUTPUT_NAME "${EXECUTABLE_NAME}d" 
+    RELEASE_OUTPUT_NAME ${EXECUTABLE_NAME}
 )
 
-# Link necessary Qt libraries
+# Link necessary Qt libraries to CodeAstra library
 target_link_libraries(${TARGET_NAME} PRIVATE Qt${QT_MAJOR_VERSION}::Widgets)

Makefile

@@ -75,3 +75,11 @@ install:
 		fi \
 	fi
 	@echo "$(PROJECT) installed."
+
+test:
+	@for test in ./build/tests/test_*; do \
+		if [ -f $$test ]; then \
+			echo "Running $$test..."; \
+			$$test; \
+		fi; \
+	done

include/FileManager.h

@@ -43,6 +43,8 @@ public slots:
     void openFile();
     void loadFileInEditor(const QString &filePath);
 
+    QString getDirectoryPath() const;
+
 private:
     FileManager(CodeEditor *editor, MainWindow *mainWindow);
     ~FileManager();

include/MainWindow.h

@@ -31,6 +31,10 @@ class MainWindow : public QMainWindow
     // of the main window, alongside the code editor
     void initTree();
 
+    QAction *createAction(const QIcon &icon, const QString &text,
+                          const QKeySequence &shortcut, const QString &statusTip,
+                          const std::function<void()> &slot);
+
 private slots:
     void showAbout();
 
@@ -40,10 +44,6 @@ private slots:
     void createHelpActions(QMenu *helpMenu);
     void createAppActions(QMenu *appMenu);
 
-    QAction *createAction(const QIcon &icon, const QString &text,
-                          const QKeySequence &shortcut, const QString &statusTip,
-                          const std::function<void()> &slot);
-
     std::unique_ptr<CodeEditor> m_editor;
     std::unique_ptr<Syntax> m_syntax;
     std::unique_ptr<Tree> m_tree;

include/Tree.h

@@ -22,20 +22,18 @@ class Tree : public QObject
     Q_OBJECT
 
 public:
-    explicit Tree(QSplitter *splitter, FileManager *FileManager);
+    explicit Tree(QSplitter *splitter);
     ~Tree();
 
-private:
-    void showContextMenu(const QPoint &pos);
-    void setupModel();
+    void initialize(const QString &directory);
+    void setupModel(const QString &directory);
     void setupTree();
     void openFile(const QModelIndex &index);
 
-    QString getDirectoryPath() const;
+private:
+    void showContextMenu(const QPoint &pos);
 
     std::unique_ptr<QFileIconProvider> m_iconProvider;
     std::unique_ptr<QFileSystemModel> m_model;
     std::unique_ptr<QTreeView> m_tree;
-
-    FileManager * m_FileManager;
 };

src/FileManager.cpp

@@ -1,11 +1,11 @@
 #include "FileManager.h"
+#include "CodeEditor.h"
+#include "MainWindow.h"
 
 #include <QFileDialog>
 #include <QMessageBox>
 #include <QTextStream>
 #include <QFileInfo>
-#include "CodeEditor.h"
-#include "MainWindow.h"
 
 FileManager::FileManager(CodeEditor *editor, MainWindow *mainWindow)
     : m_editor(editor), m_mainWindow(mainWindow)
@@ -144,3 +144,10 @@ QString FileManager::getFileExtension() const
 
     return QFileInfo(m_currentFileName).suffix().toLower();
 }
+
+QString FileManager::getDirectoryPath() const
+{
+    return QFileDialog::getExistingDirectory(
+        nullptr, QObject::tr("Open Directory"), QDir::homePath(),
+        QFileDialog::ShowDirsOnly | QFileDialog::DontResolveSymlinks);
+}

src/MainWindow.cpp

@@ -45,7 +45,7 @@ void MainWindow::initTree()
     QSplitter *splitter = new QSplitter(Qt::Horizontal, this);
     setCentralWidget(splitter);
 
-    m_tree = std::make_unique<Tree>(splitter, m_fileManager);
+    m_tree = std::make_unique<Tree>(splitter);
 
     splitter->addWidget(m_editor.get());
     splitter->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
@@ -62,8 +62,13 @@ void MainWindow::createMenuBar()
     QMenuBar *menuBar = new QMenuBar(this);
 
     QMenu *fileMenu = menuBar->addMenu("File");
+    fileMenu->setObjectName("File");
+
     QMenu *helpMenu = menuBar->addMenu("Help");
-    QMenu *appMenu  = menuBar->addMenu("CodeAstra");
+    helpMenu->setObjectName("Help");
+
+    QMenu *appMenu = menuBar->addMenu("CodeAstra");
+    appMenu->setObjectName("CodeAstra");
 
     createFileActions(fileMenu);
     createHelpActions(helpMenu);
@@ -75,6 +80,15 @@ void MainWindow::createMenuBar()
 void MainWindow::createFileActions(QMenu *fileMenu)
 {
     fileMenu->addAction(createAction(QIcon(), tr("&New"), QKeySequence::New, tr("Create a new file"), [this]() { m_fileManager->newFile(); }));
+    fileMenu->addSeparator();
+    fileMenu->addAction(createAction(QIcon(), tr("&Open &Project"), QKeySequence(Qt::CTRL | Qt::SHIFT | Qt::Key_O), tr("Open a project"), [this]()
+    { 
+        QString projectPath = m_fileManager->getDirectoryPath(); 
+        if (!projectPath.isEmpty())
+        { 
+            m_tree->initialize(projectPath);
+        }
+    }));
     fileMenu->addAction(createAction(QIcon(), tr("&Open"), QKeySequence::Open, tr("Open an existing file"), [this]() { m_fileManager->openFile(); }));
     fileMenu->addSeparator();
     fileMenu->addAction(createAction(QIcon(), tr("&Save"), QKeySequence::Save, tr("Save the current file"), [this]() { m_fileManager->saveFile(); }));

src/Syntax.cpp

@@ -1,4 +1,5 @@
 #include "Syntax.h"
+
 #include <QColor>
 #include <QFont>
 

src/Tree.cpp

@@ -9,24 +9,26 @@
 #include <QTreeView>
 #include <QMenu>
 
-Tree::Tree(QSplitter *splitter, FileManager *FileManager)
+Tree::Tree(QSplitter *splitter)
     : QObject(splitter),
       m_iconProvider(std::make_unique<QFileIconProvider>()),
       m_model(std::make_unique<QFileSystemModel>()),
-      m_tree(std::make_unique<QTreeView>(splitter)),
-      m_FileManager(FileManager)
+      m_tree(std::make_unique<QTreeView>(splitter))
 {
-    setupModel();
-    setupTree();
-
     connect(m_tree.get(), &QTreeView::doubleClicked, this, &Tree::openFile);
 }
 
 Tree::~Tree() {}
 
-void Tree::setupModel()
+void Tree::initialize(const QString &directory)
 {
-    m_model->setRootPath(getDirectoryPath());
+    setupModel(directory);
+    setupTree();
+}
+
+void Tree::setupModel(const QString &directory)
+{
+    m_model->setRootPath(directory);
     m_model->setIconProvider(m_iconProvider.get());
     m_model->setFilter(QDir::AllEntries | QDir::Hidden | QDir::NoDotAndDotDot);
 }
@@ -51,13 +53,6 @@ void Tree::setupTree()
     connect(m_tree.get(), &QTreeView::customContextMenuRequested, this, &Tree::showContextMenu);
 }
 
-QString Tree::getDirectoryPath() const
-{
-    return QFileDialog::getExistingDirectory(
-        nullptr, QObject::tr("Open Directory"), QDir::homePath(),
-        QFileDialog::ShowDirsOnly | QFileDialog::DontResolveSymlinks);
-}
-
 void Tree::openFile(const QModelIndex &index)
 {
     QString filePath = m_model->filePath(index);

tests/CMakeLists.txt

@@ -0,0 +1,35 @@
+# Enable testing
+enable_testing()
+
+# Add individual test executables
+add_executable(test_mainwindow
+    test_mainwindow.cpp
+)
+
+# Add test_tree executable
+add_executable(test_tree
+    test_tree.cpp
+)
+
+# Link the test with the CodeAstra library and necessary Qt libraries
+target_link_libraries(test_mainwindow PRIVATE ${TARGET_NAME} Qt6::Widgets Qt6::Test)
+target_link_libraries(test_tree PRIVATE ${TARGET_NAME} Qt6::Widgets Qt6::Test)
+
+# Register each test with CTest
+add_test(NAME test_mainwindow COMMAND test_mainwindow)
+add_test(NAME test_tree COMMAND test_tree)
+
+# Set the runtime output directory for the test executables
+set_target_properties(test_mainwindow PROPERTIES
+    RUNTIME_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/build/tests
+)
+set_target_properties(test_tree PROPERTIES
+    RUNTIME_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/build/tests
+)
+
+set_property(SOURCE test_mainwindow.cpp PROPERTY SKIP_AUTOMOC OFF)
+set_property(SOURCE test_tree.cpp PROPERTY SKIP_AUTOMOC OFF)
+
+# Include directories for tests
+target_include_directories(test_mainwindow PRIVATE ${CMAKE_SOURCE_DIR}/include)
+target_include_directories(test_tree PRIVATE ${CMAKE_SOURCE_DIR}/include)