atest

Documentation

Overview

Package atest provides functionality for running automated tests, that require the Amphion engine to be running. During the test the frontend is not run. So, no UI is rendered, and you can only simulate frontend callbacks (like click).

Index

• func MakeTestScene(delegate TestingDelegate) (*engine.SceneObject, *engine.SceneObject)
• func RunEngineTest(t *testing.T, delegate TestingDelegate)
• func RunEngineTestWithScene(t *testing.T, prepareDelegate, testingDelegate SceneTestingDelegate)
• func SimulateCallback(code int, data string)
• func SimulateClick(x, y int, button engine.MouseButton)
• func SimulateClickOnObject(o *engine.SceneObject, button engine.MouseButton)
• func Stop()
• func WaitForStop()
• type Frontend
  • func (f *Frontend) CommencePanic(reason, msg string)
  • func (f *Frontend) Execute(item dispatch.WorkItem)
  • func (f *Frontend) GetApp() *frontend.App
  • func (f *Frontend) GetContext() frontend.Context
  • func (f *Frontend) GetLaunchArgs() a.SiMap
  • func (f *Frontend) GetMessageDispatcher() dispatch.MessageDispatcher
  • func (f *Frontend) GetPlatform() common.Platform
  • func (f *Frontend) GetRenderer() *rendering.ARenderer
  • func (f *Frontend) GetResourceManager() frontend.ResourceManager
  • func (f *Frontend) GetWorkDispatcher() dispatch.WorkDispatcher
  • func (f *Frontend) Init()
  • func (f *Frontend) Run()
  • func (f *Frontend) SendMessage(message *dispatch.Message)
  • func (f *Frontend) SetEngineDispatcher(disp dispatch.MessageDispatcher)
• type RendererDelegate
  • func (r *RendererDelegate) OnClear()
  • func (r *RendererDelegate) OnCreatePrimitiveRenderingContext(ctx *rendering.PrimitiveRenderingContext)
  • func (r *RendererDelegate) OnPerformRenderingEnd()
  • func (r *RendererDelegate) OnPerformRenderingStart()
  • func (r *RendererDelegate) OnPrepare()
  • func (r *RendererDelegate) OnStop()
• type ResourceManager
  • func (r *ResourceManager) FullPathOf(id a.ResId) string
  • func (r *ResourceManager) IdOf(path string) a.ResId
  • func (r *ResourceManager) PathOf(id a.ResId) string
  • func (r *ResourceManager) ReadFile(id a.ResId) ([]byte, error)
  • func (r *ResourceManager) RegisterResource(path string)
• type SceneTestingDelegate
• type TestingComponent
  • func NewTestingComponent(testingDelegate TestingDelegate) *TestingComponent
  • func (t *TestingComponent) OnStart()
• type TestingDelegate

Functions

func MakeTestScene

func MakeTestScene(delegate TestingDelegate) (*engine.SceneObject, *engine.SceneObject)

MakeTestScene creates the default testing scene, that contains only one child object of size (100; 100; 100) located in the center with the TestingComponent attached to it.

func RunEngineTest

func RunEngineTest(t *testing.T, delegate TestingDelegate)

RunEngineTest starts the Amphion engine and the calls the specified delegate.

func RunEngineTestWithScene

func RunEngineTestWithScene(t *testing.T, prepareDelegate, testingDelegate SceneTestingDelegate)

RunEngineTestWithScene first starts the Amphion engine. It then creates the default testing scene (See MakeTestScene). The prepareDelegate is called before the scene is shown. Here you can perform some setup like adding new objects and components to the scene. The testingDelegate is where you actually call the tested code.

func SimulateCallback

func SimulateCallback(code int, data string)

SimulateCallback simulates a frontend callback with the specified code and data.

func SimulateClick

func SimulateClick(x, y int, button engine.MouseButton)

SimulateClick simulates user's click at the specified position on the screen.

func SimulateClickOnObject

