2021-06-25 04:02:19 +00:00
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.
using System ;
using NUnit.Framework ;
using osu.Framework.Allocation ;
using osu.Framework.Bindables ;
using osu.Framework.Graphics ;
using osu.Framework.Graphics.Containers ;
2021-10-27 05:49:50 +00:00
using osu.Game.Online.API ;
2021-06-25 04:02:19 +00:00
using osu.Game.Online.Rooms ;
using osu.Game.Screens.OnlinePlay ;
namespace osu.Game.Tests.Visual.OnlinePlay
{
/// <summary>
2021-06-25 09:07:47 +00:00
/// A base test scene for all online play components and screens.
2021-06-25 04:02:19 +00:00
/// </summary>
2021-06-25 11:15:30 +00:00
public abstract class OnlinePlayTestScene : ScreenTestScene , IOnlinePlayTestSceneDependencies
2021-06-25 04:02:19 +00:00
{
2021-06-25 09:07:47 +00:00
public Bindable < Room > SelectedRoom = > OnlinePlayDependencies ? . SelectedRoom ;
public IRoomManager RoomManager = > OnlinePlayDependencies ? . RoomManager ;
public OngoingOperationTracker OngoingOperationTracker = > OnlinePlayDependencies ? . OngoingOperationTracker ;
public OnlinePlayBeatmapAvailabilityTracker AvailabilityTracker = > OnlinePlayDependencies ? . AvailabilityTracker ;
2021-06-25 04:02:19 +00:00
2021-06-25 09:07:47 +00:00
/// <summary>
/// All dependencies required for online play components and screens.
/// </summary>
2021-06-25 11:11:38 +00:00
protected OnlinePlayTestSceneDependencies OnlinePlayDependencies = > dependencies ? . OnlinePlayDependencies ;
2021-06-25 09:07:47 +00:00
2021-06-25 04:02:19 +00:00
protected override Container < Drawable > Content = > content ;
2021-10-27 05:49:50 +00:00
[Resolved]
private OsuGameBase game { get ; set ; }
2021-06-25 04:02:19 +00:00
private readonly Container content ;
private readonly Container drawableDependenciesContainer ;
2021-10-27 05:49:50 +00:00
private DelegatedDependencyContainer dependencies ;
private TestRoomRequestsHandler requestsHandler ;
2021-06-25 04:02:19 +00:00
protected OnlinePlayTestScene ( )
{
base . Content . AddRange ( new Drawable [ ]
{
drawableDependenciesContainer = new Container { RelativeSizeAxes = Axes . Both } ,
content = new Container { RelativeSizeAxes = Axes . Both } ,
} ) ;
}
protected override IReadOnlyDependencyContainer CreateChildDependencies ( IReadOnlyDependencyContainer parent )
{
2021-06-25 09:07:47 +00:00
dependencies = new DelegatedDependencyContainer ( base . CreateChildDependencies ( parent ) ) ;
return dependencies ;
2021-06-25 04:02:19 +00:00
}
[SetUp]
public void Setup ( ) = > Schedule ( ( ) = >
{
// Reset the room dependencies to a fresh state.
drawableDependenciesContainer . Clear ( ) ;
2021-06-25 09:07:47 +00:00
dependencies . OnlinePlayDependencies = CreateOnlinePlayDependencies ( ) ;
drawableDependenciesContainer . AddRange ( OnlinePlayDependencies . DrawableComponents ) ;
2021-06-25 04:02:19 +00:00
} ) ;
2021-10-27 05:49:50 +00:00
public override void SetUpSteps ( )
{
base . SetUpSteps ( ) ;
AddStep ( "setup API" , ( ) = >
{
requestsHandler = new TestRoomRequestsHandler ( ) ;
( ( DummyAPIAccess ) API ) . HandleRequest = request = > requestsHandler . HandleRequest ( request , API . LocalUser . Value , game ) ;
} ) ;
}
2021-06-25 04:02:19 +00:00
/// <summary>
/// Creates the room dependencies. Called every <see cref="Setup"/>.
/// </summary>
/// <remarks>
2021-06-25 09:07:47 +00:00
/// Any custom dependencies required for online play sub-classes should be added here.
2021-06-25 04:02:19 +00:00
/// </remarks>
2021-06-25 11:11:38 +00:00
protected virtual OnlinePlayTestSceneDependencies CreateOnlinePlayDependencies ( ) = > new OnlinePlayTestSceneDependencies ( ) ;
2021-06-25 04:02:19 +00:00
/// <summary>
2021-06-25 09:07:47 +00:00
/// A <see cref="IReadOnlyDependencyContainer"/> providing a mutable lookup source for online play dependencies.
2021-06-25 04:02:19 +00:00
/// </summary>
2021-06-25 09:07:47 +00:00
private class DelegatedDependencyContainer : IReadOnlyDependencyContainer
2021-06-25 04:02:19 +00:00
{
/// <summary>
2021-06-25 09:07:47 +00:00
/// The online play dependencies.
2021-06-25 04:02:19 +00:00
/// </summary>
2021-06-25 11:11:38 +00:00
public OnlinePlayTestSceneDependencies OnlinePlayDependencies { get ; set ; }
2021-06-25 04:02:19 +00:00
private readonly IReadOnlyDependencyContainer parent ;
private readonly DependencyContainer injectableDependencies ;
/// <summary>
2021-06-25 09:07:47 +00:00
/// Creates a new <see cref="DelegatedDependencyContainer"/>.
2021-06-25 04:02:19 +00:00
/// </summary>
2021-06-25 09:07:47 +00:00
/// <param name="parent">The fallback <see cref="IReadOnlyDependencyContainer"/> to use when <see cref="OnlinePlayDependencies"/> cannot satisfy a dependency.</param>
public DelegatedDependencyContainer ( IReadOnlyDependencyContainer parent )
2021-06-25 04:02:19 +00:00
{
this . parent = parent ;
injectableDependencies = new DependencyContainer ( this ) ;
}
public object Get ( Type type )
2021-06-25 09:07:47 +00:00
= > OnlinePlayDependencies ? . Get ( type ) ? ? parent . Get ( type ) ;
2021-06-25 04:02:19 +00:00
public object Get ( Type type , CacheInfo info )
2021-06-25 09:07:47 +00:00
= > OnlinePlayDependencies ? . Get ( type , info ) ? ? parent . Get ( type , info ) ;
2021-06-25 04:02:19 +00:00
public void Inject < T > ( T instance )
where T : class
= > injectableDependencies . Inject ( instance ) ;
}
}
}