Merge pull request #70 from NuiCpp/devel

5cript · web-flow · commit 0926d2f929c2 · 2023-09-05T23:41:28.000+02:00
Added Tests and Example App to Actions
diff --git a/.github/workflows/build_and_test.yml b/.github/workflows/build_and_test.yml
@@ -8,7 +8,7 @@ on:
 
 env:
   # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
-  BUILD_TYPE: Release
+  BUILD_TYPE: Debug
 
 jobs:
   ubuntu:
@@ -35,19 +35,16 @@ jobs:
           platform_version: 22.04
 
       - name: Configure CMake
-        run: cmake -B ${{github.workspace}}/build/clang_${{env.BUILD_TYPE}} -G"Ninja" -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DNUI_BUILD_EXAMPLES=off -DCMAKE_CXX_EXTENSIONS=on -DCMAKE_CXX_FLAGS="-fuse-ld=lld" -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_COMPILER=clang -DCMAKE_LINKER=lld -DCMAKE_CXX_STANDARD=20
+        run: cmake -B ${{github.workspace}}/build/clang_${{env.BUILD_TYPE}} -G"Ninja" -DNUI_ENABLE_TESTS=on -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DNUI_BUILD_EXAMPLES=on -DCMAKE_CXX_EXTENSIONS=on -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_COMPILER=clang -DCMAKE_LINKER=lld -DCMAKE_CXX_STANDARD=20
         env:
           BOOST_ROOT: ${{ steps.install-boost.outputs.BOOST_ROOT }}
 
       - name: Build
         run: cmake --build ${{github.workspace}}/build/clang_${{env.BUILD_TYPE}} --config ${{env.BUILD_TYPE}}
 
-    # TODO:
-    #- name: Test
-    #  working-directory: ${{github.workspace}}/build/clang_${{env.BUILD_TYPE}}
-    # Execute tests defined by the CMake configuration.
-    # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
-    # run: ctest -C ${{env.BUILD_TYPE}}
+      - name: Test
+        working-directory: ${{github.workspace}}/build/clang_${{env.BUILD_TYPE}}
+        run: ./tests/nui-tests
 
   ubuntu20:
     runs-on: ubuntu-20.04
@@ -76,13 +73,17 @@ jobs:
           platform: x64
 
       - name: Configure CMake
-        run: cmake -B ${{github.workspace}}/build/clang_${{env.BUILD_TYPE}} -G"Ninja" -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DNUI_BUILD_EXAMPLES=off -DCMAKE_CXX_EXTENSIONS=on -DCMAKE_CXX_COMPILER=c++ -DCMAKE_C_COMPILER=cc -DCMAKE_CXX_STANDARD=20
+        run: cmake -B ${{github.workspace}}/build/clang_${{env.BUILD_TYPE}} -G"Ninja" -DNUI_ENABLE_TESTS=on -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DNUI_BUILD_EXAMPLES=on -DCMAKE_CXX_EXTENSIONS=on -DCMAKE_CXX_COMPILER=c++ -DCMAKE_C_COMPILER=cc -DCMAKE_CXX_STANDARD=20
         env:
           BOOST_ROOT: ${{ steps.install-boost.outputs.BOOST_ROOT }}
 
       - name: Build
         run: cmake --build ${{github.workspace}}/build/clang_${{env.BUILD_TYPE}} --config ${{env.BUILD_TYPE}}
 
+      - name: Test
+        working-directory: ${{github.workspace}}/build/clang_${{env.BUILD_TYPE}}
+        run: ./tests/nui-tests
+
   windows-msys2:
     runs-on: windows-2022
     defaults:
@@ -101,7 +102,11 @@ jobs:
         run: echo "WSPACE=$(cygpath '${{github.workspace}}')" >> $GITHUB_ENV
 
       - name: Configure CMake
-        run: cmake -B ${{env.WSPACE}}/build/clang_${{env.BUILD_TYPE}} -G"Ninja" -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DNUI_BUILD_EXAMPLES=off -DCMAKE_CXX_EXTENSIONS=on -DCMAKE_CXX_FLAGS="-fuse-ld=lld" -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_COMPILER=clang -DCMAKE_LINKER=lld -DCMAKE_CXX_STANDARD=20
+        run: cmake -B ${{env.WSPACE}}/build/clang_${{env.BUILD_TYPE}} -G"Ninja" -DNUI_ENABLE_TESTS=on -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DNUI_BUILD_EXAMPLES=off -DCMAKE_CXX_EXTENSIONS=on -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_COMPILER=clang -DCMAKE_LINKER=lld -DCMAKE_CXX_STANDARD=20
 
       - name: Build
         run: cmake --build ${{env.WSPACE}}/build/clang_${{env.BUILD_TYPE}} --config ${{env.BUILD_TYPE}}
