Merge pull request #35 from peppy/visual-test-framework

Add basic implementation of VisualTest framework for osu! project.
2025-01-12 15:22:55 +08:00 · 2016-09-24 20:44:37 +09:00 · 2016-09-24 20:44:37 +09:00 · 8a168f2d29
commit 8a168f2d29
parent 75b430515b 32b67023f3
10 changed files with 338 additions and 53 deletions
--- a/osu.Desktop.VisualTests/Program.cs
+++ b/osu.Desktop.VisualTests/Program.cs
@ -0,0 +1,20 @@
+// Copyright (c) 2007-2016 ppy Pty Ltd <contact@ppy.sh>.
+// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu-framework/master/LICENCE
+
+using System;
+using osu.Framework.Desktop;
+using osu.Framework.OS;
+
+namespace osu.Framework.VisualTests
+{
+    public static class Program
+    {
+        [STAThread]
+        public static void Main(string[] args)
+        {
+            BasicGameHost host = Host.GetSuitableHost();
+            host.Load(new VisualTestGame());
+            host.Run();
+        }
+    }
+}
--- a/osu.Desktop.VisualTests/Tests/TestCaseTextAwesome.cs
+++ b/osu.Desktop.VisualTests/Tests/TestCaseTextAwesome.cs
@ -0,0 +1,54 @@
+using OpenTK;
+using OpenTK.Graphics;
+using osu.Framework.GameModes.Testing;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.MathUtils;
+using osu.Game.Graphics;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace osu.Desktop.Tests
+{
+    class TestCaseTextAwesome : TestCase
+    {
+        public override string Name => @"TextAwesome";
+
+        public override string Description => @"Tests display of icons";
+
+        public override void Reset()
+        {
+            base.Reset();
+
+            FlowContainer flow;
+
+            Add(flow = new FlowContainer()
+            {
+                SizeMode = InheritMode.XY,
+                Size = new Vector2(0.5f),
+                Anchor = Anchor.Centre,
+                Origin = Anchor.Centre
+            });
+
+            int i = 50;
+            foreach (FontAwesome fa in Enum.GetValues(typeof(FontAwesome)))
+            {
+                flow.Add(new TextAwesome
+                {
+                    Icon = fa,
+                    TextSize = 60,
+                    Colour = new Color4(
+                        Math.Max(0.5f, RNG.NextSingle()),
+                        Math.Max(0.5f, RNG.NextSingle()),
+                        Math.Max(0.5f, RNG.NextSingle()),
+                        1)
+                });
+
+                if (i-- == 0) break;
+            }
+        }
+    }
+}
--- a/osu.Desktop.VisualTests/VisualTestGame.cs
+++ b/osu.Desktop.VisualTests/VisualTestGame.cs
@ -0,0 +1,21 @@
+// Copyright (c) 2007-2016 ppy Pty Ltd <contact@ppy.sh>.
+// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu-framework/master/LICENCE
+
+using osu.Framework.GameModes.Testing;
+using osu.Framework.Graphics.Cursor;
+using osu.Game;
+
+namespace osu.Framework.VisualTests
+{
+    class VisualTestGame : OsuGameBase
+    {
+        public override void Load()
+        {
+            base.Load();
+
+            Add(new TestBrowser());
+
+            ShowPerformanceOverlay = true;
+        }
+    }
+}
--- a/osu.Desktop.VisualTests/osu.Desktop.VisualTests.csproj
+++ b/osu.Desktop.VisualTests/osu.Desktop.VisualTests.csproj
@ -0,0 +1,174 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="4.0">
+  <PropertyGroup>
+    <ProjectGuid>{69051C69-12AE-4E7D-A3E6-460D2E282312}</ProjectGuid>
+    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
+    <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
+    <OutputType>WinExe</OutputType>
+    <AppDesignerFolder>Properties</AppDesignerFolder>
+    <RootNamespace>osu.Desktop</RootNamespace>
+    <AssemblyName>osu!</AssemblyName>
+    <ManifestCertificateThumbprint>3CF060CD28877D0E3112948951A64B2A7CEEC909</ManifestCertificateThumbprint>
+    <ManifestKeyFile>codesigning.pfx</ManifestKeyFile>
+    <GenerateManifests>false</GenerateManifests>
+    <SignManifests>false</SignManifests>
+    <IsWebBootstrapper>false</IsWebBootstrapper>
+    <FileUpgradeFlags>
+    </FileUpgradeFlags>
+    <OldToolsVersion>3.5</OldToolsVersion>
+    <UpgradeBackupLocation>
+    </UpgradeBackupLocation>
+    <StartupObject>osu.Framework.VisualTests.Program</StartupObject>
+    <RunPostBuildEvent>OnOutputUpdated</RunPostBuildEvent>
+    <SignAssembly>false</SignAssembly>
+    <TargetZone>LocalIntranet</TargetZone>
+    <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
+    <PublishUrl>publish\</PublishUrl>
+    <Install>true</Install>
+    <InstallFrom>Disk</InstallFrom>
+    <UpdateEnabled>false</UpdateEnabled>
+    <UpdateMode>Foreground</UpdateMode>
+    <UpdateInterval>7</UpdateInterval>
+    <UpdateIntervalUnits>Days</UpdateIntervalUnits>
+    <UpdatePeriodically>false</UpdatePeriodically>
+    <UpdateRequired>false</UpdateRequired>
+    <MapFileExtensions>true</MapFileExtensions>
+    <ApplicationRevision>2</ApplicationRevision>
+    <ApplicationVersion>1.0.0.%2a</ApplicationVersion>
+    <UseApplicationTrust>false</UseApplicationTrust>
+    <BootstrapperEnabled>true</BootstrapperEnabled>
+    <ProductVersion>12.0.0</ProductVersion>
+    <SchemaVersion>2.0</SchemaVersion>
+    <TargetFrameworkProfile>
+    </TargetFrameworkProfile>
+    <NuGetPackageImportStamp>
+    </NuGetPackageImportStamp>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
+    <DebugSymbols>true</DebugSymbols>
+    <DebugType>full</DebugType>
+    <Optimize>false</Optimize>
+    <OutputPath>bin\Debug\</OutputPath>
+    <DefineConstants>DEBUG</DefineConstants>
+    <ErrorReport>prompt</ErrorReport>
+    <WarningLevel>0</WarningLevel>
+    <NoStdLib>true</NoStdLib>
+    <UseVSHostingProcess>false</UseVSHostingProcess>
+    <PlatformTarget>AnyCPU</PlatformTarget>
+    <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+    <CodeAnalysisRuleSet>AllRules.ruleset</CodeAnalysisRuleSet>
+    <RunCodeAnalysis>false</RunCodeAnalysis>
+    <Prefer32Bit>true</Prefer32Bit>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
+    <DebugType>none</DebugType>
+    <Optimize>true</Optimize>
+    <OutputPath>bin\Release\</OutputPath>
+    <DefineConstants>CuttingEdge NoUpdate</DefineConstants>
+    <ErrorReport>prompt</ErrorReport>
+    <WarningLevel>4</WarningLevel>
+    <NoStdLib>true</NoStdLib>
+    <UseVSHostingProcess>false</UseVSHostingProcess>
+    <PlatformTarget>AnyCPU</PlatformTarget>
+    <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+    <CodeAnalysisRuleSet>AllRules.ruleset</CodeAnalysisRuleSet>
+    <Prefer32Bit>false</Prefer32Bit>
+  </PropertyGroup>
+  <PropertyGroup>
+    <Win32Resource>
+    </Win32Resource>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Deploy|AnyCPU'">
+    <OutputPath>bin\Deploy\</OutputPath>
+    <DefineConstants>CuttingEdge</DefineConstants>
+    <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+    <Optimize>true</Optimize>
+    <NoStdLib>true</NoStdLib>
+    <PlatformTarget>AnyCPU</PlatformTarget>
+    <UseVSHostingProcess>false</UseVSHostingProcess>
+    <ErrorReport>prompt</ErrorReport>
+    <CodeAnalysisRuleSet>AllRules.ruleset</CodeAnalysisRuleSet>
+    <Prefer32Bit>false</Prefer32Bit>
+  </PropertyGroup>
+  <ItemGroup>
+    <Reference Include="mscorlib" />
+    <Reference Include="OpenTK, Version=1.2.0.0, Culture=neutral, PublicKeyToken=bad199fe84eb3df4" />
+    <Reference Include="System" />
+  </ItemGroup>
+  <ItemGroup>
+    <None Include="..\osu.licenseheader">
+      <Link>osu.licenseheader</Link>
+    </None>
+  </ItemGroup>
+  <ItemGroup>
+    <BootstrapperPackage Include="Microsoft.Net.Client.3.5">
+      <Visible>False</Visible>
+      <ProductName>.NET Framework 3.5 SP1 Client Profile</ProductName>
+      <Install>false</Install>
+    </BootstrapperPackage>
+    <BootstrapperPackage Include="Microsoft.Net.Framework.2.0">
+      <Visible>False</Visible>
+      <ProductName>.NET Framework 2.0 %28x86%29</ProductName>
+      <Install>true</Install>
+    </BootstrapperPackage>
+    <BootstrapperPackage Include="Microsoft.Net.Framework.3.0">
+      <Visible>False</Visible>
+      <ProductName>.NET Framework 3.0 %28x86%29</ProductName>
+      <Install>false</Install>
+    </BootstrapperPackage>
+    <BootstrapperPackage Include="Microsoft.Net.Framework.3.5">
+      <Visible>False</Visible>
+      <ProductName>.NET Framework 3.5</ProductName>
+      <Install>false</Install>
+    </BootstrapperPackage>
+    <BootstrapperPackage Include="Microsoft.Net.Framework.3.5.SP1">
+      <Visible>False</Visible>
+      <ProductName>.NET Framework 3.5 SP1</ProductName>
+      <Install>false</Install>
+    </BootstrapperPackage>
+  </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\osu-framework\osu.Framework.Desktop\osu.Framework.Desktop.csproj">
+      <Project>{65dc628f-a640-4111-ab35-3a5652bc1e17}</Project>
+      <Name>osu.Framework.Desktop</Name>
+    </ProjectReference>
+    <ProjectReference Include="..\osu-framework\osu.Framework\osu.Framework.csproj">
+      <Project>{c76bf5b3-985e-4d39-95fe-97c9c879b83a}</Project>
+      <Name>osu.Framework</Name>
+    </ProjectReference>
+    <ProjectReference Include="..\osu-resources\osu.Game.Resources\osu.Game.Resources.csproj">
+      <Project>{d9a367c9-4c1a-489f-9b05-a0cea2b53b58}</Project>
+      <Name>osu.Game.Resources</Name>
+    </ProjectReference>
+    <ProjectReference Include="..\osu.Game\osu.Game.csproj">
+      <Project>{0d3fbf8a-7464-4cf7-8c90-3e7886df2d4d}</Project>
+      <Name>osu.Game</Name>
+    </ProjectReference>
+  </ItemGroup>
+  <ItemGroup>
+    <Compile Include="Program.cs" />
+    <Compile Include="Tests\TestCaseTextAwesome.cs" />
+    <Compile Include="VisualTestGame.cs" />
+  </ItemGroup>
+  <ItemGroup />
+  <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
+  <!-- To modify your build process, add your task inside one of the targets below and uncomment it.
+       Other similar extension points exist, see Microsoft.Common.targets.
+  <Target Name="BeforeBuild">
+  </Target>
+  <Target Name="AfterBuild">
+  </Target>
+  -->
+  <ProjectExtensions>
+    <VisualStudio>
+    </VisualStudio>
+  </ProjectExtensions>
+  <PropertyGroup>
+    <PreBuildEvent>
+    </PreBuildEvent>
+  </PropertyGroup>
+  <PropertyGroup>
+    <PostBuildEvent>
+    </PostBuildEvent>
+  </PropertyGroup>
+</Project>
--- a/osu.Game/GameModes/Menu/MainMenu.cs
+++ b/osu.Game/GameModes/Menu/MainMenu.cs
@ -1,13 +1,10 @@
 //Copyright (c) 2007-2016 ppy Pty Ltd <contact@ppy.sh>.
 //Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE

