Jail Animation controller Test Plan - UQcsse3200/2023-studio-2 GitHub Wiki

Overview

This wiki page provides documentation for the JailAnimationController class, an essential component responsible for managing animations for a jail entity in the game. This page includes details about the class, its responsibilities, and associated unit tests to ensure its correct functionality.

Introduction

The JailAnimationController class is a vital component of the game responsible for managing animations associated with a jail entity. It ensures that animations related to the jail entity are displayed correctly and updated as required during gameplay.

Class Overview

The JailAnimationController class is an integral part of the game's component system. It collaborates with other components and systems to render animations for the jail entity. Here's an overview of its key components:

  • AssetManager (Dependency): Responsible for loading game assets, including the texture atlas required for animations.
  • AnimationRenderComponent (Dependency): Manages and renders animations.
  • TextureAtlas (Dependency): Represents the texture atlas containing animation frames.

Initialization

Before running the unit tests, the JailAnimationController class is set up as follows:

  • Mock objects for AssetManager, AnimationRenderComponent, and TextureAtlas are created to isolate the class for testing.
  • The create method is called to initialize the animation controller.
  • The entity property is mocked to simulate the presence of the jail entity.

Unit Tests

The unit tests for the JailAnimationController class focus on ensuring that the class functions correctly in managing animations for the jail entity. The following test cases validate key methods:

Test Case 1: create Method

Objective: Verify that the create method correctly initializes the animation controller and triggers the initial animation.

Test Steps:

  1. Call the create method of the JailAnimationController.
  2. Verify that the startAnimation method of the mock AnimationRenderComponent is called with the expected animation key ("jail_close").
  3. Verify that the AssetManager is called to load the jail entity's texture atlas.
  4. Verify that the AssetManager is called to finish loading.

Test Case 2: update Method

Objective: Ensure that the update method of the JailAnimationController correctly updates the animation state based on the animation duration and the current animation.

Test Steps:

  1. Set the animationDuration property of the controller to a specific value (e.g., 10f).
  2. Mock the getCurrentAnimation method of the AnimationRenderComponent to return a specific animation key (e.g., "jail_close").
  3. Call the update method of the JailAnimationController.
  4. Verify that the AnimationRenderComponent updates the animation state accordingly based on the specified animation key and duration.

Conclusion

The JailAnimationController class plays a crucial role in managing animations for the jail entity in the game. Through unit testing, we have validated its functionality, including initialization and animation updates. These tests ensure that the animation controller functions correctly and contributes to the overall gameplay experience.

Contributors