thodg/libgit2/tests/README.md

• Show log

  Commit

• Hash : f66e7f36
  Author :
  Date : 2021-10-28T10:25:09
  

  libgit2_clar is now libgit2_tests in #6083 the test runner was renamed to libgit2_tests, but not all references to the old name were updated. this change changes all of them to use the new name.

Download

$ cmake -DBUILD_TESTS=ON -DVALGRIND=ON ..
$ cmake --build .
$ valgrind --leak-check=full --show-reachable=yes --num-callers=50 --suppressions=../libgit2_tests.supp \
  ./libgit2_tests

$ MallocStackLogging=1 MallocScribble=1 MallocLogFile=/dev/null CLAR_AT_EXIT="leaks -quiet \$PPID" \
  ./libgit2_tests

Source

• tests/README.md

• Writing Clar tests for libgit2
  ==============================
  
  For information on the Clar testing framework and a detailed introduction
  please visit:
  
  https://github.com/vmg/clar
  
  
  * Write your modules and tests. Use good, meaningful names.
  
  * Make sure you actually build the tests by setting:
  
          cmake -DBUILD_TESTS=ON build/
  
  * Test:
  
          ./build/libgit2_tests
  
  * Make sure everything is fine.
  
  * Send your pull request. That's it.
  
  
  Memory leak checks
  ------------------
  
  These are automatically run as part of CI, but if you want to check locally:
  
  #### Linux
  
  Uses [`valgrind`](http://www.valgrind.org/):
  
  ```console
  $ cmake -DBUILD_TESTS=ON -DVALGRIND=ON ..
  $ cmake --build .
  $ valgrind --leak-check=full --show-reachable=yes --num-callers=50 --suppressions=../libgit2_tests.supp \
    ./libgit2_tests
  ```
  
  #### macOS
  
  Uses [`leaks`](https://developer.apple.com/library/archive/documentation/Performance/Conceptual/ManagingMemory/Articles/FindingLeaks.html), which requires XCode installed:
  
  ```console
  $ MallocStackLogging=1 MallocScribble=1 MallocLogFile=/dev/null CLAR_AT_EXIT="leaks -quiet \$PPID" \
    ./libgit2_tests
  ```
  

Download