Cleanup and output JUnit

Author: toroidal-code

.github/workflows/test.yml

@@ -10,7 +10,7 @@ on:
       - main
 
 jobs:
-  build:
+  build-and-test:
     runs-on: ${{ matrix.os }}
 
     strategy:
@@ -43,3 +43,33 @@ jobs:
 
     - name: Test
       run: ctest --test-dir build --build-config Release
+
+    - name: Upload Test Results
+      uses: actions/upload-artifact@v4
+      if: always()
+      with:
+        name: Test Results
+        path: build/spec/results/*.xml
+
+  publish-test-results:
+    name: "Publish Tests Results"
+    needs: build-and-test
+    runs-on: ubuntu-latest
+    permissions:
+      checks: write
+
+      # only needed unless run with comment_mode: off
+      pull-requests: write
+
+    if: always()
+
+    steps:
+      - name: Download Artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: artifacts
+
+      - name: Publish Test Results
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        with:
+          files: "artifacts/**/*.xml"

CMakeLists.txt

@@ -56,7 +56,7 @@ endif()
 # HELPERS
 
 # Add spec
-function(add_spec source_file)
+function(add_spec source_file args)
   cmake_path(GET source_file STEM spec_name)
   add_executable(${spec_name} ${source_file})
   target_link_libraries(${spec_name} c++spec)
@@ -65,18 +65,27 @@ function(add_spec source_file)
     CXX_STANDARD 23
     CXX_STANDARD_REQUIRED YES
   )
