Merge pull request #5 from Kucoin/snapshot/2025.07.01

Add tests and improve PHP version compatibility #54

Author: ISAAC-XXYYZZ

CHANGELOG.md

@@ -4,6 +4,9 @@ API documentation [Changelog](https://www.kucoin.com/docs-new/change-log)
 
 Current synchronized API documentation version [20250529](https://www.kucoin.com/docs-new/change-log#20250529)
 
+## 2025-06-11(PHP 0.1.3-alpha)
+- Add compatibility for PHP versions from 7.4 to 8.x 
+
 ## 2025-06-11(1.3.0)
 - Update the latest APIs, documentation, etc
 - Introduced a new testing framework for all SDKs

Dockerfile

@@ -1,14 +1,25 @@
-FROM php:8.1-cli
+ARG PHP_RUNTIME=8.1
 
-RUN apt-get update && apt-get install -y unzip git \
+FROM php:8.1-cli AS builder
+WORKDIR /src
+RUN apt-get update && apt-get install -y unzip git jq \
     && curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
+COPY . .
+ARG SDK_VERSION=0.0.1-alpha
 
-WORKDIR /app
-COPY src ./src
-COPY composer.json ./
-COPY example ./example
-RUN composer install
+RUN cp composer.json composer.json.bak \
+    && jq --arg ver "$SDK_VERSION" '. + {version: $ver}' composer.json.bak > composer.json
+RUN rm -f composer.lock
+RUN composer install --no-dev --optimize-autoloader && \
+    mkdir -p /build_out && \
+    composer archive --format=tar --dir=/build_out
 
-WORKDIR /app/example
-#CMD ["php", "ExampleGetStarted.php"]
-CMD ["php", "ExampleWs.php"]
+FROM php:${PHP_RUNTIME}-cli
+WORKDIR /app
+RUN apt-get update && apt-get install -y unzip git  libzip-dev \
+    && curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
+RUN docker-php-ext-install zip
+COPY . /src
+COPY example /app/example
+COPY script /app
+COPY --from=builder /build_out /tmp

Makefile

@@ -0,0 +1,64 @@
+
+.PHONY: build
+build:
+	docker build -t php-sdk-image:latest .
+
+.PHONY: auto-test
+auto-test: build
+	docker run --rm php-sdk-image:latest bash /app/auto_test.sh
+
+.PHONY: before-release-test
+before-release-test: build
+	docker run --rm \
+	  -e API_KEY="$$API_KEY" \
+	  -e API_SECRET="$$API_SECRET" \
+	  -e API_PASSPHRASE="$$API_PASSPHRASE" \
+	  -e USE_LOCAL="true" \
+	  php-sdk-image:latest \
+	  bash /app/release_test.sh
+
+.PHONY: after-release-test
+after-release-test: build
+	docker run --rm \
+	  -e API_KEY="$$API_KEY" \
+	  -e API_SECRET="$$API_SECRET" \
+	  -e API_PASSPHRASE="$$API_PASSPHRASE" \
+	  php-sdk-image:latest \
+	  bash /app/release_test.sh
+
+.PHONY: run-forever-test
+run-forever-test: build
+	docker rm -f php-run-forever-test
+	docker run -idt \
+	  -e API_KEY="$$API_KEY" \
+	  -e API_SECRET="$$API_SECRET" \
+	  -e API_PASSPHRASE="$$API_PASSPHRASE" \
+	  --name php-run-forever-test \
+	  php-sdk-image:latest \
+	  bash /app/run_forever_test.sh
+
+.PHONY: reconnect-test
+reconnect-test: build
+	docker rm -f php-reconnect-test
+	docker run -idt \
+	  -e API_KEY="$$API_KEY" \
+	  -e API_SECRET="$$API_SECRET" \
+	  -e API_PASSPHRASE="$$API_PASSPHRASE" \
+	  --name php-reconnect-test --network isolated_net \
+	  php-sdk-image:latest \
+	  bash /app/ws_reconnect_test.sh
+
+
+VERSIONS = 7.4 8.0 8.1 8.2
+.PHONY: php-version-test
+php-version-test:
+	@for v in $(VERSIONS); do \
+    	  echo "---- PHP $$v ----"; \
+    	  docker build --build-arg PHP_RUNTIME=$$v -t php-sdk-image:$$v . ; \
+    	  docker run --rm \
+    	    -e API_KEY="$$API_KEY" \
+    	    -e API_SECRET="$$API_SECRET" \
+    	    -e API_PASSPHRASE="$$API_PASSPHRASE" \
+    	    -e USE_LOCAL="true" \
+    	    php-sdk-image:$$v bash /app/release_test.sh || exit $$? ; \
+    done

README.md

@@ -13,14 +13,14 @@ For an overview of the project and SDKs in other languages, refer to the [Main R
 
 ## 📦 Installation
 
-### Latest Version: `0.1.2-alpha`
+### Latest Version: `0.1.3-alpha`
 
 **Note**: This SDK is currently in the Alpha phase. We are actively iterating and improving its features, stability, and documentation. Feedback and contributions are highly encouraged to help us refine the SDK.
 
 Install the SDK using `composer`:
 
 ```bash
-composer require kucoin/kucoin-universal-sdk=0.1.2-alpha
+composer require kucoin/kucoin-universal-sdk=0.1.3-alpha
 ```
 
 ## 📖 Getting Started

composer.json

@@ -23,7 +23,7 @@
     }
   ],
   "require": {
-    "php": ">=7.4",
+    "php": "^7.4 || ^8.0",
     "jms/serializer": "^3.32",
     "doctrine/annotations": "^2.0",
     "guzzlehttp/guzzle": "^7.9",

script/auto_test.sh

@@ -0,0 +1,58 @@
+#!/bin/bash
+
+cd /src
+composer install
+
+LOG_FILE="/src/test.log"
+[ -f "$LOG_FILE" ] && rm "$LOG_FILE"
+
+overall_total=0
+overall_success=0
+overall_fail=0
+
+{
+  printf "%-20s | %-10s | %-10s | %-10s\n" "Directory" "Total" "Success" "Fail"
+  printf "%-20s-+-%-10s-+-%-10s-+-%-10s\n" "--------------------" "----------" "----------" "----------"
+} | tee "$LOG_FILE"
+
+for dir in src/Generate/*/; do
+  dir_name=${dir%/}
+  dir_name=${dir_name##*/}
+
+  test_output=$(vendor/bin/phpunit "$dir" --colors=never 2>&1 || true)
+  echo "$test_output" >> "$LOG_FILE"
+
+  summary_line=$(echo "$test_output" | grep -E "OK \(|Tests:|No tests executed")
+
+  if [[ $summary_line == OK* ]]; then
+    # OK (5 tests, 12 assertions)
+    total_tests=$(echo "$summary_line" | grep -oE '[0-9]+' | head -n1)
+    failed_tests=0
+  elif [[ $summary_line == Tests:* ]]; then
+    # Tests: 7, Assertions: 12, Failures: 2, Errors: 1
+    total_tests=$(echo "$summary_line" | grep -oE 'Tests:[[:space:]]*[0-9]+' | grep -oE '[0-9]+')
+    failed_tests=$(echo "$summary_line" | grep -oE 'Failures:[[:space:]]*[0-9]+' | grep -oE '[0-9]+')
+    failed_tests=${failed_tests:-0}
+  else
+    # No tests executed!
+    total_tests=0
+    failed_tests=0
+  fi
+
+  successful_tests=$((total_tests - failed_tests))
+
+  printf "%-20s | %-10d | %-10d | %-10d\n" \
+    "$dir_name" "$total_tests" "$successful_tests" "$failed_tests" | tee -a "$LOG_FILE"
+
+  overall_total=$((overall_total + total_tests))
+  overall_success=$((overall_success + successful_tests))
+  overall_fail=$((overall_fail + failed_tests))
+done
+
+{
+  printf "%-20s-+-%-10s-+-%-10s-+-%-10s\n" "--------------------" "----------" "----------" "----------"
+  printf "%-20s | %-10d | %-10d | %-10d\n" \
+    "Overall Summary" "$overall_total" "$overall_success" "$overall_fail"
+} | tee -a "$LOG_FILE"
+
+exit "$overall_fail"

script/release_test.sh

@@ -0,0 +1,42 @@
+#!/bin/bash
+set -e
+
+echo "USE_LOCAL = ${USE_LOCAL:-<unset>}"
+
+echo '{
+  "name": "test/test",
+  "description": "Test project",
+  "type": "project",
+  "require": {},
+  "minimum-stability": "alpha",
+  "prefer-stable": true
+}' > composer.json
+
+
+if [[ "${USE_LOCAL,,}" == "true" ]]; then
+    echo "Installing local package(s)…"
+    ls /tmp/*.tar 1>/dev/null 2>&1
+    mkdir -p ./local-packages
+    cp /tmp/*.tar ./local-packages/
+    composer config repositories.local artifact ./local-packages
+    composer require kucoin/kucoin-universal-sdk
+else
+    echo "📦 Installing kucoin-universal-sdk from Packagist…"
+    composer require kucoin/kucoin-universal-sdk
+fi
+
+echo "Echo depends..."
+composer depends php
+
+echo "Running service scripts..."
+cp /src/tests/regression/RunServiceTest.php /app
+composer require phpunit/phpunit
+composer require ramsey/uuid
+vendor/bin/phpunit --colors --bootstrap vendor/autoload.php RunServiceTest.php
+
+echo "Running example scripts..."
+cd /app/example
+php ExampleAPI.php
+php ExampleGetStarted.php
+php ExampleSign.php
+php ExampleWs.php

script/run_forever_test.sh

@@ -0,0 +1,32 @@
+#!/bin/bash
+set -e
+
+echo "USE_LOCAL = ${USE_LOCAL:-<unset>}"
+
+echo '{
+  "name": "test/test",
+  "description": "Test project",
+  "type": "project",
+  "require": {},
+  "minimum-stability": "alpha",
+  "prefer-stable": true
+}' > composer.json
+
+
+if [[ "${USE_LOCAL,,}" == "true" ]]; then
+    echo "Installing local package(s)…"
+    ls /tmp/*.tar 1>/dev/null 2>&1
+    mkdir -p ./local-packages
+    cp /tmp/*.tar ./local-packages/
+    composer config repositories.local artifact ./local-packages
+    composer require kucoin/kucoin-universal-sdk
+else
+    echo "📦 Installing kucoin-universal-sdk from Packagist…"
+    composer require kucoin/kucoin-universal-sdk
+fi
+
+cat composer.json
+
+echo "Running scripts..."
+cp /src/tests/regression/RunForeverTest.php /app
+php -d memory_limit=512M RunForeverTest.php

script/ws_reconnect_test.sh

@@ -0,0 +1,32 @@
+#!/bin/bash
+set -e
+
+echo "USE_LOCAL = ${USE_LOCAL:-<unset>}"
+
+echo '{
+  "name": "test/test",
+  "description": "Test project",
+  "type": "project",
+  "require": {},
+  "minimum-stability": "alpha",
+  "prefer-stable": true
+}' > composer.json
+
+
+if [[ "${USE_LOCAL,,}" == "true" ]]; then
+    echo "Installing local package(s)…"
+    ls /tmp/*.tar 1>/dev/null 2>&1
+    mkdir -p ./local-packages
+    cp /tmp/*.tar ./local-packages/
+    composer config repositories.local artifact ./local-packages
+    composer require kucoin/kucoin-universal-sdk
+else
+    echo "📦 Installing kucoin-universal-sdk from Packagist…"
+    composer require kucoin/kucoin-universal-sdk
+fi
+
+cat composer.json
+
+echo "Running scripts..."
+cp /src/tests/regression/RunReconnectTest.php /app
+php -d memory_limit=512M RunReconnectTest.php

src/Generate/Version.php

@@ -4,6 +4,6 @@
 
 class Version
 {
-    const SDK_VERSION = "0.1.2-alpha";
-    const SDK_GENERATE_DATE = "2025-06-11";
+    const SDK_VERSION = "0.1.3-alpha";
+    const SDK_GENERATE_DATE = "2025-07-01";
 }