add build fuzzing workflows

Author: Cryptkeeper

.github/workflows/cmake.yml

@@ -0,0 +1,80 @@
+name: CMake
+
+on:
+  push:
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  BUILD_TYPE: RelWithDebInfo
+
+jobs:
+  Ubuntu:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        compiler: [ "clang", "gcc" ]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Configure CMake
+        run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DCMAKE_C_COMPILER=${{matrix.compiler}}
+
+      - name: Build
+        run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
+
+      - name: CTest
+        working-directory: ${{github.workspace}}/build
+        run: ctest -C ${{env.BUILD_TYPE}}
+
+  Windows:
+    runs-on: windows-latest
+
+    defaults:
+      run:
+        shell: msys2 {0}
+
+    steps:
+      - uses: msys2/setup-msys2@v2
+        with:
+          msystem: mingw64
+          pacboy: >-
+            gcc:p
+            cmake:p
+            ninja:p
+
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Configure CMake
+        run: cmake -B build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -G Ninja
+
+      - name: Build
+        run: cmake --build build --config ${{env.BUILD_TYPE}}
+
+      - name: CTest
+        working-directory: ${{github.workspace}}\build
+        run: ctest -C ${{env.BUILD_TYPE}}
+
+  macOS:
+    runs-on: macos-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Configure CMake
+        run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
+
+      - name: Build
+        run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
+
+      - name: CTest
+        working-directory: ${{github.workspace}}/build
+        run: ctest -C ${{env.BUILD_TYPE}}

.github/workflows/fuzz.yml

@@ -0,0 +1,37 @@
+name: Fuzz
+
+on:
+  push:
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  BUILD_TYPE: Debug
+
+jobs:
+  Fuzz:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        test: [ "TFChannelRange_read", "TFCompressionBlock_read", "TFHeader_read" ]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Configure CMake
+        run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DCMAKE_C_COMPILER=clang -DENABLE_FUZZING=TRUE
+
+      - name: Build
+        run: cmake --build ${{github.workspace}}/build --target fuzz_${{matrix.test}} --config ${{env.BUILD_TYPE}}
+
+      - name: Fuzz
+        working-directory: ${{github.workspace}}/build
+        run: |
+          mkdir -p corpus
+          ./fuzz_${{matrix.test}} -max_total_time=30 -print_final_stats=1 corpus
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ${{matrix.test}}_corpus
+          path: ${{github.workspace}}/build/corpus

.gitignore

@@ -1,2 +1,6 @@
 # CLion
 .idea/
+
+# CMake
+cmake-build-debug/
+cmake-build-release/

CMakeLists.txt

@@ -0,0 +1,26 @@
+cmake_minimum_required(VERSION 3.24)
+project(tinyfseq C)
+
+set(CMAKE_C_STANDARD 99)
+
+enable_testing()
+
+add_executable(test_build test/build.c)
+add_test(build test_build)
+
+add_executable(test_TFError_string test/TFError_string.c)
+add_test(TFError_string test_TFError_string)
+
+if (ENABLE_FUZZING)
+    add_executable(fuzz_TFChannelRange_read fuzz/TFChannelRange_read.c)
+    target_link_libraries(fuzz_TFChannelRange_read "-fsanitize=fuzzer")
+    target_compile_options(fuzz_TFChannelRange_read PRIVATE "-fsanitize=fuzzer")
+
+    add_executable(fuzz_TFCompressionBlock_read fuzz/TFCompressionBlock_read.c)
+    target_link_libraries(fuzz_TFCompressionBlock_read "-fsanitize=fuzzer")
+    target_compile_options(fuzz_TFCompressionBlock_read PRIVATE "-fsanitize=fuzzer")
+
+    add_executable(fuzz_TFHeader_read fuzz/TFHeader_read.c)
+    target_link_libraries(fuzz_TFHeader_read "-fsanitize=fuzzer")
+    target_compile_options(fuzz_TFHeader_read PRIVATE "-fsanitize=fuzzer")
+endif ()

README.md

@@ -8,7 +8,7 @@ A single-file library (~150 LOC) for decoding FSEQ (.fseq) v2.0+ sequence files
 - `#include "tinyfseq.h"` as expected (you may need to modify the path).
 - Define `TINYFSEQ_IMPLEMENTATION` in a single C/C++ source code file ([more info on using single-file libraries](https://github.com/nothings/stb#how-do-i-use-these-libraries))
 
-A short example of including libtinyfseq and decoding a file header is available in [`example.c`](example.c)
+A short example of including libtinyfseq and printing the library version is available in the form of a [`test/build.c`](unit test).
 
 ## Compatibility
 

example.c

@@ -0,0 +1,10 @@
+#include <stdio.h>
+
+#define TINYFSEQ_IMPLEMENTATION
+#include "../tinyfseq.h"
+
+int LLVMFuzzerTestOneInput(const uint8_t *data, const size_t size) {
+    TFChannelRange range;
+    TFChannelRange_read(data, size, &range, NULL);
+    return 0;
+}

fuzz/TFChannelRange_read.c

@@ -0,0 +1,10 @@
+#include <stdio.h>
+
+#define TINYFSEQ_IMPLEMENTATION
+#include "../tinyfseq.h"
+
+int LLVMFuzzerTestOneInput(const uint8_t *data, const size_t size) {
+    TFCompressionBlock block;
+    TFCompressionBlock_read(data, size, &block, NULL);
+    return 0;
+}

fuzz/TFCompressionBlock_read.c

@@ -0,0 +1,10 @@
+#include <stdio.h>
+
+#define TINYFSEQ_IMPLEMENTATION
+#include "../tinyfseq.h"
+
+int LLVMFuzzerTestOneInput(const uint8_t *data, const size_t size) {
+    TFHeader header;
+    TFHeader_read(data, size, &header, NULL);
+    return 0;
+}

fuzz/TFHeader_read.c

@@ -0,0 +1,20 @@
+#undef NDEBUG
+#include <assert.h>
+#include <limits.h>
+#include <stdio.h>
+#include <string.h>
+
+#define TINYFSEQ_IMPLEMENTATION
+#include "../tinyfseq.h"
+
+int main(const int argc, const char **argv) {
+    (void) argc;
+    (void) argv;
+
+    // no valid `TFError_string` parameter value should return a NULL or empty string
+    for (uint8_t i = 0; i < UCHAR_MAX; i++) {
+        assert(TFError_string(i) == NULL || strlen(TFError_string(i)) == 0);
+    }
+
+    return 0;
+}