chore: move hello apps & contract tests to dedicated folders (#121)

Moves both hello apps into an examples directory.
Moves contract tests into a contract-tests directory. 
Updates the SDK contract tests README with content.

Author: cwaldren-ld

.github/workflows/client.yml

@@ -16,7 +16,7 @@ jobs:
     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
+      TEST_SERVICE_BINARY: ./build/contract-tests/sdk-contract-tests/sdk-tests
     steps:
       - uses: actions/checkout@v3
       - uses: ./.github/actions/ci
@@ -29,7 +29,7 @@ jobs:
         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'
+          extra_params: '-skip-from ./contract-tests/sdk-contract-tests/test-suppressions.txt'
   build-test:
     runs-on: ubuntu-22.04
     steps:

.github/workflows/sse.yml

@@ -23,7 +23,7 @@ jobs:
     env:
       # Port the test service (implemented in this repo) should bind to.
       TEST_SERVICE_PORT: 8123
-      TEST_SERVICE_BINARY: ./build/apps/sse-contract-tests/sse-tests
+      TEST_SERVICE_BINARY: ./build/contract-tests/sse-contract-tests/sse-tests
     steps:
       - uses: actions/checkout@v3
       - uses: ./.github/actions/ci

CMakeLists.txt

@@ -58,12 +58,12 @@ message(STATUS "LaunchDarkly: using OpenSSL v${OPENSSL_VERSION}")
 
 set(Boost_USE_STATIC_LIBS ON)
 
-if(BUILD_SHARED_LIBS)
+if (BUILD_SHARED_LIBS)
     # When building a shared library we hide all symbols
     # aside from this we have specifically exported for the C-API.
     set(CMAKE_CXX_VISIBILITY_PRESET hidden)
     set(CMAKE_VISIBILITY_INLINES_HIDDEN 1)
-endif()
+endif ()
 
 set(Boost_USE_MULTITHREADED ON)
 set(Boost_USE_STATIC_RUNTIME OFF)
@@ -90,5 +90,5 @@ set(BUILD_TESTING "${ORIGINAL_BUILD_TESTING}")
 
 set(BUILD_SHARED_LIBS "${ORIGINAL_BUILD_SHARED_LIBS}")
 
-
-add_subdirectory(apps)
+add_subdirectory(contract-tests)
+add_subdirectory(examples)

apps/sdk-contract-tests/README.md

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

apps/CMakeLists.txt renamed to contract-tests/CMakeLists.txt

@@ -0,0 +1,35 @@
+## SDK contract tests
+
+Contract tests have a "test service" on one side, and the "test harness" on
+the other.
+
+This project implements the test service for the C++ Client-Side SDK.
+
+**session (session.hpp)**
+
+This provides a simple REST API for creating/destroying
+test entities. Examples:
+
+`GET /` - returns the capabilities of this service.
+
+`DELETE /` - shutdown the service.
+
+`POST /` - create a new test entity, and return its ID.
+
+`DELETE /entity/1` - delete the an entity identified by `1`.
+
+**entity manager (entity_manager.hpp)**
+
+This manages "entities", which are unique instances of the SDK client.
+
+**definitions (definitions.hpp)**
+
+Contains JSON definitions that are used to communicate with the test harness.
+
+**server (server.hpp)**
+
+Glues everything together, mainly providing the TCP acceptor that spawns new sessions.
+
+**session (session.hpp)**
+
+Prepares HTTP responses based on the results of commands sent to entities.