func SimulateClickOnObject(o *engine.SceneObject, button engine.MouseButton)

SimulateClickOnObject simulates user's click in the center of the specified object.

func Stop

func Stop()

Stop stops the testing instance of Amphion engine.

func WaitForStop

func WaitForStop()

WaitForStop blocks the calling goroutine until the engine is stopped.

Types

type Frontend

type Frontend struct {
	// contains filtered or unexported fields
}

Frontend the testing frontend.

func (*Frontend) CommencePanic

func (f *Frontend) CommencePanic(reason, msg string)

func (*Frontend) Execute

func (f *Frontend) Execute(item dispatch.WorkItem)

func (*Frontend) GetApp

func (f *Frontend) GetApp() *frontend.App

func (*Frontend) GetContext

func (f *Frontend) GetContext() frontend.Context

func (*Frontend) GetLaunchArgs

func (f *Frontend) GetLaunchArgs() a.SiMap

func (*Frontend) GetMessageDispatcher

func (f *Frontend) GetMessageDispatcher() dispatch.MessageDispatcher

func (*Frontend) GetPlatform

func (f *Frontend) GetPlatform() common.Platform

func (*Frontend) GetRenderer

func (f *Frontend) GetRenderer() *rendering.ARenderer

func (*Frontend) GetResourceManager

func (f *Frontend) GetResourceManager() frontend.ResourceManager

func (*Frontend) GetWorkDispatcher

func (f *Frontend) GetWorkDispatcher() dispatch.WorkDispatcher

func (*Frontend) Init

func (f *Frontend) Init()

func (*Frontend) Run

func (f *Frontend) Run()

func (*Frontend) SendMessage

func (f *Frontend) SendMessage(message *dispatch.Message)

func (*Frontend) SetEngineDispatcher

func (f *Frontend) SetEngineDispatcher(disp dispatch.MessageDispatcher)

type RendererDelegate

type RendererDelegate struct {
}

func (*RendererDelegate) OnClear

func (r *RendererDelegate) OnClear()

func (*RendererDelegate) OnCreatePrimitiveRenderingContext

func (r *RendererDelegate) OnCreatePrimitiveRenderingContext(ctx *rendering.PrimitiveRenderingContext)

func (*RendererDelegate) OnPerformRenderingEnd

func (r *RendererDelegate) OnPerformRenderingEnd()

func (*RendererDelegate) OnPerformRenderingStart

func (r *RendererDelegate) OnPerformRenderingStart()

func (*RendererDelegate) OnPrepare

func (r *RendererDelegate) OnPrepare()

func (*RendererDelegate) OnStop

func (r *RendererDelegate) OnStop()

type ResourceManager

type ResourceManager struct {
	// contains filtered or unexported fields
}

func (*ResourceManager) FullPathOf

func (r *ResourceManager) FullPathOf(id a.ResId) string

func (*ResourceManager) IdOf

func (r *ResourceManager) IdOf(path string) a.ResId

func (*ResourceManager) PathOf

func (r *ResourceManager) PathOf(id a.ResId) string

func (*ResourceManager) ReadFile

func (r *ResourceManager) ReadFile(id a.ResId) ([]byte, error)

func (*ResourceManager) RegisterResource

func (r *ResourceManager) RegisterResource(path string)

type SceneTestingDelegate

type SceneTestingDelegate func(e *engine.AmphionEngine, testScene, testObject *engine.SceneObject)

type TestingComponent

type TestingComponent struct {
	engine.ComponentImpl
	// contains filtered or unexported fields
}

TestingComponent is a component for running testing code in scene. It calls the specified delegate in OnStart method.

func NewTestingComponent

func NewTestingComponent(testingDelegate TestingDelegate) *TestingComponent

func (*TestingComponent) OnStart

func (t *TestingComponent) OnStart()

type TestingDelegate

type TestingDelegate func(e *engine.AmphionEngine)