enhance workflows and tests: set AVD-specific environment variables for Android emulator setup and operations, update test cases to incorporate explicit AVD paths for improved consistency and debugging

Author: allnes

.github/workflows/e2e-android-test.yml

@@ -118,6 +118,18 @@ jobs:
           echo "  Architecture: ${{ matrix.arch }}"
           echo "  OS: ${{ matrix.os }}"
 
+          # Set Android environment variables for AVD location
+          export ANDROID_HOME=$HOME/ovmb_cache/android-sdk
+          export ANDROID_SDK_ROOT=$HOME/ovmb_cache/android-sdk
+          export ANDROID_SDK_HOME=$HOME/ovmb_cache/android-sdk
+          export ANDROID_AVD_HOME=$HOME/ovmb_cache/android-sdk/.android/avd
+
+          echo "📍 Environment variables set:"
+          echo "  ANDROID_HOME=$ANDROID_HOME"
+          echo "  ANDROID_SDK_ROOT=$ANDROID_SDK_ROOT"
+          echo "  ANDROID_SDK_HOME=$ANDROID_SDK_HOME"
+          echo "  ANDROID_AVD_HOME=$ANDROID_AVD_HOME"
+
           python -m ovmobilebench.cli setup-android \
             -c ${{ matrix.config_file }} \
             --api ${{ matrix.android-api }} \
@@ -129,9 +141,24 @@ jobs:
           echo "📊 Android SDK setup complete:"
           echo "  Cache size: $(du -sh $HOME/ovmb_cache 2>/dev/null || echo 'calculating...')"
 
+          # List created AVDs
+          echo "📱 Created AVDs:"
+          ls -la $ANDROID_AVD_HOME 2>/dev/null || echo "AVD directory not found"
+
       # === PREPARE EMULATOR ===
       - name: Start Android Emulator
         run: |
+          # Set Android environment variables for AVD location
+          export ANDROID_HOME=$HOME/ovmb_cache/android-sdk
+          export ANDROID_SDK_ROOT=$HOME/ovmb_cache/android-sdk
+          export ANDROID_SDK_HOME=$HOME/ovmb_cache/android-sdk
+          export ANDROID_AVD_HOME=$HOME/ovmb_cache/android-sdk/.android/avd
+
+          echo "📍 Starting emulator with environment:"
+          echo "  ANDROID_AVD_HOME=$ANDROID_AVD_HOME"
+          echo "📱 Available AVDs:"
+          ls -la $ANDROID_AVD_HOME 2>/dev/null || echo "No AVDs found"
+
           python tests/e2e/test_emulator_helper.py -c ${{ matrix.config_file }} start-emulator &
           # Give emulator a moment to start before checking
           sleep 10
@@ -207,7 +234,14 @@ jobs:
       # === CLEANUP ===
       - name: Stop emulator
         if: always()
-        run: python tests/e2e/test_emulator_helper.py -c ${{ matrix.config_file }} stop-emulator
+        run: |
+          # Set Android environment variables
+          export ANDROID_HOME=$HOME/ovmb_cache/android-sdk
+          export ANDROID_SDK_ROOT=$HOME/ovmb_cache/android-sdk
+          export ANDROID_SDK_HOME=$HOME/ovmb_cache/android-sdk
+          export ANDROID_AVD_HOME=$HOME/ovmb_cache/android-sdk/.android/avd
+
+          python tests/e2e/test_emulator_helper.py -c ${{ matrix.config_file }} stop-emulator
 
       - name: Upload artifacts
         if: always()

tests/e2e/test_emulator_helper.py

@@ -58,6 +58,15 @@ def get_sdk_path_from_config(config_file=None):
     return str(Path.cwd() / "ovmb_cache" / "android-sdk")
 
 
+def get_avd_home_from_config(config_file=None):
+    """Get AVD home directory - use .android/avd in SDK location."""
+    sdk_path = get_sdk_path_from_config(config_file)
+    # AVD home is in SDK_PATH/.android/avd
+    avd_home = str(Path(sdk_path) / ".android" / "avd")
+    logger.info(f"Using AVD home: {avd_home}")
+    return avd_home
+
+
 def get_arch_from_config(config_file=None):
     """Get architecture from OVMobileBench config."""
     # Use provided config file or default
@@ -82,6 +91,7 @@ def get_arch_from_config(config_file=None):
 
 # Global variables that will be initialized in main()
 ANDROID_HOME = None
