Deploy ETP server and run unit test against it in CI

Put src files in a fetpapi folder to better mimic the installation folders layout

Author: philippeVerney

.github/workflows/github-actions.yml

@@ -93,7 +93,7 @@ jobs:
         shell: bash
         run: |
           dir1="${{ github.workspace }}/src"
-          dir2="${{ github.workspace }}/../build/install/include/fetpapi"
+          dir2="${{ github.workspace }}/../build/install/include"
           diff <(cd "$dir1" && find . -type f -name "*.h" | grep -v "./etp/ssl/ssl_stream.h" | sort) <(cd "$dir2" && find . -type f -name "*.h" | grep -v "./etp/ssl/ssl_stream.h" | sort)
           if [ $? -ne 0 ]; then
            echo "❌ The directories have not the same .h files"
@@ -175,6 +175,7 @@ jobs:
         with:
           distribution: 'temurin' # See 'Supported distributions' for available options
           java-version: '11'
+      - uses: docker/setup-compose-action@v2
       - name: APT install
         run: |
           sudo apt update
@@ -205,8 +206,16 @@ jobs:
           cd ${{ github.workspace }}/..
           mkdir build
           cd build
-          cmake -DAVRO_ROOT=${{ runner.temp }}/avro-cpp-install -DAVRO_USE_STATIC_LIBS=TRUE -DWITH_FESAPI=TRUE -DFESAPI_ROOT=${{ runner.temp }}/fesapi-install -DFESAPI_JAR=${{ runner.temp }}/fesapi-install/lib/fesapiJava-2.14.1.0.jar -DWITH_JAVA_WRAPPING=TRUE ${{ github.workspace }} -DCMAKE_C_COMPILER=${{ matrix.cc }} -DCMAKE_CXX_COMPILER=${{ matrix.cxx }}
+          cmake -DAVRO_ROOT=${{ runner.temp }}/avro-cpp-install -DAVRO_USE_STATIC_LIBS=TRUE -DWITH_FESAPI=TRUE -DFESAPI_ROOT=${{ runner.temp }}/fesapi-install -DFESAPI_JAR=${{ runner.temp }}/fesapi-install/lib/fesapiJava-2.14.1.0.jar -DWITH_JAVA_WRAPPING=TRUE -DWITH_TEST=TRUE ${{ github.workspace }} -DCMAKE_C_COMPILER=${{ matrix.cc }} -DCMAKE_CXX_COMPILER=${{ matrix.cxx }}
           cmake --build . --config Release -j2
+      - name: Deploy an ETP server
+        run: |
+          docker compose -f ${{ github.workspace }}/docker/docker-compose.yml up -d
+          until [ "$(docker inspect -f '{{.State.Health.Status}}' open-etp-server)" = "healthy" ]; do sleep 1; done
+          until curl -s -o /dev/null -w "%{http_code}" http://localhost:9002/.well-known/etp-server-capabilities?GetVersion=etp12.energistics.org | grep -q "200"; do sleep 2; done
+      - name: Run Unit tests
+        run: |
+          ${{ github.workspace }}/../build/test/unitTest
   build_wheels_windows:
     name: Build wheels on windows-latest
     runs-on: windows-latest

.gitignore

@@ -2,8 +2,8 @@
 /cs/fetpapiCs.csproj
 /swig/setup.py
 /swig/swigEtp1_2Include.i
-/src/macroDefinitions.h
-/src/version_config.h
+/src/fetpapi/macroDefinitions.h
+/src/fetpapi/version_config.h
 
 ## Ignore csharp swig generated files
 /swig/swigGeneratedCsWrapper.cpp

CMakeLists.txt

@@ -22,7 +22,7 @@ set (Fetpapi_VERSION_TWEAK 0)
 set (Fetpapi_VERSION ${Fetpapi_VERSION_MAJOR}.${Fetpapi_VERSION_MINOR}.${Fetpapi_VERSION_PATCH}.${Fetpapi_VERSION_TWEAK})
 
 # Create the version config header file in order for FETPAPI users to know the FETPAPI version at runtime.
