ci: use virtual environment in functional tests

.github/workflows/tests.yaml

@@ -34,21 +34,38 @@ jobs:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Load secrets
-        working-directory: tests/functional_tests
+        working-directory: tests/functional_tests/tools/virtualenv/keys
         run: |
           mkdir -p ~/.atsign/keys/
-          echo "${{ secrets.ATKEYS_12ALPACA }}" > ~/.atsign/keys/@12alpaca_key.atKeys
-          echo "${{ secrets.ATKEYS_12SNOWBOATING }}" > ~/.atsign/keys/@12snowboating_key.atKeys
+          ls -la
+          cp "@alice🛠_key.atKeys" ~/.atsign/keys/
+          cp "@bob🛠_key.atKeys" ~/.atsign/keys/
+
+      - name: Start Virtual Environment
+        working-directory: tests/functional_tests/tools/virtualenv
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y docker-compose
+          sudo ./start_virtualenv.sh
+          sleep 5
+          sudo ./pkam_virtualenv.sh
+          sleep 1
+
+      - name: Add vip.ve.atsign.zone to /etc/hosts
+        run: |
+          echo "127.0.0.1 vip.ve.atsign.zone" | sudo tee -a /etc/hosts
+          cat /etc/hosts
+          echo "---"
+          nslookup vip.ve.atsign.zone
 
       - name: Install atSDK
         run: |
-          cmake -S . -B build -DATSDK_BUILD_TESTS="func"
+          cmake -S . -B build -DATSDK_BUILD_TESTS="func" -DCMAKE_BUILD_TYPE=Debug -DFIRST_ATSIGN="\"@alice🛠\"" -DSECOND_ATSIGN="\"@bob🛠\"" -DATDIRECTORY_HOST="\"vip.ve.atsign.zone\"" -DATDIRECTORY_PORT=64
           sudo cmake --build build --target install
 
-      - name: Build and Run Functional Tests
-        working-directory: build/tests/functional_tests
+      - name: Run Functional Tests
         run: |
-          ctest --test-dir . -VV --timeout 90
+          ctest --test-dir build/tests/functional_tests -VV --timeout 90
 
   build-examples:
     runs-on: "ubuntu-latest"

packages/atclient/include/atclient/connection.h

@@ -130,6 +130,15 @@ int atclient_connection_disconnect(atclient_connection *ctx);
  */
 bool atclient_connection_is_connected(atclient_connection *ctx);
 
+/**
+ * @brief set the blocking read timeout of the connection
+ * 
+ * @param ctx the connection to set the read timeout on, assumed to be initialized and connected
+ * @param timeout_ms the timeout in milliseconds
+ * @return void
+ */
+void atclient_connection_set_read_timeout(atclient_connection *ctx, const uint32_t timeout_ms);
+
 #ifdef __cplusplus
 }
 #endif

packages/atclient/src/atclient.c

