scripts/run-node-examples-from-readme.sh - iggy - Git at Google

 #!/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 Node.js examples from examples/nodejs/README.md files
 # Usage: ./scripts/run-node-examples-from-readme.sh [OPTIONS]
 #
 # --target - Optional target architecture for rust (e.g., x86_64-unknown-linux-musl)
 #
 # This script will run all the commands from examples/nodejs/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 `npm run` or `tsx`. 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
 ROOT_WORKDIR="$(pwd)"
 #set debug env
 export DEBUG=iggy:examples
 # Get target architecture from argument or use default

 TARGET="" # Iggy server target architecture

 while [[ $# -gt 0 ]]; do
     case "$1" in
         --target)
             TARGET="$2"
             shift 2
             ;;
         *)
             echo "Unknown option: $1"
             echo "Usage: $0 [--target TARGET]"
             exit 1
             ;;
     esac
 done

 # 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 "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

 # Execute all matching CLI commands from README.md and check if they pass or fail
 while IFS= read -r command; do
     # Remove backticks from command
     command=$(echo "${command}" | tr -d '`')

     echo -e "\e[33mChecking CLI command:\e[0m ${command}"
     echo ""

     set +e
     eval "${command}"
     exit_code=$?
     set -e

     # Stop at first failure
     if [ ${exit_code} -ne 0 ]; then
         echo ""
         echo -e "\e[31mCLI command failed:\e[0m ${command}"
         echo ""
         break
     fi

 done < <(grep -E "^\`cargo r --bin iggy -- " README.md)

 cd examples/node

 # Execute all non-TLS example commands from README.md and examples/node/README.md
 for readme_file in README.md examples/node/README.md; do
     if [ ! -f "${readme_file}" ]; then
         continue
     fi

     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 ${readme_file}:\e[0m ${command}"
         echo ""

         set +e
         eval "${command}"
         exit_code=$?
         set -e

         # Stop at first failure
         if [ ${exit_code} -ne 0 ]; then
             echo ""
             echo -e "\e[31mExample command failed:\e[0m ${command}"
             echo ""
             break 2 # Break from both loops
         fi
         # Add a small delay between examples to avoid potential race conditions
         sleep 2

     done < <(grep -E "^(npm run|tsx)" "${readme_file}" | grep -v "tcp-tls")
 done

 cd "${ROOT_WORKDIR}"

 # Stop the plain server before starting TLS server
 kill -TERM "$(cat ${PID_FILE})" 2>/dev/null || true
 sleep 2
 test -e ${PID_FILE} && rm ${PID_FILE}
 test -e ${LOG_FILE} && rm ${LOG_FILE}

 # Check if there are any TLS examples to run
 TLS_COMMANDS=""
 if [ -f "examples/node/README.md" ]; then
     TLS_COMMANDS=$(grep -E "^(npm run|tsx)" "examples/node/README.md" | grep "tcp-tls" || true)
 fi

 if [ -n "${TLS_COMMANDS}" ] && [ "${exit_code}" -eq 0 ]; then
     echo ""
     echo "=== Starting TLS server for TLS examples ==="

     # Remove old server data for clean TLS test
     test -d local_data && rm -fr local_data

     # Start TLS-enabled server
     IGGY_ROOT_USERNAME=iggy IGGY_ROOT_PASSWORD=iggy \
     IGGY_TCP_TLS_ENABLED=true \
     IGGY_TCP_TLS_CERT_FILE=core/certs/iggy_cert.pem \
     IGGY_TCP_TLS_KEY_FILE=core/certs/iggy_key.pem \
     ${SERVER_BIN} &>${LOG_FILE} &
     echo $! >${PID_FILE}

     # Wait for TLS server to start
     SERVER_START_TIME=0
     while ! grep -q "has started" ${LOG_FILE}; do
         if [ ${SERVER_START_TIME} -gt ${TIMEOUT} ]; then
             echo "TLS server did not start within ${TIMEOUT} seconds."
             cat ${LOG_FILE}
             exit 1
         fi
         echo "Waiting for TLS Iggy server to start... ${SERVER_START_TIME}"
         sleep 1
         ((SERVER_START_TIME += 1))
     done

     cd examples/node

     # Run only TLS examples
     for readme_file in README.md examples/node/README.md; do
         if [ ! -f "${readme_file}" ]; then
             continue
         fi

         while IFS= read -r command; do
             command=$(echo "${command}" | tr -d '`' | sed 's/^#.*//')
             if [ -z "${command}" ]; then
                 continue
             fi

             echo -e "\e[33mChecking TLS example command from ${readme_file}:\e[0m ${command}"
             echo ""

             set +e
             eval "${command}"
             exit_code=$?
             set -e

             if [ ${exit_code} -ne 0 ]; then
                 echo ""
                 echo -e "\e[31mTLS example command failed:\e[0m ${command}"
                 echo ""
                 break 2
             fi
             sleep 2

         done < <(grep -E "^(npm run|tsx)" "${readme_file}" | grep "tcp-tls")
     done

     cd "${ROOT_WORKDIR}"

     # Terminate TLS server
     kill -TERM "$(cat ${PID_FILE})" 2>/dev/null || true
 fi

 # Cleanup
 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}"
	#!/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 Node.js examples from examples/nodejs/README.md files
	# Usage: ./scripts/run-node-examples-from-readme.sh [OPTIONS]
	#
	# --target - Optional target architecture for rust (e.g., x86_64-unknown-linux-musl)
	#
	# This script will run all the commands from examples/nodejs/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 `npm run` or `tsx`. 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
	ROOT_WORKDIR="$(pwd)"
	#set debug env
	export DEBUG=iggy:examples
	# Get target architecture from argument or use default

	TARGET="" # Iggy server target architecture

	while [[ $# -gt 0 ]]; do
	case "$1" in
	--target)
	TARGET="$2"
	shift 2
	;;
	*)
	echo "Unknown option: $1"
	echo "Usage: $0 [--target TARGET]"
	exit 1
	;;
	esac
	done

	# 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 "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

	# Execute all matching CLI commands from README.md and check if they pass or fail
	while IFS= read -r command; do
	# Remove backticks from command
	command=$(echo "${command}" \| tr -d '`')

	echo -e "\e[33mChecking CLI command:\e[0m ${command}"
	echo ""

	set +e
	eval "${command}"
	exit_code=$?
	set -e

	# Stop at first failure
	if [ ${exit_code} -ne 0 ]; then
	echo ""
	echo -e "\e[31mCLI command failed:\e[0m ${command}"
	echo ""
	break
	fi

	done < <(grep -E "^\`cargo r --bin iggy -- " README.md)

	cd examples/node

	# Execute all non-TLS example commands from README.md and examples/node/README.md
	for readme_file in README.md examples/node/README.md; do
	if [ ! -f "${readme_file}" ]; then
	continue
	fi

	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 ${readme_file}:\e[0m ${command}"
	echo ""

	set +e
	eval "${command}"
	exit_code=$?
	set -e

	# Stop at first failure
	if [ ${exit_code} -ne 0 ]; then
	echo ""
	echo -e "\e[31mExample command failed:\e[0m ${command}"
	echo ""
	break 2 # Break from both loops
	fi
	# Add a small delay between examples to avoid potential race conditions
	sleep 2

	done < <(grep -E "^(npm run\|tsx)" "${readme_file}" \| grep -v "tcp-tls")
	done

	cd "${ROOT_WORKDIR}"

	# Stop the plain server before starting TLS server
	kill -TERM "$(cat ${PID_FILE})" 2>/dev/null \|\| true
	sleep 2
	test -e ${PID_FILE} && rm ${PID_FILE}
	test -e ${LOG_FILE} && rm ${LOG_FILE}

	# Check if there are any TLS examples to run
	TLS_COMMANDS=""
	if [ -f "examples/node/README.md" ]; then
	TLS_COMMANDS=$(grep -E "^(npm run\|tsx)" "examples/node/README.md" \| grep "tcp-tls" \|\| true)
	fi

	if [ -n "${TLS_COMMANDS}" ] && [ "${exit_code}" -eq 0 ]; then
	echo ""
	echo "=== Starting TLS server for TLS examples ==="

	# Remove old server data for clean TLS test
	test -d local_data && rm -fr local_data

	# Start TLS-enabled server
	IGGY_ROOT_USERNAME=iggy IGGY_ROOT_PASSWORD=iggy \
	IGGY_TCP_TLS_ENABLED=true \
	IGGY_TCP_TLS_CERT_FILE=core/certs/iggy_cert.pem \
	IGGY_TCP_TLS_KEY_FILE=core/certs/iggy_key.pem \
	${SERVER_BIN} &>${LOG_FILE} &
	echo $! >${PID_FILE}

	# Wait for TLS server to start
	SERVER_START_TIME=0
	while ! grep -q "has started" ${LOG_FILE}; do
	if [ ${SERVER_START_TIME} -gt ${TIMEOUT} ]; then
	echo "TLS server did not start within ${TIMEOUT} seconds."
	cat ${LOG_FILE}
	exit 1
	fi
	echo "Waiting for TLS Iggy server to start... ${SERVER_START_TIME}"
	sleep 1
	((SERVER_START_TIME += 1))
	done

	cd examples/node

	# Run only TLS examples
	for readme_file in README.md examples/node/README.md; do
	if [ ! -f "${readme_file}" ]; then
	continue
	fi

	while IFS= read -r command; do
	command=$(echo "${command}" \| tr -d '`' \| sed 's/^#.*//')
	if [ -z "${command}" ]; then
	continue
	fi

	echo -e "\e[33mChecking TLS example command from ${readme_file}:\e[0m ${command}"
	echo ""

	set +e
	eval "${command}"
	exit_code=$?
	set -e

	if [ ${exit_code} -ne 0 ]; then
	echo ""
	echo -e "\e[31mTLS example command failed:\e[0m ${command}"
	echo ""
	break 2
	fi
	sleep 2

	done < <(grep -E "^(npm run\|tsx)" "${readme_file}" \| grep "tcp-tls")
	done

	cd "${ROOT_WORKDIR}"

	# Terminate TLS server
	kill -TERM "$(cat ${PID_FILE})" 2>/dev/null \|\| true
	fi

	# Cleanup
	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}"