fix: improvements in tests, build, dependencies, docs and network options (#42)

Author: amunra

.gitignore

@@ -1,7 +1,10 @@
 target
 build
+cmake-build-debug
+cmake-build-release
 .vs
 .vscode
+.idea
 questdb-rs/Cargo.lock
 include/questdb/ilp/line_sender.gen.h
 cython/questdb/ilp/line_sender.pxd

CMakeLists.txt

@@ -5,8 +5,12 @@ set(CPACK_PROJECT_NAME ${PROJECT_NAME})
 set(CPACK_PROJECT_VERSION ${PROJECT_VERSION})
 include(CPack)
 
-include(CTest)
-enable_testing()
+option(QUESTDB_TESTS_AND_EXAMPLES "Build test and example targets" OFF)
+
+if (QUESTDB_TESTS_AND_EXAMPLES)
+    include(CTest)
+    enable_testing()
+endif()
 
 set(CMAKE_C_STANDARD 11)
 set(CMAKE_C_STANDARD_REQUIRED ON)
@@ -25,8 +29,7 @@ option(
 # Imports `questdb_client` target.
 add_subdirectory(corrosion)
 corrosion_import_crate(
-    MANIFEST_PATH questdb-rs-ffi/Cargo.toml
-    LINK_AS C)
+    MANIFEST_PATH questdb-rs-ffi/Cargo.toml)
 target_include_directories(
     questdb_client INTERFACE
     ${CMAKE_CURRENT_SOURCE_DIR}/include)
@@ -37,7 +40,10 @@ if(WIN32)
         DEFINE_SYMBOL "LINESENDER_DYN_LIB")
     target_link_libraries(
         questdb_client-shared
-        INTERFACE wsock32 ws2_32)
+        INTERFACE wsock32 ws2_32 ntdll)
+    target_link_libraries(
+        questdb_client-static
+        INTERFACE wsock32 ws2_32 ntdll)
 endif(WIN32)
 if(APPLE)
     target_link_libraries(
@@ -77,77 +83,79 @@ function(compile_example TARGET_NAME)
         questdb_client)
 endfunction()
 
-compile_example(
-    line_sender_c_example
-    examples/line_sender_c_example.c)
-compile_example(
-    line_sender_c_example_auth
-    examples/line_sender_c_example_auth.c)
-compile_example(
-    line_sender_c_example_tls_ca
-    examples/line_sender_c_example_tls_ca.c)
-compile_example(
-    line_sender_c_example_auth_tls
-    examples/line_sender_c_example_auth_tls.c)
-compile_example(
-    line_sender_cpp_example
-    examples/line_sender_cpp_example.cpp)
-compile_example(
-    line_sender_cpp_example_auth
-    examples/line_sender_cpp_example_auth.cpp)
-compile_example(
-    line_sender_cpp_example_tls_ca
-    examples/line_sender_cpp_example_tls_ca.cpp)
-compile_example(
-    line_sender_cpp_example_auth_tls
-    examples/line_sender_cpp_example_auth_tls.cpp)
-
-# Include Rust tests as part of the tests run
-add_test(
-    NAME rust_tests
-    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/questdb-rs
-    COMMAND cargo test --features insecure-skip-verify -- --nocapture)
+if (QUESTDB_TESTS_AND_EXAMPLES)
+    compile_example(
+        line_sender_c_example
+        examples/line_sender_c_example.c)
+    compile_example(
+        line_sender_c_example_auth
+        examples/line_sender_c_example_auth.c)
+    compile_example(
+        line_sender_c_example_tls_ca
+        examples/line_sender_c_example_tls_ca.c)
+    compile_example(
+        line_sender_c_example_auth_tls
+        examples/line_sender_c_example_auth_tls.c)
+    compile_example(
+        line_sender_cpp_example
+        examples/line_sender_cpp_example.cpp)
+    compile_example(
+        line_sender_cpp_example_auth
+        examples/line_sender_cpp_example_auth.cpp)
+    compile_example(
+        line_sender_cpp_example_tls_ca
+        examples/line_sender_cpp_example_tls_ca.cpp)
+    compile_example(
+        line_sender_cpp_example_auth_tls
+        examples/line_sender_cpp_example_auth_tls.cpp)
 
