Software testing

2024-08-20T06:04:16Z

Callahanp: /* Structure of a CPPUnit test */

Software testing

2024-08-20T05:49:35Z

Callahanp: /* Structure of a CPPUnit test */

2024-05-31T01:24:00Z

Callahanp:

==Start With==

*[[/cmake.org/getting-started/|https://cmake.org/getting-started/]] -- Build using g++ and clang.
*[[/learn.microsoft.com/en-us/vcpkg/|https://learn.microsoft.com/en-us/vcpkg/]] -- cross-platform C/C++ package manager
*[[https://www.jenkins.io/ -- Automation Server
*[[/www.sourceware.org/gdb/|https://www.sourceware.org/gdb/]] or [[/lldb.llvm.org/|https://lldb.llvm.org/]] -- Debuggers
*[[/github.com/google/sanitizers|https://github.com/google/sanitizers]] -- Read about each of the available sanitizers
*[[/valgrind.org/docs/manual/quick-start.html|https://valgrind.org/docs/manual/quick-start.html]] -- A suite of debugging and profiling tools
*A review of all the options for each tool you want to acquire.

== Reading Lists ==

=== Overviews ===

{| class="wikitable"
! Topic !! Overview !! Options !! Progress !! Notes !!
|-
| vcpkg || https://learn.microsoft.com/en-us/vcpkg/ ||
|-
| apt || https://wiki.debian.org/Apt ||
|-
| cmake || https://cmake.org/getting-started/ ||
|-
| g++ || https://www.gnu.org/software/gcc/ ||
|-
| gdb || https://www.sourceware.org/gdb/ ||
|-
| llvm || llvm.org ||
|-
| clang || https://clang.llvm.org/ ||
|-
| lldb || https://lldb.llvm.org/ ||
|-
| valgrind || https://valgrind.org/ ||
|-
| lcov || https://github.com/linux-test-project/lcov || -DENABLE_COVERAGE=1
if (ENABLE_COVERAGE)
set(CMAKE_BUILD_TYPE "Debug" CACHE STRING
"set the build type." FORCE)
include(CodeCoverage.cmake)
append_coverage_compiler_flags()
endif()

add_executable
target_link_libraries( a.exe test_a.cpp CPPUnit::CPPUnit
if (ENABLE_COVERAGE)
setup_target_for_coverage_lcov(
NAME coverage
EXECUTABLE ${cmake_current_binarey_dir}/test_a
LCOV_ARGS --rc lcov_branch_coverage=1
GENHTML_ARGS --legend --branch-coveragbe
DEPENDENCIES test_a)
|-

| sanitizers || https://github.com/google/sanitizers
https://www.cl.cam.ac.uk/~nk480/C1819/lecture5.pdf
|
|-
| asan || https://github.com/google/sanitizers/wiki/AddressSanitizer ||gdb & clang:
CMAKE_CXX_FLAGS -fsanitize=address
CMAKE_EXE_LINKER_FLAGS -fsanitize=address
|-
| msan || https://github.com/google/sanitizers/wiki/MemorySanitizer ||
|-
| tsan || https://github.com/google/sanitizers/wiki/ThreadSanitizerCppManual ||
|-
| ubsan || https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html || gdb & clang:
CMAKE_CXX_FLAGS -fsanitize=undefined
CMAKE_EXE_LINKER_FLAGS -fsanitize=undefined
|}

==Start With==

*[[/cmake.org/getting-started/|https://cmake.org/getting-started/]] -- Build using g++ and clang.
*[[/learn.microsoft.com/en-us/vcpkg/|https://learn.microsoft.com/en-us/vcpkg/]] -- cross-platform C/C++ package manager
*[[/www.sourceware.org/gdb/|https://www.sourceware.org/gdb/]] or [[/lldb.llvm.org/|https://lldb.llvm.org/]] -- Debuggers
*[[/github.com/google/sanitizers|https://github.com/google/sanitizers]] -- Read about each of the available sanitizers
*[[/valgrind.org/docs/manual/quick-start.html|https://valgrind.org/docs/manual/quick-start.html]] -- A suite of debugging and profiling tools
*A review of all the options for each tool you want to acquire.

== Reading Lists ==

=== Overviews ===

{| class="wikitable"
! Topic !! Overview !! Options !! Progress !! Notes !!
|-
| vcpkg || https://learn.microsoft.com/en-us/vcpkg/ ||
|-
| apt || https://wiki.debian.org/Apt ||
|-
| cmake || https://cmake.org/getting-started/ ||
|-
| g++ || https://www.gnu.org/software/gcc/ ||
|-
| gdb || https://www.sourceware.org/gdb/ ||
|-
| llvm || llvm.org ||
|-
| clang || https://clang.llvm.org/ ||
|-
| lldb || https://lldb.llvm.org/ ||
|-
| valgrind || https://valgrind.org/ ||
|-
| sanitizers || https://github.com/google/sanitizers
https://www.cl.cam.ac.uk/~nk480/C1819/lecture5.pdf
|
|-
| asan || https://github.com/google/sanitizers/wiki/AddressSanitizer ||
|-
| msan || https://github.com/google/sanitizers/wiki/MemorySanitizer ||
|-
| tsan || https://github.com/google/sanitizers/wiki/ThreadSanitizerCppManual ||
|-
| ubsan || https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html ||

|}

==Start With==

*[[/cmake.org/getting-started/|https://cmake.org/getting-started/]] -- Build using g++ and clang.
*[[/learn.microsoft.com/en-us/vcpkg/|https://learn.microsoft.com/en-us/vcpkg/]] -- cross-platform C/C++ package manager
*[[/www.sourceware.org/gdb/|https://www.sourceware.org/gdb/]] or [[/lldb.llvm.org/|https://lldb.llvm.org/]] -- Debuggers
*[[/github.com/google/sanitizers|https://github.com/google/sanitizers]] -- Read about each of the available sanitizers
*[[/valgrind.org/docs/manual/quick-start.html|https://valgrind.org/docs/manual/quick-start.html]] -- A suite of debugging and profiling tools
*A review of all the options for each tool you want to acquire.

== Reading Lists ==

=== Overviews ===

{| class="wikitable"
! Topic !! Overview !! Options !! Progress !! Notes !!
|-
| vcpkg || https://learn.microsoft.com/en-us/vcpkg/ ||
|-
| apt || https://wiki.debian.org/Apt ||
|-
| cmake || https://cmake.org/getting-started/ ||
|-
| g++ || https://www.gnu.org/software/gcc/ ||
|-
| gdb || https://www.sourceware.org/gdb/ ||
|-
| llvm || llvm.org ||
|-
| clang || https://clang.llvm.org/ ||
|-
| lldb || https://lldb.llvm.org/ ||
|-
| valgrind || https://valgrind.org/ ||
|-
| sanitizers || https://github.com/google/sanitizers
https://www.cl.cam.ac.uk/~nk480/C1819/lecture5.pdf
|
|-
| asan || https://github.com/google/sanitizers/wiki/AddressSanitizer ||
|-
| msan || https://github.com/google/sanitizers/wiki/MemorySanitizer ||
|-
| tsan || https://github.com/google/sanitizers/wiki/ThreadSanitizerCppManual ||
|-
| ubsan || https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html ||

|}

=== Integration ===

{| class="wikitable"
! Topic !! Download_and_compile.sh !! dev1
|-
| vcpkg || ||
|-
| apt || ||
|-
| cmake || ||
|-
| g++ || ||
|-
| gdb || ||
|-
| llvm || ||
|-
| clang || ||
|-
| lldb || ||
|-
| valgrind || ||
|-
| sanitizers || ||
|-
| asan || ||
|-
| msan || ||
|-
| tsan || ||
|-
| ubsan || ||

|}

==Follow-on Questions==

* Does g++ support each of these sanitizers?
* What other tools should I research besides gdb, lldb, valgrind, UBSAN, ASAN, TSAN, and MSAN?
* Are there tools other than sanitizers and debuggers I should know about?
* Are there obsolete tools I should ignore?
* Are there books that cover C++ topics beyond writing C++? How about how-to guides? (I'll be searching for these next, but do you happen to know any particularly useful and easy to read?
* In his reply, [[/www.reddit.com/user/Ujjawal-Gupta/|Ujjawal-Gupta]] mentions crash dumps and crash dump tools. I don't know much about them. What good resources on this topic are there for Linux, Windows, and Mac?

== Background ==
I'm about to start going through the list above for myself. It may take a while.

I'm currently involved in a project with about half a million existing lines of C++ code and want to know what tools I need to work in this environment properly. The application has multi-threaded parts.

I can do basic g++, Debug, DebWithRelInfo, and Release builds using cmake or a pre-defined build script and step through code line-by-line with the gdb in VSCode, but want to become familiar with gdb at the command line.

I want to come up to speed with clang and lldb in vscode.

[[/stackoverflow.com/questions/63978029/setup-lldb-debugging-with-cpp-extension-in-vscode-linux|https://stackoverflow.com/questions/63978029/setup-lldb-debugging-with-cpp-extension-in-vscode-linux]]

== Other Thoughts ==

I need to familiarize myself with other tools available, learn how to enable particular tools in a build, and learn how to use the tool's output.

I want to learn to use tools like UBSAN, ASAN, TSAN, and MSAN effectively and how to switch from g++ to clang when appropriate. I want to learn what tools other than the sanitizers and debuggers above are available.

There's no such thing as free beer! Someone pays for flightgear cloud infrastructure that I personallly benefit from. So I contribute a little at:

<nowiki>https://liberapay.com/t3r</nowiki>

Currently working on:

Git Worktrees with download_and_compile.sh (done & working)

Web Socket Refactor & Fix.

OSM (Open Street Map) Scenery Build (on hold)

Goals (Maybe)

*Download Scenery from Current Scenery Developers
*Build Scripts for Scenery Land Class, Elevation, and OSM processing
*Understand the underlying formats in Flightgear Scenery
*Understand the processing of Scenery data between tiles in the build process and the running simulator
*Assist Scenery Developers with technical support.
*full explanation of the advantages and disadvantages of the worktree approach.

[[Hackathon Proposal: Property Subscription Improvements|Hackathon-2023-Proposal-Websocket-Property-Subscription-Improvements]]

User:Callahanp

2024-05-30T16:12:30Z

Callahanp: formatting

User:Callahanp

2024-05-30T16:08:49Z

Callahanp: What I'm really doing

Callahanp:Git Worktrees with download and compile.sh

2024-04-24T20:47:36Z

Callahanp: Created page with "A while ago I encountered the idea of using git worktrees for various branches instead of a single git workspace with stash and switch branches. I found the idea appealing for a number of reasons, but found that there are advantages and disadvantages to both approaches. A bit of explanation of both methods. {| class="wikitable" |+ Two Approaches to the problem of concurrent work on multiple branches |- ! Single Worktree !! Separate Git Worktrees |- | A user might have..."

A while ago I encountered the idea of using git worktrees for various branches instead of a single git workspace with stash and switch branches. I found the idea appealing for a number of reasons, but found that there are advantages and disadvantages to both approaches.

A bit of explanation of both methods.
{| class="wikitable"
|+ Two Approaches to the problem of concurrent work on multiple branches
|-
! Single Worktree !! Separate Git Worktrees
|-
| A user might have just one, or several complete clones of a set of repositories. Each of these clones would have a single worktree. If working on multiple branches the user might simply do the work on a separate set of clones, or they could use a single set by using git stash to move between branches.

|}

Reasons for adoption of one approach or the other might include
* A need to quickly produce separate builds for next, stable and lts versions
* A need to work on changes to multiple branches in parallel
* Comple
{| class="wikitable"
|+ Advantages
|-
! Single Worktree !! Separate Git Worktrees
|-
| Good for doing one thing at a time || Multitasking
|-
| Simple to change context: move to a different directory, or stash current branch work, switch branches as needed and continue|| Multiple contexts are all set up and ready to go
|-
| Less to keep track of ||
|-
| || Faster Context Switching
|-
| || Worktrees take up less space than a
|-
| Sequential Builds || Parallel Builds
|-
| 1 script sets up your environment. It's all you need. || Configuration file covers multiple working contexts in an easy to read format

|}

{| class="wikitable"
|+ Disadvantages
|-
! Single Worktree !! Separate Git Worktrees
|-
|
Manually track all the contexts in which you wish to work || More active contexts - You'll need tools to manage the complexity
|-
| When the work gets complex, managing it manually becomes harder || Definitely more complex, but then it supports very complex needs.
|-
| Multiple full copies of repositories in some situations || Requires some configuration to avoid manually setting up each working context.
|-

|}

User:Callahanp

2024-04-24T19:12:34Z

Callahanp:

There's no such thing as free beer! Someone pays for flightgear cloud infrastructure that I personallly benefit from. So I contribute a little at:

<nowiki>https://liberapay.com/t3r</nowiki>

Currently working on:

Git Worktrees with download_and_compile.sh

Web Socket Refactor & Fix.

OSM (Open Street Map) Scenery Build

Goals (Maybe)

* Download Scenery from Current Scenery Developers
* Build Scripts for Scenery Land Class, Elevation, and OSM processing
* Understand the underlying formats in Flightgear Scenery
* Understand the processing of Scenery data between tiles in the build process and the running simulator
* Assist Scenery Developers with technical support.
* full explanation of the advantages and disadvantages of the worktree approach.

[[Hackathon Proposal: Property Subscription Improvements|Hackathon-2023-Proposal-Websocket-Property-Subscription-Improvements]]

Software testing

2024-04-22T17:02:11Z

Callahanp:

Software testing

2024-04-22T16:52:15Z

Callahanp: