[release] Bump EnvPool assets to 0.3.0 (#414)

## Description

This bumps EnvPool to 1.2.5 and updates release asset resolution for the
published `envpool-assets==0.3.0` split packages:

- `envpool-assets`
- `envpool-assets-mujoco-large`
- `envpool-assets-mujoco-playground-humanoid`

The registration modules now resolve assets from the owning split asset
package, while keeping the existing local-package /
`ENVPOOL_ASSETS_PATH` fallback path. The release smoke check also
verifies representative files from each split asset wheel.

## Motivation and Context

This fixes missing MuJoCo Playground assets in the 1.2.4 release path,
where installed wheels could register Playground envs but fail at
runtime because the XML assets were not present in `envpool-assets`.

Fixes #413.

- [x] I have raised an issue to propose this change
([required](https://envpool.readthedocs.io/en/latest/pages/contributing.html)
for new features and bug fixes)

## Types of changes

What types of changes does your code introduce? Put an `x` in all the
boxes that apply:

- [x] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds core functionality)
- [ ] New environment (non-breaking change which adds 3rd-party
environment)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] Documentation (update in the documentation)
- [ ] Example (update in the folder of example)

## Implemented Tasks

- [x] Bump EnvPool version to 1.2.5 and require asset wheels
`>=0.3.0,<0.4.0`
- [x] Route base, MyoSuite, and MuJoCo Playground registrations to the
correct split asset packages
- [x] Extend release smoke checks to cover the split asset packages and
a Playground env

## Checklist

Go over all the following points, and put an `x` in all the boxes that
apply.
If you are unsure about any of these, don't hesitate to ask. We are here
to help!

