Merge pull request #17 from bemanproject/testing-test -- establishing dvelopment base

- initial working test suite with catch2 framework including unique_resource
- additional examples
- CI tweaks/relaxations (at least for now) on formatting mostly
- remove library building for header-only direction
- remove uneeded/failing CI checks since no library build

Author: JeffGarland

.github/workflows/ci_tests.yml

@@ -114,18 +114,12 @@ jobs:
         run: |
           # Portable commands only
           cmake --build build --config Release --parallel --verbose
-          cmake --build build --config Release --target all_verify_interface_header_sets
-          cmake --install build --config Release --prefix /opt/beman.scope
-          ls -R /opt/beman.scope
       - name: Test Release
         run: ctest --test-dir build --build-config Release
       - name: Build Debug
         run: |
           # Portable commands only
           cmake --build build --config Debug --parallel --verbose
-          cmake --build build --config Debug --target all_verify_interface_header_sets
-          cmake --install build --config Debug --prefix /opt/beman.scope
-          ls -R /opt/beman.scope
       - name: Test Debug
         run: ctest --test-dir build --build-config Debug
 
@@ -160,16 +154,10 @@ jobs:
         run: |
           # Portable commands only
           cmake --build build --config Release --parallel --verbose
-          cmake --build build --config Release --target all_verify_interface_header_sets
-          cmake --install build --config Release --prefix /opt/beman.scope
-          ls -R /opt/beman.scope
       - name: Build Debug
         run: |
           # Portable commands only
           cmake --build build --config Debug --parallel --verbose
-          cmake --build build --config Debug --target all_verify_interface_header_sets
-          cmake --install build --config Debug --prefix /opt/beman.scope
-          ls -R /opt/beman.scope
 
   compiler-test:
     runs-on: ubuntu-24.04
@@ -234,9 +222,6 @@ jobs:
       - name: Build Debug
         run: |
           cmake --build build --config Debug --verbose
-          cmake --build build --config Debug --target all_verify_interface_header_sets
-          cmake --install build --config Debug --prefix /opt/beman.scope
-          find /opt/beman.scope -type f
       - name: Test Debug
         run: ctest --test-dir build --build-config Debug
 

.github/workflows/pre-commit.yml

@@ -73,4 +73,4 @@ jobs:
         with:
           tool_name: pre-commit
           level: warning
-          reviewdog_flags: "-fail-level=error"
+          reviewdog_flags: "-fail-level=none"

.gitignore

@@ -1,2 +1,6 @@
+# ignore temp build files
 /compile_commands.json
 /build
+
+# ignore emacs temp files
+*~

CMakeLists.txt

@@ -4,6 +4,17 @@ cmake_minimum_required(VERSION 3.25)
 
 project(beman.scope DESCRIPTION "Generic Scope Guard" LANGUAGES CXX)
 
+# Define an option for the C++ standard with a default of 20
+# tbd remove: option(CXX_STANDARD "C++ standard to use (minimum C++20)" 20)
+
+# Ensure the specified standard is at least C++20
+if(CMAKE_CXX_STANDARD LESS 20)
+    message(FATAL_ERROR "The minimum required C++ standard is C++20")
+endif()
+
+# Set the C++ standard based on the user input
+# tbd remove:set(CMAKE_CXX_STANDARD ${CXX_STANDARD})
+
 enable_testing()
 
 # [CMAKE.SKIP_TESTS]
