Packages on develop (#6)

* new: dev: add some workflows and simple tox file, cleanup cmake warnings
* add conda-dev environment file, boost plus gtest only
* both gtest and gmock are required in conda deps
* refactor conda build matrix
* add missing ip2string.h header on windows
* set MSVC compiler in windows env
* use platform compiler deps
* update gtest submodule to v1.12.x and use gtest lib var
* replace gtest submodule with find_package or fetch_content
* fall back to FetchContent_Populate in buster action
* cleanup find_threads and find_pcap issues
* add latest debian build files from gitlab, update ci build steps

Signed-off-by: Stephen L Arnold <sarnold@vctlabs.com>

Author: sarnold

.github/workflows/conda-dev.yml

@@ -0,0 +1,84 @@
+name: CondaDev
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: libtins ${{ matrix.python-version }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        # does not like windows
+        os: ['ubuntu-22.04', 'ubuntu-24.04']
+        python-version: ['3.9', '3.11']
+        include:
+          - os: 'ubuntu-22.04'
+            generator: 'Ninja'
+            build_type: 'Release'
+          - os: 'ubuntu-24.04'
+            generator: 'Ninja'
+            build_type: 'RelWithDebInfo'
+
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON: ${{ matrix.python-version }}
+      PYTHONIOENCODING: utf-8
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Setup base python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.x'
+
+    - name: Cache conda
+      id: cache
+      uses: actions/cache@v4
+      env:
+        # Increase this value to reset cache if environment.devenv.yml has not changed
+        CACHE_NUMBER: 1
+      with:
+        path: ~/conda_pkgs_dir
+        key: ${{ runner.os }}-conda-${{ env.CACHE_NUMBER }}-${{ hashFiles('environment.devenv.yml') }}
+
+    - uses: conda-incubator/setup-miniconda@v3
+      with:
+        auto-update-conda: true
+        python-version: ${{ matrix.python-version }}
+        channels: conda-forge,defaults
+        channel-priority: strict
+        conda-remove-defaults: true
+        use-only-tar-bz2: true
+
+    - name: Configure condadev environment
+      shell: bash -el {0}
+      env:
+        PY_VER: ${{ matrix.python-version }}
+      run: |
+        conda config --set always_yes yes --set changeps1 no
+        conda config --add channels conda-forge
+        conda install conda-devenv
+        conda info -a
+        conda devenv
+
+    - name: Build and test
+      shell: bash -el {0}
+      env:
+        PY_VER: ${{ matrix.python-version }}
+      run: |
+        source activate libtins-test
+        cmake \
+          -G "${{ matrix.generator }}" -S . -B build \
+          -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \
+          -DLIBTINS_ENABLE_CXX11=ON \
+          -DCMAKE_INSTALL_PREFIX:PATH=${CONDA_PREFIX}
+        cmake --build build --target install --parallel 4
+        cmake --build build --target tests --parallel 4
+        ctest -V --test-dir build/

.github/workflows/debs.yml

@@ -0,0 +1,87 @@
+name: Debian packages
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  get_version:
+    name: Get version info
+    runs-on: ubuntu-22.04
+    defaults:
+      run:
+        shell: bash
+    outputs:
+      version: ${{ steps.git_ver.outputs.version }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Get package version
+        id: git_ver
+        run: |
+          version=$(git describe --tags | sed -e "s|v||" -e "s|-g|+g|")
+          echo "Version from git: ${version}"
+          echo "version=${version}" >> $GITHUB_OUTPUT
+
+  build_debs:
+    name: ${{ matrix.name }}
+    runs-on: ubuntu-22.04
+    needs: [get_version]
+
+    strategy:
+      fail-fast: false
+      matrix:
+        name: [
+          x64_bookworm,
+          x64_trixie,
+          x64_sid,
+        ]
+
+        include:
+          - name: x64_bookworm
+            dist: bookworm
+
+          - name: x64_trixie
+            dist: trixie
+
+          - name: x64_sid
+            dist: sid
+
+    steps:
+      - name: Check github variables
+        env:
+          VERSION: ${{ needs.get_version.outputs.version }}
+        run: |
+          echo "Package version from git: ${VERSION}"
+
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install deps and update debian changelog
+        run: |
+          sudo apt-get update
+          sudo apt-get install devscripts
+          debchange -v ${{ needs.get_version.outputs.version }}-${{ matrix.dist }} -b -M --distribution ${{ matrix.dist }} "ci build"
+
+      - name: Build deb packages
+        uses: jtdor/build-deb-action@v1
+        env:
+          DEB_BUILD_OPTIONS: noautodbgsym
+        with:
+          apt-opts: --install-recommends
+          docker-image: "debian:${{ matrix.dist }}-slim"
+          buildpackage-opts: --build=binary --no-sign
+          extra-build-deps: git cmake
+
+      - name: Upload deb files
+        uses: actions/upload-artifact@v4
+        with:
+          name: "libtins_${{ needs.get_version.outputs.version }}-${{ matrix.dist }}"
+          path: ./debian/artifacts/*.deb

.github/workflows/tests.yaml

@@ -11,18 +11,18 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          submodules: true
 
       - name: Install libpcap
         run: sudo apt-get install -y libpcap-dev
 
-      - name: Initialize submodules
-        run: git submodule init && git submodule update
-
       - name: Initialize build system
-        run: mkdir build && cd build && cmake ..
+        run: cmake -G "Unix Makefiles" -S . -B build -DCMAKE_BUILD_TYPE=Release
 
       - name: Build tests
         run: cmake --build build --target tests
 
       - name: Run tests
-        run: ctest build
+        run: ctest -V --test-dir build/

.gitignore

@@ -1,2 +1,3 @@
 build/**
 include/tins/config.h
+.tox/

.gitmodules

@@ -1,4 +0,0 @@
-[submodule "googletest"]
-	path = googletest
-    url = https://github.com/google/googletest.git
-    ignore = dirty

CMakeLists.txt

@@ -1,5 +1,16 @@
-CMAKE_MINIMUM_REQUIRED(VERSION 2.8.1)
-PROJECT(libtins)
+# pre-test discovery mode for gtest_discover_tests was added in 3.18
+cmake_minimum_required(VERSION 3.12...3.18)
+
+if(POLICY CMP0167)
+    cmake_policy(SET CMP0167 NEW)
+endif()
+
+if(POLICY CMP0135)
+    cmake_policy(SET CMP0135 NEW)
+endif()
+
+# Add cmake modules of this project to the module path
+list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules)
 
 OPTION(LIBTINS_BUILD_EXAMPLES "Build examples" ON)
 OPTION(LIBTINS_BUILD_TESTS "Build tests" ON)
@@ -12,6 +23,21 @@ ELSE(NOT CMAKE_BUILD_TYPE)
     MESSAGE(STATUS "Using specified '${CMAKE_BUILD_TYPE}' build type.")
 ENDIF(NOT CMAKE_BUILD_TYPE)
 
+project(
+    libtins
+    LANGUAGES CXX
+)
+
+# Check the thread library info early as setting compiler flags seems to
+# interfere with the detection and causes CMAKE_THREAD_LIBS_INIT to not
+# include -lpthread when it should.
+if(LIBTINS_BUILD_TESTS)
+    if (NOT TARGET Threads::Threads)
+        find_package(Threads REQUIRED)
+    endif ()
+    set(LINK_LIBS ${LINK_LIBS} Threads::Threads)
+endif()
+
 # Compilation flags.
 IF(MSVC)
     # Don't always use Wall, since VC's /Wall is ridiculously verbose.
@@ -50,8 +76,14 @@ SET(TINS_VERSION_MINOR 6)
 SET(TINS_VERSION_PATCH 0)
 SET(LIBTINS_VERSION "${TINS_VERSION_MAJOR}.${TINS_VERSION_MINOR}")
 
-# Required Packages
-SET(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules/")
+set(CMAKE_CXX_STANDARD 14)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS ON)
+
+if(CMAKE_CXX_COMPILER_ID STREQUAL Clang)
+    set(CLANG_DEFAULT_CXX_STDLIB libc++)
+    set(CLANG_DEFAULT_RTLIB compiler-rt)
+endif()
 
 # Allow disabling packet capture mechanism
 OPTION(LIBTINS_ENABLE_PCAP "Enable capturing packets via libpcap" ON)
@@ -87,7 +119,9 @@ IF(WIN32)
 
 ENDIF(WIN32)
 
-INCLUDE(ExternalProject)
+INCLUDE(CTest)
+INCLUDE(GNUInstallDirs)
+#INCLUDE(ExternalProject)
 
 # *******************
 # Compilation options
@@ -155,7 +189,7 @@ ELSE()
 ENDIF()
 
 # Search for libboost
-FIND_PACKAGE(Boost)
+FIND_PACKAGE(Boost, CONFIG)
 
 # Optionally enable the ACK tracker (on by default)
 OPTION(LIBTINS_ENABLE_ACK_TRACKER "Enable TCP ACK tracking support" ON)
@@ -279,38 +313,29 @@ IF(LIBTINS_BUILD_EXAMPLES)
 ENDIF()
 
 IF(LIBTINS_BUILD_TESTS)
-    # Only include googletest if the git submodule has been fetched
-    IF(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/googletest/CMakeLists.txt")
-        # Enable tests and add the test directory
-        MESSAGE(STATUS "Tests have been enabled")
-        SET(GOOGLETEST_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/googletest)
-        SET(GOOGLETEST_INCLUDE ${GOOGLETEST_ROOT}/googletest/include)
-        SET(GOOGLETEST_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR}/googletest)
-        SET(GOOGLETEST_LIBRARY ${GOOGLETEST_BINARY_DIR}/googletest)
-
-        ExternalProject_Add(
+    find_package(GTest)
+    include_directories(${GTEST_INCLUDE_DIRS})
+    IF(NOT GTEST_FOUND)
+        message (WARNING "Can't find system Google Test")
+        include(FetchContent)
+        FetchContent_Declare(
             googletest
-            DOWNLOAD_COMMAND ""
-            SOURCE_DIR ${GOOGLETEST_ROOT}
-            BINARY_DIR ${GOOGLETEST_BINARY_DIR}
-            CMAKE_CACHE_ARGS "-DBUILD_GTEST:bool=ON" "-DBUILD_GMOCK:bool=OFF"
-                            "-Dgtest_force_shared_crt:bool=ON"
-                            "-DCMAKE_CXX_COMPILER:path=${CMAKE_CXX_COMPILER}"
-            INSTALL_COMMAND ""
+            # Specify the commit => this is release 1.12.1
+            URL https://github.com/google/googletest/archive/58d77fa8070e8cec2dc1ed015d66b454c8d78850.zip
         )
-        # Make sure we build googletest before anything else
-        ADD_DEPENDENCIES(tins googletest)
-        ENABLE_TESTING()
-        ADD_SUBDIRECTORY(tests)
-    ELSE()
-        FIND_PACKAGE(GTest QUIET)
-        IF(${GTest_FOUND})
-            ENABLE_TESTING()
-            ADD_SUBDIRECTORY(tests)
-        ELSE()
-            MESSAGE(STATUS "googletest git submodule is absent. Run `git submodule init && git submodule update` to get it")
-        ENDIF()
+        FetchContent_GetProperties(googletest)
+        if(NOT googletest_POPULATED)
+          # Fetch the content using previously declared details
+          FetchContent_Populate(googletest)
+          add_subdirectory(${googletest_SOURCE_DIR} ${googletest_BINARY_DIR})
+        endif()
+        include_directories(${gtest_SOURCE_DIR}/include ${gtest_SOURCE_DIR})
     ENDIF()
+    # For Windows: Prevent overriding the parent project's compiler/linker settings
+    set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+    ENABLE_TESTING()
+    set(GTEST_LINK_LIBRARIES gtest gtest_main)
+    ADD_SUBDIRECTORY(tests)
 ENDIF()
 
 # **********************************

cmake/Modules/CheckCXXFeatures.cmake

@@ -50,7 +50,7 @@ if (NOT CMAKE_CXX_COMPILER_LOADED)
     message(FATAL_ERROR "CheckCXX11Features modules only works if language CXX is enabled")
 endif ()
 
-cmake_minimum_required(VERSION 2.8.3)
+#cmake_minimum_required(VERSION 2.8.3)
 
 #
 ### Check for needed compiler flags

cmake/Modules/FindPCAP.cmake

@@ -73,7 +73,9 @@ endif (NOT PCAP_LINKS_SOLO)
 
 include(CheckFunctionExists)
 set(CMAKE_REQUIRED_LIBRARIES ${PCAP_LIBRARY})
-check_function_exists(pcap_get_pfring_id HAVE_PF_RING)
+# this is not actually used, is not part of normal libpcap, and
+# causes breakage in some build environments, eg, bookworm docker image
+#check_function_exists(pcap_get_pfring_id HAVE_PF_RING)
 check_function_exists(pcap_set_immediate_mode HAVE_PCAP_IMMEDIATE_MODE)
 check_function_exists(pcap_set_tstamp_precision HAVE_PCAP_TIMESTAMP_PRECISION)
 set(CMAKE_REQUIRED_LIBRARIES)