- [x] I have read the
[CONTRIBUTION](https://envpool.readthedocs.io/en/latest/pages/contributing.html)
guide (**required**)
- [ ] My change requires a change to the documentation.
- [x] I have updated the tests accordingly (*required for a bug fix or a
new feature*).
- [ ] I have updated the documentation accordingly.
- [ ] I have reformatted the code using `make format` (**required**)
- [ ] I have checked the code using `make lint` (**required**)
- [ ] I have ensured `make bazel-test` pass. (**required**)

Validation run:

- `python3 -m py_compile envpool/registration.py
envpool/atari/registration.py envpool/gfootball/registration.py
envpool/procgen/registration.py envpool/vizdoom/registration.py
envpool/mujoco/dmc/registration.py envpool/mujoco/gym/registration.py
envpool/mujoco/metaworld/registration.py
envpool/mujoco/myosuite/registration.py
envpool/mujoco/playground/registration.py
envpool/mujoco/robotics/registration.py
scripts/release_installed_wheel_smoke.py`
- `git diff --check origin/main...HEAD`
- `envpool-assets` GitHub Actions run `26133010572` built and published
all three `0.3.0` asset wheels successfully

Author: Trinkle23897

BUILD

@@ -52,6 +52,12 @@ filegroup(
     srcs = [".clang-tidy"],
 )
 
+filegroup(
+    name = "setup_cfg",
+    srcs = ["setup.cfg"],
+    visibility = ["//visibility:public"],
+)
+
 py_binary(
     name = "setup",
     srcs = _SETUP_SRCS,

envpool/BUILD

@@ -81,6 +81,7 @@ py_test(
     name = "make_test",
     timeout = "long",
     srcs = ["make_test.py"],
+    data = ["//:setup_cfg"],
     imports = [".."],
     deps = [
         ":envpool",

envpool/__init__.py

@@ -37,7 +37,7 @@
     register,
 )
 
-__version__ = "1.2.4"
+__version__ = "1.2.5"
 __all__ = [
     "register",
     "make",

envpool/atari/registration.py

@@ -15,9 +15,10 @@
 
 import os
 
-from envpool.registration import base_path, register
+from envpool.registration import asset_base_path, register
 
-atari_rom_path = os.path.join(base_path, "atari", "roms")
+_ATARI_BASE_PATH = asset_base_path("envpool_assets", "atari/roms")
+atari_rom_path = os.path.join(_ATARI_BASE_PATH, "atari", "roms")
 atari_game_list = sorted([
     i.replace(".bin", "") for i in os.listdir(atari_rom_path)
 ])
@@ -32,4 +33,5 @@
         gymnasium_cls="AtariGymnasiumEnvPool",
         task=game,
         max_episode_steps=27000,
+        base_path=_ATARI_BASE_PATH,
     )

envpool/gfootball/registration.py

@@ -13,7 +13,9 @@
 # limitations under the License.
 """Google Research Football env registration."""
 
-from envpool.registration import register
+from envpool.registration import asset_base_path, register
+
+_GFOOTBALL_BASE_PATH = asset_base_path("envpool_assets", "gfootball/assets")
 
 _SCENARIOS = (
     ("11_vs_11_competition", 3000),
@@ -45,4 +47,5 @@
         spec_cls="GfootballEnvSpec",
         dm_cls="GfootballDMEnvPool",
         gymnasium_cls="GfootballGymnasiumEnvPool",
+        base_path=_GFOOTBALL_BASE_PATH,
     )

envpool/make_test.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 """Test for envpool.make."""
 
+import configparser
 import gc
 import os
 import pprint
@@ -22,6 +23,7 @@
 from contextlib import contextmanager
 from pathlib import Path
 from typing import Callable, get_type_hints
+from unittest import mock
 
 import dm_env
 import gymnasium
@@ -60,6 +62,32 @@
     "img_height": 240,
 }
 
+_FAMILY_SMOKE_TASKS: dict[str, tuple[str, ...]] = {
+    "envpool.atari": ("Defender-v5",),
+    "envpool.box2d": ("LunarLander-v3",),
+    "envpool.classic_control": ("CartPole-v1",),
+    "envpool.gfootball": ("gfootball/academy_empty_goal_close-v1",),
+    "envpool.highway": ("HighwayFast-v0",),
+    "envpool.jumanji": ("Game2048-v1",),
+    "envpool.minigrid": ("MiniGrid-DoorKey-8x8-v0",),
+    "envpool.mujoco.dmc": ("WalkerWalk-v1",),
+    "envpool.mujoco.gym": ("Ant-v5",),
+    "envpool.mujoco.metaworld": ("MetaWorld/Reach-v3",),
+    "envpool.mujoco.playground": (
+        "Go1JoystickFlatTerrain-v1",
+        "G1JoystickFlatTerrain-v1",
+    ),
+    "envpool.mujoco.robotics": ("FetchReach-v4",),
+    "envpool.pgx": ("TicTacToe-v1",),
+    "envpool.procgen": ("CoinrunEasy-v0",),
+    "envpool.toy_text": ("Catch-v0",),
+    "envpool.vizdoom": ("MyWayHome-v1",),
+}
+
+_DYNAMIC_FAMILY_SMOKE_PREFIXES: dict[str, str] = {
+    "envpool.mujoco.myosuite": "MyoSuite/",
+}
+
 
 @contextmanager
 def _temporary_workdir(prefix: str) -> Iterator[str]:
@@ -89,6 +117,23 @@ def _stable_render_kwargs(task_id: str, **kwargs: object) -> dict[str, object]:
 
 
 class _MakeTest(absltest.TestCase):
+    def _family_smoke_tasks(self) -> dict[str, tuple[str, ...]]:
+        from envpool.registration import registry
+
+        tasks = dict(_FAMILY_SMOKE_TASKS)
+        for import_path, prefix in _DYNAMIC_FAMILY_SMOKE_PREFIXES.items():
+            candidates = sorted(
+                task_id
+                for task_id, (registered_import_path, _, _) in (
+                    registry.specs.items()
+                )
+                if registered_import_path == import_path
+                and task_id.startswith(prefix)
+            )
+            self.assertNotEmpty(candidates, import_path)
+            tasks[import_path] = (candidates[0],)
+        return tasks
+
     def check_render_unsupported(self, task_id: str, **kwargs: object) -> None:
         for factory in (envpool.make_gym, envpool.make_gymnasium):
             with self.assertRaisesRegex(RuntimeError, "render not implemented"):
@@ -131,7 +176,19 @@ def render_once(factory: _RenderFactory) -> None:
             raise
 
     def test_version(self) -> None:
-        print(envpool.__version__)
+        config = configparser.ConfigParser()
+        self.assertTrue(config.read(Path(__file__).parents[1] / "setup.cfg"))
+        self.assertEqual(config["metadata"]["version"], envpool.__version__)
+
+    def test_asset_base_path_env_override(self) -> None:
+        from envpool.registration import asset_base_path
+
+        with tempfile.TemporaryDirectory() as tmpdir:
+            with mock.patch.dict(os.environ, {"ENVPOOL_ASSETS_PATH": tmpdir}):
+                self.assertEqual(
+                    asset_base_path("envpool_assets", "atari/roms"),
+                    os.path.abspath(tmpdir),
+                )
 
     def test_public_typing_interface(self) -> None:
         self.assertTrue(Path(envpool.__file__).with_name("py.typed").is_file())
@@ -162,6 +219,26 @@ def test_public_typing_interface(self) -> None:
     def test_list_all_envs(self) -> None:
         pprint.pprint(envpool.list_all_envs())
 
+    def test_make_registered_env_families(self) -> None:
+        from envpool.registration import registry
+
+        registered_import_paths = {
+            import_path for import_path, _, _ in registry.specs.values()
+        }
+        smoke_tasks = self._family_smoke_tasks()
+        self.assertEmpty(registered_import_paths - smoke_tasks.keys())
+        self.assertEmpty(smoke_tasks.keys() - registered_import_paths)
+        missing_task_ids = [
+            task_id
+            for task_ids in smoke_tasks.values()
+            for task_id in task_ids
+            if task_id not in registry.specs
+        ]
+        self.assertEmpty(missing_task_ids)
+        for import_path, task_ids in smoke_tasks.items():
+            with self.subTest(import_path=import_path):
+                self.check_step(list(task_ids))
+
     def test_make_atari(self) -> None:
         self.assertRaises(TypeError, envpool.make, "Pong-v5")
         spec = envpool.make_spec("Defender-v5")
@@ -419,6 +496,11 @@ def test_make_mujoco_dmc(self) -> None:
             "WalkerWalk-v1",
         ])
 