+
+      - name: Test
+        working-directory: ${{github.workspace}}/build/clang_${{env.BUILD_TYPE}}
+        run: ./tests/nui-tests.exe
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -15,8 +15,6 @@ include(${CMAKE_CURRENT_LIST_DIR}/cmake/dependencies/describe.cmake)
 include(${CMAKE_CURRENT_LIST_DIR}/cmake/dependencies/mp11.cmake)
 if (EMSCRIPTEN)
     include(${CMAKE_CURRENT_LIST_DIR}/cmake/dependencies/libcpppre.cmake)
-    include(${CMAKE_CURRENT_LIST_DIR}/cmake/frontend/common.cmake)
-    include(${CMAKE_CURRENT_LIST_DIR}/cmake/frontend/options.cmake)
     include(${CMAKE_CURRENT_LIST_DIR}/cmake/frontend/emscripten.cmake)
 else()
     if (${NUI_ENABLE_TESTS})
@@ -33,7 +31,6 @@ else()
     add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/tools/parcel_adapter)
     add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/tools/patch_emscripten_config)
     include(${CMAKE_CURRENT_LIST_DIR}/cmake/backend/common.cmake)
-    include(${CMAKE_CURRENT_LIST_DIR}/cmake/backend/options.cmake)
     include(${CMAKE_CURRENT_LIST_DIR}/cmake/backend/emscripten.cmake)
 endif()
 
@@ -43,6 +40,7 @@ endif()
 add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/nui/src/nui)
 
 if (${NUI_ENABLE_TESTS})
+    enable_testing()
     include(${CMAKE_CURRENT_LIST_DIR}/cmake/dependencies/gtest.cmake)
     add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/nui/test/nui)
 endif()
