Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/trunk.yml
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ jobs:
run: |
sudo apt-get update
sudo apt-get install -y build-essential cmake git python3-pip clang-format clang-tidy cppcheck
sudo apt-get install -y libcurl4-openssl-dev

- name: Install Conan
if: ${{ steps.src-changed.outputs.change == 'true' || steps.deps-changed.outputs.change == 'true' }}
Expand All @@ -98,7 +99,7 @@ jobs:
if: ${{ steps.src-changed.outputs.change == 'true' || steps.deps-changed.outputs.change == 'true' }}
run: |
source .venv/bin/activate
conan install . --build=missing -s build_type="${BUILD_TYPE}"
conan install . --build=missing -s build_type="${BUILD_TYPE}" -o "with_tests=True"
deactivate
env:
BUILD_TYPE: Release
Expand Down Expand Up @@ -126,6 +127,7 @@ jobs:
cmake -S . -B "build/${BUILD_TYPE}" \
-DCMAKE_BUILD_TYPE="${BUILD_TYPE}" \
-DCMAKE_TOOLCHAIN_FILE="$PWD/build/${BUILD_TYPE}/generators/conan_toolchain.cmake" \
-DCPP_WORKSPACE_BUILD_TESTS="ON" \
-DCMAKE_CXX_COMPILER=g++-13
cmake --build "build/${BUILD_TYPE}" \
--parallel
Expand Down
4 changes: 3 additions & 1 deletion .github/workflows/validate-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ jobs:
run: |
sudo apt-get update
sudo apt-get install -y build-essential cmake git python3-pip clang-format clang-tidy cppcheck
sudo apt-get install -y libcurl4-openssl-dev

- name: Install Conan
if: ${{ steps.src-changed.outputs.change == 'true' || steps.deps-changed.outputs.change == 'true' }}
Expand All @@ -101,7 +102,7 @@ jobs:
if: ${{ steps.src-changed.outputs.change == 'true' || steps.deps-changed.outputs.change == 'true' }}
run: |
source .venv/bin/activate
conan install . --build=missing -s build_type="${BUILD_TYPE}"
conan install . --build=missing -s build_type="${BUILD_TYPE}" -o "with_tests=True"
deactivate
env:
BUILD_TYPE: Release
Expand All @@ -128,6 +129,7 @@ jobs:
cmake -S . -B "build/${BUILD_TYPE}" \
-DCMAKE_BUILD_TYPE="${BUILD_TYPE}" \
-DCMAKE_TOOLCHAIN_FILE="$PWD/build/${BUILD_TYPE}/generators/conan_toolchain.cmake" \
-DCPP_WORKSPACE_BUILD_TESTS="ON" \
-DCMAKE_CXX_COMPILER=g++-13
cmake --build "build/${BUILD_TYPE}" \
--parallel
Expand Down
54 changes: 30 additions & 24 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
cmake_minimum_required(VERSION 3.20)

project(cpp-workspace VERSION 0.4.2 LANGUAGES CXX)
project(cpp-workspace VERSION 0.4.3 LANGUAGES CXX)

set(CMAKE_CXX_STANDARD 20)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
Expand All @@ -11,38 +11,44 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)

add_executable(cpp-workspace-app
src/main.cpp
src/interface/progress_spinner.cpp
src/interface/user_interface.cpp
src/ollama/ollama_client.cpp
src/storage/qdrant_client.cpp
src/utils/args_utils.cpp
src/utils/curl_utils.cpp
src/utils/text_utils.cpp
src/utils/system_utils.cpp
src/utils/embedding_utils.cpp
src/utils/retrieving_utils.cpp
src/utils/http_utils.hpp
)
option(CPP_WORKSPACE_BUILD_TESTS "Build unit tests" ON)

