script/next-checks/next-checks-cargo-doc.sh

#!/usr/bin/env bash
#
# Copyright (c) 2025 Arm Limited. All rights reserved.
#
# SPDX-License-Identifier: BSD-3-Clause
#

TF_ROOT="$1"
TEST_CASE="Rust cargo doc checks"
LOG_FILE=`mktemp -t common.XXXX`
EXIT_VALUE=0

echo "# ${TEST_CASE}"
echo >> "$LOG_TEST_FILENAME"
echo "****** $TEST_CASE ******" >> "$LOG_TEST_FILENAME"
echo >> "$LOG_TEST_FILENAME"
echo "Platforms:" >> "$LOG_TEST_FILENAME"

available_platforms=$(make --silent -C ${TF_ROOT} list_platforms)

# Run cargo doc for all platforms
for plat in $available_platforms
do
    echo >> $LOG_FILE
    echo "############### ${TEST_CASE} - platform: ${plat}" >> "$LOG_FILE"
    echo >> $LOG_FILE
    make -C ${TF_ROOT} PLAT=${plat} cargo-doc >> "$LOG_FILE" 2>&1

    if [ "$?" -ne 0 ]; then
        echo -e "  ${plat}\t: FAIL" >> "$LOG_TEST_FILENAME"
        EXIT_VALUE=1
    else
        echo -e "  ${plat}\t: PASS" >> "$LOG_TEST_FILENAME"
    fi
done

echo >> "$LOG_TEST_FILENAME"
if [[ "$EXIT_VALUE" == 0 ]]; then
  echo "Result : SUCCESS" >> "$LOG_TEST_FILENAME"
else
  echo "Result : FAILURE" >> "$LOG_TEST_FILENAME"
fi
echo >> "$LOG_TEST_FILENAME"
cat "$LOG_FILE" >> "$LOG_TEST_FILENAME"

rm "$LOG_FILE"

exit "$EXIT_VALUE"