-# Unit test binaries.
-function(compile_test TARGET_NAME)
-    list(POP_FRONT ARGV)  # compile_test
-    add_executable(
-        ${TARGET_NAME}
-        ${ARGV})
-    target_link_libraries(
-        ${TARGET_NAME}
-        questdb_client)
-    target_include_directories(
-        ${TARGET_NAME}
-        PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)
-    set_compile_flags(${TARGET_NAME})
+    # Include Rust tests as part of the tests run
     add_test(
-        NAME ${TARGET_NAME}
-        COMMAND ${TARGET_NAME})
-endfunction()
+        NAME rust_tests
+        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/questdb-rs
+        COMMAND cargo test --features insecure-skip-verify -- --nocapture)
 
-compile_test(
-    test_line_sender
-    cpp_test/mock_server.cpp
-    cpp_test/test_line_sender.cpp)
+    # Unit test binaries.
+    function(compile_test TARGET_NAME)
+        list(POP_FRONT ARGV)  # compile_test
+        add_executable(
+            ${TARGET_NAME}
+            ${ARGV})
+        target_link_libraries(
+            ${TARGET_NAME}
+            questdb_client)
+        target_include_directories(
+            ${TARGET_NAME}
+            PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)
+        set_compile_flags(${TARGET_NAME})
+        add_test(
+            NAME ${TARGET_NAME}
+            COMMAND ${TARGET_NAME})
+    endfunction()
 
-# System testing Python3 script.
-# This will download the latest QuestDB instance from Github,
-# thus will also require a Java 11 installation to run the tests.
-option(QUESTDB_SYSTEM_TESTING "Run system tests" OFF)
-if(QUESTDB_SYSTEM_TESTING)
-    find_package(
-        Python3
-        REQUIRED
-        COMPONENTS Interpreter)
-    find_package(
-        Java
-        11
-        REQUIRED)
-    add_test(
-        NAME system_test
-        COMMAND python3 ${CMAKE_CURRENT_SOURCE_DIR}/system_test/test.py run -v)
-    set_tests_properties(
-        system_test PROPERTIES
-        ENVIRONMENT BUILD_DIR_PATH=${CMAKE_BINARY_DIR})
-endif(QUESTDB_SYSTEM_TESTING)
+    compile_test(
+        test_line_sender
+        cpp_test/mock_server.cpp
+        cpp_test/test_line_sender.cpp)
+
+    # System testing Python3 script.
+    # This will download the latest QuestDB instance from Github,
+    # thus will also require a Java 11 installation to run the tests.
+    option(QUESTDB_SYSTEM_TESTING "Run system tests" OFF)
+    if(QUESTDB_SYSTEM_TESTING)
+        find_package(
+            Python3
+            REQUIRED
+            COMPONENTS Interpreter)
+        find_package(
+            Java
+            11
+            REQUIRED)
+        add_test(
+            NAME system_test
+            COMMAND python3 ${CMAKE_CURRENT_SOURCE_DIR}/system_test/test.py run -v)
+        set_tests_properties(
+            system_test PROPERTIES
+            ENVIRONMENT BUILD_DIR_PATH=${CMAKE_BINARY_DIR})
+    endif(QUESTDB_SYSTEM_TESTING)
+endif()

README.md

@@ -66,7 +66,6 @@ To get started, read the language-specific guides.
 
 * [Data quality and threading considerations](doc/CONSIDERATIONS.md)
 * [Authentication and TLS encryption](doc/SECURITY.md)
-* [Troubleshooting](doc/TROUBLESHOOTING.md)
 
 ## Community
 

cbindgen.toml

