[apache#2292] improvement(PyClient): Fix unstable Python client integ…

…ration test in Github Action

.github/workflows/backend-integration-test.yml

@@ -95,7 +95,7 @@ jobs:
       - name: Backend Integration Test
         id: integrationTest
         run: |
-          ./gradlew test --rerun-tasks -PskipTests -PtestMode=${{ matrix.test-mode }} -PjdkVersion=${{ matrix.java-version }} -PskipWebITs -P${{ matrix.backend }}
+          ./gradlew test --rerun-tasks -PskipTests -PtestMode=${{ matrix.test-mode }} -PjdkVersion=${{ matrix.java-version }} -PskipWebITs -P${{ matrix.backend }} -PskipPyClientITs
 
       - name: Upload integrate tests reports
         uses: actions/upload-artifact@v3

.github/workflows/python-integration-test.yml

@@ -57,18 +57,26 @@ jobs:
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v2
 
-      - name: Free up disk space
-        run: |
-          dev/ci/util_free_space.sh
-
       - name: Python Client Integration Test
         id: integrationTest
+        env:
+          EXTERNAL_START_GRAVITINO: true
         run: |
           ./gradlew compileDistribution -x test -PjdkVersion=${{ matrix.java-version }}
+
           for pythonVersion in "3.8" "3.9" "3.10" "3.11"
           do
-            ./gradlew -PjdkVersion=${{ matrix.java-version }} -PpythonVersion=${pythonVersion} :client:client-python:integrationTest
+            echo "Use Python version ${pythonVersion} to test the Python client."
+            # Start Gravitino server and set the environment variable
+            ./distribution/package/bin/gravitino.sh start
+
+            ./gradlew -PjdkVersion=${{ matrix.java-version }} -PpythonVersion=${pythonVersion} :client:client-python:test
+
+            # Stop Gravitino server and clean database
+            ./distribution/package/bin/gravitino.sh stop
+            rm -rf ./distribution/package/data
           done
+          
 
       - name: Upload integrate tests reports
         uses: actions/upload-artifact@v3

clients/client-python/build.gradle.kts

@@ -26,9 +26,9 @@ fun gravitinoServer(operation: String) {
     val exitCode = process.waitFor()
     if (exitCode == 0) {
       val currentContext = process.inputStream.bufferedReader().readText()
-      println("Current docker context is: $currentContext")
+      println("Gravitino server status: $currentContext")
     } else {
-      println("checkOrbStackStatus Command execution failed with exit code $exitCode")
+      println("Gravitino server execution failed with exit code $exitCode")
     }
 }
 
@@ -39,26 +39,25 @@ tasks {
   }
 
   val test by registering(VenvTask::class) {
-    dependsOn(pipInstall)
-    venvExec = "python"
-    args = listOf("-m", "unittest")
-    workingDir = projectDir.resolve(".")
-  }
-
-  val integrationTest by registering(VenvTask::class) {
-    doFirst() {
-      gravitinoServer("start")
-    }
+    val skipPyClientITs = project.hasProperty("skipPyClientITs")
+    if (!skipPyClientITs) {
+      doFirst {
+        gravitinoServer("start")
+      }
 
-    dependsOn(pipInstall)
-    venvExec = "python"
-    args = listOf("-m", "unittest")
-    workingDir = projectDir.resolve(".")
-    environment = mapOf("PROJECT_VERSION" to project.version,
-      "GRADLE_START_GRAVITINO" to "True")
+      dependsOn(pipInstall)
+      venvExec = "python"
+      args = listOf("-m", "unittest")
+      workingDir = projectDir.resolve(".")
+      environment = mapOf(
+        "PROJECT_VERSION" to project.version,
+        "GRAVITINO_HOME" to project.rootDir.path + "/distribution/package",
+        "EXTERNAL_START_GRAVITINO" to "true"
+      )
 
-    doLast {
-      gravitinoServer("stop")
+      doLast {
+        gravitinoServer("stop")
+      }
     }
   }
 

clients/client-python/tests/integration/integration_test_env.py

@@ -20,11 +20,11 @@ def get_gravitino_server_version():
         response.close()
         return True
     except requests.exceptions.RequestException as e:
-        logger.warning("Failed to access the server: {}", e)
+        logger.warning("Failed to access the Gravitino server")
         return False
 
 
-def check_gravitino_server_status():
+def check_gravitino_server_status() -> bool:
     gravitino_server_running = False
     for i in range(5):
         logger.info("Monitoring Gravitino server status. Attempt %s", i + 1)
@@ -53,15 +53,20 @@ class IntegrationTestEnv(unittest.TestCase):
     def setUpClass(cls):
         _init_logging()
 
-        if os.environ.get('GRADLE_START_GRAVITINO') is not None:
-            logger.info('Manual start gravitino server [%s].', check_gravitino_server_status())
+        if os.environ.get('EXTERNAL_START_GRAVITINO') is not None:
+            """Maybe Gravitino server already startup by Gradle test command or developer manual startup."""
+            if not check_gravitino_server_status():
+                logger.error("ERROR: Can't find online Gravitino server!")
             return
 
-        current_path = os.getcwd()
-        cls.gravitino_startup_script = os.path.join(current_path, '../../../distribution/package/bin/gravitino.sh')
+        GravitinoHome = os.environ.get('GRAVITINO_HOME')
+        if GravitinoHome is None:
+            logger.error('Gravitino Python client integration test must configure `GRAVITINO_HOME`')
+
+        cls.gravitino_startup_script = os.path.join(GravitinoHome, 'bin/gravitino.sh')
         if not os.path.exists(cls.gravitino_startup_script):
             logger.error("Can't find Gravitino startup script: %s, "
-                         "Please execute `./gradlew compileDistribution -x test` in the gravitino project root "
+                         "Please execute `./gradlew compileDistribution -x test` in the Gravitino project root "
                          "directory.", cls.gravitino_startup_script)
             quit(0)
 
@@ -78,11 +83,9 @@ def setUpClass(cls):
             logger.error("ERROR: Can't start Gravitino server!")
             quit(0)
 
-        cls.clean_test_date()
-
     @classmethod
     def tearDownClass(cls):
-        if os.environ.get('GRADLE_START_GRAVITINO') is not None:
+        if os.environ.get('EXTERNAL_START_GRAVITINO') is not None:
             return
 
         logger.info("Stop integration test environment...")