target_include_directories(cpp-workspace-app
PRIVATE
${CMAKE_SOURCE_DIR}/src
${CMAKE_SOURCE_DIR}/src/interface
${CMAKE_SOURCE_DIR}/src/ollama
${CMAKE_SOURCE_DIR}/src/storage
${CMAKE_SOURCE_DIR}/src/utils
)
message(STATUS "Current source dir: ${CMAKE_CURRENT_SOURCE_DIR}")
file(GLOB_RECURSE CORE_SOURCES CONFIGURE_DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/src/interface/*.cpp
${CMAKE_CURRENT_SOURCE_DIR}/src/interface/*.hpp
${CMAKE_CURRENT_SOURCE_DIR}/src/ollama/*.cpp
${CMAKE_CURRENT_SOURCE_DIR}/src/ollama/*.hpp
${CMAKE_CURRENT_SOURCE_DIR}/src/storage/*.cpp
${CMAKE_CURRENT_SOURCE_DIR}/src/storage/*.hpp
${CMAKE_CURRENT_SOURCE_DIR}/src/utils/*.cpp
${CMAKE_CURRENT_SOURCE_DIR}/src/utils/*.hpp)
if(NOT CORE_SOURCES)
message(FATAL_ERROR "No core sources found. Check the paths in CORE_SOURCES.")
endif()
add_library(cpp-workspace-core
STATIC
${CORE_SOURCES})
target_include_directories(cpp-workspace-core
PUBLIC
${CMAKE_CURRENT_SOURCE_DIR}/src)

add_executable(cpp-workspace-app src/main.cpp)
target_link_libraries(cpp-workspace-app PRIVATE cpp-workspace-core)

find_package(fmt REQUIRED)
find_package(CURL REQUIRED)
find_package(nlohmann_json REQUIRED)
find_package(Curses REQUIRED)
target_link_libraries(cpp-workspace-app
target_link_libraries(cpp-workspace-core
PRIVATE
fmt::fmt
CURL::libcurl
nlohmann_json::nlohmann_json
Curses::Curses
)

if(CPP_WORKSPACE_BUILD_TESTS)
enable_testing()
add_subdirectory(tests)
endif()
13 changes: 13 additions & 0 deletions conanfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@
class AppConan(ConanFile):
settings = "os", "compiler", "build_type", "arch"

options = {"with_tests": [True, False]}

default_options = {
"with_tests": False,
##
# If ncurses++ is linked (check using `grep -c "ncurses++" build/Release/tests/CMakeFiles/cpp-workspace-tests.dir/link.txt`),
# unit tests will fail if `GTest::gtest_main` is linked after `cpp-workspace-core` in `./tests/CMakeLists.txt`.
##
"ncurses/*:with_cxx": False,
}

generators = "CMakeDeps", "CMakeToolchain"

def requirements(self):
Expand All @@ -13,6 +24,8 @@ def requirements(self):
self.requires("libcurl/8.5.0")
self.requires("nlohmann_json/3.11.2")
self.requires("ncurses/6.5")
if getattr(self.options, "with_tests") == True and self.test_requires != None:
self.test_requires("gtest/1.15.0")

def layout(self):
cmake_layout(self)
2 changes: 1 addition & 1 deletion src/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ int main(int argc, const char* argv[]) {
std::string message{};

ArgsUtils args_utils;
struct ParsedArgs parsed_args = args_utils.parse_args(&argc, argv);
struct ParsedArgs parsed_args = args_utils.parse_args(argc, argv);

if (parsed_args.help == true) {
args_utils.print_help();
Expand Down
29 changes: 17 additions & 12 deletions src/utils/args_utils.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ ArgsUtils::ArgsUtils() {
* @param argv Array of argument strings from main()
* @return ParsedArgs struct containing all parsed argument values
*/
struct ParsedArgs ArgsUtils::parse_args(const int* argc, const char* argv[]) {
struct ParsedArgs ArgsUtils::parse_args(const int argc, const char* const argv[]) const {
struct ParsedArgs parsed_args {};
parsed_args.model = "gemma3n:latest";
parsed_args.embedding_model = "embeddinggemma:latest";
Expand All @@ -41,31 +41,28 @@ struct ParsedArgs ArgsUtils::parse_args(const int* argc, const char* argv[]) {
parsed_args.help = false;

std::string arg{};
for (int i = 1; i < *argc; i += 1) {
for (int i = 1; i < argc; i += 1) {
arg = argv[i];
size_t eq_pos = arg.find('=');

if (eq_pos == std::string::npos) {
continue;
}

std::string key = arg.substr(0, eq_pos);
std::string val = arg.substr(eq_pos + 1);

if (handlers.count(key)) {
handlers[key](val, &parsed_args);
auto it = handlers.find(arg.substr(0, eq_pos));
if (it != handlers.end()) {
it->second(arg.substr(eq_pos + 1), &parsed_args);
}
}

return parsed_args;
}

/**
* Prints usage information for all supported runtime arguments and exits.
* Displays each argument name, type, description, and default value.
* Returns the help text containing information about all supported runtime arguments.
*/
void ArgsUtils::print_help() {
printf("Usage: app [OPTIONS]\n\n"
const char* ArgsUtils::help_text() {
return "Usage: app [OPTIONS]\n\n"
"Options:\n"
" --model=<name> The LLM model to use for inference.\n"
" (default: gemma3n:latest)\n\n"
Expand All @@ -84,7 +81,15 @@ void ArgsUtils::print_help() {
" --skip_embedding=<true|false> Skip embedding creation.\n"
" (default: false)\n\n"
" --help=<true|false> Print help.\n"
" (default: false)\n");
" (default: false)\n";
}

/**
* Prints usage information for all supported runtime arguments and exits.
* Displays each argument name, type, description, and default value.
*/
void ArgsUtils::print_help() {
printf("%s", this->help_text());

std::exit(0);
}
4 changes: 3 additions & 1 deletion src/utils/args_utils.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@ class ArgsUtils {
public:
ArgsUtils();

struct ParsedArgs parse_args(const int* argc, const char* argv[]);
struct ParsedArgs parse_args(const int argc, const char* const argv[]) const;

const char* help_text();

void print_help();
};
16 changes: 16 additions & 0 deletions tests/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
find_package(GTest CONFIG REQUIRED)

add_executable(cpp-workspace-tests
args_utils_test.cpp
)

target_link_libraries(cpp-workspace-tests
PRIVATE
# GTest::gtest_main - should be linked before `cpp-workspace-core` if the core library links `ncurses++` or similar C++ bindings that add `main()`.
cpp-workspace-core
GTest::gtest_main
)

include(GoogleTest)
gtest_discover_tests(cpp-workspace-tests DISCOVERY_MODE PRE_TEST)

139 changes: 139 additions & 0 deletions tests/args_utils_test.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
#include <gtest/gtest.h>

#include <algorithm>
#include <initializer_list>
#include <iterator>
#include <string>
#include <utility>
#include <vector>

#include "utils/args_utils.hpp"

namespace {

// Owns the strings so the const char* pointers remain valid for the test.
class Argv {
public:
Argv(std::initializer_list<std::string> args = {}) : storage_{"app"} {
storage_.insert(storage_.end(), args.begin(), args.end());
ptrs_.reserve(storage_.size());
std::transform(storage_.begin(), storage_.end(), std::back_inserter(ptrs_),
[](const std::string& s) { return s.c_str(); });
argc_ = static_cast<int>(ptrs_.size());
}
Argv(const Argv&) = delete;
Argv& operator=(const Argv&) = delete;

int argc() const {
return argc_;
}
const char* const* argv() const {
return ptrs_.data();
}

private:
std::vector<std::string> storage_;
std::vector<const char*> ptrs_;
int argc_ = 0;
};

} // namespace

TEST(ArgsUtilsDefaults, ReturnsDefaultsWhenNoArgsGiven) {
ArgsUtils utils;
Argv argv;
auto p = utils.parse_args(argv.argc(), argv.argv());

EXPECT_EQ(p.model, "gemma3n:latest");
EXPECT_EQ(p.embedding_model, "embeddinggemma:latest");
EXPECT_EQ(p.prompt, "Hey! What's up!");
EXPECT_FALSE(p.stream);
EXPECT_FALSE(p.rag);
EXPECT_FALSE(p.interactive);
EXPECT_FALSE(p.dark_theme);
EXPECT_FALSE(p.skip_embedding);
EXPECT_FALSE(p.help);
}

TEST(ArgsUtilsParse, AssignsStringValues) {
ArgsUtils utils;
Argv argv{"--model=llama3", "--embedding_model=nomic", "--prompt=hi there"};
auto p = utils.parse_args(argv.argc(), argv.argv());

EXPECT_EQ(p.model, "llama3");
EXPECT_EQ(p.embedding_model, "nomic");
EXPECT_EQ(p.prompt, "hi there");
}

TEST(ArgsUtilsParse, SplitsOnFirstEqualsOnly) {
ArgsUtils utils;
Argv argv{"--prompt=a=b"};
EXPECT_EQ(utils.parse_args(argv.argc(), argv.argv()).prompt, "a=b");
}

TEST(ArgsUtilsParse, EmptyValueYieldsEmptyString) {
ArgsUtils utils;
Argv argv{"--model="};
EXPECT_EQ(utils.parse_args(argv.argc(), argv.argv()).model, "");
}

TEST(ArgsUtilsParse, LastOccurrenceWins) {
ArgsUtils utils;
Argv argv{"--model=a", "--model=b"};
EXPECT_EQ(utils.parse_args(argv.argc(), argv.argv()).model, "b");
}

TEST(ArgsUtilsParse, IgnoresArgsWithoutEquals) {
ArgsUtils utils;
Argv argv{"--stream", "--model"};
auto p = utils.parse_args(argv.argc(), argv.argv());

EXPECT_FALSE(p.stream);
EXPECT_EQ(p.model, "gemma3n:latest");
}

TEST(ArgsUtilsParse, IgnoresUnknownKeys) {
ArgsUtils utils;
Argv argv{"--unknown=x"};
auto p = utils.parse_args(argv.argc(), argv.argv());

EXPECT_EQ(p.model, "gemma3n:latest");
EXPECT_FALSE(p.stream);
}

using BoolField = bool ParsedArgs::*;
using BoolCase = std::pair<std::string, BoolField>;

class BoolFlagTest : public testing::TestWithParam<BoolCase> {};

TEST_P(BoolFlagTest, ExactTrueEnablesFlag) {
ArgsUtils utils;
Argv argv{GetParam().first + "=true"};
auto p = utils.parse_args(argv.argc(), argv.argv());
EXPECT_TRUE(p.*GetParam().second);
}

TEST_P(BoolFlagTest, NonExactTrueValuesLeaveFlagDisabled) {
ArgsUtils utils;
for (const char* val : {"TRUE", "1", "yes", "false"}) {
Argv argv{GetParam().first + "=" + val};
auto p = utils.parse_args(argv.argc(), argv.argv());
EXPECT_FALSE(p.*GetParam().second) << "value: " << val;
}
}

INSTANTIATE_TEST_SUITE_P(AllBoolFlags, BoolFlagTest,
testing::Values(BoolCase{"--stream", &ParsedArgs::stream}, BoolCase{"--rag", &ParsedArgs::rag},
BoolCase{"--interactive", &ParsedArgs::interactive},
BoolCase{"--dark_theme", &ParsedArgs::dark_theme},
BoolCase{"--skip_embedding", &ParsedArgs::skip_embedding},
BoolCase{"--help", &ParsedArgs::help}));

TEST(ArgsUtilsHelp, DocumentsEveryHandledFlag) {
ArgsUtils utils;
const std::string text = utils.help_text();
for (const char* key : {"--model=", "--embedding_model=", "--prompt=", "--stream=", "--rag=", "--interactive=",
"--dark_theme=", "--skip_embedding=", "--help="}) {
EXPECT_NE(text.find(key), std::string::npos) << "missing: " << key;
}
}
Loading
Loading