[#5976] Improvement(bin):Add validation checks to the startup scripts to prevent incorrect usage

[liuchunhao]

What changes were proposed in this pull request?

#5976

• Add file suffix ‘template’ to the following scripts:

  • bin/gravitino.sh
  • bin/common.sh
  • bin/gravitino-iceberg-rest-server.sh

• Add a validation check on GRAVITINO_VERSION in the script bin/common.sh ( renamed to bin/common.sh.template ) with the followings :

  GRAVITINO_VERSION=GRAVITINO_VERSION_PLACEHOLDER
  if [[ "$GRAVITINO_VERSION" == *_VERSION_PLACEHOLDER ]]; then
    echo "GRAVITINO_VERSION is not set. Please make sure you are running the script from the distribution/package/bin and before running the script, run './gradle clean build -x test compileDistribution'"
    exit 1
  fi
  

• Update the following tasks in the root build.gradle.kts as described below :

  • compileDistribution
  • compileIcebergRESTServer

   eachFile {
        if (name == "gravitino-env.sh" || name == "common.sh") {
          filter { line ->
            line.replace("GRAVITINO_VERSION_PLACEHOLDER", "$version")
          }
        }
      }

Why are the changes needed?

To prevent incorrect usage with startup scripts

Does this PR introduce any user-facing change?

No

How was this patch tested?

• The scripts below will exit with status 1 and print an error message with the correct instructions

cd bin
gravitino.sh.template start    
gravitino-iceberg-rest-server.sh.template start

• correct way to run gravitino :

./gradle clean build -x test compileDistribution

cd distribution/package/bin

./gravitino.sh start

./gravitino-iceberg-rest-server.sh start

[tengqm]

This smells like an over engineering effort although I do appreciate the intention.

[xunliu]

@liuchunhao Thank you for your improve user experience.
Some Gravitino new user do not know the need compile the Gravitino first, but directly execution bin/gravitino.sh in the project root path, and find that it cannot be used, causing confusion to new users.

[xunliu]

Please update the prompt message:

No GRAVITINO_VERSION was found, you may need to:
1. Run the gravitino.sh script on the compiled Gravitino.
2. Run the gravitino.sh script in the release package.

[liuchunhao]

Thank you for the feedback. I will make the updates as required:

• Update the error message for startup failures
• Adjust the version check
• Revert the root build.gradle.kts files

[justinmclean]

"Run the gravitino.sh script in the release package." this may not be the best instructions, as an ASF release package is source, not binary.

[liuchunhao]

What does 'release package' mean? Should it instead be referred to as a 'distribution package'?

[xunliu]

@justinmclean The problem is that there are some users who run gravitino.sh scripts without compiling, causing them to fail. We want to give them some tips. Do you have any better suggestions?

[justinmclean]

Ask them to use a binary distribution or compile it first? i.e:

1. Run the gravitino.sh script in a compiled version of Gravitino.
2. Run the gravitino.sh script from a binary release package.

[xunliu]

I will use your PR to test, because gravitino.sh is very important.
So, I need some time to review this PR. Thanks.

[liuchunhao]

I will use your PR to test, because gravitino.sh is very important. So, I need some time to review this PR. Thanks.

I ran ./gradle clean build compileDistribution with all test tasks, and everything seems fine.
After launching ./gravitino.sh start, I sent an API call to /api/version, and it worked fine.

[xunliu]

hi @liuchunhao
Please update docs/getting-started.md#getting-started-locally
3. Start Gravitino using the gravitino.sh script in the binary release package or Docker image:

<path-to-gravitino>/bin/gravitino.sh start

4. Start Gravitino using the gravitino.sh script in the distribution package:

./gradlew compileDistribution -x test
<path-to-gravitino>/distribution/package/bin/gravitino.sh start