CMake and testability improvements

.github/workflows/ci.yml

@@ -1,7 +1,7 @@
 
 name: CI
 
-on: pull_request
+on: [push, pull_request]
 
 jobs:
 
@@ -12,6 +12,8 @@ jobs:
 
     strategy:
 
+      fail-fast: false
+
       matrix:
 
         toolchain:
@@ -63,25 +65,25 @@ jobs:
     steps:
 
     - name: Checkout Code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
+
+    - name: Create Build Environment
+      run: cmake -E make_directory ${{runner.workspace}}/build
 
     - name: Configure
-      working-directory: test
-      run: cmake -S . -B build ${{ matrix.cmake_opts }}
+      working-directory: ${{runner.workspace}}/build
+      shell: bash
+      run: cmake -DARGPARSE_BUILD_SAMPLES=ON -DCMAKE_BUILD_TYPE=Debug ${{ matrix.cmake_opts }} $GITHUB_WORKSPACE
       env:
         CC: ${{ matrix.c_compiler }}
         CXX: ${{ matrix.cxx_compiler }}
 
     - name: Build for ${{ matrix.os }} with ${{ matrix.compiler }}
-      working-directory: test
-      run: cmake --build build
+      working-directory: ${{runner.workspace}}/build
+      run: cmake --build . --config Debug --verbose
 
     - name: Test
-      if: ${{ ! startsWith(matrix.os, 'windows') }}
-      working-directory: test/build
-      run: ./tests
-
-    - name: Test (Windows)
-      if: ${{ startsWith(matrix.os, 'windows') }}
-      working-directory: test/build
-      run: ./Debug/tests.exe
+      working-directory: ${{runner.workspace}}/build
+      run: ctest -C Debug -V
+      env:
+        CTEST_OUTPUT_ON_FAILURE: True

.gitignore

@@ -264,6 +264,9 @@ __pycache__/
 # CMake build directory
 build
 
+# CMake Testing directory
+Testing
+
 # Cppcheck build directory
 analysis-cppcheck-build-dir
 

CMakeLists.txt

@@ -13,8 +13,8 @@ project(argparse
         LANGUAGES CXX
 )
 
-option(ARGPARSE_INSTALL "Include an install target" ON)
-option(ARGPARSE_BUILD_TESTS "Build tests" ON)
+option(ARGPARSE_INSTALL "Include an install target" ${ARGPARSE_IS_TOP_LEVEL})
+option(ARGPARSE_BUILD_TESTS "Build tests" ${ARGPARSE_IS_TOP_LEVEL})
 option(ARGPARSE_BUILD_SAMPLES "Build samples" OFF)
 
 include(GNUInstallDirs)
@@ -28,15 +28,41 @@ target_include_directories(argparse INTERFACE
   $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
   $<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/include>)
 
