Gymnasium/tests/wrappers/test_record_video.py

import os
import shutil

import gymnasium
from gymnasium.wrappers import capped_cubic_video_schedule


def test_record_video_using_default_trigger():
    env = gymnasium.make(
        "CartPole-v1", render_mode="rgb_array_list", disable_env_checker=True
    )
    env = gymnasium.wrappers.RecordVideo(env, "videos")
    env.reset()
    for _ in range(199):
        action = env.action_space.sample()
        _, _, terminated, truncated, _ = env.step(action)
        if terminated or truncated:
            env.reset()
    env.close()
    assert os.path.isdir("videos")
    mp4_files = [file for file in os.listdir("videos") if file.endswith(".mp4")]
    assert len(mp4_files) == sum(
        capped_cubic_video_schedule(i) for i in range(env.episode_id + 1)
    )
    shutil.rmtree("videos")


def test_record_video_reset():
    env = gymnasium.make(
        "CartPole-v1", render_mode="rgb_array", disable_env_checker=True
    )
    env = gymnasium.wrappers.RecordVideo(
        env, "videos", step_trigger=lambda x: x % 100 == 0
    )
    ob_space = env.observation_space
    obs, info = env.reset()
    env.close()
    assert os.path.isdir("videos")
    shutil.rmtree("videos")
    assert ob_space.contains(obs)
    assert isinstance(info, dict)


def test_record_video_step_trigger():
    env = gymnasium.make(
        "CartPole-v1", render_mode="rgb_array", disable_env_checker=True
    )
    env._max_episode_steps = 20
    env = gymnasium.wrappers.RecordVideo(
        env, "videos", step_trigger=lambda x: x % 100 == 0
    )
    env.reset()
    for _ in range(199):
        action = env.action_space.sample()
        _, _, terminated, truncated, _ = env.step(action)
        if terminated or truncated:
            env.reset()
    env.close()
    assert os.path.isdir("videos")
    mp4_files = [file for file in os.listdir("videos") if file.endswith(".mp4")]
    assert len(mp4_files) == 2
    shutil.rmtree("videos")


def make_env(gym_id, seed, **kwargs):
    def thunk():
        env = gymnasium.make(gym_id, disable_env_checker=True, **kwargs)
        env._max_episode_steps = 20
        if seed == 1:
            env = gymnasium.wrappers.RecordVideo(
                env, "videos", step_trigger=lambda x: x % 100 == 0
            )
        return env

    return thunk


def test_record_video_within_vector():
    envs = gymnasium.vector.SyncVectorEnv(
        [make_env("CartPole-v1", 1 + i, render_mode="rgb_array") for i in range(2)]
    )
    envs = gymnasium.wrappers.RecordEpisodeStatistics(envs)
    envs.reset()
    for i in range(199):
        _, _, _, _, infos = envs.step(envs.action_space.sample())

        # break when every env is done
        if "episode" in infos and all(infos["_episode"]):
            print(f"episode_reward={infos['episode']['r']}")

    assert os.path.isdir("videos")
    mp4_files = [file for file in os.listdir("videos") if file.endswith(".mp4")]
    assert len(mp4_files) == 2
    shutil.rmtree("videos")