Merge pull request #4 from daniel-gustainis/devops_refactor

Devops refactor
This commit is contained in:
30hours 2024-01-11 19:38:06 +10:30 committed by GitHub
commit 45719a3e59
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
22 changed files with 366 additions and 125 deletions

39
.devcontainer/Dockerfile Normal file
View file

@ -0,0 +1,39 @@
# ubuntu-22.04 by default
ARG VARIANT="jammy"
FROM mcr.microsoft.com/vscode/devcontainers/cpp:0-${VARIANT}
ENV DEBIAN_FRONTEND=noninteractive
# Feel like this shouldn't be needed but it drops me in / during build
WORKDIR /workspace
RUN apt-get update \
#
# Install dev tools and package dependencies
&& apt-get install -y clang-tidy clang-format doxygen graphviz gfortran \
libfftw3-dev liblapack-dev libopenblas-dev libudev-dev libusb-1.0.0-dev \
#
# Clean up
&& apt-get autoremove -y \
&& apt-get clean -y \
&& rm -rf /var/lib/apt/lists/*
# Install dependencies from vcpkg
RUN vcpkg integrate install \
&& vcpkg install catch2 \
&& vcpkg install rapidjson \
&& vcpkg install asio \
&& vcpkg install cpp-httplib \
&& vcpkg install armadillo \
&& vcpkg install ryml
COPY lib/sdrplay-3.0.7/SDRplay_RSP_API-Linux-3.07.1.run /workspace/
# Install shitty sdrplay API
RUN chmod +x /workspace/SDRplay_RSP_API-Linux-3.07.1.run \
&& /workspace/SDRplay_RSP_API-Linux-3.07.1.run --tar -xf \
&& cp x86_64/libsdrplay_api.so.3.07 /usr/local/lib/libsdrplay_api.so \
&& ln -s /usr/local/lib/libsdrplay_api.so /usr/local/lib/libsdrplay_api.so.3.07 \
&& cp inc/* /usr/local/include \
&& chmod 644 /usr/local/lib/libsdrplay_api.so /usr/local/lib/libsdrplay_api.so.3.07 \
&& ldconfig

View file

@ -0,0 +1,48 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-docker-compose
{
"name": "blah2 dev",
// Update the 'dockerComposeFile' list if you have more compose files or use different names.
// The .devcontainer/docker-compose.yml file contains any overrides you need/want to make.
"dockerComposeFile": [
"docker-compose.yml"
],
// The 'service' property is the name of the service for the container that VS Code should
// use. Update this value and .devcontainer/docker-compose.yml to the real service name.
"service": "blah2-dev",
// The optional 'workspaceFolder' property is the path VS Code should open by default when
// connected. This is typically a file mount in .devcontainer/docker-compose.yml
"workspaceFolder": "/workspace",
// Features to add to the dev container. More info: https://containers.dev/features.
// "features": {},
// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],
// Uncomment the next line if you want start specific services in your Docker Compose config.
// "runServices": [],
// Uncomment the next line if you want to keep your containers running after VS Code shuts down.
// "shutdownAction": "none",
// Uncomment the next line to run commands after the container is created.
// "postCreateCommand": "cat /etc/os-release",
// Configure tool-specific properties.
// "customizations": {},
"customizations": {
"vscode": {
// Add the IDs of extensions you want installed when the container is created.
"extensions": [
"ms-vscode.cpptools-extension-pack",
],
}
},
// Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
"remoteUser": "vscode"
}

View file

@ -0,0 +1,13 @@
version: "3.2"
services:
blah2-dev:
user: vscode
build:
context: ..
dockerfile: .devcontainer/Dockerfile
volumes:
- type: bind
source: ..
target: /workspace
working_dir: /workspace
command: sleep infinity

2
.gitignore vendored
View file

@ -1,4 +1,4 @@
build/* build*/*
bin/* bin/*
!build/README.md !build/README.md
!bin/README.md !bin/README.md

View file

@ -1,104 +1,86 @@
project(blah2)
cmake_minimum_required(VERSION 3.8) cmake_minimum_required(VERSION 3.8)
if(COMMAND cmake_policy)
cmake_policy(SET CMP0003 NEW)
endif(COMMAND cmake_policy)
project(blah2)
include(CMakePrintHelpers)
include(CTest)
SET(CMAKE_CXX_STANDARD 17) find_package(Threads REQUIRED)
SET(CMAKE_CXX_STANDARD_REQUIRED ON) find_package(asio CONFIG REQUIRED)
SET(CMAKE_CXX_EXTENSIONS OFF) find_package(RapidJSON REQUIRED)
SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -pthread") find_package(ryml CONFIG REQUIRED)
find_package(httplib REQUIRED)
find_package(Armadillo REQUIRED)
find_package(Catch2 CONFIG REQUIRED)
# TODO: When release CI is finished, don't use these dirs, install target should go to prod
SET (PROJECT_ROOT "${PROJECT_SOURCE_DIR}") SET (PROJECT_ROOT "${PROJECT_SOURCE_DIR}")
SET (CMAKE_RUNTIME_OUTPUT_DIRECTORY "${PROJECT_ROOT}/bin") SET (CMAKE_RUNTIME_OUTPUT_DIRECTORY "${PROJECT_ROOT}/bin")
SET (PROJECT_TEST_DIR "${PROJECT_SOURCE_DIR}/test")
SET (PROJECT_SOURCE_DIR "${PROJECT_SOURCE_DIR}/src")
SET (PROJECT_BINARY_DIR "${PROJECT_ROOT}/bin")
SET (PROJECT_BINARY_TEST_DIR "${PROJECT_ROOT}/bin/test") SET (PROJECT_BINARY_TEST_DIR "${PROJECT_ROOT}/bin/test")
SET (PROJECT_BINARY_TEST_UNIT_DIR "${PROJECT_ROOT}/bin/test/unit")
SET (PROJECT_LIB_DIR "${PROJECT_ROOT}/lib")
MESSAGE ("Source path: ${PROJECT_SOURCE_DIR}")
MESSAGE ("Binary path: ${PROJECT_BINARY_DIR}") MESSAGE ("Binary path: ${PROJECT_BINARY_DIR}")
MESSAGE ("Binary test path: ${PROJECT_BINARY_TEST_DIR}") MESSAGE ("Binary test path: ${PROJECT_BINARY_TEST_DIR}")
MESSAGE ("Lib path: ${PROJECT_LIB_DIR}")
# Include from top-level src dir
include_directories(src)
# TODO: Create FindSdrplay.cmake for this
add_library(sdrplay /usr/local/include/sdrplay_api.h)
set_target_properties(sdrplay PROPERTIES LINKER_LANGUAGE C)
target_link_libraries(sdrplay PUBLIC /usr/local/lib/libsdrplay_api.so.3.07)
add_executable(blah2 add_executable(blah2
${PROJECT_SOURCE_DIR}/blah2.cpp src/blah2.cpp
${PROJECT_SOURCE_DIR}/capture/Capture.cpp src/capture/Capture.cpp
${PROJECT_SOURCE_DIR}/capture/rspduo/RspDuo.cpp src/capture/rspduo/RspDuo.cpp
${PROJECT_SOURCE_DIR}/process/ambiguity/Ambiguity.cpp src/process/ambiguity/Ambiguity.cpp
${PROJECT_SOURCE_DIR}/process/clutter/WienerHopf.cpp src/process/clutter/WienerHopf.cpp
${PROJECT_SOURCE_DIR}/process/detection/CfarDetector1D.cpp src/process/detection/CfarDetector1D.cpp
${PROJECT_SOURCE_DIR}/process/detection/Centroid.cpp src/process/detection/Centroid.cpp
${PROJECT_SOURCE_DIR}/process/detection/Interpolate.cpp src/process/detection/Interpolate.cpp
${PROJECT_SOURCE_DIR}/process/tracker/Tracker.cpp src/process/tracker/Tracker.cpp
${PROJECT_SOURCE_DIR}/process/spectrum/SpectrumAnalyser.cpp src/process/spectrum/SpectrumAnalyser.cpp
${PROJECT_SOURCE_DIR}/process/meta/HammingNumber.cpp src/process/meta/HammingNumber.cpp
${PROJECT_SOURCE_DIR}/data/IqData.cpp src/data/IqData.cpp
${PROJECT_SOURCE_DIR}/data/Map.cpp src/data/Map.cpp
${PROJECT_SOURCE_DIR}/data/Detection.cpp src/data/Detection.cpp
${PROJECT_SOURCE_DIR}/data/Track.cpp src/data/Track.cpp
${PROJECT_SOURCE_DIR}/data/meta/Timing.cpp src/data/meta/Timing.cpp
) )
add_library(ryml ${PROJECT_LIB_DIR}/rapidyaml-0.5.0/ryml-0.5.0.hpp) target_link_libraries(blah2 PRIVATE
add_library(rapidjson ${PROJECT_LIB_DIR}/rapidjson-1.1.0/) Threads::Threads
add_library(sdrplay /usr/local/include/sdrplay_api.h) rapidjson
add_library(asio ${PROJECT_LIB_DIR}/asio-1.26.0/asio.hpp) asio::asio
add_library(httplib ${PROJECT_LIB_DIR}/cpp-httplib-0.12.2/httplib.h) ryml::ryml
add_library(catch2 ${PROJECT_LIB_DIR}/catch2/catch_amalgamated.cpp) httplib::httplib
target_include_directories(catch2 PUBLIC ${PROJECT_LIB_DIR}/catch2) armadillo
fftw3
include_directories("${PROJECT_LIB_DIR}/rapidjson-1.1.0/") fftw3_threads
set_target_properties(rapidjson PROPERTIES LINKER_LANGUAGE CXX) sdrplay
target_link_libraries(blah2 rapidjson) )
include_directories("${PROJECT_LIB_DIR}/asio-1.26.0/")
set_target_properties(asio PROPERTIES LINKER_LANGUAGE CXX)
target_link_libraries(blah2 asio)
include_directories("${PROJECT_LIB_DIR}/cpp-httplib-0.12.2/")
set_target_properties(httplib PROPERTIES LINKER_LANGUAGE CXX)
target_link_libraries(blah2 httplib)
include_directories("${PROJECT_LIB_DIR}/rapidyaml-0.5.0/")
set_target_properties(ryml PROPERTIES LINKER_LANGUAGE CXX)
target_link_libraries(blah2 ryml)
set_target_properties(sdrplay PROPERTIES LINKER_LANGUAGE C)
target_link_libraries(sdrplay /usr/local/lib/libsdrplay_api.so.3.07)
target_link_libraries(blah2 sdrplay)
target_link_libraries(blah2 fftw3)
target_link_libraries(blah2 fftw3_threads)
target_link_libraries(blah2 lapack)
target_link_libraries(blah2 blas)
target_link_libraries(blah2 armadillo)
include_directories("${PROJECT_SOURCE_DIR}/capture/")
include_directories("${PROJECT_SOURCE_DIR}/capture/rspduo/")
include_directories("${PROJECT_SOURCE_DIR}/process/ambiguity/")
include_directories("${PROJECT_SOURCE_DIR}/process/clutter/")
include_directories("${PROJECT_SOURCE_DIR}/process/detection/")
include_directories("${PROJECT_SOURCE_DIR}/process/tracker/")
include_directories("${PROJECT_SOURCE_DIR}/process/spectrum/")
include_directories("${PROJECT_SOURCE_DIR}/process/meta/")
include_directories("${PROJECT_SOURCE_DIR}/data/")
include_directories("${PROJECT_SOURCE_DIR}/data/meta/")
# unit tests # unit tests
add_executable(testAmbiguity add_executable(testAmbiguity
${PROJECT_TEST_DIR}/unit/process/ambiguity/TestAmbiguity.cpp test/unit/process/ambiguity/TestAmbiguity.cpp
${PROJECT_SOURCE_DIR}/data/IqData.cpp src/data/IqData.cpp
${PROJECT_SOURCE_DIR}/data/Map.cpp src/data/Map.cpp
${PROJECT_SOURCE_DIR}/process/ambiguity/Ambiguity.cpp src/process/ambiguity/Ambiguity.cpp
${PROJECT_SOURCE_DIR}/process/meta/HammingNumber.cpp) src/process/meta/HammingNumber.cpp)
target_link_libraries(testAmbiguity catch2 fftw3 fftw3_threads) target_link_libraries(testAmbiguity PRIVATE Catch2::Catch2WithMain fftw3 fftw3_threads)
set_target_properties(testAmbiguity PROPERTIES set_target_properties(testAmbiguity PROPERTIES
RUNTIME_OUTPUT_DIRECTORY "${PROJECT_BINARY_TEST_UNIT_DIR}") RUNTIME_OUTPUT_DIRECTORY "${PROJECT_BINARY_TEST_UNIT_DIR}")
add_executable(testTracker add_executable(testTracker
${PROJECT_TEST_DIR}/unit/process/tracker/TestTracker.cpp test/unit/process/tracker/TestTracker.cpp
${PROJECT_SOURCE_DIR}/data/Detection.cpp src/data/Detection.cpp
${PROJECT_SOURCE_DIR}/data/Track.cpp src/data/Track.cpp
${PROJECT_SOURCE_DIR}/process/tracker/Tracker.cpp) src/process/tracker/Tracker.cpp)
target_link_libraries(testTracker catch2) target_link_libraries(testTracker PRIVATE Catch2::Catch2WithMain)
set_target_properties(testTracker PROPERTIES set_target_properties(testTracker PROPERTIES
RUNTIME_OUTPUT_DIRECTORY "${PROJECT_BINARY_TEST_UNIT_DIR}") RUNTIME_OUTPUT_DIRECTORY "${PROJECT_BINARY_TEST_UNIT_DIR}")
add_test(NAME testAmbiguity COMMAND testAmbiguity)
add_test(NAME testTracker COMMAND testTracker)

145
CMakePresets.json Normal file
View file

@ -0,0 +1,145 @@
{
"version": 3,
"cmakeMinimumRequired": {
"major": 3,
"minor": 21,
"patch": 0
},
"configurePresets": [
{
"name": "cmake-pedantic",
"hidden": true,
"warnings": {
"dev": true,
"deprecated": true,
"unusedCli": true,
"systemVars": false
},
"errors": {
"dev": true,
"deprecated": true
}
},
{
"name": "cppcheck",
"hidden": true,
"cacheVariables": {
"CMAKE_CXX_CPPCHECK": "cppcheck;--inline-suppr"
}
},
{
"name": "clang-tidy",
"hidden": true,
"cacheVariables": {
"CMAKE_CXX_CLANG_TIDY": "clang-tidy",
"CMAKE_EXPORT_COMPILE_COMMANDS": "ON"
}
},
{
"name": "ci-std",
"description": "This preset makes sure the project actually builds with at least the specified standard",
"hidden": true,
"cacheVariables": {
"CMAKE_CXX_EXTENSIONS": "OFF",
"CMAKE_CXX_STANDARD": "20",
"CMAKE_CXX_STANDARD_REQUIRED": "ON"
}
},
{
"name": "ci-vcpkg",
"hidden": true,
"description": "Bootstrap the toolchain with vcpkg installed paths",
"toolchainFile": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake"
},
{
"name": "ci-build",
"binaryDir": "${sourceDir}/build/${presetName}",
"inherits": ["cmake-pedantic"],
"hidden": true
},
{
"name": "ci-unix",
"generator": "Unix Makefiles",
"hidden": true,
"condition": {
"type": "equals",
"lhs": "${hostSystemName}",
"rhs": "Linux"
},
"inherits": [
"ci-std",
"ci-build",
"ci-vcpkg"
]
},
{
"name": "ci-release",
"hidden": true,
"cacheVariables": {
"CMAKE_BUILD_TYPE": "Release"
}
},
{
"name": "ci-debug",
"hidden": true,
"cacheVariables": {
"CMAKE_BUILD_TYPE": "Debug"
}
},
{
"name": "dev-unix-release",
"installDir": "$env{HOME}/.local",
"inherits": [
"ci-unix",
"ci-release"
]
},
{
"name": "dev-unix-debug",
"inherits": [
"ci-unix",
"ci-debug"
]
},
{
"name": "dev-unix-release-sa",
"inherits": [
"ci-unix",
"ci-release",
"clang-tidy"
]
}
],
"buildPresets": [
{
"name": "dev-unix-debug",
"configurePreset": "dev-unix-debug",
"configuration": "Debug",
"jobs": 4
},
{
"name": "dev-unix-release",
"configurePreset": "dev-unix-release",
"configuration": "Release",
"jobs": 4
},
{
"name": "dev-unix-release-sa",
"configurePreset": "dev-unix-release-sa",
"configuration": "Release",
"jobs": 4
}
],
"testPresets": [
{
"name": "test-all-unix-release",
"configurePreset": "dev-unix-release",
"output": {
"outputOnFailure": true
},
"execution": {
"jobs": 1
}
}
]
}

View file

@ -2,23 +2,24 @@
/// @brief A real-time radar. /// @brief A real-time radar.
/// @author 30hours /// @author 30hours
#define RYML_SINGLE_HDR_DEFINE_NOW #include "capture/Capture.h"
#include "data/IqData.h"
#include "data/Map.h"
#include "data/Detection.h"
#include "data/meta/Timing.h"
#include "data/Track.h"
#include "process/ambiguity/Ambiguity.h"
#include "process/clutter/WienerHopf.h"
#include "process/detection/CfarDetector1D.h"
#include "process/detection/Centroid.h"
#include "process/detection/Interpolate.h"
#include "process/spectrum/SpectrumAnalyser.h"
#include "process/tracker/Tracker.h"
#include <ryml-0.5.0.hpp> #include <ryml/ryml.hpp>
#include <ryml/ryml_std.hpp> // optional header, provided for std:: interop
#include <c4/format.hpp> // needed for the examples below
#include <asio.hpp> #include <asio.hpp>
#include <Capture.h>
#include <Ambiguity.h>
#include <WienerHopf.h>
#include <CfarDetector1D.h>
#include <Tracker.h>
#include <IqData.h>
#include <Map.h>
#include <Detection.h>
#include <Track.h>
#include <Centroid.h>
#include <Interpolate.h>
#include <Timing.h>
#include <SpectrumAnalyser.h>
#include <sys/types.h> #include <sys/types.h>
#include <getopt.h> #include <getopt.h>
#include <string> #include <string>

View file

@ -1,5 +1,5 @@
#include "Capture.h" #include "Capture.h"
#include "RspDuo.h" #include "rspduo/RspDuo.h"
#include <iostream> #include <iostream>
#include <thread> #include <thread>
#include <httplib.h> #include <httplib.h>

View file

@ -7,7 +7,7 @@
#define CAPTURE_H #define CAPTURE_H
#include <string> #include <string>
#include <IqData.h> #include "data/IqData.h"
class Capture class Capture
{ {

View file

@ -1,4 +1,5 @@
#include <RspDuo.h> #include "RspDuo.h"
#include <stdbool.h> #include <stdbool.h>
#include <stdint.h> #include <stdint.h>
#include <stdio.h> #include <stdio.h>

View file

@ -20,9 +20,10 @@
#define RSPDUO_H #define RSPDUO_H
#include "sdrplay_api.h" #include "sdrplay_api.h"
#include "data/IqData.h"
#include <stdint.h> #include <stdint.h>
#include <string> #include <string>
#include <IqData.h>
#define BUFFER_SIZE_NR 1024 #define BUFFER_SIZE_NR 1024

View file

@ -15,7 +15,8 @@
#ifndef TRACK_H #ifndef TRACK_H
#define TRACK_H #define TRACK_H
#include <Detection.h> #include "data/Detection.h"
#include <stdint.h> #include <stdint.h>
#include <vector> #include <vector>
#include <string> #include <string>

View file

@ -8,9 +8,9 @@
#pragma once #pragma once
#include <IqData.h> #include "data/IqData.h"
#include <Map.h> #include "data/Map.h"
#include <HammingNumber.h> #include "process/meta/HammingNumber.h"
#include <stdint.h> #include <stdint.h>
#include <fftw3.h> #include <fftw3.h>
#include <memory> #include <memory>

View file

@ -9,7 +9,7 @@
#ifndef WIENERHOPF_H #ifndef WIENERHOPF_H
#define WIENERHOPF_H #define WIENERHOPF_H
#include <IqData.h> #include "data/IqData.h"
#include <stdint.h> #include <stdint.h>
#include <fftw3.h> #include <fftw3.h>
#include <armadillo> #include <armadillo>

View file

@ -7,7 +7,7 @@
#ifndef CENTROID_H #ifndef CENTROID_H
#define CENTROID_H #define CENTROID_H
#include <Detection.h> #include "data/Detection.h"
#include <stdint.h> #include <stdint.h>
class Centroid class Centroid

View file

@ -1,5 +1,6 @@
#include "CfarDetector1D.h" #include "CfarDetector1D.h"
#include "Map.h" #include "data/Map.h"
#include <iostream> #include <iostream>
#include <vector> #include <vector>
#include <cmath> #include <cmath>

View file

@ -8,8 +8,8 @@
#ifndef CFARDETECTOR1D_H #ifndef CFARDETECTOR1D_H
#define CFARDETECTOR1D_H #define CFARDETECTOR1D_H
#include <Map.h> #include "data/Map.h"
#include <Detection.h> #include "data/Detection.h"
#include <stdint.h> #include <stdint.h>
#include <complex> #include <complex>

View file

@ -11,8 +11,8 @@
#ifndef INTERPOLATE_H #ifndef INTERPOLATE_H
#define INTERPOLATE_H #define INTERPOLATE_H
#include <Map.h> #include "data/Map.h"
#include <Detection.h> #include "data/Detection.h"
class Interpolate class Interpolate
{ {

View file

@ -9,7 +9,7 @@
#ifndef SPECTRUMANALYSER_H #ifndef SPECTRUMANALYSER_H
#define SPECTRUMANALYSER_H #define SPECTRUMANALYSER_H
#include <IqData.h> #include "data/IqData.h"
#include <stdint.h> #include <stdint.h>
#include <fftw3.h> #include <fftw3.h>

View file

@ -10,8 +10,8 @@
#ifndef TRACKER_H #ifndef TRACKER_H
#define TRACKER_H #define TRACKER_H
#include <Detection.h> #include "data/Detection.h"
#include <Track.h> #include "data/Track.h"
#include <stdint.h> #include <stdint.h>
class Tracker class Tracker

View file

@ -5,12 +5,15 @@
/// @todo Add golden data IqData file for testing. /// @todo Add golden data IqData file for testing.
/// @todo Declaration match to coding style? /// @todo Declaration match to coding style?
#define CATCH_CONFIG_MAIN #include <catch2/catch_test_macros.hpp>
#include "catch_amalgamated.hpp" #include <catch2/matchers/catch_matchers_floating_point.hpp>
#include <catch2/generators/catch_generators.hpp>
#include "process/ambiguity/Ambiguity.h"
#include "Ambiguity.h"
#include <random> #include <random>
#include <iostream> #include <iostream>
#include <filesystem>
/// @brief Use random_device as RNG. /// @brief Use random_device as RNG.
std::random_device g_rd; std::random_device g_rd;
@ -146,6 +149,12 @@ TEST_CASE("Process_Simple", "[process]")
/// @brief Test processing from a file. /// @brief Test processing from a file.
TEST_CASE("Process_File", "[process]") TEST_CASE("Process_File", "[process]")
{ {
std::filesystem::path test_input_file("20231214-230611.rspduo");
// Bail if the test file doesn't exist
if (!std::filesystem::exists(test_input_file)) {
SKIP("Input test file does not exist.");
}
auto round_hamming = GENERATE(true, false); auto round_hamming = GENERATE(true, false);
int32_t delayMin{-10}; int32_t delayMin{-10};

View file

@ -2,12 +2,12 @@
/// @brief Unit test for Tracker.cpp /// @brief Unit test for Tracker.cpp
/// @author 30hours /// @author 30hours
#define CATCH_CONFIG_MAIN #include <catch2/catch_test_macros.hpp>
#include "catch_amalgamated.hpp"
#include "data/Detection.h"
#include "data/Track.h"
#include "process/tracker/Tracker.h"
#include "Detection.h"
#include "Tracker.h"
#include "Track.h"
#include <string> #include <string>
#include <vector> #include <vector>
#include <random> #include <random>