diff --git a/cmake/backend/emscripten.cmake b/cmake/backend/emscripten.cmake
@@ -1,5 +1,3 @@
-project(emscripten-git NONE)
-
 if(UNIX)
     add_custom_command(
         OUTPUT "${CMAKE_BINARY_DIR}/_deps/emscripten-src/upstream/emscripten/.emscripten"
@@ -78,8 +76,8 @@ function(nui_add_emscripten_target)
         SOURCE_DIR "${SOURCE_DIR}"
         # emscripten cmake with passed down Release/Debug build type
         CONFIGURE_COMMAND 
-            ${EMCMAKE} cmake 
-                ${NUI_ADD_EMSCRIPTEN_TARGET_ARGS_CMAKE_OPTIONS} 
+            ${EMCMAKE} cmake
+                ${NUI_ADD_EMSCRIPTEN_TARGET_ARGS_CMAKE_OPTIONS}
                 "${SOURCE_DIR}"
         # copy over package.json and fill parcel options that do not exist on it
         BUILD_COMMAND $<TARGET_FILE:parcel-adapter> "${SOURCE_DIR}/package.json" "${CMAKE_BINARY_DIR}/module_${NUI_ADD_EMSCRIPTEN_TARGET_ARGS_TARGET}/package.json" "${NUI_ADD_EMSCRIPTEN_TARGET_ARGS_TARGET}"
diff --git a/cmake/backend/options.cmake b/cmake/backend/options.cmake
diff --git a/cmake/frontend/options.cmake b/cmake/frontend/options.cmake
diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt
@@ -0,0 +1 @@
+add_subdirectory(basic)
diff --git a/examples/basic/.gitignore b/examples/basic/.gitignore
@@ -0,0 +1,8 @@
+build
+_build
+.vscode
+.vs
+.idea
+out
+CMakeSettings.json
+node_modules
diff --git a/examples/basic/.parcelrc b/examples/basic/.parcelrc
@@ -0,0 +1,7 @@
+{
+  "extends": "@parcel/config-default",
+  "reporters": [
+    "...",
+    "parcel-reporter-static-files-copy"
+  ]
+}
diff --git a/examples/basic/CMakeLists.txt b/examples/basic/CMakeLists.txt
@@ -0,0 +1,17 @@
+cmake_minimum_required(VERSION 3.21)
+
+project(nui-template VERSION 0.1.0)
+
+include (${CMAKE_CURRENT_LIST_DIR}/_cmake/common_options.cmake)
+
+# Add executable (sources are added later, depending on frontend/backend)
+add_executable(basic-example)
+set_common_options(basic-example)
+
+set(PREJS_FILE ${CMAKE_CURRENT_LIST_DIR}/frontend/source/frontend/js/module.js)
+
+if (EMSCRIPTEN)  
+    add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/frontend/source/frontend)
+else()
+	add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/backend/source/backend)
+endif()
diff --git a/examples/basic/LICENSE b/examples/basic/LICENSE
@@ -0,0 +1,23 @@
+Boost Software License - Version 1.0 - August 17th, 2003
+
+Permission is hereby granted, free of charge, to any person or organization
+obtaining a copy of the software and accompanying documentation covered by
+this license (the "Software") to use, reproduce, display, distribute,
+execute, and transmit the Software, and to prepare derivative works of the
+Software, and to permit third-parties to whom the Software is furnished to
+do so, all subject to the following:
+
+The copyright notices in the Software and this entire statement, including
+the above license grant, this restriction and the following disclaimer,
+must be included in all copies of the Software, in whole or in part, and
+all derivative works of the Software, unless such copies or derivative
+works are solely in the form of machine-executable object code generated by
+a source language processor.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/examples/basic/README.md b/examples/basic/README.md
@@ -0,0 +1,22 @@
+# nui-template
+A template repository to base new projects off of.
+This is a template for projects using Nui https://github.com/NuiCpp/Nui.
+
+## Transform into your own project:
+Rename the project "nui-template" in your cmake file to what your project is called.
+
+## Dependencies
+You need the following things installed to get going.
+- clang 15 oder higher.
+- npm (available from the environment variable PATH)
+- boost
+- libcurl
+- crypto++
+- binaryen
+
+### Windows
+Visual Studio and msys2 are supported.
+To know more read the documentation here: TODO.
+
+### Linux 
+Install gtk+-3.0 and webkit2gtk-4.0 for webview, more information here: https://github.com/webview/webview
diff --git a/examples/basic/_cmake/common_options.cmake b/examples/basic/_cmake/common_options.cmake
@@ -0,0 +1,12 @@
+function(set_common_options TARGET)
+    if (${MSVC})
+        set(WARNINGS -Wmost)
+    else()
+        set(WARNINGS -Wall -Wextra -Wpedantic)
+    endif()
+    set(COMMON_OPTIONS ${WARNINGS} -fexceptions -pedantic)
+    set(DEBUG_OPTIONS  -g ${COMMON_OPTIONS})
+    set(RELEASE_OPTIONS -O3 ${COMMON_OPTIONS})
+    target_compile_options(${TARGET} PUBLIC "$<$<CONFIG:DEBUG>:${DEBUG_OPTIONS}>")
+    target_compile_options(${TARGET} PUBLIC "$<$<CONFIG:RELEASE>:${RELEASE_OPTIONS}>")
+endfunction()
diff --git a/examples/basic/backend/source/backend/CMakeLists.txt b/examples/basic/backend/source/backend/CMakeLists.txt
@@ -0,0 +1,25 @@
+target_sources(basic-example PRIVATE main.cpp)	
+
+target_include_directories(basic-example PRIVATE ${CMAKE_CURRENT_LIST_DIR}/../../include)
+
+# Link backend of nui outside of emscripten
+target_link_libraries(basic-example PRIVATE nui-backend)
+
+set_target_properties(basic-example
+    PROPERTIES
+    RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin/examples/basic-example"
+)
+
+# Creates a target that is compiled through emscripten. This target becomes the frontend part.
+nui_add_emscripten_target(basic-example
+    TARGET
+        basic-example
+    PREJS 
+        ${PREJS_FILE}
+    SOURCE_DIR
+        ${CMAKE_SOURCE_DIR}
+    CMAKE_OPTIONS
+        "-DNUI_BUILD_EXAMPLES=on"
+        # I recommend to work with a release build by default because debug builds get big fast.
+        "-DCMAKE_BUILD_TYPE=Release"
+)
diff --git a/examples/basic/backend/source/backend/main.cpp b/examples/basic/backend/source/backend/main.cpp
@@ -0,0 +1,14 @@
+#include <nui/core.hpp>
+#include <nui/window.hpp>
+
+// This file is generated by nui.
+#include <index.hpp>
+
+int main() {
+  using namespace Nui;
+
+  Window window{{.title = "Nui", .debug = true /* may open dev tools */}};
+  window.setSize(480, 320, WebViewHint::WEBVIEW_HINT_NONE);
+  window.setHtml(index());
+  window.run();
+}
diff --git a/examples/basic/frontend/include/frontend/main_page.hpp b/examples/basic/frontend/include/frontend/main_page.hpp
@@ -0,0 +1,8 @@
+#pragma once
+
+#include <nui/frontend/element_renderer.hpp>
+
+class MainPage {
+public:
+  Nui::ElementRenderer render();
+};
diff --git a/examples/basic/frontend/source/frontend/CMakeLists.txt b/examples/basic/frontend/source/frontend/CMakeLists.txt
@@ -0,0 +1,20 @@
+target_sources(basic-example PRIVATE main.cpp main_page.cpp)
+
+target_include_directories(basic-example PRIVATE ${CMAKE_CURRENT_LIST_DIR}/../../include)
+
+# Link frontend of nui inside of emscripten
+target_link_libraries(basic-example PRIVATE nui-frontend)
+
+nui_prepare_emscripten_target(
+    TARGET
+        basic-example
+    PARCEL_ARGS
+    PREJS
+        ${PREJS_FILE}
+    EMSCRIPTEN_LINK_OPTIONS
+        -sEXPORTED_FUNCTIONS=_frontendMain
+        -O2
+        -sALLOW_MEMORY_GROWTH=1 
+    EMSCRIPTEN_COMPILE_OPTIONS
+        -O3
+)
diff --git a/examples/basic/frontend/source/frontend/js/module.js b/examples/basic/frontend/source/frontend/js/module.js
@@ -0,0 +1,5 @@
+var Module = {
+    onRuntimeInitialized: () => {
+        Module.main();
+    }
+};
diff --git a/examples/basic/frontend/source/frontend/main.cpp b/examples/basic/frontend/source/frontend/main.cpp
@@ -0,0 +1,24 @@
+#include <frontend/main_page.hpp>
+
+#include <nui/core.hpp>
+#include <nui/window.hpp>
+
+#include <nui/frontend/dom/dom.hpp>
+
+#include <memory>
+
+static std::unique_ptr<MainPage> mainPage{};
+static std::unique_ptr<Nui::Dom::Dom> dom{};
+
+extern "C" void frontendMain()
+{
+    mainPage = std::make_unique<MainPage>();
+    dom = std::make_unique<Nui::Dom::Dom>();
+    dom->setBody(mainPage->render());
+}
+
+EMSCRIPTEN_BINDINGS(nui_example_frontend)
+{
+    emscripten::function("main", &frontendMain);
+}
+#include <nui/frontend/bindings.hpp>
diff --git a/examples/basic/frontend/source/frontend/main_page.cpp b/examples/basic/frontend/source/frontend/main_page.cpp
@@ -0,0 +1,11 @@
+#include <frontend/main_page.hpp>
+
+#include <nui/frontend/elements.hpp>
+
+Nui::ElementRenderer MainPage::render() {
+  using namespace Nui;
+  using namespace Nui::Elements;
+  using Nui::Elements::div; // because of the global div.
+
+  return body{}("Hello World");
+}
diff --git a/examples/basic/package.json b/examples/basic/package.json
@@ -0,0 +1,14 @@
+{
+    "description": "",
+    "name": "nui-template",
+    "version": "1.0.0",
+    "devDependencies": {
+        "parcel": "^2.9.1",
+        "parcel-reporter-static-files-copy": "^1.5.0"
+    },
+    "staticFiles": {
+        "staticPath": "static/assets",
+        "staticOutPath": "assets",
+        "distDir": "../bin"
+    }
+}
diff --git a/examples/basic/static/assets/README.md b/examples/basic/static/assets/README.md
@@ -0,0 +1 @@
+Put images here and other things to copy next to the executeable.
diff --git a/examples/basic/static/index.html b/examples/basic/static/index.html
@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Nui</title>
+
+    <!-- You have to import like this to achieve inlining of the style -->
+    <style>
+        @import "./styles/main.css";
+    </style>
+
+    <!-- You have to import like this to achieve inlining of the script -->
+    <script type="module" defer>
+        import "./source/index.js";
+        import "../bin/index.js";
+    </script>
+</head>
+<body>
+</body>
diff --git a/examples/basic/static/source/index.js b/examples/basic/static/source/index.js
@@ -0,0 +1,3 @@
+(() => {
+    // This is an example source file for javascript that assists your app.
+})();
diff --git a/examples/basic/static/styles/main.css b/examples/basic/static/styles/main.css
diff --git a/examples/basic/vcpkg.json b/examples/basic/vcpkg.json
@@ -0,0 +1,10 @@
+{
+    "name": "nui-template",
+    "dependencies": [
+        "boost",
+        "openssl",
+        "cryptopp",
+        "curl"
+    ],
+    "builtin-baseline": "c6592ce60ff394049905365865f59e3a4d93d35b"
+}
diff --git a/nui/include/nui/frontend/elements/impl/html_element.hpp b/nui/include/nui/frontend/elements/impl/html_element.hpp
diff --git a/nui/include/nui/frontend/elements/impl/html_element.tpp b/nui/include/nui/frontend/elements/impl/html_element.tpp
diff --git a/nui/test/nui/CMakeLists.txt b/nui/test/nui/CMakeLists.txt
diff --git a/nui/test/nui/engine/array.cpp b/nui/test/nui/engine/array.cpp
diff --git a/nui/test/nui/engine/reference_type.hpp b/nui/test/nui/engine/reference_type.hpp
diff --git a/tools/parcel_adapter/main.cpp b/tools/parcel_adapter/main.cpp

-Original file line number
+Diff line change
@@ @@ -0,0 +1,8 @@ @@
 +build
 +_build
 +.vscode
 +.vs
 +.idea
 +out
 +CMakeSettings.json
 +node_modules