-  add_test(NAME ${spec_name} COMMAND ${spec_name} --verbose)
+  add_test(NAME ${spec_name} COMMAND ${spec_name} --verbose ${args})
 endfunction(add_spec)
 
 # Discover Specs
 function(discover_specs spec_folder)
   file(GLOB_RECURSE specs ${spec_folder}/*_spec.cpp)
 
   foreach(spec IN LISTS specs)
-    add_spec(${spec})
+    add_spec(${spec} "")
   endforeach()
 endfunction(discover_specs)
 
+function(discover_specs_output_junit spec_folder)
+  file(GLOB_RECURSE specs ${spec_folder}/*_spec.cpp)
+
+  foreach(spec IN LISTS specs)
+    cmake_path(GET spec STEM spec_name)
+    add_spec(${spec} "--output-junit;${CMAKE_CURRENT_BINARY_DIR}/results/${spec_name}.xml")
+  endforeach()
+endfunction(discover_specs_output_junit)
+
 # OPTIONS
 option(CPPSPEC_BUILD_TESTS "Build C++Spec tests")
 option(CPPSPEC_BUILD_EXAMPLES "Build C++Spec examples")

include/argparse.hpp

@@ -60,6 +60,11 @@ inline Runner parse(int argc, char** const argv) {
 
   auto junit_output_filepath = program.get<std::string>("--output-junit");
   if (!junit_output_filepath.empty()) {
+    // create directories recursively if they don't exist
+    std::filesystem::path junit_output_path = junit_output_filepath;
+    std::filesystem::create_directories(junit_output_path.parent_path());
+
+    // open file stream
     auto* file_stream = new std::ofstream(junit_output_filepath);
     auto junit_output = std::make_shared<Formatters::JUnitXML>(*file_stream, false);
     return Runner{formatter, junit_output};

include/class_description.hpp

@@ -26,17 +26,16 @@ class ClassDescription : public Description {
   std::string type;
 
  public:
-  const bool has_subject = true;
   T subject;  // subject field public for usage in `expect([self.]subject)`
 
   // Constructor
   // if there's no explicit subject given, then use
   // the default constructor of the given type as the implicit subject.
   ClassDescription(Block block, std::source_location location = std::source_location::current())
-      : block(block), type(" : " + Util::demangle(typeid(T).name())), subject(T()) {
-    this->description = Pretty::to_word(subject);
-    this->set_location(location);
-  }
+      : Description(location, Pretty::to_word(subject)),
+        block(block),
+        type(" : " + Util::demangle(typeid(T).name())),
+        subject(T()) {}
 
   ClassDescription(const char* description,
                    Block block,
@@ -67,7 +66,7 @@ class ClassDescription : public Description {
       : Description(location, Pretty::to_word(subject)),
         block(block),
         type(" : " + Util::demangle(typeid(T).name())),
-        subject(std::move(subject)) {}
+        subject(std::forward<U>(subject)) {}
 
   template <typename U>
   ClassDescription(std::initializer_list<U> init_list,
@@ -85,7 +84,7 @@ class ClassDescription : public Description {
                    std::source_location location = std::source_location::current())
       : Description(location, description), block(block), subject(T(init_list)) {}
 
-  ItCD<T>& it(const char* description,
+  ItCD<T>& it(const char* name,
               std::function<void(ItCD<T>&)> block,
               std::source_location location = std::source_location::current());
   ItCD<T>& it(std::function<void(ItCD<T>&)> block, std::source_location location = std::source_location::current());
@@ -114,7 +113,7 @@ class ClassDescription : public Description {
 
   template <class U, class B>
   ClassDescription<U>& context(U&& subject, B block, std::source_location location = std::source_location::current()) {
-    return this->context("", subject, block, location);
+    return this->context("", std::forward<U>(subject), block, location);
   }
   void run() override;
 
@@ -149,7 +148,7 @@ ClassContext<U>& ClassDescription<T>::context(const char* description,
                                               U&& subject,
                                               B block,
                                               std::source_location location) {
-  auto* context = this->make_child<ClassContext<U>>(description, subject, block, location);
+  auto* context = this->make_child<ClassContext<U>>(description, std::forward<U>(subject), block, location);
   context->ClassContext<U>::before_eaches = this->before_eaches;
   context->ClassContext<U>::after_eaches = this->after_eaches;
   context->timed_run();
@@ -186,7 +185,7 @@ ClassContext<T>& Description::context(const char* description, T& subject, B blo
 
 template <Util::not_c_string T, class B>
 ClassContext<T>& Description::context(T&& subject, B block, std::source_location location) {
-  auto* context = this->make_child<ClassContext<T>>(subject, block, location);
+  auto* context = this->make_child<ClassContext<T>>(std::forward<T>(subject), block, location);
   context->before_eaches = this->before_eaches;
   context->after_eaches = this->after_eaches;
   context->timed_run();
@@ -195,7 +194,7 @@ ClassContext<T>& Description::context(T&& subject, B block, std::source_location
 
 template <class T, class B>
 ClassContext<T>& Description::context(const char* description, T&& subject, B block, std::source_location location) {
-  auto* context = this->make_child<ClassContext<T>>(description, subject, block, location);
+  auto* context = this->make_child<ClassContext<T>>(description, std::forward<T>(subject), block, location);
   context->before_eaches = this->before_eaches;
   context->after_eaches = this->after_eaches;
   context->timed_run();

include/description.hpp

@@ -23,11 +23,10 @@ class Description : public Runnable {
  public:
   using Block = std::function<void(Description&)>;
 
-  const bool has_subject = false;
-  std::forward_list<LetBase*> lets{};
-  std::deque<VoidBlock> after_alls{};
-  std::deque<VoidBlock> before_eaches{};
-  std::deque<VoidBlock> after_eaches{};
+  std::forward_list<LetBase*> lets;
+  std::deque<VoidBlock> after_alls;
+  std::deque<VoidBlock> before_eaches;
+  std::deque<VoidBlock> after_eaches;
 
  private:
   Block block;
@@ -43,25 +42,27 @@ class Description : public Runnable {
   Description(const char* description,
               Block block,
               std::source_location location = std::source_location::current()) noexcept
-      : Runnable(location), block(block), description(description) {
+      : Runnable(location), block(std::move(block)), description(description) {
     this->set_location(location);
   }
 
   Description(std::source_location location, std::string&& description) noexcept
       : Runnable(location), description(std::move(description)) {}
 
   Description(std::source_location location, const char* description, Block block) noexcept
-      : Runnable(location), block(block), description(description) {}
+      : Runnable(location), block(std::move(block)), description(description) {}
 
   /********* Specify/It *********/
 
-  ItD& it(const char* description, ItD::Block body, std::source_location location = std::source_location::current());
+  ItD& it(const char* name, ItD::Block body, std::source_location location = std::source_location::current());
   ItD& it(ItD::Block body, std::source_location location = std::source_location::current());
 
   /********* Context ***********/
 
   template <class T = std::nullptr_t>
-  Description& context(const char* name, Block body, std::source_location location = std::source_location::current());
+  Description& context(const char* description,
+                       Block body,
+                       std::source_location location = std::source_location::current());
 
   template <Util::not_c_string T, class B>
   ClassDescription<T>& context(T& subject, B block, std::source_location location = std::source_location::current());
@@ -119,7 +120,7 @@ using Context = Description;
 /*========= Description::it =========*/
 
 inline ItD& Description::it(const char* description, ItD::Block block, std::source_location location) {
-  auto it = this->make_child<ItD>(location, description, block);
+  auto* it = this->make_child<ItD>(location, description, block);
   it->timed_run();
   exec_after_eaches();
   exec_before_eaches();
@@ -174,13 +175,15 @@ inline void Description::after_all(VoidBlock b) {
 /*----------- private -------------*/
 
 inline void Description::exec_before_eaches() {
-  for (VoidBlock& b : before_eaches)
+  for (VoidBlock& b : before_eaches) {
     b();
+  }
 }
 
 inline void Description::exec_after_eaches() {
-  for (VoidBlock& b : after_eaches)
+  for (VoidBlock& b : after_eaches) {
     b();
+  }
 }
 
 /*========= Description::let =========*/
@@ -208,8 +211,9 @@ auto Description::let(T block) -> Let<decltype(block())> {
 // TODO: Should this be protected?
 inline void Description::reset_lets() noexcept {
   // For every let in our list, reset it.
-  for (auto& let : lets)
+  for (auto& let : lets) {
     let->reset();
+  }
 
   // Recursively reset all the lets in the family tree
   if (this->has_parent()) {
@@ -221,8 +225,9 @@ inline void Description::reset_lets() noexcept {
 
 inline void Description::run() {
   block(*this);  // Run the block
-  for (VoidBlock& a : after_alls)
+  for (VoidBlock& a : after_alls) {
     a();  // Run all our after_alls
+  }
 }
 
 /*>>>>>>>>>>>>>>>>>>>> ItD <<<<<<<<<<<<<<<<<<<<<<<<<*/