@@ -8,7 +8,7 @@ header = """/*******************************************************************
  *    \\__\\_\\\\__,_|\\___||___/\\__|____/|____/
  *
  *  Copyright (c) 2014-2019 Appsicle
- *  Copyright (c) 2019-2022 QuestDB
+ *  Copyright (c) 2019-2023 QuestDB
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.

ci/run_all_tests.py

@@ -38,12 +38,9 @@ def main():
     test_line_sender_path = next(iter(
         build_dir.glob(f'**/test_line_sender{exe_suffix}')))
     system_test_path = pathlib.Path('system_test') / 'test.py'
-    qdb_v = '6.4.3'  # The version of QuestDB we'll test against.
+    qdb_v = '7.3.2'  # The version of QuestDB we'll test against.
 
-    run_cmd('cargo', 'test',
-        '--features', 'insecure-skip-verify',
-        '--', '--nocapture',
-        cwd='questdb-rs')
+    run_cmd('cargo', 'test', '--all-features', '--', '--nocapture', cwd='questdb-rs')
     run_cmd(str(test_line_sender_path))
     run_cmd('python3', str(system_test_path), 'run', '--versions', qdb_v, '-v')
 

ci/run_tests_pipeline.yaml

@@ -67,11 +67,11 @@ stages:
             displayName: "Update and set Rust toolchain"
           - script: |
               cd questdb-rs
-              cargo build --example basic
-              cargo build --example auth
-              cargo build --example auth_tls
+              cargo build --example basic --features=chrono_timestamp
+              cargo build --example auth --features=chrono_timestamp
+              cargo build --example auth_tls --features=chrono_timestamp
             displayName: Build Rust examples.
-          - script: cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
+          - script: cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DQUESTDB_TESTS_AND_EXAMPLES=ON
             env:
               JAVA_HOME: $(JAVA_HOME_11_X64)
             displayName: "Build Makefile with CMake"
@@ -96,4 +96,41 @@ stages:
             inputs:
               pathToPublish: ./build
             displayName: "Publish build directory"
-            condition: eq(variables['BUILD_WITH_MINGW'], '1')
+            condition: eq(variables['BUILD_WITH_MINGW'], '1')
+      - job: CargoFmtAndClippy
+        displayName: "cargo fmt and clippy"
+        pool:
+          vmImage: 'ubuntu-latest'
+        timeoutInMinutes: 10
+        steps:
+          - checkout: self
+          - script: |
+              rustup component add clippy
+              rustup component add rustfmt
+            displayName: "Install clippy and rustfmt"
+          - script: |
+              cd questdb-rs
+              cargo fmt --all -- --check
+            displayName: "questdb-rs: fmt"
+          - script: |
+              cd questdb-rs
+              cargo clippy --all-targets --all-features -- -D warnings
+            displayName: "questdb-rs: clippy"
+          - script: |
+              cd questdb-rs-ffi
+              cargo fmt --all -- --check
+            displayName: "questdb-rs-ffi: fmt"
+          - script: |
+              cd questdb-rs-ffi
+              cargo clippy --all-targets --all-features -- -D warnings
+            displayName: "questdb-rs-ffi: clippy"
+          - script: |
+              cd system_test
+              cd tls_proxy
+              cargo fmt --all -- --check
+            displayName: "tls_proxy: fmt"
+          - script: |
+              cd system_test
+              cd tls_proxy
+              cargo clippy --all-targets --all-features -- -D warnings
+            displayName: "tls_proxy: clippy"

corrosion/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: ["jschwe"]

corrosion/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,81 @@
+name: Bug Report
+description: File a bug report
+title: "[Bug]: "
+labels: ["bug", "triage"]
+assignees:
+  - jschwe
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    attributes:
+      label: Current Behavior
+      description: A concise description of what you're experiencing.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A concise description of what you expected to happen.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Steps To Reproduce
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1. In this environment...
+        2. With this config...
+        3. Run '...'
+        4. See error...
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Environment
+      description: |
+        examples:
+          - **OS**: Ubuntu 22.04
+          - **CMake**: 3.22.0
+          - **CMake Generator**: Ninja 1.11
+      value: |
+        - OS:
+        - CMake:
+        - CMake Generator:
+      render: markdown
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: CMake configure log with Debug log-level
+      description: |
+        Output when configuring with `cmake -S<source_dir> -B<build_dir> --log-level=DEBUG <your_other_options>`:
+        <details><summary>CMake configure log</summary>
+        <p>
+        
+        ```
+        <log>
+        ```
+        
+        </p>
+        </details>
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: CMake Build step log
+      description: |
+        Output when building with `cmake --build <build_dir> --verbose`:
+        <details><summary>CMake build log</summary>
+        <p>
+
+        ```
+        <log>
+        ```
+
+        </p>
+        </details>
+    validations:
+      required: false