feat: minimal SDK contract tests (#52)

* add SDK contract test server

* allow for null evaluation reason when deserializing flag evaluation result

* add github action for SDK tests

* feat: implement AllFlags

* fix: send identify event on client creation (#54)

* have ContextFilter take the global private attributes by value

* feat: add context build/parse routines [contract-tests] (#74)

Author: cwaldren-ld

.github/actions/sse-contract-tests/action.yml renamed to .github/actions/contract-tests/action.yml

@@ -1,6 +1,14 @@
 name: "Server-Sent-Events Contract Tests"
 description: 'Runs the SSE test harness against a specified test service.'
 inputs:
+  repo:
+    required: false
+    description: "Name of the test harness repo"
+    default: 'sdk-test-harness'
+  version:
+    required: false
+    description: "Version of the test harness"
+    default: 'v2'
   test_service_port:
     required: true
     description: "Port of the component under test."
@@ -22,7 +30,7 @@ runs:
   steps:
     - name: 'Run Test Harness'
       shell: bash
-      run: curl -s https://raw.githubusercontent.com/launchdarkly/sse-contract-tests/v2.0.0/downloader/run.sh | bash
+      run: curl -s https://raw.githubusercontent.com/launchdarkly/${{ inputs.repo }}/main/downloader/run.sh | bash
       env:
-        VERSION: v2
+        VERSION: ${{ inputs.version }}
         PARAMS: -url http://localhost:${{ inputs.test_service_port }} -port ${{ inputs.test_harness_port }} ${{ inputs.extra_params }} ${{ inputs.debug_logging == 'true' && '-debug' || '' }} -stop-service-at-end

.github/workflows/client.yml

@@ -11,6 +11,25 @@ on:
       - '**.md'
 
 jobs:
+  contract-tests:
+    runs-on: ubuntu-22.04
+    env:
+      # Port the test service (implemented in this repo) should bind to.
+      TEST_SERVICE_PORT: 8123
+      TEST_SERVICE_BINARY: ./build/apps/sdk-contract-tests/sdk-tests
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/ci
+        with:
+          cmake_target: sdk-tests
+          run_tests: false
+      - name: 'Launch test service as background task'
+        run: $TEST_SERVICE_BINARY $TEST_SERVICE_PORT 2>&1 &
+      - uses: ./.github/actions/contract-tests
+        with:
+          # Inform the test harness of test service's port.
+          test_service_port: ${{ env.TEST_SERVICE_PORT }}
+          extra_params: '-skip-from ./apps/sdk-contract-tests/test-suppressions.txt'
   build-test:
     runs-on: ubuntu-22.04
     steps:

.github/workflows/sse.yml

@@ -32,8 +32,8 @@ jobs:
           run_tests: false
       - name: 'Launch test service as background task'
         run: $TEST_SERVICE_BINARY $TEST_SERVICE_PORT 2>&1 &
-      - uses: ./.github/actions/sse-contract-tests
+      - uses: ./.github/actions/contract-tests
         with:
-          # Inform the test harness of test service's port.
+          repo: 'sse-contract-tests'
           test_service_port: ${{ env.TEST_SERVICE_PORT }}
           extra_params: '-skip HTTP -skip reconnection'

apps/CMakeLists.txt

@@ -1,3 +1,4 @@
 #add_subdirectory(hello-c)
 add_subdirectory(sse-contract-tests)
+add_subdirectory(sdk-contract-tests)
 add_subdirectory(hello-cpp)

apps/sdk-contract-tests/CMakeLists.txt

@@ -0,0 +1,36 @@
+# Required for Apple Silicon support.
+cmake_minimum_required(VERSION 3.19)
+
+project(
+        LaunchDarklyCPPSDKTestHarness
+        VERSION 0.1
+        DESCRIPTION "LaunchDarkly CPP SDK Test Harness"
+        LANGUAGES CXX
+)
+
+set(Boost_USE_STATIC_LIBS ON)
+set(Boost_USE_MULTITHREADED ON)
+set(Boost_USE_STATIC_RUNTIME OFF)
+find_package(Boost 1.80 REQUIRED COMPONENTS coroutine)
+
+
+include(${CMAKE_FILES}/json.cmake)
+include(${CMAKE_FILES}/foxy.cmake)
+
+add_executable(sdk-tests
+        src/main.cpp
+        src/server.cpp
+        src/session.cpp
+        src/definitions.cpp
+        src/entity_manager.cpp
+        src/client_entity.cpp
+        )
+
+target_link_libraries(sdk-tests PRIVATE
+        launchdarkly::client
+        foxy
+        nlohmann_json::nlohmann_json
+        Boost::coroutine
+        )
+
+target_include_directories(sdk-tests PUBLIC include)

apps/sdk-contract-tests/README.md

@@ -0,0 +1,36 @@
+#pragma once
+
+#include <launchdarkly/client_side/api.hpp>
+#include <memory>
+#include "definitions.hpp"
+
+class ClientEntity {
+   public:
+    explicit ClientEntity(
+        std::unique_ptr<launchdarkly::client_side::Client> client);
+
+    tl::expected<nlohmann::json, std::string> Command(CommandParams params);
+
+   private:
+    tl::expected<nlohmann::json, std::string> Evaluate(
+        EvaluateFlagParams params);
+
+    tl::expected<nlohmann::json, std::string> EvaluateDetail(
+        EvaluateFlagParams);
+
+    tl::expected<nlohmann::json, std::string> EvaluateAll(
+        EvaluateAllFlagParams params);
+
+    tl::expected<nlohmann::json, std::string> Identify(
+        IdentifyEventParams params);
+
+    tl::expected<nlohmann::json, std::string> Custom(CustomEventParams params);
+
+    tl::expected<nlohmann::json, std::string> ContextBuild(
+        ContextBuildParams params);
+
+    tl::expected<nlohmann::json, std::string> ContextConvert(
+        ContextConvertParams params);
+
+    std::unique_ptr<launchdarkly::client_side::Client> client_;
+};