+
+# Pedantic compiler options
+# Update if necessary
+if(MSVC)
+  # Force to always compile with W4
+  if(CMAKE_CXX_FLAGS MATCHES "/W[0-4]")
+    string(REGEX REPLACE "/W[0-4]" "/W4" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
+  else()
+    set(ARGPARSE_PEDANTIC_COMPILE_FLAGS "/W4")
+  endif()
+  list(APPEND ARGPARSE_PEDANTIC_COMPILE_FLAGS "/WX")
+elseif(CMAKE_CXX_COMPILER_ID MATCHES "GNU")
+  set(ARGPARSE_PEDANTIC_COMPILE_FLAGS -Wall -Wno-long-long -pedantic -Wsign-conversion -Wshadow -Wconversion -Werror -Wextra)
+elseif(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
+  set(ARGPARSE_PEDANTIC_COMPILE_FLAGS -Wall -Wno-long-long -pedantic -Wsign-conversion -Wshadow -Wconversion -Werror -Wextra)
+endif()
+
+if(NOT CMAKE_BUILD_TYPE)
+  set(CMAKE_BUILD_TYPE Release)
+endif()
+
+if(NOT CMAKE_CXX_STANDARD)
+  set(CMAKE_CXX_STANDARD 17)
+endif()
+
 if(ARGPARSE_BUILD_SAMPLES)
   add_subdirectory(samples)
 endif()
-
-if(ARGPARSE_BUILD_TESTS AND ARGPARSE_IS_TOP_LEVEL)
+
+if(ARGPARSE_BUILD_TESTS)
+  enable_testing()
   add_subdirectory(test)
 endif()
-  
-if(ARGPARSE_INSTALL AND ARGPARSE_IS_TOP_LEVEL)
+
+if(ARGPARSE_INSTALL)
   install(TARGETS argparse EXPORT argparseConfig)
   install(EXPORT argparseConfig
           NAMESPACE argparse::
@@ -95,6 +121,6 @@ if(ARGPARSE_INSTALL AND ARGPARSE_IS_TOP_LEVEL)
   install(FILES "${PKG_CONFIG_FILE_NAME}"
         DESTINATION "${CMAKE_INSTALL_LIBDIR}/pkgconfig"
   )
-endif()
 
-include(CPack)
+  include(CPack)
+endif()

include/argparse/argparse.hpp

@@ -1387,8 +1387,9 @@ class Argument {
     }
     if constexpr (details::IsContainer<T>) {
       return any_cast_container<T>(m_values);
+    } else {
+      return std::any_cast<T>(m_values.front());
     }
-    return std::any_cast<T>(m_values.front());
   }
 
   template <typename T>

samples/CMakeLists.txt

@@ -1,32 +1,11 @@
-cmake_minimum_required(VERSION 3.6)
-project(argparse_samples)
-
-if(MSVC)
-  # Force to always compile with W4
-  if(CMAKE_CXX_FLAGS MATCHES "/W[0-4]")
-    string(REGEX REPLACE "/W[0-4]" "/W4" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
-  else()
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W4")
-  endif()
-elseif(CMAKE_COMPILER_IS_GNUCC OR CMAKE_COMPILER_IS_GNUCXX)
-  # Update if necessary
-  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wno-long-long -pedantic -Wsign-conversion -Wshadow -Wconversion")
-endif()
-
-if(NOT CMAKE_BUILD_TYPE)
-  set(CMAKE_BUILD_TYPE Release)
-endif()
-
-# Disable deprecation for windows
-if (WIN32)
-	add_compile_definitions(_CRT_SECURE_NO_WARNINGS)
-endif()
 
 function(add_sample NAME)
-  ADD_EXECUTABLE(ARGPARSE_SAMPLE_${NAME} ${NAME}.cpp)
-  INCLUDE_DIRECTORIES("../include" ".")
-  set_target_properties(ARGPARSE_SAMPLE_${NAME} PROPERTIES OUTPUT_NAME ${NAME})
-  set_property(TARGET ARGPARSE_SAMPLE_${NAME} PROPERTY CXX_STANDARD 17)
+  add_executable(argparse_sample_${NAME} ${NAME}.cpp)
+  target_link_libraries(argparse_sample_${NAME} PRIVATE argparse::argparse)
+  if(ARGPARSE_PEDANTIC_COMPILE_FLAGS)
+    target_compile_options(argparse_sample_${NAME} PRIVATE ${ARGPARSE_PEDANTIC_COMPILE_FLAGS})
+  endif()
+  set_target_properties(argparse_sample_${NAME} PROPERTIES OUTPUT_NAME ${NAME})
 endfunction()
 
 add_sample(positional_argument)
@@ -43,4 +22,4 @@ add_sample(gathering_remaining_arguments)
 add_sample(subcommands)
 add_sample(parse_known_args)
 add_sample(custom_prefix_characters)
-add_sample(custom_assignment_characters)
+add_sample(custom_assignment_characters)

samples/gathering_remaining_arguments.cpp

@@ -20,7 +20,7 @@ int main(int argc, char *argv[]) {
     std::cout << files.size() << " files provided" << std::endl;
     for (auto &file : files)
       std::cout << file << std::endl;
-  } catch (std::logic_error &e) {
+  } catch (const std::logic_error &) {
     std::cout << "No files provided" << std::endl;
   }
 }

test/CMakeLists.txt

@@ -1,28 +1,6 @@
-cmake_minimum_required(VERSION 3.6)
-project(argparse_tests)
 
-if(MSVC)
-  # Force to always compile with W4
-  if(CMAKE_CXX_FLAGS MATCHES "/W[0-4]")
-    string(REGEX REPLACE "/W[0-4]" "/W4" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
-  else()
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W4")
-  endif()
-elseif(CMAKE_COMPILER_IS_GNUCC OR CMAKE_COMPILER_IS_GNUCXX)
-  # Update if necessary
-  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wno-long-long -Wpedantic -Wsign-conversion -Wshadow -Wconversion -Werror -Wextra")
-endif()
-
-if(NOT CMAKE_BUILD_TYPE)
-  set(CMAKE_BUILD_TYPE Release)
-endif()
 
-# Disable deprecation for windows
-if (WIN32)
-	add_compile_definitions(_CRT_SECURE_NO_WARNINGS)
-endif()
-
-# ARGPARSE executable
+# ARGPARSE test executable
 file(GLOB ARGPARSE_TEST_SOURCES
     main.cpp
     test_actions.cpp
@@ -56,13 +34,10 @@ file(GLOB ARGPARSE_TEST_SOURCES
     test_equals_form.cpp
     test_prefix_chars.cpp
 )
-set_source_files_properties(main.cpp
-    PROPERTIES
-    COMPILE_DEFINITIONS DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN)
-ADD_EXECUTABLE(ARGPARSE_TESTS ${ARGPARSE_TEST_SOURCES})
-INCLUDE_DIRECTORIES("../include" ".")
-set_target_properties(ARGPARSE_TESTS PROPERTIES OUTPUT_NAME tests)
-set_property(TARGET ARGPARSE_TESTS PROPERTY CXX_STANDARD 17)
 
-# Set ${PROJECT_NAME} as the startup project
-set_property(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY VS_STARTUP_PROJECT ARGPARSE_TESTS)
+add_executable(argparse_tests ${ARGPARSE_TEST_SOURCES})
+if(ARGPARSE_PEDANTIC_COMPILE_FLAGS)
+  target_compile_options(argparse_tests PRIVATE ${ARGPARSE_PEDANTIC_COMPILE_FLAGS})
+endif()
+target_link_libraries(argparse_tests PRIVATE argparse::argparse)
+add_test(NAME argparse_tests COMMAND argparse_tests)

test/README.md

@@ -7,7 +7,7 @@ $ mkdir build
 $ cd build
 $ cmake ../.
 $ make
-$ ./tests
+$ ./argparse_tests
 ```
 
 ## Windows
@@ -21,5 +21,5 @@ $ cmake ../. -G "Visual Studio 15 2017"
 ```
 
 2. Open ARGPARSE.sln
-3. Build tests in RELEASE | x64
-4. Run tests.exe
+3. Build argparse_tests in RELEASE | x64
+4. Run argparse_tests.exe

test/main.cpp

@@ -1 +1,2 @@
-#include <doctest.hpp>
+#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN
+#include "doctest.hpp"

test/test_actions.cpp

@@ -3,7 +3,7 @@ import argparse;
 #else
 #include <argparse/argparse.hpp>
 #endif
-#include <doctest.hpp>
+#include "doctest.hpp"
 
 using doctest::test_suite;
 

test/test_append.cpp

@@ -3,7 +3,7 @@ import argparse;
 #else
 #include <argparse/argparse.hpp>
 #endif
-#include <doctest.hpp>
+#include "doctest.hpp"
 
 #include <string>
 #include <vector>

test/test_as_container.cpp

@@ -3,7 +3,7 @@ import argparse;
 #else
 #include <argparse/argparse.hpp>
 #endif
-#include <doctest.hpp>
+#include "doctest.hpp"
 
 using doctest::test_suite;
 

test/test_bool_operator.cpp

@@ -4,7 +4,7 @@ import argparse;
 #include <argparse/argparse.hpp>
 #endif
 
-#include <doctest.hpp>
+#include "doctest.hpp"
 
 using doctest::test_suite;
 

test/test_choices.cpp

@@ -4,7 +4,7 @@ import argparse;
 #include <argparse/argparse.hpp>
 #endif
 
-#include <doctest.hpp>
+#include "doctest.hpp"
 
 using doctest::test_suite;
 

test/test_compound_arguments.cpp

@@ -3,8 +3,8 @@ import argparse;
 #else
 #include <argparse/argparse.hpp>
 #endif
-#include <doctest.hpp>
-#include <test_utility.hpp>
+#include "doctest.hpp"
+#include "test_utility.hpp"
 
 using doctest::test_suite;
 

test/test_container_arguments.cpp

@@ -3,8 +3,8 @@ import argparse;
 #else
 #include <argparse/argparse.hpp>
 #endif
-#include <doctest.hpp>
-#include <test_utility.hpp>
+#include "doctest.hpp"
+#include "test_utility.hpp"
 
 using doctest::test_suite;
 

test/test_default_args.cpp

@@ -3,7 +3,7 @@ import argparse;
 #else
 #include <argparse/argparse.hpp>
 #endif
-#include <doctest.hpp>
+#include "doctest.hpp"
 
 #include <iostream>
 #include <sstream>

test/test_default_value.cpp

@@ -3,7 +3,7 @@ import argparse;
 #else
 #include <argparse/argparse.hpp>
 #endif
-#include <doctest.hpp>
+#include "doctest.hpp"
 #include <string>
 
 using doctest::test_suite;

test/test_equals_form.cpp

@@ -3,7 +3,7 @@ import argparse;
 #else
 #include <argparse/argparse.hpp>
 #endif
-#include <doctest.hpp>
+#include "doctest.hpp"
 
 #include <iostream>
 #include <string>

test/test_error_reporting.cpp

@@ -3,7 +3,7 @@ import argparse;
 #else
 #include <argparse/argparse.hpp>
 #endif
-#include <doctest.hpp>
+#include "doctest.hpp"
 
 #include <iostream>
 #include <string>

test/test_get.cpp

@@ -3,7 +3,7 @@ import argparse;
 #else
 #include <argparse/argparse.hpp>
 #endif
-#include <doctest.hpp>
+#include "doctest.hpp"
 
 #include <any>
 

test/test_help.cpp

@@ -3,7 +3,7 @@ import argparse;
 #else
 #include <argparse/argparse.hpp>
 #endif
-#include <doctest.hpp>
+#include "doctest.hpp"
 
 #include <optional>
 #include <sstream>