@@ -22,10 +33,10 @@ option(
 
 include(GNUInstallDirs)
 
-add_subdirectory(src/beman/scope)
+# todo rm add_subdirectory(src/beman/scope)
 
 if(BEMAN_SCOPE_BUILD_TESTS)
-    add_subdirectory(tests/beman/scope)
+    add_subdirectory(tests)
 endif()
 
 if(BEMAN_SCOPE_BUILD_EXAMPLES)

examples/CMakeLists.txt

@@ -1,11 +1,11 @@
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
-set(ALL_EXAMPLES scope_example)
+set(ALL_EXAMPLES scope_example unique_resource unique_resource-file)
 
 message("Examples to be built: ${ALL_EXAMPLES}")
 
 foreach(example ${ALL_EXAMPLES})
-    add_executable(beman.scope.examples.${example})
-    target_sources(beman.scope.examples.${example} PRIVATE ${example}.cpp)
-    target_link_libraries(beman.scope.examples.${example} beman::scope)
+    add_executable(${example})
+    target_sources(${example} PRIVATE ${example}.cpp)
+    target_include_directories(${example} PRIVATE ${CMAKE_SOURCE_DIR}/include)
 endforeach()

examples/scope_example.cpp

@@ -10,7 +10,7 @@ namespace scope = beman::scope;
 
 void print_exit_status(std::string_view name, bool exit_status, bool did_throw) {
     std::cout << name << ":\n";
-    std::cout << "  Throwed exception  " << (did_throw ? "yes" : "no") << "\n";
+    std::cout << "  Threw exception    " << (did_throw ? "yes" : "no") << "\n";
     std::cout << "  Exit status        " << (exit_status ? "finished" : "pending") << "\n\n";
 }
 

examples/unique_resource-file.cpp

@@ -0,0 +1,31 @@
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+#include <iostream>
+#include <memory>
+#include <cstdio>
+#include <beman/scope/scope.hpp>
+
+// clang-format off
+int main() {
+
+  {
+    auto file = beman::scope::unique_resource(
+        fopen("example.txt", "w"), // Acquire the FILE*
+        [](FILE* f) {
+            if (f) {
+                std::cout << "Closing file.\n";
+                fclose(f); // Release (cleanup) the resource
+            }
+        }
+    );
+
+    if (!file.get()) {
+        std::cerr << "Failed to open file.\n";
+        return 1;
+    }
+  }
+
+  // Resource is automatically released when `file` goes out of scope
+  std::cout << "File has been closed \n";
+
+}

examples/unique_resource.cpp

@@ -0,0 +1,31 @@
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+#include <iostream>
+#include <memory>
+#include <beman/scope/scope.hpp>
+
+constexpr size_t arr_size = 10;
+// clang-format off
+int main() {
+
+  {
+    // Allocate an array
+    auto resource_ptr = beman::scope::unique_resource
+    (
+       new int[arr_size], // acquire array resource
+       // Cleanup function
+       [](int* ptr) { delete[] ptr;
+                      std::cout << "Array deleted.\n"; }
+    );
+
+    // Use the array
+    for (size_t i = 0; i < arr_size; ++i) {
+        resource_ptr.get()[i] = static_cast<int>(i * 2);
+    }
+    std::cout << "First element: " << resource_ptr.get()[0] << "\n";
+  }
+
+  // Resource is automatically released when `resource_ptr` goes out of scope
+  std::cout << "After scope: \n";
+
+}

examples/unique_resource_example.cpp

@@ -0,0 +1,28 @@
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+include(FetchContent)
+
+FetchContent_Declare(
+    Catch2
+    GIT_REPOSITORY https://github.com/catchorg/Catch2.git
+    GIT_TAG v3.8.0
+)
+FetchContent_MakeAvailable(Catch2)
+
+set(ALL_TESTNAMES scope_success scope_exit scope_fail unique_resource)
+
+message("Tests to be built: ${ALL_TESTS}")
+
+include(CTest)
+include(Catch)
+
+foreach(testname ${ALL_TESTNAMES})
+    add_executable(test.${testname})
+    target_sources(test.${testname} PRIVATE ${testname}.test.cpp)
+    target_include_directories(
+        test.${testname}
+        PRIVATE ${CMAKE_SOURCE_DIR}/include
+    )
+    target_link_libraries(test.${testname} PRIVATE Catch2::Catch2WithMain)
+    catch_discover_tests(test.${testname})
+endforeach()