+AVD_HOME = None
 ARCHITECTURE = None
 
 
@@ -95,6 +105,16 @@ def create_avd(api_level: int, avd_name: str = None):
     )
 
     avdmanager_path = Path(ANDROID_HOME) / "cmdline-tools" / "latest" / "bin" / "avdmanager"
+
+    # Set environment variables for AVD creation
+    env = os.environ.copy()
+    env["ANDROID_SDK_ROOT"] = ANDROID_HOME
+    env["ANDROID_HOME"] = ANDROID_HOME
+    env["ANDROID_AVD_HOME"] = AVD_HOME
+
+    # Create AVD directory if it doesn't exist
+    Path(AVD_HOME).mkdir(parents=True, exist_ok=True)
+
     cmd = [
         str(avdmanager_path),
         "create",
@@ -108,8 +128,8 @@ def create_avd(api_level: int, avd_name: str = None):
         "--force",
     ]
 
-    subprocess.run(cmd, input="no\n", text=True, check=True)
-    logger.info(f"AVD '{avd_name}' created successfully")
+    subprocess.run(cmd, input="no\n", text=True, check=True, env=env)
+    logger.info(f"AVD '{avd_name}' created successfully in {AVD_HOME}")
 
 
 def start_emulator(avd_name: str = None, api_level: int = 30):
@@ -155,7 +175,7 @@ def start_emulator(avd_name: str = None, api_level: int = 30):
     env = os.environ.copy()
     env["ANDROID_SDK_ROOT"] = ANDROID_HOME
     env["ANDROID_HOME"] = ANDROID_HOME
-    env["ANDROID_AVD_HOME"] = str(Path(ANDROID_HOME) / "avd")
+    env["ANDROID_AVD_HOME"] = AVD_HOME
 
     subprocess.Popen(cmd, env=env)
     logger.info("Emulator started in background")
@@ -242,7 +262,14 @@ def delete_avd(avd_name: str = None, api_level: int = 30):
 
     logger.info(f"Deleting AVD '{avd_name}'...")
     avdmanager_path = Path(ANDROID_HOME) / "cmdline-tools" / "latest" / "bin" / "avdmanager"
-    subprocess.run([str(avdmanager_path), "delete", "avd", "-n", avd_name], check=False)
+
+    # Set environment variables for AVD deletion
+    env = os.environ.copy()
+    env["ANDROID_SDK_ROOT"] = ANDROID_HOME
+    env["ANDROID_HOME"] = ANDROID_HOME
+    env["ANDROID_AVD_HOME"] = AVD_HOME
+
+    subprocess.run([str(avdmanager_path), "delete", "avd", "-n", avd_name], check=False, env=env)
 
 
 def main():
@@ -280,13 +307,16 @@ def main():
 
     args = parser.parse_args()
 
-    # Initialize ANDROID_HOME and ARCHITECTURE from config
-    global ANDROID_HOME, ARCHITECTURE
+    # Initialize ANDROID_HOME, AVD_HOME and ARCHITECTURE from config
+    global ANDROID_HOME, AVD_HOME, ARCHITECTURE
     ANDROID_HOME = get_sdk_path_from_config(args.config)
+    AVD_HOME = get_avd_home_from_config(args.config)
     ARCHITECTURE = get_arch_from_config(args.config)
     os.environ["ANDROID_HOME"] = ANDROID_HOME
     os.environ["ANDROID_SDK_ROOT"] = ANDROID_HOME
+    os.environ["ANDROID_AVD_HOME"] = AVD_HOME
     logger.info(f"Using Android SDK: {ANDROID_HOME}")
+    logger.info(f"Using AVD home: {AVD_HOME}")
     logger.info(f"Using architecture: {ARCHITECTURE}")
 
     if args.command == "create-avd":

tests/helpers/test_emulator_helper.py

@@ -13,8 +13,9 @@
 # Import and configure test_emulator_helper module
 import test_emulator_helper
 
-# Set ANDROID_HOME and ARCHITECTURE for all tests
+# Set ANDROID_HOME, AVD_HOME and ARCHITECTURE for all tests
 test_emulator_helper.ANDROID_HOME = "/mock/android-sdk"
+test_emulator_helper.AVD_HOME = "/mock/android-sdk/.android/avd"
 test_emulator_helper.ARCHITECTURE = "arm64-v8a"  # Default for tests
 
 