+    def test_make_mujoco_playground(self) -> None:
+        self.check_step([
+            "Go1JoystickFlatTerrain-v1",
+        ])
+
     def test_render_smoke(self) -> None:
         self.check_render("CartPole-v1")
         self.check_render("LunarLander-v3")

envpool/mujoco/dmc/registration.py

@@ -13,7 +13,9 @@
 # limitations under the License.
 """Mujoco dm_control suite env registration."""
 
-from envpool.registration import register
+from envpool.registration import asset_base_path, register
+
+_DMC_BASE_PATH = asset_base_path("envpool_assets", "mujoco/assets_dmc")
 
 # from suite.BENCHMARKING
 dmc_mujoco_envs = [
@@ -81,4 +83,5 @@
         gymnasium_cls=f"Dmc{domain_name}GymnasiumEnvPool",
         task_name=task,
         max_episode_steps=max_episode_steps,
+        base_path=_DMC_BASE_PATH,
     )

envpool/mujoco/gym/registration.py

@@ -15,7 +15,9 @@
 
 from typing import Any
 
-from envpool.registration import register
+from envpool.registration import asset_base_path, register
+
+_GYM_BASE_PATH = asset_base_path("envpool_assets", "mujoco/assets_gym")
 
 gym_mujoco_envs = [
     ("Ant", ("v3", "v4", "v5"), 1000),
@@ -89,5 +91,6 @@
             gymnasium_cls=f"Gym{task}GymnasiumEnvPool",
             post_constraint=(version == "v5"),
             max_episode_steps=max_episode_steps,
+            base_path=_GYM_BASE_PATH,
             **extra_args,
         )

envpool/mujoco/metaworld/registration.py

@@ -13,7 +13,11 @@
 # limitations under the License.
 """MetaWorld v3 Sawyer env registration."""
 
-from envpool.registration import register
+from envpool.registration import asset_base_path, register
+
+_METAWORLD_BASE_PATH = asset_base_path(
+    "envpool_assets", "mujoco/metaworld/assets"
+)
 
 
 def metaworld_public_task_name(task_name: str) -> str:
@@ -96,4 +100,5 @@ def metaworld_task_id(task_name: str) -> str:
         gymnasium_cls="MetaWorldGymnasiumEnvPool",
         task_name=task_name,
         max_episode_steps=500,
+        base_path=_METAWORLD_BASE_PATH,
     )

envpool/mujoco/myosuite/registration.py

@@ -13,21 +13,16 @@
 # limitations under the License.
 """MyoSuite v2.11.6 env registration."""
 
-import os
-
-from envpool.registration import base_path, package_base_path, register
+from envpool.registration import asset_base_path, register
 
 from .tasks import MYOSUITE_TASKS
 
 myosuite_task_ids = [str(task["id"]) for task in MYOSUITE_TASKS]
 myosuite_envpool_task_ids = [
     f"MyoSuite/{task_id}" for task_id in myosuite_task_ids
 ]
-_myosuite_package_assets = os.path.join(
-    package_base_path, "mujoco/myosuite/assets"
-)
-_myosuite_base_path = (
-    package_base_path if os.path.exists(_myosuite_package_assets) else base_path
+_MYOSUITE_BASE_PATH = asset_base_path(
+    "envpool_assets_mujoco_large", "mujoco/myosuite/assets"
 )
 
 for task in MYOSUITE_TASKS:
@@ -41,5 +36,5 @@
         gymnasium_cls="MyoSuiteGymnasiumEnvPool",
         task_name=task_id,
         max_episode_steps=task["max_episode_steps"],
-        base_path=_myosuite_base_path,
+        base_path=_MYOSUITE_BASE_PATH,
     )