You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iggy.apache.org by hg...@apache.org on 2025/11/18 11:19:38 UTC
(iggy) 04/12: move script
This is an automated email from the ASF dual-hosted git repository.
hgruszecki pushed a commit to branch 1889-test-examples
in repository https://gitbox.apache.org/repos/asf/iggy.git
commit 88914ae0d91ea16ce5fce6acf918107cc7aa2d90
Author: Huan-Cheng Chang <ch...@gmail.com>
AuthorDate: Sun Sep 28 10:13:40 2025 +0100
move script
---
.../actions/python-maturin/pre-merge/action.yml | 13 --
.github/config/components.yml | 4 +-
.github/workflows/_test_examples.yml | 7 +
examples/python/README.md | 4 +-
scripts/run-python-examples-from-readme.sh | 153 +++++++++++++++++++++
5 files changed, 165 insertions(+), 16 deletions(-)
diff --git a/.github/actions/python-maturin/pre-merge/action.yml b/.github/actions/python-maturin/pre-merge/action.yml
index 75eda5161..878845cc0 100644
--- a/.github/actions/python-maturin/pre-merge/action.yml
+++ b/.github/actions/python-maturin/pre-merge/action.yml
@@ -137,19 +137,6 @@ runs:
exit ${TEST_EXIT_CODE:-0}
shell: bash
- - name: Run Python example tests
- if: inputs.task == 'test' && steps.iggy.outcome == 'success'
- run: |
- echo "Running example tests with Iggy server at ${{ steps.iggy.outputs.address }}..."
-
- IGGY_SERVER_HOST=127.0.0.1 \
- IGGY_SERVER_TCP_PORT=8090 \
- ./foreign/python/scripts/test_examples.sh || TEST_EXIT_CODE=$?
-
- # Exit with test result
- exit ${TEST_EXIT_CODE:-0}
- shell: bash
-
- name: Run Python unit tests only (fallback)
if: inputs.task == 'test' && steps.iggy.outcome != 'success'
run: |
diff --git a/.github/config/components.yml b/.github/config/components.yml
index 1d775d85f..e77b3d9b7 100644
--- a/.github/config/components.yml
+++ b/.github/config/components.yml
@@ -237,13 +237,15 @@ components:
- "rust-server"
- "sdk-go"
- "sdk-csharp"
+ - "sdk-python"
- "ci-infrastructure" # CI changes trigger full regression
paths:
- "examples/**"
- "scripts/run-rust-examples-from-readme.sh"
- "scripts/run-go-examples-from-readme.sh"
- "scripts/run-csharp-examples-from-readme.sh"
- tasks: ["examples-rust", "examples-go", "examples-csharp"]
+ - "scripts/run-python-examples-from-readme.sh"
+ tasks: ["examples-rust", "examples-go", "examples-csharp", "examples-python"]
web-ui:
paths:
diff --git a/.github/workflows/_test_examples.yml b/.github/workflows/_test_examples.yml
index 89e847141..0353ed9ec 100644
--- a/.github/workflows/_test_examples.yml
+++ b/.github/workflows/_test_examples.yml
@@ -112,6 +112,13 @@ jobs:
# Run the examples script which will use the prebuilt server binary
./scripts/run-csharp-examples-from-readme.sh
+ - name: Run Python examples
+ if: inputs.component == 'examples-suite' && inputs.task == 'examples-python'
+ run: |
+ echo "Running Python examples tests..."
+ # Run the examples script which will use the prebuilt server binary
+ ./scripts/run-python-examples-from-readme.sh
+
- name: Upload reports
if: always()
uses: actions/upload-artifact@v4
diff --git a/examples/python/README.md b/examples/python/README.md
index eab95b923..70aa4fa95 100644
--- a/examples/python/README.md
+++ b/examples/python/README.md
@@ -49,8 +49,8 @@ python getting-started/consumer.py
Core functionality with detailed configuration options:
```bash
-python basic/producer.py <connection_string>
-python basic/consumer.py <connection_string>
+python basic/producer.py
+python basic/consumer.py
```
Demonstrates fundamental client connection, authentication, batch message sending, and polling with support for TCP/QUIC/HTTP protocols.
diff --git a/scripts/run-python-examples-from-readme.sh b/scripts/run-python-examples-from-readme.sh
new file mode 100755
index 000000000..e5de27e2b
--- /dev/null
+++ b/scripts/run-python-examples-from-readme.sh
@@ -0,0 +1,153 @@
+#!/bin/bash
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+set -euo pipefail
+
+# Script to run Python examples from README.md and examples/python/README.md files
+# Usage: ./scripts/run-python-examples-from-readme.sh [TARGET]
+#
+# TARGET - Optional target architecture (e.g., x86_64-unknown-linux-musl)
+# If not provided, uses the default target
+#
+# This script will run all the commands from both README.md and examples/python/README.md files
+# and check if they pass or fail.
+# If any command fails, it will print the command and exit with non-zero status.
+# If all commands pass, it will remove the log file and exit with zero status.
+#
+# Note: This script assumes that the iggy-server is not running and will start it in the background.
+# It will wait until the server is started before running the commands.
+# It will also terminate the server after running all the commands.
+# Script executes every command in README files which is enclosed in backticks (`) and starts
+# with `python `. Other commands are ignored.
+# Order of commands in README files is important as script will execute them from top to bottom.
+
+readonly LOG_FILE="iggy-server.log"
+readonly PID_FILE="iggy-server.pid"
+readonly TIMEOUT=300
+
+# Get target architecture from argument or use default
+TARGET="${1:-}"
+if [ -n "${TARGET}" ]; then
+ echo "Using target architecture: ${TARGET}"
+else
+ echo "Using default target architecture"
+fi
+
+# Remove old server data if present
+test -d local_data && rm -fr local_data
+test -e ${LOG_FILE} && rm ${LOG_FILE}
+test -e ${PID_FILE} && rm ${PID_FILE}
+
+# Check if server binary exists
+SERVER_BIN=""
+if [ -n "${TARGET}" ]; then
+ SERVER_BIN="target/${TARGET}/debug/iggy-server"
+else
+ SERVER_BIN="target/debug/iggy-server"
+fi
+
+if [ ! -f "${SERVER_BIN}" ]; then
+ echo "Error: Server binary not found at ${SERVER_BIN}"
+ echo "Please build the server binary before running this script:"
+ if [ -n "${TARGET}" ]; then
+ echo " cargo build --target ${TARGET} --bin iggy-server"
+ else
+ echo " cargo build --bin iggy-server"
+ fi
+ exit 1
+fi
+
+echo "Using server binary at ${SERVER_BIN}"
+
+# Run iggy server using the prebuilt binary
+echo "Starting server from ${SERVER_BIN}..."
+IGGY_ROOT_USERNAME=iggy IGGY_ROOT_PASSWORD=iggy ${SERVER_BIN} &>${LOG_FILE} &
+echo $! >${PID_FILE}
+
+# Wait until "Iggy server has started" string is present inside iggy-server.log
+SERVER_START_TIME=0
+while ! grep -q "Iggy server has started" ${LOG_FILE}; do
+ if [ ${SERVER_START_TIME} -gt ${TIMEOUT} ]; then
+ echo "Server did not start within ${TIMEOUT} seconds."
+ ps fx
+ cat ${LOG_FILE}
+ exit 1
+ fi
+ echo "Waiting for Iggy server to start... ${SERVER_START_TIME}"
+ sleep 1
+ ((SERVER_START_TIME += 1))
+done
+
+echo "🚀 Running python example scripts..."
+
+cd examples/python || exit 1
+
+EXEC_TIMEOUT_SEC=10
+exit_code=0
+
+# Execute all example commands from examples/python/README.md and check if they pass or fail
+exit_code=0
+if [ -f "README.md" ]; then
+ while IFS= read -r command; do
+ # Remove backticks and comments from command
+ command=$(echo "${command}" | tr -d '`' | sed 's/^#.*//')
+ # Skip empty lines
+ if [ -z "${command}" ]; then
+ continue
+ fi
+
+ echo -e "\e[33mChecking example command from examples/python/README.md:\e[0m ${command}"
+ echo ""
+
+ set +e
+ timeout $EXEC_TIMEOUT_SEC eval "${command}"
+ test_exit_code=0
+ set -e
+
+ # Stop at first failure
+ # Since examples might last longer, timeout error 124 is ignored here
+ if [[ $test_exit_code -ne 0 && $test_exit_code -ne 124 ]]; then
+ echo ""
+ echo -e "\e[31mExample command failed:\e[0m ${command}"
+ echo ""
+ break
+ fi
+ # Add a small delay between examples to avoid potential race conditions
+ sleep 2
+
+ done < <(grep -E "^python " "README.md")
+fi
+
+cd ../..
+
+# Terminate server
+kill -TERM "$(cat ${PID_FILE})"
+test -e ${PID_FILE} && rm ${PID_FILE}
+
+# If everything is ok remove log and pid files otherwise cat server log
+if [ "${exit_code}" -eq 0 ]; then
+ echo "Test passed"
+else
+ echo "Test failed, see log file:"
+ test -e ${LOG_FILE} && cat ${LOG_FILE}
+fi
+
+test -e ${LOG_FILE} && rm ${LOG_FILE}
+test -e ${PID_FILE} && rm ${PID_FILE}
+
+exit "${exit_code}"