@@ -24,65 +25,65 @@ class TestEmulatorHelper:
     @pytest.fixture(autouse=True)
     def setup(self):
         """Setup test environment."""
-        # Ensure ANDROID_HOME and ARCHITECTURE are set for all tests
+        # Ensure ANDROID_HOME, AVD_HOME and ARCHITECTURE are set for all tests
         test_emulator_helper.ANDROID_HOME = "/mock/android-sdk"
+        test_emulator_helper.AVD_HOME = "/mock/android-sdk/.android/avd"
         test_emulator_helper.ARCHITECTURE = "arm64-v8a"  # Default for tests
 
     def test_create_avd_with_default_name(self):
         """Test AVD creation with default naming."""
         from test_emulator_helper import create_avd
 
         with patch("subprocess.run") as mock_run:
-            mock_run.return_value = Mock(returncode=0)
+            with patch("pathlib.Path.mkdir"):  # Mock mkdir to avoid filesystem operations
+                mock_run.return_value = Mock(returncode=0)
+
+                create_avd(api_level=30)
 
-            create_avd(api_level=30)
-
-            expected_cmd = [
-                "/mock/android-sdk/cmdline-tools/latest/bin/avdmanager",
-                "create",
-                "avd",
-                "-n",
-                "ovmobilebench_avd_api30",
-                "-k",
-                "system-images;android-30;google_apis;arm64-v8a",
-                "-d",
-                "pixel_5",
-                "--force",
-            ]
-            mock_run.assert_called_once_with(expected_cmd, input="no\n", text=True, check=True)
+                # Check that subprocess.run was called with correct parameters
+                actual_call = mock_run.call_args
+                assert (
+                    actual_call[0][0][0] == "/mock/android-sdk/cmdline-tools/latest/bin/avdmanager"
+                )
+                assert "create" in actual_call[0][0]
+                assert "avd" in actual_call[0][0]
+                assert "ovmobilebench_avd_api30" in actual_call[0][0]
+                assert "system-images;android-30;google_apis;arm64-v8a" in actual_call[0][0]
+                assert actual_call[1]["input"] == "no\n"
+                assert actual_call[1]["check"] is True
 
     def test_create_avd_with_custom_name(self):
         """Test AVD creation with custom name."""
         from test_emulator_helper import create_avd
 
         with patch("subprocess.run") as mock_run:
-            mock_run.return_value = Mock(returncode=0)
-
-            create_avd(api_level=34, avd_name="custom_avd")
-
-            expected_cmd = [
-                "/mock/android-sdk/cmdline-tools/latest/bin/avdmanager",
-                "create",
-                "avd",
-                "-n",
-                "custom_avd",
-                "-k",
-                "system-images;android-34;google_apis;arm64-v8a",
-                "-d",
-                "pixel_5",
-                "--force",
-            ]
-            mock_run.assert_called_once_with(expected_cmd, input="no\n", text=True, check=True)
+            with patch("pathlib.Path.mkdir"):  # Mock mkdir to avoid filesystem operations
+                mock_run.return_value = Mock(returncode=0)
+
+                create_avd(api_level=34, avd_name="custom_avd")
+
+                # Check that subprocess.run was called with correct parameters
+                actual_call = mock_run.call_args
+                assert (
+                    actual_call[0][0][0] == "/mock/android-sdk/cmdline-tools/latest/bin/avdmanager"
+                )
+                assert "create" in actual_call[0][0]
+                assert "avd" in actual_call[0][0]
+                assert "custom_avd" in actual_call[0][0]
+                assert "system-images;android-34;google_apis;arm64-v8a" in actual_call[0][0]
+                assert actual_call[1]["input"] == "no\n"
+                assert actual_call[1]["check"] is True
 
     def test_create_avd_failure(self):
         """Test AVD creation failure handling."""
         from test_emulator_helper import create_avd
 
         with patch("subprocess.run") as mock_run:
-            mock_run.side_effect = subprocess.CalledProcessError(1, "avdmanager")
+            with patch("pathlib.Path.mkdir"):  # Mock mkdir to avoid filesystem operations
+                mock_run.side_effect = subprocess.CalledProcessError(1, "avdmanager")
 
-            with pytest.raises(subprocess.CalledProcessError):
-                create_avd(api_level=30)
+                with pytest.raises(subprocess.CalledProcessError):
+                    create_avd(api_level=30)
 
     @patch("platform.system")
     def test_start_emulator_linux(self, mock_platform):