-configure_file(${CMAKE_CURRENT_SOURCE_DIR}/cmake/version_config.h.in ${CMAKE_CURRENT_SOURCE_DIR}/src/version_config.h)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/cmake/version_config.h.in ${CMAKE_CURRENT_SOURCE_DIR}/src/fetpapi/version_config.h)
 
 if (CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
 	set (CMAKE_INSTALL_PREFIX ${CMAKE_CURRENT_BINARY_DIR}/install CACHE PATH "${PROJECT_NAME} install prefix" FORCE)
@@ -170,7 +170,7 @@ endif ()
 
 # Namespaces definitions
 set (FETPAPI_ETP_NS etp CACHE STRING "Namespace for etp objects")
-configure_file(${CMAKE_CURRENT_SOURCE_DIR}/cmake/macroDefinitions.h.in ${CMAKE_CURRENT_SOURCE_DIR}/src/macroDefinitions.h @ONLY) # Overwrite if different
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/cmake/macroDefinitions.h.in ${CMAKE_CURRENT_SOURCE_DIR}/src/fetpapi/macroDefinitions.h @ONLY) # Overwrite if different
 
 # ============================================================================
 # SWIG wrapping
@@ -197,7 +197,7 @@ endif (WITH_PYTHON_WRAPPING)
 # Getting source files
 # ============================================================================
 
-include(${CMAKE_CURRENT_SOURCE_DIR}/src/CMakeLists.txt)
+include(${CMAKE_CURRENT_SOURCE_DIR}/src/fetpapi/CMakeLists.txt)
 set (ALL_SOURCES_AND_HEADERS
 	${FETPAPI_HEADERS}
 	${FETPAPI_ETP_SOURCES}

cmake/swigEtp1_2Include.i.in

@@ -40,7 +40,7 @@ under the License.
 %include "stdint.i"
 %include "std_string.i"
 
-%include "../src/macroDefinitions.h"
+%include "../src/fetpapi/macroDefinitions.h"
 
 //************************/
 // JAVA
@@ -147,14 +147,14 @@ under the License.
 typedef long long 				time_t;
 
 %{
-#include "../src/etp/ClientSessionLaunchers.h"
-#include "../src/etp/EtpHelpers.h"
+#include "../src/fetpapi/etp/ClientSessionLaunchers.h"
+#include "../src/fetpapi/etp/EtpHelpers.h"
 %}
 
 #ifdef WITH_FESAPI
 %{
-#include "../src/etp/fesapi/FesapiHdfProxy.h"
-#include "../src/etp/fesapi/FesapiHelpers.h"
+#include "../src/fetpapi/etp/fesapi/FesapiHdfProxy.h"
+#include "../src/fetpapi/etp/fesapi/FesapiHelpers.h"
 %}
 #endif
 

docker/docker-compose.yml

@@ -0,0 +1,30 @@
+name: etpserver
+services:
+  open-etp-postgresql:
+    container_name: open-etp-postgresql
+    image: postgres
+    environment:
+      POSTGRES_USER: tester
+      POSTGRES_PASSWORD: tester
+      POSTGRES_DB: postkv
+    restart: unless-stopped
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U $$POSTGRES_USER -d $$POSTGRES_DB"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+      start_period: 5s
+  open-etp-server:
+    container_name: open-etp-server
+    image: community.opengroup.org:5555/osdu/platform/domain-data-mgmt-services/reservoir/open-etp-server/open-etp-server-main
+    command: openETPServer server --start --log_level debug --jobs 4
+    depends_on:
+      open-etp-postgresql:
+        condition: service_healthy
+    environment:
+      RDMS_DATA_PARTITION_MODE: single
+      ENABLE_ANY_NUMBER_OF_THREADS: true
+      POSTGRESQL_CONN_STRING: host=open-etp-postgresql port=5432 dbname=postkv user=tester password=tester
+    ports:
+      - "9002:9002"
+    restart: unless-stopped

example/withFesapi/etpClient.cpp

@@ -28,9 +28,9 @@ under the License.
 #include <fesapi/resqml2_0_1/ContinuousProperty.h>
 #include <fesapi/resqml2_0_1/LocalDepth3dCrs.h>
 
-#include "etp/ClientSessionLaunchers.h"
-#include "etp/fesapi/FesapiHdfProxy.h"
-#include "etp/fesapi/FesapiHelpers.h"
+#include "fetpapi/etp/ClientSessionLaunchers.h"
+#include "fetpapi/etp/fesapi/FesapiHdfProxy.h"
+#include "fetpapi/etp/fesapi/FesapiHelpers.h"
 
 namespace {
 	std::vector<std::string> tokenize(const std::string& str, char delimiter) {