From 8ee354591f81f0159a2cb9b2795fae9999844df5 Mon Sep 17 00:00:00 2001 From: onqtam Date: Wed, 15 Dec 2021 15:42:40 +0200 Subject: [PATCH] removed most references to onqtam and replaced with doctest - the github org --- .github/workflows/main.yml | 4 +- .travis.yml | 14 ++--- README.md | 16 +++--- doc/html_generated/assertions.html | 2 +- doc/html_generated/build-systems.html | 4 +- doc/html_generated/configuration.html | 4 +- doc/html_generated/faq.html | 6 +- doc/html_generated/features.html | 6 +- doc/html_generated/reporters.html | 2 +- doc/html_generated/roadmap.html | 8 +-- doc/html_generated/stringification.html | 2 +- doc/html_generated/testcases.html | 2 +- doc/html_generated/tutorial.html | 2 +- doc/markdown/assertions.md | 2 +- doc/markdown/build-systems.md | 4 +- doc/markdown/configuration.md | 4 +- doc/markdown/faq.md | 6 +- doc/markdown/features.md | 6 +- doc/markdown/reporters.md | 2 +- doc/markdown/roadmap.md | 8 +-- doc/markdown/stringification.md | 2 +- doc/markdown/testcases.md | 2 +- doc/markdown/tutorial.md | 2 +- doctest/doctest.h | 14 ++--- doctest/extensions/doctest_util.h | 2 +- doctest/parts/doctest.cpp | 6 +- doctest/parts/doctest_fwd.h | 8 +-- examples/all_features/CMakeLists.txt | 2 +- examples/all_features/subcases.cpp | 2 +- .../all_features/test_output/filter_2_xml.txt | 2 +- .../test_output/filter_3_junit.txt | 2 +- .../all_features/test_output/filter_3_xml.txt | 2 +- .../test_output/subcases.cpp_junit.txt | 8 +-- .../test_output/subcases.cpp_xml.txt | 2 +- .../CMakeLists.txt | 2 +- ...test_force_link_static_lib_in_target.cmake | 2 +- scripts/data/article.txt | 12 ++-- scripts/data/article2.txt | 56 +++++++++---------- scripts/random_dev_notes.md | 6 -- 39 files changed, 116 insertions(+), 122 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 600388bb9..0e7a0d4cf 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -144,7 +144,7 @@ jobs: compiler: clang version: "8" - # fails like this: https://github.com/onqtam/doctest/runs/1562896476?check_suite_focus=true + # fails like this: https://github.com/doctest/doctest/runs/1562896476?check_suite_focus=true # - name: ubuntu-latest-clang-9 # os: ubuntu-latest # compiler: clang @@ -155,7 +155,7 @@ jobs: compiler: clang version: "10" - # fails like this: https://github.com/onqtam/doctest/runs/1562896512?check_suite_focus=true + # fails like this: https://github.com/doctest/doctest/runs/1562896512?check_suite_focus=true # - name: ubuntu-latest-clang-11 # os: ubuntu-latest # compiler: clang diff --git a/.travis.yml b/.travis.yml index b3c27105b..a79df98e3 100644 --- a/.travis.yml +++ b/.travis.yml @@ -31,7 +31,7 @@ # coverity_scan: # # COVERITY_SCAN_TOKEN added as env var in travis project # project: -# name: onqtam/doctest +# name: doctest/doctest # notification_email: vik.kirilov@gmail.com # build_command: clang++ scripts/hello_world.cpp -I doctest # branch_pattern: coverity_scan @@ -138,14 +138,14 @@ # sources: *apt_sources # # Clang 3.5 -# - env: COMPILER=clang++-3.5 HAS_ASAN=true HAS_UBSAN=true # no HAS_TSAN - see errors: https://travis-ci.org/onqtam/doctest/builds/417926743 +# - env: COMPILER=clang++-3.5 HAS_ASAN=true HAS_UBSAN=true # no HAS_TSAN - see errors: https://travis-ci.org/doctest/doctest/builds/417926743 # addons: &clang35 # apt: # packages: ["clang-3.5", "valgrind", "libc6-dbg", "g++-6"] # sources: *apt_sources # # Clang 3.6 -# - env: COMPILER=clang++-3.6 HAS_ASAN=true HAS_UBSAN=true # no HAS_TSAN - see errors: https://travis-ci.org/onqtam/doctest/builds/417926743 +# - env: COMPILER=clang++-3.6 HAS_ASAN=true HAS_UBSAN=true # no HAS_TSAN - see errors: https://travis-ci.org/doctest/doctest/builds/417926743 # addons: &clang36 # apt: # packages: ["clang-3.6", "valgrind", "libc6-dbg", "g++-6"] @@ -159,14 +159,14 @@ # sources: *apt_sources # # Clang 3.8 -# - env: COMPILER=clang++-3.8 HAS_ASAN=true HAS_UBSAN=true # no HAS_TSAN - see errors: https://travis-ci.org/onqtam/doctest/builds/417926743 +# - env: COMPILER=clang++-3.8 HAS_ASAN=true HAS_UBSAN=true # no HAS_TSAN - see errors: https://travis-ci.org/doctest/doctest/builds/417926743 # addons: &clang38 # apt: # packages: ["clang-3.8", "valgrind", "libc6-dbg", "g++-6"] # sources: *apt_sources # # Clang 3.9 -# - env: COMPILER=clang++-3.9 # no HAS_ASAN/HAS_UBSAN - see errors: https://travis-ci.org/onqtam/doctest/jobs/386263910 +# - env: COMPILER=clang++-3.9 # no HAS_ASAN/HAS_UBSAN - see errors: https://travis-ci.org/doctest/doctest/jobs/386263910 # addons: &clang39 # apt: # packages: ["clang-3.9", "valgrind", "libc6-dbg", "g++-6"] @@ -229,7 +229,7 @@ # sources: *apt_sources # # Xcode 9.4 Clang -# - env: COMPILER=clang++ HAS_UBSAN=true HAS_TSAN=true # no HAS_ASAN - errors since using thread_local even in single-threaded cases - see errors: https://travis-ci.org/onqtam/doctest/builds/417181981 +# - env: COMPILER=clang++ HAS_UBSAN=true HAS_TSAN=true # no HAS_ASAN - errors since using thread_local even in single-threaded cases - see errors: https://travis-ci.org/doctest/doctest/builds/417181981 # osx_image: xcode9.4 # os: osx @@ -259,7 +259,7 @@ # # static code analysis # - env: COMPILER=clang++-4.0 STATIC_CODE_ANALYSIS=true -# # seems to not be present yet: https://travis-ci.org/github/onqtam/doctest/jobs/688097537 +# # seems to not be present yet: https://travis-ci.org/github/doctest/doctest/jobs/688097537 # # GCC 10 # - env: COMPILER=g++-10 HAS_ASAN=true HAS_UBSAN=true HAS_TSAN=true SANITIZER_CXX_FLAGS="-fuse-ld=gold -static-libasan" TSAN_CXX_FLAGS="-ltsan" # compiler: gcc diff --git a/README.md b/README.md index 510e12077..746ece1ab 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,13 @@ master branch - Windows + Windows All - + # [>> doctest is looking for maintainers <<](https://github.com/doctest/doctest/issues/554) @@ -72,7 +72,7 @@ The **key** differences between it and other testing frameworks are that it is l - [**thread-safe**](doc/markdown/faq.md#is-doctest-thread-aware) - asserts can be used from multiple threads spawned from a single test case - [**example**](examples/all_features/concurrency.cpp) - asserts can be used [**outside of a testing context**](doc/markdown/assertions.md#using-asserts-out-of-a-testing-context) - as a general purpose assert library - [**example**](examples/all_features/asserts_used_outside_of_tests.cpp) - No global namespace pollution (everything is in ```doctest::```) & doesn't drag **any** headers with it -- [**Portable**](doc/markdown/features.md#extremely-portable) C++11 (use tag [**1.2.9**](https://github.com/onqtam/doctest/tree/1.2.9) for C++98) with over 100 different CI builds (static analysis, sanitizers..) +- [**Portable**](doc/markdown/features.md#extremely-portable) C++11 (use tag [**1.2.9**](https://github.com/doctest/doctest/tree/1.2.9) for C++98) with over 100 different CI builds (static analysis, sanitizers..) - binaries (exe/dll) can use the test runner of another binary => tests in a single registry - [**example**](examples/executable_dll_and_plugin/) ![cost-of-including-the-framework-header](scripts/data/benchmarks/header.png) @@ -92,7 +92,7 @@ The framework can be used just like any other without mixing production code and [This table](https://github.com/martinmoene/catch-lest-other-comparison) compares **doctest** / [**Catch**](https://github.com/catchorg/Catch2) / [**lest**](https://github.com/martinmoene/lest) which are all very similar. -Checkout the [**CppCon 2017 talk**](https://cppcon2017.sched.com/event/BgsI/mix-tests-and-production-code-with-doctest-implementing-and-using-the-fastest-modern-c-testing-framework) on [**YouTube**](https://www.youtube.com/watch?v=eH1CxEC29l8) to get a better understanding of how the framework works and read about how to use it in [**the JetBrains article**](https://blog.jetbrains.com/rscpp/better-ways-testing-with-doctest/) - highlighting the unique aspects of the framework! On a short description on how to use the framework along production code you could refer to [**this GitHub issue**](https://github.com/onqtam/doctest/issues/252). There is also an [**older article**](https://accu.org/var/uploads/journals/Overload137.pdf) in the february edition of ACCU Overload 2017. +Checkout the [**CppCon 2017 talk**](https://cppcon2017.sched.com/event/BgsI/mix-tests-and-production-code-with-doctest-implementing-and-using-the-fastest-modern-c-testing-framework) on [**YouTube**](https://www.youtube.com/watch?v=eH1CxEC29l8) to get a better understanding of how the framework works and read about how to use it in [**the JetBrains article**](https://blog.jetbrains.com/rscpp/better-ways-testing-with-doctest/) - highlighting the unique aspects of the framework! On a short description on how to use the framework along production code you could refer to [**this GitHub issue**](https://github.com/doctest/doctest/issues/252). There is also an [**older article**](https://accu.org/var/uploads/journals/Overload137.pdf) in the february edition of ACCU Overload 2017. [![CppCon 2017 talk about doctest on youtube](scripts/data/youtube-cppcon-talk-thumbnail.png)](https://www.youtube.com/watch?v=eH1CxEC29l8) diff --git a/doc/html_generated/assertions.html b/doc/html_generated/assertions.html index e15b9e9ac..fa2c334fe 100644 --- a/doc/html_generated/assertions.html +++ b/doc/html_generated/assertions.html @@ -134,7 +134,7 @@ The results would be best when using the [**```DOCTEST_CONFIG_SUPER_FAST_ASSERTS```**](configuration.html#doctest_config_super_fast_asserts) config identifier. -Checkout the [**example**](../../examples/all_features/asserts_used_outside_of_tests.cpp) showcasing how that is done. For more information see the [**issue for the feature request**](https://github.com/onqtam/doctest/issues/114). +Checkout the [**example**](../../examples/all_features/asserts_used_outside_of_tests.cpp) showcasing how that is done. For more information see the [**issue for the feature request**](https://github.com/doctest/doctest/issues/114). Currently [**logging macros**](logging.html) cannot be used for extra context for asserts outside of a test run. That means that the ```_MESSAGE``` variants of asserts are also not usable - since they are just a packed ```INFO()``` with an assert right after it. diff --git a/doc/html_generated/build-systems.html b/doc/html_generated/build-systems.html index 4d0d31750..b96cd64ce 100644 --- a/doc/html_generated/build-systems.html +++ b/doc/html_generated/build-systems.html @@ -5,7 +5,7 @@ ## Build systems -The latest released version of doctest can be obtained from here: https://raw.githubusercontent.com/onqtam/doctest/master/doctest/doctest.h +The latest released version of doctest can be obtained from here: https://raw.githubusercontent.com/doctest/doctest/master/doctest/doctest.h You can substitute ```master``` with ```dev``` or a tag like ```1.2.9``` for a specific version in the URL above. @@ -35,7 +35,7 @@ ExternalProject_Add( doctest PREFIX ${CMAKE_BINARY_DIR}/doctest - GIT_REPOSITORY https://github.com/onqtam/doctest.git + GIT_REPOSITORY https://github.com/doctest/doctest.git TIMEOUT 10 UPDATE_COMMAND ${GIT_EXECUTABLE} pull CONFIGURE_COMMAND "" diff --git a/doc/html_generated/configuration.html b/doc/html_generated/configuration.html index 243b49d46..23360263d 100644 --- a/doc/html_generated/configuration.html +++ b/doc/html_generated/configuration.html @@ -117,7 +117,7 @@ - msvc ```C4389``` 'operator' : signed/unsigned mismatch - msvc ```C4018``` 'expression' : signed/unsigned mismatch -You can checkout [**this**](https://github.com/onqtam/doctest/issues/16#issuecomment-246803303) issue to better understand why I suppress these warnings by default. +You can checkout [**this**](https://github.com/doctest/doctest/issues/16#issuecomment-246803303) issue to better understand why I suppress these warnings by default. This can be defined both globally and in specific source files only. @@ -236,7 +236,7 @@ ### **```DOCTEST_CONFIG_INCLUDE_TYPE_TRAITS```** -This can be used to include the `````` C++11 header. That in turn will enable the ability for the ```Approx``` helper to be used with strong typedefs of ```double``` - check [this](https://github.com/onqtam/doctest/issues/62) or [this](https://github.com/onqtam/doctest/issues/85) issue for more details on that. +This can be used to include the `````` C++11 header. That in turn will enable the ability for the ```Approx``` helper to be used with strong typedefs of ```double``` - check [this](https://github.com/doctest/doctest/issues/62) or [this](https://github.com/doctest/doctest/issues/85) issue for more details on that. This can be defined both globally and in specific source files only. diff --git a/doc/html_generated/faq.html b/doc/html_generated/faq.html index b86780bb3..0dcef4373 100644 --- a/doc/html_generated/faq.html +++ b/doc/html_generated/faq.html @@ -70,7 +70,7 @@ - the main one is that only doctest from the C++ frameworks is usable next to your production code (speed of compilation, ability to remove the tests from the binary, ability to execute tests/code/both, ability to have tests in multiple shared objects and still a single registry for all of them) - doctest is a single header - Google Test has to be built as a separate static library and linked against. -- doctest has the concept of [**Subcases**](https://github.com/onqtam/doctest/blob/master/doc/markdown/tutorial.html#test-cases-and-subcases) which is a much cleaner way to share setup and teardown code between tests compared to fixtures and class inheritance - Google Test is quite verbose! +- doctest has the concept of [**Subcases**](https://github.com/doctest/doctest/blob/master/doc/markdown/tutorial.html#test-cases-and-subcases) which is a much cleaner way to share setup and teardown code between tests compared to fixtures and class inheritance - Google Test is quite verbose! - doctest compiles faster and probably runs faster (although the runtime becomes an issue only when you have millions of asserts) - doctest asserts are thread-safe even on Windows (Google Test uses pthreads so thread-safe asserts are available only on UNIX) - doctest overall has a simpler API @@ -136,12 +136,12 @@ It doesn't work in 2 scenarios: -- either the target or the library uses a precompiled header - see [**this**](https://github.com/onqtam/doctest/issues/21#issuecomment-247001423) issue for details +- either the target or the library uses a precompiled header - see [**this**](https://github.com/doctest/doctest/issues/21#issuecomment-247001423) issue for details - either the target or the library is an imported target (pre-built) and not built within the current cmake tree You can also checkout this repository for a different solution: [**pthom/doctest_registerlibrary**](https://github.com/pthom/doctest_registerlibrary). -A compiler-specific solution for MSVC is to use the [```/OPT:NOREF```](https://msdn.microsoft.com/en-us/library/bxwfs976.aspx) linker flag (thanks to [lectem](https://github.com/Lectem) for [reporting](https://github.com/onqtam/doctest/issues/106) it!). Another option is to look at [```/wholearchive```](https://docs.microsoft.com/en-us/cpp/build/reference/wholearchive-include-all-library-object-files?view=vs-2019) for MSVC. +A compiler-specific solution for MSVC is to use the [```/OPT:NOREF```](https://msdn.microsoft.com/en-us/library/bxwfs976.aspx) linker flag (thanks to [lectem](https://github.com/Lectem) for [reporting](https://github.com/doctest/doctest/issues/106) it!). Another option is to look at [```/wholearchive```](https://docs.microsoft.com/en-us/cpp/build/reference/wholearchive-include-all-library-object-files?view=vs-2019) for MSVC. ### Why is comparing C strings (```char*```) actually comparing pointers? diff --git a/doc/html_generated/features.html b/doc/html_generated/features.html index 78de2dfdd..467f8fa2b 100644 --- a/doc/html_generated/features.html +++ b/doc/html_generated/features.html @@ -28,16 +28,16 @@ **SOME OF THIS IS OUTDATED** -- Standards compliant **C++11** code - should work with any **C++11** capable compiler (use tag [**1.2.9**](https://github.com/onqtam/doctest/tree/1.2.9) for C++98 and older compilers) +- Standards compliant **C++11** code - should work with any **C++11** capable compiler (use tag [**1.2.9**](https://github.com/doctest/doctest/tree/1.2.9) for C++98 and older compilers) - tested with **GCC**: **4.8**, **4.9**, **5**, **6**, **7**, **8**, **9**, **10** - tested with **Clang**: **3.5**, **3.6**, **3.7**, **3.8**, **3.9**, **4**, **5**, **6**, **7**, **8**, **9** (XCode 6+) - tested with **MSVC**: **2015**, **2017**, **2019** (also in 32 bit mode) -- per-commit tested on [**travis**](https://travis-ci.org/onqtam/doctest) and [**appveyor**](https://ci.appveyor.com/project/onqtam/doctest) CI services +- per-commit tested on [**travis**](https://travis-ci.org/doctest/doctest) and [**appveyor**](https://ci.appveyor.com/project/doctest/doctest) CI services - warnings as errors even on the most aggressive warning levels - see [**here**](../../scripts/cmake/common.cmake#L84) - statically analyzed on the CI - [**Cppcheck**](http://cppcheck.sourceforge.net/) / [**Clang-Tidy**](https://clang.llvm.org/extra/clang-tidy/) / [**Coverity Scan**](https://scan.coverity.com/) / [**OCLint**](http://oclint.org/) / [**Visual Studio Analyzer**](https://docs.microsoft.com/en-us/visualstudio/code-quality/analyzing-c-cpp-code-quality-by-using-code-analysis) - all tests have their output compared to reference output of a previous known good run - all tests built and ran in **Debug**/**Release** modes - - all tests ran through **valgrind** under **Linux** (sadly [not under OSX](https://github.com/onqtam/doctest/issues/11)) + - all tests ran through **valgrind** under **Linux** (sadly [not under OSX](https://github.com/doctest/doctest/issues/11)) - all tests ran through **address**, **UB** and **thread** sanitizers under **Linux**/**OSX** - tests are ran in more than **150** different configurations on UNIX (Linux + OSX) on **travis** CI - tests are ran in a total of **14** different configurations on Windows on **appveyor** CI diff --git a/doc/html_generated/reporters.html b/doc/html_generated/reporters.html index 48557fb05..ccacb28f7 100644 --- a/doc/html_generated/reporters.html +++ b/doc/html_generated/reporters.html @@ -10,7 +10,7 @@ You can list all registered reporters/listeners with ```--list-reporters```. There are a few implemented reporters in the framework: - ```console``` - streaming - writes normal lines of text with coloring if a capable terminal is detected - ```xml``` - streaming - writes in xml format tailored to doctest -- ```junit``` - buffering - writes in JUnit-compatible xml - for more information look [here](https://github.com/onqtam/doctest/issues/318) and [here](https://github.com/onqtam/doctest/issues/376). +- ```junit``` - buffering - writes in JUnit-compatible xml - for more information look [here](https://github.com/doctest/doctest/issues/318) and [here](https://github.com/doctest/doctest/issues/376). Streaming means that results are delivered progressively and not at the end of the test run. diff --git a/doc/html_generated/roadmap.html b/doc/html_generated/roadmap.html index 43a855476..4b27e3c26 100644 --- a/doc/html_generated/roadmap.html +++ b/doc/html_generated/roadmap.html @@ -10,11 +10,11 @@ [![Patreon](https://cloud.githubusercontent.com/assets/8225057/5990484/70413560-a9ab-11e4-8942-1a63607c0b00.png)](http://www.patreon.com/onqtam) [![PayPal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.me/onqtam/10) -Planned features for future releases - order changes constantly... Also look through the [**issues**](https://github.com/onqtam/doctest/issues). +Planned features for future releases - order changes constantly... Also look through the [**issues**](https://github.com/doctest/doctest/issues). ### For 2.5: -- https://github.com/onqtam/doctest/issues/208 +- https://github.com/doctest/doctest/issues/208 - reporters: - ability to redirect the stdout/stderr from test cases and capture it - like Catch does it - xUnit/TeamCity reporter @@ -31,7 +31,7 @@ - [rapidcheck](https://github.com/emil-e/rapidcheck) - [autocheck](https://github.com/thejohnfreeman/autocheck) - [CppQuickCheck](https://github.com/grogers0/CppQuickCheck) -- proper conan package - https://github.com/onqtam/doctest/issues/103 +- proper conan package - https://github.com/doctest/doctest/issues/103 - IDE integration - https://blogs.msdn.microsoft.com/vcblog/2017/05/10/unit-testing-and-the-future-announcing-the-test-adapter-for-google-test/ - https://www.reddit.com/r/cpp/comments/65c0f1/run_cpp_unit_tests_from_xcode_and_visual_studio/ @@ -55,7 +55,7 @@ - test execution in [separate processes](https://github.com/catchorg/Catch2/issues/853) - ```fork()``` for UNIX and [this](https://github.com/nemequ/munit/issues/2) for Windows - killing a test that exceeds a time limit (will perhaps require threading or processes) - [symbolizer](https://github.com/facebook/folly/tree/master/folly/experimental/symbolizer) - for a stack trace - when an assertion fails - and it's in a user function with some deep callstack away from the current test case - how to know the exact code path that lead to the failing assert -- ability to make the framework not capture unexpected exceptions - as requested [here](https://github.com/onqtam/doctest/issues/12#issuecomment-235334585) +- ability to make the framework not capture unexpected exceptions - as requested [here](https://github.com/doctest/doctest/issues/12#issuecomment-235334585) - add Approx ability to compare with absolute epsilon - [Catch PR](https://github.com/catchorg/Catch2/pull/538) - ability to customize the colors in the console output (may also use styles - based on [this](https://github.com/agauniyal/rang) or [this](https://github.com/ikalnytskyi/termcolor)) - implement breaking into the debugger under linux - see [here](https://github.com/catchorg/Catch2/pull/585) and [here](https://github.com/scottt/debugbreak) diff --git a/doc/html_generated/stringification.html b/doc/html_generated/stringification.html index 894b5c8f0..fd1835e96 100644 --- a/doc/html_generated/stringification.html +++ b/doc/html_generated/stringification.html @@ -8,7 +8,7 @@ **doctest** needs to be able to convert types you use in assertions and logging expressions into strings (for logging and reporting purposes). Most built-in types are supported out of the box but there are three ways that you can tell **doctest** how to convert your own types (or other, third-party types) into strings. -For stringifying enums checkout [this issue](https://github.com/onqtam/doctest/issues/121). +For stringifying enums checkout [this issue](https://github.com/doctest/doctest/issues/121). ## ```operator<<``` overload for ```std::ostream``` diff --git a/doc/html_generated/testcases.html b/doc/html_generated/testcases.html index 3d3df29b2..0aa0b0b96 100644 --- a/doc/html_generated/testcases.html +++ b/doc/html_generated/testcases.html @@ -53,7 +53,7 @@ Other than the additional prefixes and the formatting in the console reporter these macros behave exactly as ```TEST_CASE```s and ```SUBCASE```s. As such there is nothing enforcing the correct sequencing of these macros - that's up to the programmer! -Note that when using the [`--test-case=`](https://github.com/onqtam/doctest/blob/master/doc/markdown/commandline.html) command line option (or `--subcase=`) you will have to pass the prefix `Scenario: ` as well. +Note that when using the [`--test-case=`](https://github.com/doctest/doctest/blob/master/doc/markdown/commandline.html) command line option (or `--subcase=`) you will have to pass the prefix `Scenario: ` as well. ## Test fixtures diff --git a/doc/html_generated/tutorial.html b/doc/html_generated/tutorial.html index 0820e4593..e417782d0 100644 --- a/doc/html_generated/tutorial.html +++ b/doc/html_generated/tutorial.html @@ -5,7 +5,7 @@ ## Tutorial -To get started with **doctest** all you need is to download the [**latest version**](https://raw.githubusercontent.com/onqtam/doctest/master/doctest/doctest.h) which is just a single header and include it in your source files (or add this repository as a git submodule). +To get started with **doctest** all you need is to download the [**latest version**](https://raw.githubusercontent.com/doctest/doctest/master/doctest/doctest.h) which is just a single header and include it in your source files (or add this repository as a git submodule). This tutorial assumes you can use the header directly: ```#include "doctest.h"``` - so it is either in the same folder with your test source files or you have set up the include paths to it in your build system properly. diff --git a/doc/markdown/assertions.md b/doc/markdown/assertions.md index 7e16316b8..bdd33af7b 100644 --- a/doc/markdown/assertions.md +++ b/doc/markdown/assertions.md @@ -129,7 +129,7 @@ A ```doctest::Context``` object still has to be created somewhere and set as the The results would be best when using the [**```DOCTEST_CONFIG_SUPER_FAST_ASSERTS```**](configuration.md#doctest_config_super_fast_asserts) config identifier. -Checkout the [**example**](../../examples/all_features/asserts_used_outside_of_tests.cpp) showcasing how that is done. For more information see the [**issue for the feature request**](https://github.com/onqtam/doctest/issues/114). +Checkout the [**example**](../../examples/all_features/asserts_used_outside_of_tests.cpp) showcasing how that is done. For more information see the [**issue for the feature request**](https://github.com/doctest/doctest/issues/114). Currently [**logging macros**](logging.md) cannot be used for extra context for asserts outside of a test run. That means that the ```_MESSAGE``` variants of asserts are also not usable - since they are just a packed ```INFO()``` with an assert right after it. diff --git a/doc/markdown/build-systems.md b/doc/markdown/build-systems.md index 09ed76e48..474516539 100644 --- a/doc/markdown/build-systems.md +++ b/doc/markdown/build-systems.md @@ -1,6 +1,6 @@ ## Build systems -The latest released version of doctest can be obtained from here: https://raw.githubusercontent.com/onqtam/doctest/master/doctest/doctest.h +The latest released version of doctest can be obtained from here: https://raw.githubusercontent.com/doctest/doctest/master/doctest/doctest.h You can substitute ```master``` with ```dev``` or a tag like ```1.2.9``` for a specific version in the URL above. @@ -30,7 +30,7 @@ find_package(Git REQUIRED) ExternalProject_Add( doctest PREFIX ${CMAKE_BINARY_DIR}/doctest - GIT_REPOSITORY https://github.com/onqtam/doctest.git + GIT_REPOSITORY https://github.com/doctest/doctest.git TIMEOUT 10 UPDATE_COMMAND ${GIT_EXECUTABLE} pull CONFIGURE_COMMAND "" diff --git a/doc/markdown/configuration.md b/doc/markdown/configuration.md index 869d2eb61..feb20ba55 100644 --- a/doc/markdown/configuration.md +++ b/doc/markdown/configuration.md @@ -112,7 +112,7 @@ By default the library suppresses warnings about comparing signed and unsigned t - msvc ```C4389``` 'operator' : signed/unsigned mismatch - msvc ```C4018``` 'expression' : signed/unsigned mismatch -You can checkout [**this**](https://github.com/onqtam/doctest/issues/16#issuecomment-246803303) issue to better understand why I suppress these warnings by default. +You can checkout [**this**](https://github.com/doctest/doctest/issues/16#issuecomment-246803303) issue to better understand why I suppress these warnings by default. This can be defined both globally and in specific source files only. @@ -231,7 +231,7 @@ This should be defined only in the source file where the library is implemented ### **```DOCTEST_CONFIG_INCLUDE_TYPE_TRAITS```** -This can be used to include the `````` C++11 header. That in turn will enable the ability for the ```Approx``` helper to be used with strong typedefs of ```double``` - check [this](https://github.com/onqtam/doctest/issues/62) or [this](https://github.com/onqtam/doctest/issues/85) issue for more details on that. +This can be used to include the `````` C++11 header. That in turn will enable the ability for the ```Approx``` helper to be used with strong typedefs of ```double``` - check [this](https://github.com/doctest/doctest/issues/62) or [this](https://github.com/doctest/doctest/issues/85) issue for more details on that. This can be defined both globally and in specific source files only. diff --git a/doc/markdown/faq.md b/doc/markdown/faq.md index b587bcfa5..7e73157ae 100644 --- a/doc/markdown/faq.md +++ b/doc/markdown/faq.md @@ -65,7 +65,7 @@ Here are a couple of differences: - the main one is that only doctest from the C++ frameworks is usable next to your production code (speed of compilation, ability to remove the tests from the binary, ability to execute tests/code/both, ability to have tests in multiple shared objects and still a single registry for all of them) - doctest is a single header - Google Test has to be built as a separate static library and linked against. -- doctest has the concept of [**Subcases**](https://github.com/onqtam/doctest/blob/master/doc/markdown/tutorial.md#test-cases-and-subcases) which is a much cleaner way to share setup and teardown code between tests compared to fixtures and class inheritance - Google Test is quite verbose! +- doctest has the concept of [**Subcases**](https://github.com/doctest/doctest/blob/master/doc/markdown/tutorial.md#test-cases-and-subcases) which is a much cleaner way to share setup and teardown code between tests compared to fixtures and class inheritance - Google Test is quite verbose! - doctest compiles faster and probably runs faster (although the runtime becomes an issue only when you have millions of asserts) - doctest asserts are thread-safe even on Windows (Google Test uses pthreads so thread-safe asserts are available only on UNIX) - doctest overall has a simpler API @@ -131,12 +131,12 @@ As an alternative I have created a CMake function that forces every object file It doesn't work in 2 scenarios: -- either the target or the library uses a precompiled header - see [**this**](https://github.com/onqtam/doctest/issues/21#issuecomment-247001423) issue for details +- either the target or the library uses a precompiled header - see [**this**](https://github.com/doctest/doctest/issues/21#issuecomment-247001423) issue for details - either the target or the library is an imported target (pre-built) and not built within the current cmake tree You can also checkout this repository for a different solution: [**pthom/doctest_registerlibrary**](https://github.com/pthom/doctest_registerlibrary). -A compiler-specific solution for MSVC is to use the [```/OPT:NOREF```](https://msdn.microsoft.com/en-us/library/bxwfs976.aspx) linker flag (thanks to [lectem](https://github.com/Lectem) for [reporting](https://github.com/onqtam/doctest/issues/106) it!). Another option is to look at [```/wholearchive```](https://docs.microsoft.com/en-us/cpp/build/reference/wholearchive-include-all-library-object-files?view=vs-2019) for MSVC. +A compiler-specific solution for MSVC is to use the [```/OPT:NOREF```](https://msdn.microsoft.com/en-us/library/bxwfs976.aspx) linker flag (thanks to [lectem](https://github.com/Lectem) for [reporting](https://github.com/doctest/doctest/issues/106) it!). Another option is to look at [```/wholearchive```](https://docs.microsoft.com/en-us/cpp/build/reference/wholearchive-include-all-library-object-files?view=vs-2019) for MSVC. ### Why is comparing C strings (```char*```) actually comparing pointers? diff --git a/doc/markdown/features.md b/doc/markdown/features.md index e236627d8..3cc9dd1d2 100644 --- a/doc/markdown/features.md +++ b/doc/markdown/features.md @@ -23,16 +23,16 @@ **SOME OF THIS IS OUTDATED** -- Standards compliant **C++11** code - should work with any **C++11** capable compiler (use tag [**1.2.9**](https://github.com/onqtam/doctest/tree/1.2.9) for C++98 and older compilers) +- Standards compliant **C++11** code - should work with any **C++11** capable compiler (use tag [**1.2.9**](https://github.com/doctest/doctest/tree/1.2.9) for C++98 and older compilers) - tested with **GCC**: **4.8**, **4.9**, **5**, **6**, **7**, **8**, **9**, **10** - tested with **Clang**: **3.5**, **3.6**, **3.7**, **3.8**, **3.9**, **4**, **5**, **6**, **7**, **8**, **9** (XCode 6+) - tested with **MSVC**: **2015**, **2017**, **2019** (also in 32 bit mode) -- per-commit tested on [**travis**](https://travis-ci.org/onqtam/doctest) and [**appveyor**](https://ci.appveyor.com/project/onqtam/doctest) CI services +- per-commit tested on [**travis**](https://travis-ci.org/doctest/doctest) and [**appveyor**](https://ci.appveyor.com/project/doctest/doctest) CI services - warnings as errors even on the most aggressive warning levels - see [**here**](../../scripts/cmake/common.cmake#L84) - statically analyzed on the CI - [**Cppcheck**](http://cppcheck.sourceforge.net/) / [**Clang-Tidy**](https://clang.llvm.org/extra/clang-tidy/) / [**Coverity Scan**](https://scan.coverity.com/) / [**OCLint**](http://oclint.org/) / [**Visual Studio Analyzer**](https://docs.microsoft.com/en-us/visualstudio/code-quality/analyzing-c-cpp-code-quality-by-using-code-analysis) - all tests have their output compared to reference output of a previous known good run - all tests built and ran in **Debug**/**Release** modes - - all tests ran through **valgrind** under **Linux** (sadly [not under OSX](https://github.com/onqtam/doctest/issues/11)) + - all tests ran through **valgrind** under **Linux** (sadly [not under OSX](https://github.com/doctest/doctest/issues/11)) - all tests ran through **address**, **UB** and **thread** sanitizers under **Linux**/**OSX** - tests are ran in more than **150** different configurations on UNIX (Linux + OSX) on **travis** CI - tests are ran in a total of **14** different configurations on Windows on **appveyor** CI diff --git a/doc/markdown/reporters.md b/doc/markdown/reporters.md index c592a0446..8de752148 100644 --- a/doc/markdown/reporters.md +++ b/doc/markdown/reporters.md @@ -5,7 +5,7 @@ Doctest has a modular reporter/listener system with which users can write their You can list all registered reporters/listeners with ```--list-reporters```. There are a few implemented reporters in the framework: - ```console``` - streaming - writes normal lines of text with coloring if a capable terminal is detected - ```xml``` - streaming - writes in xml format tailored to doctest -- ```junit``` - buffering - writes in JUnit-compatible xml - for more information look [here](https://github.com/onqtam/doctest/issues/318) and [here](https://github.com/onqtam/doctest/issues/376). +- ```junit``` - buffering - writes in JUnit-compatible xml - for more information look [here](https://github.com/doctest/doctest/issues/318) and [here](https://github.com/doctest/doctest/issues/376). Streaming means that results are delivered progressively and not at the end of the test run. diff --git a/doc/markdown/roadmap.md b/doc/markdown/roadmap.md index 93009fae6..004035f3c 100644 --- a/doc/markdown/roadmap.md +++ b/doc/markdown/roadmap.md @@ -5,11 +5,11 @@ This library is free, and will stay free but needs your support to sustain its d [![Patreon](https://cloud.githubusercontent.com/assets/8225057/5990484/70413560-a9ab-11e4-8942-1a63607c0b00.png)](http://www.patreon.com/onqtam) [![PayPal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.me/onqtam/10) -Planned features for future releases - order changes constantly... Also look through the [**issues**](https://github.com/onqtam/doctest/issues). +Planned features for future releases - order changes constantly... Also look through the [**issues**](https://github.com/doctest/doctest/issues). ### For 2.5: -- https://github.com/onqtam/doctest/issues/208 +- https://github.com/doctest/doctest/issues/208 - reporters: - ability to redirect the stdout/stderr from test cases and capture it - like Catch does it - xUnit/TeamCity reporter @@ -26,7 +26,7 @@ Planned features for future releases - order changes constantly... Also look thr - [rapidcheck](https://github.com/emil-e/rapidcheck) - [autocheck](https://github.com/thejohnfreeman/autocheck) - [CppQuickCheck](https://github.com/grogers0/CppQuickCheck) -- proper conan package - https://github.com/onqtam/doctest/issues/103 +- proper conan package - https://github.com/doctest/doctest/issues/103 - IDE integration - https://blogs.msdn.microsoft.com/vcblog/2017/05/10/unit-testing-and-the-future-announcing-the-test-adapter-for-google-test/ - https://www.reddit.com/r/cpp/comments/65c0f1/run_cpp_unit_tests_from_xcode_and_visual_studio/ @@ -50,7 +50,7 @@ Planned features for future releases - order changes constantly... Also look thr - test execution in [separate processes](https://github.com/catchorg/Catch2/issues/853) - ```fork()``` for UNIX and [this](https://github.com/nemequ/munit/issues/2) for Windows - killing a test that exceeds a time limit (will perhaps require threading or processes) - [symbolizer](https://github.com/facebook/folly/tree/master/folly/experimental/symbolizer) - for a stack trace - when an assertion fails - and it's in a user function with some deep callstack away from the current test case - how to know the exact code path that lead to the failing assert -- ability to make the framework not capture unexpected exceptions - as requested [here](https://github.com/onqtam/doctest/issues/12#issuecomment-235334585) +- ability to make the framework not capture unexpected exceptions - as requested [here](https://github.com/doctest/doctest/issues/12#issuecomment-235334585) - add Approx ability to compare with absolute epsilon - [Catch PR](https://github.com/catchorg/Catch2/pull/538) - ability to customize the colors in the console output (may also use styles - based on [this](https://github.com/agauniyal/rang) or [this](https://github.com/ikalnytskyi/termcolor)) - implement breaking into the debugger under linux - see [here](https://github.com/catchorg/Catch2/pull/585) and [here](https://github.com/scottt/debugbreak) diff --git a/doc/markdown/stringification.md b/doc/markdown/stringification.md index 4ce75385d..75d34339b 100644 --- a/doc/markdown/stringification.md +++ b/doc/markdown/stringification.md @@ -3,7 +3,7 @@ **doctest** needs to be able to convert types you use in assertions and logging expressions into strings (for logging and reporting purposes). Most built-in types are supported out of the box but there are three ways that you can tell **doctest** how to convert your own types (or other, third-party types) into strings. -For stringifying enums checkout [this issue](https://github.com/onqtam/doctest/issues/121). +For stringifying enums checkout [this issue](https://github.com/doctest/doctest/issues/121). ## ```operator<<``` overload for ```std::ostream``` diff --git a/doc/markdown/testcases.md b/doc/markdown/testcases.md index 8ffd18c73..957a60946 100644 --- a/doc/markdown/testcases.md +++ b/doc/markdown/testcases.md @@ -48,7 +48,7 @@ When any of these macros are used the console reporter recognises them and forma Other than the additional prefixes and the formatting in the console reporter these macros behave exactly as ```TEST_CASE```s and ```SUBCASE```s. As such there is nothing enforcing the correct sequencing of these macros - that's up to the programmer! -Note that when using the [`--test-case=`](https://github.com/onqtam/doctest/blob/master/doc/markdown/commandline.md) command line option (or `--subcase=`) you will have to pass the prefix `Scenario: ` as well. +Note that when using the [`--test-case=`](https://github.com/doctest/doctest/blob/master/doc/markdown/commandline.md) command line option (or `--subcase=`) you will have to pass the prefix `Scenario: ` as well. ## Test fixtures diff --git a/doc/markdown/tutorial.md b/doc/markdown/tutorial.md index 96d9f1074..ae6dd102b 100644 --- a/doc/markdown/tutorial.md +++ b/doc/markdown/tutorial.md @@ -1,6 +1,6 @@ ## Tutorial -To get started with **doctest** all you need is to download the [**latest version**](https://raw.githubusercontent.com/onqtam/doctest/master/doctest/doctest.h) which is just a single header and include it in your source files (or add this repository as a git submodule). +To get started with **doctest** all you need is to download the [**latest version**](https://raw.githubusercontent.com/doctest/doctest/master/doctest/doctest.h) which is just a single header and include it in your source files (or add this repository as a git submodule). This tutorial assumes you can use the header directly: ```#include "doctest.h"``` - so it is either in the same folder with your test source files or you have set up the include paths to it in your build system properly. diff --git a/doctest/doctest.h b/doctest/doctest.h index 5449014cb..38a8f54c5 100644 --- a/doctest/doctest.h +++ b/doctest/doctest.h @@ -11,7 +11,7 @@ // https://opensource.org/licenses/MIT // // The documentation can be found at the library's page: -// https://github.com/onqtam/doctest/blob/master/doc/markdown/readme.md +// https://github.com/doctest/doctest/blob/master/doc/markdown/readme.md // // ================================================================================================= // ================================================================================================= @@ -457,7 +457,7 @@ template class tuple; #if DOCTEST_MSVC >= DOCTEST_COMPILER(19, 20, 0) DOCTEST_CLANG_SUPPRESS_WARNING_WITH_PUSH("-Wreserved-identifier") -// see this issue on why this is needed: https://github.com/onqtam/doctest/issues/183 +// see this issue on why this is needed: https://github.com/doctest/doctest/issues/183 template class allocator; template @@ -1019,7 +1019,7 @@ String toString(const DOCTEST_REF_WRAP(T) value) { } #if DOCTEST_MSVC >= DOCTEST_COMPILER(19, 20, 0) -// see this issue on why this is needed: https://github.com/onqtam/doctest/issues/183 +// see this issue on why this is needed: https://github.com/doctest/doctest/issues/183 DOCTEST_INTERFACE String toString(const std::string& in); #endif // VS 2019 @@ -1311,7 +1311,7 @@ DOCTEST_CLANG_SUPPRESS_WARNING_WITH_PUSH("-Wunused-comparison") DOCTEST_NOINLINE operator Result() { // this is needed only for MSVC 2015: -// https://ci.appveyor.com/project/onqtam/doctest/builds/38181202 +// https://ci.appveyor.com/project/doctest/doctest/builds/38181202 DOCTEST_MSVC_SUPPRESS_WARNING_WITH_PUSH(4800) // 'int': forcing value to bool bool res = static_cast(lhs); DOCTEST_MSVC_SUPPRESS_WARNING_POP @@ -2886,7 +2886,7 @@ DOCTEST_MAKE_STD_HEADERS_CLEAN_FROM_WARNINGS_ON_WALL_BEGIN #include #include #include -// borland (Embarcadero) compiler requires math.h and not cmath - https://github.com/onqtam/doctest/pull/37 +// borland (Embarcadero) compiler requires math.h and not cmath - https://github.com/doctest/doctest/pull/37 #ifdef __BORLANDC__ #include #endif // __BORLANDC__ @@ -2944,7 +2944,7 @@ DOCTEST_MAKE_STD_HEADERS_CLEAN_FROM_WARNINGS_ON_WALL_BEGIN #endif // DOCTEST_PLATFORM_WINDOWS -// this is a fix for https://github.com/onqtam/doctest/issues/348 +// this is a fix for https://github.com/doctest/doctest/issues/348 // https://mail.gnome.org/archives/xml/2012-January/msg00000.html #if !defined(HAVE_UNISTD_H) && !defined(STDOUT_FILENO) #define STDOUT_FILENO fileno(stdout) @@ -3630,7 +3630,7 @@ DOCTEST_TO_STRING_OVERLOAD(int long long unsigned, "%llu") String toString(std::nullptr_t) { return "NULL"; } #if DOCTEST_MSVC >= DOCTEST_COMPILER(19, 20, 0) -// see this issue on why this is needed: https://github.com/onqtam/doctest/issues/183 +// see this issue on why this is needed: https://github.com/doctest/doctest/issues/183 String toString(const std::string& in) { return in.c_str(); } #endif // VS 2019 diff --git a/doctest/extensions/doctest_util.h b/doctest/extensions/doctest_util.h index 00e1151e4..bdf6fa5ca 100644 --- a/doctest/extensions/doctest_util.h +++ b/doctest/extensions/doctest_util.h @@ -8,7 +8,7 @@ // https://opensource.org/licenses/MIT // // The documentation can be found at the library's page: -// https://github.com/onqtam/doctest/blob/master/doc/markdown/readme.md +// https://github.com/doctest/doctest/blob/master/doc/markdown/readme.md // #pragma once diff --git a/doctest/parts/doctest.cpp b/doctest/parts/doctest.cpp index 48efbfce3..aa3666ac4 100644 --- a/doctest/parts/doctest.cpp +++ b/doctest/parts/doctest.cpp @@ -59,7 +59,7 @@ DOCTEST_MAKE_STD_HEADERS_CLEAN_FROM_WARNINGS_ON_WALL_BEGIN #include #include #include -// borland (Embarcadero) compiler requires math.h and not cmath - https://github.com/onqtam/doctest/pull/37 +// borland (Embarcadero) compiler requires math.h and not cmath - https://github.com/doctest/doctest/pull/37 #ifdef __BORLANDC__ #include #endif // __BORLANDC__ @@ -117,7 +117,7 @@ DOCTEST_MAKE_STD_HEADERS_CLEAN_FROM_WARNINGS_ON_WALL_BEGIN #endif // DOCTEST_PLATFORM_WINDOWS -// this is a fix for https://github.com/onqtam/doctest/issues/348 +// this is a fix for https://github.com/doctest/doctest/issues/348 // https://mail.gnome.org/archives/xml/2012-January/msg00000.html #if !defined(HAVE_UNISTD_H) && !defined(STDOUT_FILENO) #define STDOUT_FILENO fileno(stdout) @@ -803,7 +803,7 @@ DOCTEST_TO_STRING_OVERLOAD(int long long unsigned, "%llu") String toString(std::nullptr_t) { return "NULL"; } #if DOCTEST_MSVC >= DOCTEST_COMPILER(19, 20, 0) -// see this issue on why this is needed: https://github.com/onqtam/doctest/issues/183 +// see this issue on why this is needed: https://github.com/doctest/doctest/issues/183 String toString(const std::string& in) { return in.c_str(); } #endif // VS 2019 diff --git a/doctest/parts/doctest_fwd.h b/doctest/parts/doctest_fwd.h index 6c433adbf..47130efc7 100644 --- a/doctest/parts/doctest_fwd.h +++ b/doctest/parts/doctest_fwd.h @@ -8,7 +8,7 @@ // https://opensource.org/licenses/MIT // // The documentation can be found at the library's page: -// https://github.com/onqtam/doctest/blob/master/doc/markdown/readme.md +// https://github.com/doctest/doctest/blob/master/doc/markdown/readme.md // // ================================================================================================= // ================================================================================================= @@ -454,7 +454,7 @@ template class tuple; #if DOCTEST_MSVC >= DOCTEST_COMPILER(19, 20, 0) DOCTEST_CLANG_SUPPRESS_WARNING_WITH_PUSH("-Wreserved-identifier") -// see this issue on why this is needed: https://github.com/onqtam/doctest/issues/183 +// see this issue on why this is needed: https://github.com/doctest/doctest/issues/183 template class allocator; template @@ -1016,7 +1016,7 @@ String toString(const DOCTEST_REF_WRAP(T) value) { } #if DOCTEST_MSVC >= DOCTEST_COMPILER(19, 20, 0) -// see this issue on why this is needed: https://github.com/onqtam/doctest/issues/183 +// see this issue on why this is needed: https://github.com/doctest/doctest/issues/183 DOCTEST_INTERFACE String toString(const std::string& in); #endif // VS 2019 @@ -1308,7 +1308,7 @@ DOCTEST_CLANG_SUPPRESS_WARNING_WITH_PUSH("-Wunused-comparison") DOCTEST_NOINLINE operator Result() { // this is needed only for MSVC 2015: -// https://ci.appveyor.com/project/onqtam/doctest/builds/38181202 +// https://ci.appveyor.com/project/doctest/doctest/builds/38181202 DOCTEST_MSVC_SUPPRESS_WARNING_WITH_PUSH(4800) // 'int': forcing value to bool bool res = static_cast(lhs); DOCTEST_MSVC_SUPPRESS_WARNING_POP diff --git a/examples/all_features/CMakeLists.txt b/examples/all_features/CMakeLists.txt index 0433dd1a1..5027f257b 100644 --- a/examples/all_features/CMakeLists.txt +++ b/examples/all_features/CMakeLists.txt @@ -86,7 +86,7 @@ doctest_add_test(NAME all_binary ${common_args} -tc=all?binary* -s) # print all doctest_add_test(NAME abort_after ${common_args} -aa=2 -e=off -sf=*coverage*) # abort after 2 assert fails and parse a negative doctest_add_test(NAME first_last ${common_args} -f=2 -l=4 -sf=*coverage*) # run a range doctest_add_test(NAME filter_1 ${common_args} -ts=none) # should filter out all -# -order-by=name to avoid different output depending on the compiler used. See https://github.com/onqtam/doctest/issues/287 +# -order-by=name to avoid different output depending on the compiler used. See https://github.com/doctest/doctest/issues/287 doctest_add_test(NAME filter_2 COMMAND $ -tse=* -nv -order-by=name) # should filter out all + print skipped doctest_add_test(NAME filter_3 ${common_args} -sc=from*,sc* -sce=sc2 -sf=*subcases*) # enter a specific subcase - sc1 doctest_add_test(NAME order_1 ${common_args} -ob=suite -ns -sf=*test_cases_and_suites*) diff --git a/examples/all_features/subcases.cpp b/examples/all_features/subcases.cpp index 3755c4f1a..506fdb7d0 100644 --- a/examples/all_features/subcases.cpp +++ b/examples/all_features/subcases.cpp @@ -121,7 +121,7 @@ static void checks(int data) DOCTEST_SUBCASE("check data 2") { REQUIRE(data % 4 == 0); } } -TEST_CASE("Nested - related to https://github.com/onqtam/doctest/issues/282") +TEST_CASE("Nested - related to https://github.com/doctest/doctest/issues/282") { DOCTEST_SUBCASE("generate data variant 1") { diff --git a/examples/all_features/test_output/filter_2_xml.txt b/examples/all_features/test_output/filter_2_xml.txt index 0524c845c..075c09a12 100644 --- a/examples/all_features/test_output/filter_2_xml.txt +++ b/examples/all_features/test_output/filter_2_xml.txt @@ -4,7 +4,7 @@ - + diff --git a/examples/all_features/test_output/filter_3_junit.txt b/examples/all_features/test_output/filter_3_junit.txt index 0a84efe8b..82457f9a5 100644 --- a/examples/all_features/test_output/filter_3_junit.txt +++ b/examples/all_features/test_output/filter_3_junit.txt @@ -8,7 +8,7 @@ root - + diff --git a/examples/all_features/test_output/filter_3_xml.txt b/examples/all_features/test_output/filter_3_xml.txt index 4edeb7d18..f8ba04bed 100644 --- a/examples/all_features/test_output/filter_3_xml.txt +++ b/examples/all_features/test_output/filter_3_xml.txt @@ -38,7 +38,7 @@ root - + diff --git a/examples/all_features/test_output/subcases.cpp_junit.txt b/examples/all_features/test_output/subcases.cpp_junit.txt index 3efcc004d..e2fd1a907 100644 --- a/examples/all_features/test_output/subcases.cpp_junit.txt +++ b/examples/all_features/test_output/subcases.cpp_junit.txt @@ -72,10 +72,10 @@ CHECK( false ) is NOT correct! failure... but the show must go on! - - - - + + + + diff --git a/examples/all_features/test_output/subcases.cpp_xml.txt b/examples/all_features/test_output/subcases.cpp_xml.txt index 183592681..061c3b247 100644 --- a/examples/all_features/test_output/subcases.cpp_xml.txt +++ b/examples/all_features/test_output/subcases.cpp_xml.txt @@ -169,7 +169,7 @@ root - + diff --git a/examples/combining_the_same_tests_built_differently_in_multiple_shared_objects/CMakeLists.txt b/examples/combining_the_same_tests_built_differently_in_multiple_shared_objects/CMakeLists.txt index e6c75e93b..45014fa6c 100644 --- a/examples/combining_the_same_tests_built_differently_in_multiple_shared_objects/CMakeLists.txt +++ b/examples/combining_the_same_tests_built_differently_in_multiple_shared_objects/CMakeLists.txt @@ -1,4 +1,4 @@ -# for more information about this example refer to the GitHub issue: https://github.com/onqtam/doctest/issues/436 +# for more information about this example refer to the GitHub issue: https://github.com/doctest/doctest/issues/436 # create the test runner, to which all other targets will link to add_library(test_runner SHARED test_runner.cpp) diff --git a/examples/exe_with_static_libs/doctest_force_link_static_lib_in_target.cmake b/examples/exe_with_static_libs/doctest_force_link_static_lib_in_target.cmake index ecabc4123..8b696e36f 100644 --- a/examples/exe_with_static_libs/doctest_force_link_static_lib_in_target.cmake +++ b/examples/exe_with_static_libs/doctest_force_link_static_lib_in_target.cmake @@ -29,7 +29,7 @@ endfunction() # this is the magic function - forces every object file from the library to be linked into the target (dll or executable) # it doesn't work in 2 scenarios: -# - either the target or the library uses a precompiled header - see the end of this issue for details: https://github.com/onqtam/doctest/issues/21 +# - either the target or the library uses a precompiled header - see the end of this issue for details: https://github.com/doctest/doctest/issues/21 # - either the target or the library is an imported target (pre-built) and not built within the current cmake tree # Alternatives: # - use CMake object libraries instead of static libraries - >> THIS IS ACTUALLY PREFERRED << to all this CMake trickery diff --git a/scripts/data/article.txt b/scripts/data/article.txt index 206d1b084..7854a328d 100644 --- a/scripts/data/article.txt +++ b/scripts/data/article.txt @@ -2,7 +2,7 @@ doctest is a fully open source light and feature-rich C++11 single-header testing framework for unit tests and TDD. -Web Site: https://github.com/onqtam/doctest +Web Site: https://github.com/doctest/doctest Version tested: 2.0.0 System requirements: C++11 or newer License & Pricing: MIT, free @@ -249,9 +249,9 @@ The development of doctest is supported with donations. [4] https://github.com/cpputest/cpputest [5] https://github.com/google/googletest [6] https://en.wikipedia.org/wiki/List_of_unit_testing_frameworks#C.2B.2B -[7] https://github.com/onqtam/doctest/blob/master/doc/markdown/faq.md#how-is-doctest-different-from-catch -[8] https://github.com/onqtam/doctest/blob/master/doc/markdown/features.md -[9] https://github.com/onqtam/doctest/blob/master/doc/markdown/roadmap.md -[10] https://github.com/onqtam/doctest/blob/master/doc/markdown/benchmarks.md -[11] https://github.com/onqtam/doctest/blob/master/doc/markdown/assertions.md#fast-asserts +[7] https://github.com/doctest/doctest/blob/master/doc/markdown/faq.md#how-is-doctest-different-from-catch +[8] https://github.com/doctest/doctest/blob/master/doc/markdown/features.md +[9] https://github.com/doctest/doctest/blob/master/doc/markdown/roadmap.md +[10] https://github.com/doctest/doctest/blob/master/doc/markdown/benchmarks.md +[11] https://github.com/doctest/doctest/blob/master/doc/markdown/assertions.md#fast-asserts [12] http://baptiste-wicht.com/posts/2016/09/blazing-fast-unit-test-compilation-with-doctest-11.html diff --git a/scripts/data/article2.txt b/scripts/data/article2.txt index 0555366e0..9f94d9522 100644 --- a/scripts/data/article2.txt +++ b/scripts/data/article2.txt @@ -122,32 +122,32 @@ Testing is a fundamental aspect of software engineering and the stakes are getti doctest [0] stands out with its ability to write tests in a new and easier way - unlocking the potential for more thorough, up-to-date and uniform testing. Locality is king not only in CPU caches. There is quite a lot of work left which can be seen in the roadmap [27] - exciting times ahead! If you are curious about implementation details of the framework make sure to checkout the CppCon [28] presentation! -[0] https://github.com/onqtam/doctest -[1] https://github.com/onqtam/doctest/blob/master/doc/markdown/benchmarks.md -[2] https://starcharts.herokuapp.com/onqtam/doctest -[3] https://github.com/onqtam/doctest/blob/master/doc/markdown/assertions.md#expression-decomposing-asserts -[4] https://github.com/onqtam/doctest/blob/master/doc/markdown/faq.md#is-doctest-thread-aware -[5] https://github.com/onqtam/doctest/blob/master/doc/markdown/configuration.md#doctest_config_no_exceptions -[6] https://github.com/onqtam/doctest/blob/master/doc/markdown/tutorial.md#test-cases-and-subcases -[7] https://github.com/onqtam/doctest/blob/master/doc/markdown/logging.md -[8] https://github.com/onqtam/doctest/blob/master/doc/markdown/reporters.md -[9] https://github.com/onqtam/doctest/blob/master/doc/markdown/parameterized-tests.md#templated-test-cases---parameterized-by-type -[10] https://github.com/onqtam/doctest/blob/master/doc/markdown/testcases.md#test-suites -[11] https://github.com/onqtam/doctest/blob/master/doc/markdown/testcases.md#decorators -[12] https://github.com/onqtam/doctest/blob/master/doc/markdown/commandline.md -[13] https://github.com/onqtam/doctest/blob/master/doc/markdown/features.md#other-features -[14] https://github.com/onqtam/doctest/blob/master/doc/markdown/benchmarks.md#cost-of-including-the-header -[15] https://github.com/onqtam/doctest/blob/master/doc/markdown/benchmarks.md#cost-of-an-assertion-macro -[16] https://github.com/onqtam/doctest/blob/master/doc/markdown/configuration.md#doctest_config_disable -[17] https://github.com/onqtam/doctest/blob/master/doc/markdown/features.md#unintrusive-transparent -[18] https://github.com/onqtam/doctest/blob/master/doc/markdown/features.md#extremely-portable -[19] https://github.com/onqtam/doctest/blob/master/doc/markdown/main.md -[20] https://github.com/onqtam/doctest/blob/master/doc/markdown/configuration.md#doctest_config_implementation_in_dll -[21] https://github.com/onqtam/doctest/tree/master/examples/executable_dll_and_plugin -[22] https://github.com/onqtam/doctest/blob/master/doc/markdown/assertions.md#using-asserts-out-of-a-testing-context -[23] https://github.com/onqtam/doctest/blob/master/examples/all_features/asserts_used_outside_of_tests.cpp#L18 -[24] https://github.com/onqtam/doctest/blob/master/doc/markdown/assertions.md#binary-and-unary-asserts -[25] https://github.com/onqtam/doctest/blob/master/doc/markdown/configuration.md#doctest_config_super_fast_asserts -[26] https://github.com/onqtam/doctest/blob/master/doc/markdown/faq.md#how-to-get-the-best-compile-time-performance-with-the-framework -[27] https://github.com/onqtam/doctest/blob/master/doc/markdown/roadmap.md +[0] https://github.com/doctest/doctest +[1] https://github.com/doctest/doctest/blob/master/doc/markdown/benchmarks.md +[2] https://starcharts.herokuapp.com/doctest/doctest +[3] https://github.com/doctest/doctest/blob/master/doc/markdown/assertions.md#expression-decomposing-asserts +[4] https://github.com/doctest/doctest/blob/master/doc/markdown/faq.md#is-doctest-thread-aware +[5] https://github.com/doctest/doctest/blob/master/doc/markdown/configuration.md#doctest_config_no_exceptions +[6] https://github.com/doctest/doctest/blob/master/doc/markdown/tutorial.md#test-cases-and-subcases +[7] https://github.com/doctest/doctest/blob/master/doc/markdown/logging.md +[8] https://github.com/doctest/doctest/blob/master/doc/markdown/reporters.md +[9] https://github.com/doctest/doctest/blob/master/doc/markdown/parameterized-tests.md#templated-test-cases---parameterized-by-type +[10] https://github.com/doctest/doctest/blob/master/doc/markdown/testcases.md#test-suites +[11] https://github.com/doctest/doctest/blob/master/doc/markdown/testcases.md#decorators +[12] https://github.com/doctest/doctest/blob/master/doc/markdown/commandline.md +[13] https://github.com/doctest/doctest/blob/master/doc/markdown/features.md#other-features +[14] https://github.com/doctest/doctest/blob/master/doc/markdown/benchmarks.md#cost-of-including-the-header +[15] https://github.com/doctest/doctest/blob/master/doc/markdown/benchmarks.md#cost-of-an-assertion-macro +[16] https://github.com/doctest/doctest/blob/master/doc/markdown/configuration.md#doctest_config_disable +[17] https://github.com/doctest/doctest/blob/master/doc/markdown/features.md#unintrusive-transparent +[18] https://github.com/doctest/doctest/blob/master/doc/markdown/features.md#extremely-portable +[19] https://github.com/doctest/doctest/blob/master/doc/markdown/main.md +[20] https://github.com/doctest/doctest/blob/master/doc/markdown/configuration.md#doctest_config_implementation_in_dll +[21] https://github.com/doctest/doctest/tree/master/examples/executable_dll_and_plugin +[22] https://github.com/doctest/doctest/blob/master/doc/markdown/assertions.md#using-asserts-out-of-a-testing-context +[23] https://github.com/doctest/doctest/blob/master/examples/all_features/asserts_used_outside_of_tests.cpp#L18 +[24] https://github.com/doctest/doctest/blob/master/doc/markdown/assertions.md#binary-and-unary-asserts +[25] https://github.com/doctest/doctest/blob/master/doc/markdown/configuration.md#doctest_config_super_fast_asserts +[26] https://github.com/doctest/doctest/blob/master/doc/markdown/faq.md#how-to-get-the-best-compile-time-performance-with-the-framework +[27] https://github.com/doctest/doctest/blob/master/doc/markdown/roadmap.md [28] https://www.youtube.com/watch?v=eH1CxEC29l8 diff --git a/scripts/random_dev_notes.md b/scripts/random_dev_notes.md index 1bdd25451..f47b98b8f 100644 --- a/scripts/random_dev_notes.md +++ b/scripts/random_dev_notes.md @@ -5,8 +5,6 @@ move down from /Wall to /W4 for Visual Studio... /Wall is absolutely unnecessary https://github.com/catchorg/Catch2/blob/master/docs/tostring.md#catchis_range-specialisation -rope-ish startup of doctest - and filter duplicates on run() - https://blog.travis-ci.com/2018-10-11-windows-early-release add in the faq about the compile errors with stream<<"array" - nikola goranov, also moving to catch undef/define stuffs - use vararg macro, also make the "moving from catch to doctest" easier to find, also this: https://stackoverflow.com/questions/35530850/how-to-require-a-semicolon-after-a-macro/52122660#52122660 @@ -66,7 +64,3 @@ https://github.com/martinmoene/catch-lest-other-comparison - https://github.com/catchorg/Catch2/pull/1405 - toString trouble - https://github.com/catchorg/Catch2/issues/741 - https://github.com/catchorg/Catch2/commit/33ed1773f40b406dbf3b7201bf52694bd86b1503 - -- I suspect -Wsign-compare is not being silenced by the pragmas... - see this build - https://travis-ci.org/onqtam/game/jobs/196987454 - check_eq(numDigits(0), 1); numDigits returns uint32