ci/ban_generated_plugin_registrant_java.sh

#!/bin/bash
#
# Copyright 2013 The Flutter Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

set -e

# Needed because if it is set, cd may print the path it changed to.
unset CDPATH

# On Mac OS, readlink -f doesn't work, so follow_links traverses the path one
# link at a time, and then cds into the link destination and find out where it
# ends up.
#
# The function is enclosed in a subshell to avoid changing the working directory
# of the caller.
function follow_links() (
  cd -P "$(dirname -- "$1")"
  file="$PWD/$(basename -- "$1")"
  while [[ -L "$file" ]]; do
    cd -P "$(dirname -- "$file")"
    file="$(readlink -- "$file")"
    cd -P "$(dirname -- "$file")"
    file="$PWD/$(basename -- "$file")"
  done
  echo "$file"
)

SCRIPT_DIR=$(follow_links "$(dirname -- "${BASH_SOURCE[0]}")")
SRC_DIR="$(
  cd "$SCRIPT_DIR/../.."
  pwd -P
)"

# Check if a file named **/GeneratedPluginRegistrant.java exists in the project.
# If it does, fail the build and print a message to the user pointing them to
# the file and instructing them to remove it.
#
# See: https://github.com/flutter/flutter/issues/143782.

# The expected path to the file. Any *other* path is unexpected.
EXPECTED_PATHS=("./shell/platform/android/test/io/flutter/plugins/GeneratedPluginRegistrant.java")

# Temporarily change the working directory to the root of the Flutter project.
pushd "$SRC_DIR/flutter" >/dev/null

# Change back to the original working directory.
function cleanup() {
  popd >/dev/null
}

trap cleanup EXIT

# Find all files named GeneratedPluginRegistrant.java in the project.
echo "Finding all files named GeneratedPluginRegistrant.java in the project..."
GENERATED_PLUGIN_REGISTRANT_PATHS=$(find . -name "GeneratedPluginRegistrant.java" | grep -v third_party)

# Iterate over the found paths and check if they are expected.
for path in $GENERATED_PLUGIN_REGISTRANT_PATHS; do
  if [[ ! " ${EXPECTED_PATHS[@]} " =~ " ${path} " ]]; then
    echo "ERROR: Found unexpected file named GeneratedPluginRegistrant.java at $path."
    echo "Please remove this file from the project."
    exit 1
  fi
done

echo "Done."