Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
godotengine
GitHub Repository: godotengine/godot
 Path: blob/master/misc/scripts/validate_extension_api.sh
9896 views
1
#!/bin/bash

2
set -o pipefail

3


4
if [ ! -f "version.py" ]; then

5
  echo "Warning: This script is intended to be run from the root of the Godot repository."

6
  echo "Some of the paths checks may not work as intended from a different folder."

7
fi

8


9
if [ $# != 1 ]; then

10
  echo "Usage: @0 <path-to-godot-executable>"

11
  exit 1

12
fi

13


14
api_validation_dir="$( dirname -- "$( dirname -- "${BASH_SOURCE[0]//\.\//}" )" )/extension_api_validation/"

15


16
has_problems=0

17
warn_extra=0

18
reference_tag=""

19
expected_errors=""

20


21
make_annotation()

22
{

23
  local title=$1

24
  local body=$2

25
  local type=$3

26
  local file=$4

27
  if [[ "$GITHUB_OUTPUT" == "" ]]; then

28
    echo "$title"

29
    echo "$body"

30
  else

31
    body="$(awk 1 ORS='%0A' - <<<"$body")"

32
    echo "::$type file=$file,title=$title ::$body"

33
  fi

34
}

35


36
get_expected_output()

37
{

38
  local parts=()

39
  IFS='_' read -ra parts <<< "$(basename -s .expected "$1")"

40


41
  if [[ "${#parts[@]}" == "2" ]]; then

42
    cat "$1" >> "$expected_errors"

43
    get_expected_output "$(find "$api_validation_dir" -name "${parts[1]}*.expected")"

44
    reference_tag="${parts[0]}"

45
    warn_extra=0

46
  else

47
    cat "$1" >> "$expected_errors"

48
    reference_tag="${parts[0]}"

49
    warn_extra=1

50
  fi

51
}

52


53
while read -r file; do

54
    reference_file="$(mktemp)"

55
    validate="$(mktemp)"

56
    validation_output="$(mktemp)"

57
    allowed_errors="$(mktemp)"

58
    expected_errors="$(mktemp)"

59
    get_expected_output "$file"

60


61
    # Download the reference extension_api.json

62
    wget -nv --retry-on-http-error=503 --tries=5 --timeout=60 -cO "$reference_file" "https://raw.githubusercontent.com/godotengine/godot-cpp/godot-$reference_tag/gdextension/extension_api.json" || has_problems=1

63
    # Validate the current API against the reference

64
    "$1" --headless --validate-extension-api "$reference_file" 2>&1 | tee "$validate" | awk '!/^Validate extension JSON:/' - || true

65
    # Collect the expected and actual validation errors

66
    awk '/^Validate extension JSON:/' - < "$validate" | sort > "$validation_output"

67
    awk '/^Validate extension JSON:/' - < "$expected_errors" | sort > "$allowed_errors"

68


69
    # Differences between the expected and actual errors

70
    new_validation_error="$(comm -23 "$validation_output" "$allowed_errors")"

71
    obsolete_validation_error="$(comm -13 "$validation_output" "$allowed_errors")"

72


73
    if [ -n "$obsolete_validation_error" ] && [ "$warn_extra" = "1" ]; then

74
        #make_annotation "The following validation errors no longer occur (compared to $reference_tag):" "$obsolete_validation_error" warning "$file"

75
        echo "The following validation errors no longer occur (compared to $reference_tag):"

76
        echo "$obsolete_validation_error"

77
    fi

78
    if [ -n "$new_validation_error" ]; then

79
        make_annotation "Compatibility to $reference_tag is broken in the following ways:" "$new_validation_error" error "$file"

80
        has_problems=1

81
    fi

82


83
    rm -f "$reference_file" "$validate" "$validation_output" "$allowed_errors" "$expected_errors"

84
done <<< "$(find "$api_validation_dir" -name "*.expected")"

85


86
exit $has_problems

87


88