@@ -273,7 +273,7 @@ int atclient_pkam_authenticate(atclient *ctx, const char *atsign, const atclient
       options->atserver_port != 0) {
     atserver_host = options->atserver_host;
     atserver_port = options->atserver_port;
-    should_free_atserver_host = true;
+    should_free_atserver_host = false;
   }
 
   if (atserver_host == NULL || atserver_port == 0) {
@@ -719,7 +719,7 @@ exit: {
 bool atclient_is_connected(atclient *ctx) { return atclient_connection_is_connected(&(ctx->atserver_connection)); }
 
 void atclient_set_read_timeout(atclient *ctx, const int timeout_ms) {
-  atclient_tls_socket_set_read_timeout(&ctx->atserver_connection._socket, timeout_ms);
+  atclient_connection_set_read_timeout(&ctx->atserver_connection, timeout_ms);
 }
 
 static void atclient_set_atsign_initialized(atclient *ctx, const bool initialized) {

packages/atclient/src/connection.c

@@ -632,6 +632,14 @@ int atclient_connection_read(atclient_connection *ctx, unsigned char **value, si
 exit: { return ret; }
 }
 
+void atclient_connection_set_read_timeout(atclient_connection *ctx, const uint32_t timeout_ms) {
+  if (ctx == NULL) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "ctx is NULL\n");
+    return;
+  }
+  atclient_tls_socket_set_read_timeout(&ctx->_socket, timeout_ms);
+}
+
 static void atclient_connection_set_is_connection_enabled(atclient_connection *ctx, const bool should_be_connected) {
   ctx->_is_connection_enabled = should_be_connected;
 }

packages/atclient/src/monitor.c

@@ -55,7 +55,7 @@ exit: { return ret; }
 }
 
 void atclient_monitor_set_read_timeout(atclient *monitor_conn, const int timeoutms) {
-  atclient_tls_socket_set_read_timeout(&monitor_conn->atserver_connection._socket, timeoutms);
+  atclient_set_read_timeout(monitor_conn, timeoutms);
 }
 
 int atclient_monitor_start(atclient *monitor_conn, const char *regex) {

packages/atclient/src/socket_mbedtls.c

@@ -151,8 +151,10 @@ int atclient_tls_socket_connect(struct atclient_tls_socket *socket, const char *
     return 1;
   }
 
-  char port_str[5];
-  snprintf(port_str, 5, "%" PRIu16, port);
+  const size_t port_str_size = 6;
+  char port_str[port_str_size];
+  memset(port_str, 0, sizeof(char) * port_str_size);
+  snprintf(port_str, port_str_size, "%" PRIu16, port);
 
   int ret;
   // 1. Connect

tests/functional_tests/CMakeLists.txt

@@ -1,15 +1,27 @@
 option(FIRST_ATSIGN "First atSign used for all functional tests" OFF)
 if(NOT "${FIRST_ATSIGN}" STREQUAL OFF)
-  message("Functional tests override first atsign: ${FIRST_ATSIGN}")
+  message("[ATSDK FUNCTIONAL TESTS] Functional tests override first atsign: ${FIRST_ATSIGN}")
   add_compile_definitions(FIRST_ATSIGN=${FIRST_ATSIGN})
 endif()
 
 option(SECOND_ATSIGN "Second atSign for two-way atSign functional tests" OFF)
 if(NOT "${SECOND_ATSIGN}" STREQUAL OFF)
-  message("Functional tests override second atsign: ${SECOND_ATSIGN}")
+  message("[ATSDK FUNCTIONAL TESTS] Functional tests override second atsign: ${SECOND_ATSIGN}")
   add_compile_definitions(SECOND_ATSIGN=${SECOND_ATSIGN})
 endif()
 
+option(ATDIRECTORY_HOST "Host for atDirectory functional tests" OFF)
+if(NOT "${ATDIRECTORY_HOST}" STREQUAL OFF)
+  message("[ATSDK FUNCTIONAL TESTS] Functional tests override atDirectory host: ${ATDIRECTORY_HOST}")
+  add_compile_definitions(ATDIRECTORY_HOST=${ATDIRECTORY_HOST})
+endif()
+
+option(ATDIRECTORY_PORT "Port for atDirectory functional tests" OFF)
+if(NOT "${ATDIRECTORY_PORT}" STREQUAL OFF)
+  message("[ATSDK FUNCTIONAL TESTS] Functional tests override atDirectory port: ${ATDIRECTORY_PORT}")
+  add_compile_definitions(ATDIRECTORY_PORT=${ATDIRECTORY_PORT})
+endif()
+
 cmake_minimum_required(VERSION 3.19)
 set(CMAKE_C_STANDARD 99)
 

tests/functional_tests/lib/include/functional_tests/config.h

@@ -6,8 +6,13 @@ extern "C" {
 
 #include <stddef.h>
 
-#define ROOT_HOST "root.atsign.org"
-#define ROOT_PORT 64
+#ifndef ATDIRECTORY_HOST
+#define ATDIRECTORY_HOST "root.atsign.org"
+#endif
+
+#ifndef ATDIRECTORY_PORT
+#define ATDIRECTORY_PORT 64
+#endif 
 
 #ifndef FIRST_ATSIGN
 #define FIRST_ATSIGN "@12alpaca"

tests/functional_tests/lib/include/functional_tests/helpers.h

@@ -7,8 +7,8 @@ extern "C" {
 #include "atclient/atclient.h"
 #include <stddef.h>
 
-int functional_tests_set_up_atkeys(atclient_atkeys *atkeys, const char *atsign, const size_t atsignlen);
-int functional_tests_pkam_auth(atclient *atclient, atclient_atkeys *atkeys, const char *atsign, const size_t atsignlen);
+int functional_tests_set_up_atkeys(atclient_atkeys *atkeys, const char *atsign);
+int functional_tests_pkam_auth(atclient *atclient, atclient_atkeys *atkeys, const char *atsign);
 int functional_tests_publickey_exists(atclient *atclient, const char *key, const char *shared_by,
                                       const char *knamespace);
 int functional_tests_selfkey_exists(atclient *atclient, const char *key, const char *shared_by, const char *knamespace);

tests/functional_tests/lib/src/helpers.c

@@ -12,15 +12,15 @@
 
 #define TAG "functional_tests_helpers"
 
-int functional_tests_set_up_atkeys(atclient_atkeys *atkeys, const char *atsign, const size_t atsignlen) {
+int functional_tests_set_up_atkeys(atclient_atkeys *atkeys, const char *atsign) {
   int ret = 1;
 
   const size_t atkeyspathsize = 1024;
   char atkeyspath[atkeyspathsize];
   memset(atkeyspath, 0, atkeyspathsize);
   size_t atkeyspathlen = 0;
 
-  if ((ret = functional_tests_get_atkeys_path(atsign, atsignlen, atkeyspath, atkeyspathsize, &atkeyspathlen)) != 0) {
+  if ((ret = functional_tests_get_atkeys_path(atsign, strlen(atsign), atkeyspath, atkeyspathsize, &atkeyspathlen)) != 0) {
     atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "Failed to get atkeys_sharedwith path: %d\n", ret);
     goto exit;
   }
@@ -35,22 +35,55 @@ int functional_tests_set_up_atkeys(atclient_atkeys *atkeys, const char *atsign,
 exit: { return ret; }
 }
 
-int functional_tests_pkam_auth(atclient *atclient, atclient_atkeys *atkeys, const char *atsign,
-                               const size_t atsignlen) {
+int functional_tests_pkam_auth(atclient *atclient, atclient_atkeys *atkeys, const char *atsign) {
   int ret = 1;
 
   atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_INFO, "functional_tests_pkam_auth Begin\n");
 
-  if ((ret = atclient_pkam_authenticate(atclient, atsign, atkeys, NULL, NULL)) != 0) {
+  if(atclient == NULL) {
+    ret = 1;
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "atclient is NULL\n");
+    return ret;
+  }
+
+  if(atkeys == NULL) {
+    ret = 1;
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "atkeys is NULL\n");
+    return ret;
+  }
+
+  if(atsign == NULL) {
+    ret = 1;
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "atsign is NULL\n");
+    return ret;
+  }
+
+  atclient_authenticate_options authenticate_options;
+  atclient_authenticate_options_init(&authenticate_options);
+
+  if((ret = atclient_authenticate_options_set_atdirectory_host(&authenticate_options, ATDIRECTORY_HOST)) != 0) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "atclient_authenticate_options_set_atdirectory_host: %d\n", ret);
+    goto exit;
+  }
+
+  if((ret = atclient_authenticate_options_set_atdirectory_port(&authenticate_options, ATDIRECTORY_PORT)) != 0) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "atclient_authenticate_options_set_atdirectory_port: %d\n", ret);
+    goto exit;
+  }
+
+  if ((ret = atclient_pkam_authenticate(atclient, atsign, atkeys, &authenticate_options, NULL)) != 0) {
     atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "atclient_pkam_authenticate: %d\n", ret);
     goto exit;
   }
 
+  atclient_set_read_timeout(atclient, 5*1000); // 5 second read timeout
+
   atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_INFO, "pkam authenticated\n");
 
   goto exit;
 
 exit: {
+  atclient_authenticate_options_free(&authenticate_options);
   atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_INFO, "functional_tests_pkam_auth End (%d)\n", ret);
   return ret;
 }