-using OpenTK;
 using osu.Framework.Audio.Sample;
 using osu.Framework.Audio.Track;
 using osu.Framework.GameModes;
 using osu.Framework.Graphics;
-using osu.Framework.Graphics.Sprites;
-using osu.Framework.Graphics.UserInterface;

 namespace osu.Game.GameModes.Menu
 {
--- a/osu.Game/Graphics/TextAwesome.cs
+++ b/osu.Game/Graphics/TextAwesome.cs
@ -6,9 +6,9 @@ using OpenTK;

 namespace osu.Game.Graphics
 {
-    internal class TextAwesome : SpriteText
+    public class TextAwesome : SpriteText
    {
-        //internal override FontFace FontFace => (int)Icon < 0xf000 ? FontFace.OsuFont : FontFace.FontAwesome;
+        //public override FontFace FontFace => (int)Icon < 0xf000 ? FontFace.OsuFont : FontFace.FontAwesome;

        private FontAwesome icon;

@ -34,7 +34,7 @@ namespace osu.Game.Graphics
        }
    }

-    internal enum FontAwesome
+    public enum FontAwesome
    {
        glass = 0xf000,
        music = 0xf001,
--- a/osu.Game/OsuGame.cs
+++ b/osu.Game/OsuGame.cs
@ -1,30 +1,16 @@
 //Copyright (c) 2007-2016 ppy Pty Ltd <contact@ppy.sh>.
 //Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE

-using System;
-using System.Collections.Generic;
 using osu.Game.Configuration;
 using osu.Game.GameModes.Menu;
-using osu.Game.Graphics.Processing;
-using osu.Game.Online.API;
-using osu.Game.Online.API.Requests;
 using OpenTK;
 using osu.Framework.Graphics;
-using osu.Framework.Graphics.Cursor;
-using osu.Framework.Graphics.Textures;
-using osu.Framework.IO.Stores;
 using osu.Framework.OS;

 namespace osu.Game
 {
-    public class OsuGame : Framework.Game
+    public class OsuGame : OsuGameBase
    {
-        internal OsuConfigManager Config = new OsuConfigManager();
-
-        protected override string MainResourceFile => @"osu.Game.Resources.dll";
-
-        internal APIAccess API;
-
        public override void SetHost(BasicGameHost host)
        {
            base.SetHost(host);
@ -36,37 +22,7 @@ namespace osu.Game
        {
            base.Load();

-            //this completely overrides the framework default. will need to change once we make a proper FontStore.
-            Fonts = new TextureStore() { ScaleAdjust = 0.01f };
-            Fonts.AddStore(new GlyphStore(Resources, @"Fonts/Exo2.0-Regular"));
-            Fonts.AddStore(new GlyphStore(Resources, @"Fonts/FontAwesome"));
-            Fonts.AddStore(new GlyphStore(Resources, @"Fonts/osuFont"));
-
-
-            API = new APIAccess()
-            {
-                Username = Config.Get<string>(OsuConfig.Username),
-                Password = Config.Get<string>(OsuConfig.Password),
-                Token = Config.Get<string>(OsuConfig.Token)
-            };
-
-			//var req = new ListChannelsRequest();
-			//req.Success += content =>
-			//{
-			//};
-			//API.Queue(req);
-
-			Children = new Drawable[]
-			{
-				new RatioAdjust
-				{
-					Children = new Drawable[]
-					{
-						new MainMenu(),
-						new CursorContainer()
-					}
-				}
-			};
+            Add(new MainMenu());
        }

        protected override void Dispose(bool isDisposing)
@ -80,7 +36,7 @@ namespace osu.Game
        public override bool Invalidate(Invalidation invalidation = Invalidation.All, Drawable source = null, bool shallPropagate = true)
        {
            if (!base.Invalidate(invalidation, source, shallPropagate)) return false;
-            
+
            if (Parent != null)
            {
                Config.Set(OsuConfig.Width, ActualSize.X);
--- a/osu.Game/OsuGameBase.cs
+++ b/osu.Game/OsuGameBase.cs
@ -0,0 +1,53 @@
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Cursor;
+using osu.Framework.Graphics.Textures;
+using osu.Framework.IO.Stores;
+using osu.Game.Configuration;
+using osu.Game.Graphics.Processing;
+using osu.Game.Online.API;
+
+namespace osu.Game
+{
+    public class OsuGameBase : Framework.Game
+    {
+        internal OsuConfigManager Config = new OsuConfigManager();
+
+        protected override string MainResourceFile => @"osu.Game.Resources.dll";
+
+        internal APIAccess API;
+
+        protected override Container AddTarget => ratioContainer?.IsLoaded == true ? ratioContainer : base.AddTarget;
+
+        private RatioAdjust ratioContainer;
+
+        public override void Load()
+        {
+            base.Load();
+
+            //this completely overrides the framework default. will need to change once we make a proper FontStore.
+            Fonts = new TextureStore() { ScaleAdjust = 0.01f };
+            Fonts.AddStore(new GlyphStore(Resources, @"Fonts/Exo2.0-Regular"));
+            Fonts.AddStore(new GlyphStore(Resources, @"Fonts/FontAwesome"));
+            Fonts.AddStore(new GlyphStore(Resources, @"Fonts/osuFont"));
+
+            API = new APIAccess()
+            {
+                Username = Config.Get<string>(OsuConfig.Username),
+                Password = Config.Get<string>(OsuConfig.Password),
+                Token = Config.Get<string>(OsuConfig.Token)
+            };
+
+            Add(new Drawable[]
+            {
+                ratioContainer = new RatioAdjust
+                {
+                    Children = new Drawable[]
+                    {
+                        new CursorContainer()
+                    }
+                }
+            });
+        }
+    }
+}
--- a/osu.Game/osu.Game.csproj
+++ b/osu.Game/osu.Game.csproj
@ -63,6 +63,7 @@
    <Compile Include="Online\Chat\Channel.cs" />
    <Compile Include="Online\Chat\Message.cs" />
    <Compile Include="OsuGame.cs" />
+    <Compile Include="OsuGameBase.cs" />
    <Compile Include="Properties\AssemblyInfo.cs" />
  </ItemGroup>
  <ItemGroup>
--- a/osu.sln
+++ b/osu.sln
@ -17,6 +17,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Framework", "Framework", "{
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "osu.Framework.Desktop", "osu-framework\osu.Framework.Desktop\osu.Framework.Desktop.csproj", "{65DC628F-A640-4111-AB35-3A5652BC1E17}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "osu.Desktop.VisualTests", "osu.Desktop.VisualTests\osu.Desktop.VisualTests.csproj", "{69051C69-12AE-4E7D-A3E6-460D2E282312}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@ -54,6 +56,12 @@ Global
 		{65DC628F-A640-4111-AB35-3A5652BC1E17}.Deploy|Any CPU.Build.0 = Debug|Any CPU
 		{65DC628F-A640-4111-AB35-3A5652BC1E17}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{65DC628F-A640-4111-AB35-3A5652BC1E17}.Release|Any CPU.Build.0 = Release|Any CPU
+		{69051C69-12AE-4E7D-A3E6-460D2E282312}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{69051C69-12AE-4E7D-A3E6-460D2E282312}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{69051C69-12AE-4E7D-A3E6-460D2E282312}.Deploy|Any CPU.ActiveCfg = Deploy|Any CPU
+		{69051C69-12AE-4E7D-A3E6-460D2E282312}.Deploy|Any CPU.Build.0 = Deploy|Any CPU
+		{69051C69-12AE-4E7D-A3E6-460D2E282312}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{69051C69-12AE-4E7D-A3E6-460D2E282312}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@ -64,5 +72,6 @@ Global
 		{0D3FBF8A-7464-4CF7-8C90-3E7886DF2D4D} = {0D37A2AD-80A4-464F-A1DE-1560B70F1CE3}
 		{D9A367C9-4C1A-489F-9B05-A0CEA2B53B58} = {0D37A2AD-80A4-464F-A1DE-1560B70F1CE3}
 		{65DC628F-A640-4111-AB35-3A5652BC1E17} = {7A75DFA2-DE65-4458-98AF-26AF96FFD6DC}
+		{69051C69-12AE-4E7D-A3E6-460D2E282312} = {0D37A2AD-80A4-464F-A1DE-1560B70F1CE3}
 	EndGlobalSection
 EndGlobal