Merge pull request #270 from nowsprinting/chore/screenshot_async

Change screenshot method to TakeScreenshotAsync

Author: nowsprinting

Runtime/Monkey.cs

@@ -30,8 +30,6 @@ namespace TestHelper.UI
     /// </summary>
     public static class Monkey
     {
-        private static MonoBehaviour s_coroutineRunner; // for take screenshots
-
         /// <summary>
         /// Run monkey testing by repeating to call <c cref="RunStep">RunStep</c> and wait.
         /// </summary>
@@ -288,14 +286,19 @@ private static async UniTask TakeScreenshotAsync(ScreenshotOptions screenshotOpt
                 return;
             }
 
+            var filename = screenshotOptions.FilenameStrategy.GetFilename();
+            message.Append($", screenshot={filename}");
+
+#if UNITY_2023_1_OR_NEWER
+            await ScreenshotHelper.TakeScreenshotAsync(
+                directory: screenshotOptions.Directory,
+                filename: filename);
+#else
             if (!s_coroutineRunner)
             {
                 s_coroutineRunner = new GameObject("CoroutineRunner").AddComponent<CoroutineRunner>();
             }
 
-            var filename = screenshotOptions.FilenameStrategy.GetFilename();
-            message.Append($", screenshot={filename}");
-
             await ScreenshotHelper.TakeScreenshot(
                     directory: screenshotOptions.Directory,
                     filename: filename,
@@ -304,10 +307,15 @@ await ScreenshotHelper.TakeScreenshot(
                     logFilepath: false
                 )
                 .ToUniTask(s_coroutineRunner);
+#endif
         }
 
+#if !UNITY_2023_1_OR_NEWER
+        private static MonoBehaviour s_coroutineRunner; // for take screenshots
+
         private class CoroutineRunner : MonoBehaviour
         {
         }
+#endif
     }
 }

Runtime/MonkeyConfig.cs

@@ -57,6 +57,7 @@ public class MonkeyConfig
         /// <summary>
         /// Show Gizmos on <c>GameView</c> during running monkey test if true
         /// </summary>
+        [Obsolete("Use GizmosShowOnGameViewAttribute or GameViewControlHelper.SetGizmos instead.")]
         public bool Gizmos { get; set; }
 
         /// <summary>
@@ -94,7 +95,9 @@ public class MonkeyConfig
 
         /// <summary>
         /// Operators that the monkey invokes.
-        /// <c>logger</c> and <c>screenshotOptions</c> will be overridden at runtime by the same name properties in this <c>MonkeyConfig</c> instance.
+        /// <p/>
+        /// <c>logger</c>, <c>screenshotOptions</c>, <c>GetScreenPoint</c>, and <c>ReachableStrategy</c> will be overridden at runtime by the same name properties in this <c>MonkeyConfig</c> instance.
+        /// And <c>Random</c> will also be overridden at runtime by a forked instance from the <c>Random</c> property in this <c>MonkeyConfig</c> instance.
         /// </summary>
         public IEnumerable<IOperator> Operators { get; set; } = new IOperator[]
         {

Runtime/Operators/Utils/OperationLogger.cs

@@ -61,6 +61,11 @@ public async UniTask Log()
             if (_screenshotOptions != null)
             {
                 _lastScreenshotPath = _screenshotOptions.FilenameStrategy.GetFilename();
+#if UNITY_2023_1_OR_NEWER
+                await ScreenshotHelper.TakeScreenshotAsync(
+                    directory: _screenshotOptions.Directory,
+                    filename: _lastScreenshotPath);
+#else
                 await ScreenshotHelper.TakeScreenshot(
                         directory: _screenshotOptions.Directory,
                         filename: _lastScreenshotPath,
@@ -69,6 +74,7 @@ await ScreenshotHelper.TakeScreenshot(
                         logFilepath: false
                     )
                     .ToUniTask(_gameObject.GetComponent<MonoBehaviour>());
+#endif
             }
 
             _logger.Log(BuildMessage());

Runtime/Operators/Utils/PointerClickEventSimulator.cs

@@ -27,7 +27,7 @@ namespace TestHelper.UI.Operators.Utils
         /// </summary>
         /// <param name="gameObject">Click target <c>GameObject</c></param>
         /// <param name="raycastResult"><c>RaycastResult</c> includes the screen position of the starting operation. Passing <c>default</c> may be OK, depending on the game-title implementation.</param>
-        /// <param name="logger">Verbose logger set if you need</param>
+        /// <param name="logger">Logger that outputs messages when something is irregular.</param>
         public PointerClickEventSimulator(GameObject gameObject, RaycastResult raycastResult, ILogger logger)
         {
             _gameObject = gameObject;

Runtime/Operators/Utils/PointerDragEventSimulator.cs

@@ -31,7 +31,7 @@ public struct PointerDragEventSimulator : IDisposable
         /// </summary>
         /// <param name="gameObject">Drag target <c>GameObject</c></param>
         /// <param name="raycastResult"><c>RaycastResult</c> includes the screen position of the starting operation. Passing <c>default</c> may be OK, depending on the game-title implementation.</param>
-        /// <param name="logger">Verbose logger set if you need</param>
+        /// <param name="logger">Logger that outputs messages when something is irregular.</param>
         public PointerDragEventSimulator(GameObject gameObject, RaycastResult raycastResult, ILogger logger)
         {
             _gameObject = gameObject;

Runtime/ScreenshotOptions.cs

@@ -1,6 +1,7 @@
 // Copyright (c) 2023-2024 Koji Hasegawa.
 // This software is released under the MIT License.
 
+using System;
 using TestHelper.UI.ScreenshotFilenameStrategies;
 using UnityEngine;
 
@@ -27,6 +28,7 @@ public class ScreenshotOptions
         /// The factor to increase resolution with.
         /// SuperSize and StereoCaptureMode cannot be specified at the same time.
         /// </summary>
+        [Obsolete("The way screenshots are taken has changed, so this property is no longer used.")]
         public int SuperSize { get; set; } = 1;
 
         /// <summary>
@@ -37,6 +39,7 @@ public class ScreenshotOptions
         /// Require stereo rendering settings.
         /// See: https://docs.unity3d.com/Manual/SinglePassStereoRendering.html
         /// </remarks>
+        [Obsolete("The way screenshots are taken has changed, so this property is no longer used.")]
         public ScreenCapture.StereoScreenCaptureMode StereoCaptureMode { get; set; } =
             ScreenCapture.StereoScreenCaptureMode.LeftEye;
     }

Tests/Runtime/MonkeyTest.cs

@@ -344,7 +344,6 @@ public void LotteryOperator_BingoReachableComponent_ReturnOperator()
         public class Screenshots
         {
             private const int FileSizeThreshold = 5441;         // VGA size solid color file size
-            private const int FileSizeThreshold2X = 100 * 1024; // Normal size is 80 to 90KB
             private readonly string _defaultOutputDirectory = CommandLineArgs.GetScreenshotDirectory();
             private string _filename;
             private string _path;
@@ -361,7 +360,7 @@ public void SetUp()
                 }
             }
 
-            private MonkeyConfig CreateMonkeyConfig(ScreenshotOptions screenshotOptions)
+            private static MonkeyConfig CreateMonkeyConfig(ScreenshotOptions screenshotOptions)
             {
                 var config = new MonkeyConfig
                 {
@@ -377,7 +376,7 @@ private MonkeyConfig CreateMonkeyConfig(ScreenshotOptions screenshotOptions)
                 return config;
             }
 
-            private InteractableComponentsFinder CreateInteractableComponentsFinder(MonkeyConfig config)
+            private static InteractableComponentsFinder CreateInteractableComponentsFinder(MonkeyConfig config)
             {
                 return new InteractableComponentsFinder(operators: config.Operators);
             }
@@ -419,7 +418,6 @@ public async Task RunStep_withScreenshots_specifyPath_takeScreenshotsAndSaveToSp
                 {
                     Directory = relativeDirectory,
                     FilenameStrategy = new StubScreenshotFilenameStrategy(filename),
-                    SuperSize = 2,
                 });
                 var interactableComponentsFinder = CreateInteractableComponentsFinder(config);
 
@@ -434,53 +432,6 @@ await Monkey.RunStep(
                 Assert.That(new FileInfo(path), Has.Length.GreaterThan(FileSizeThreshold));
             }
 
-            [Test]
-            [Description("This test fails with stereo rendering settings.")]
-            [LoadScene(TestScene)]
-            public async Task RunStep_withScreenshots_superSize_takeScreenshotsSuperSize()
-            {
-                var config = CreateMonkeyConfig(new ScreenshotOptions
-                {
-                    SuperSize = 2, // 2x size
-                });
-                var interactableComponentsFinder = CreateInteractableComponentsFinder(config);
-
-                await Monkey.RunStep(
-                    config.Random,
-                    config.Logger,
-                    interactableComponentsFinder,
-                    config.IgnoreStrategy,
-                    config.ReachableStrategy);
-
-                Assert.That(_path, Does.Exist);
-                Assert.That(new FileInfo(_path), Has.Length.GreaterThan(FileSizeThreshold2X));
-                // Note: This test fails with stereo rendering settings.
-                //  See: https://docs.unity3d.com/Manual/SinglePassStereoRendering.html
-            }
-
-            [Test]
-            [LoadScene(TestScene)]
-            [Description("Is it a stereo screenshot? See for yourself! Be a witness!!")]
-            public async Task RunStep_withScreenshots_stereo_takeScreenshotsStereo()
-            {
-                var config = CreateMonkeyConfig(new ScreenshotOptions
-                {
-                    StereoCaptureMode = ScreenCapture.StereoScreenCaptureMode.BothEyes,
-                });
-                var interactableComponentsFinder = CreateInteractableComponentsFinder(config);
-
-                await Monkey.RunStep(
-                    config.Random,
-                    config.Logger,
-                    interactableComponentsFinder,
-                    config.IgnoreStrategy,
-                    config.ReachableStrategy);
-
-                Assert.That(_path, Does.Exist);
-                // Note: Require stereo rendering settings.
-                //  See: https://docs.unity3d.com/Manual/SinglePassStereoRendering.html
-            }
-
             [Test]
             [LoadScene(TestScene)]
             public async Task Run_withScreenshots_noInteractiveComponent_takeScreenshot()
@@ -511,12 +462,11 @@ public async Task Run_withScreenshots_noInteractiveComponent_takeScreenshot()
             }
 
             [Test]
-            [GameViewResolution(GameViewResolution.VGA)]
             [LoadScene("../Scenes/InfiniteLoop.unity")]
             public async Task Run_withScreenshots_InfiniteLoop_takeScreenshot()
             {
-                _filename = $"{TestContext.CurrentContext.Test.Name}_0011.png"; // 10 steps + 1
-                _path = Path.Combine(_defaultOutputDirectory, _filename);
+                var filename = $"{TestContext.CurrentContext.Test.Name}_0011.png"; // 10 steps + 1
+                var path = Path.Combine(_defaultOutputDirectory, filename);
 
                 var config = CreateMonkeyConfig(new ScreenshotOptions());
                 config.Lifetime = TimeSpan.FromSeconds(2); // 2sec
@@ -530,10 +480,10 @@ public async Task Run_withScreenshots_InfiniteLoop_takeScreenshot()
                 }
                 catch (InfiniteLoopException e)
                 {
-                    Assert.That(e.Message, Does.Contain(_filename));
+                    Assert.That(e.Message, Does.Contain(filename));
                 }
 
-                Assert.That(_path, Does.Exist);
+                Assert.That(path, Does.Exist);
             }
         }
 
@@ -661,10 +611,10 @@ public void LotteryOperator_NotReachableObjectOnly_LogNotLottery()
         }
 
         [TestFixture]
+        [GameViewResolution(GameViewResolution.VGA)]
         public class DetectingInfiniteLoop
         {
             [Test]
-            [GameViewResolution(GameViewResolution.VGA)]
             [LoadScene("../Scenes/InfiniteLoop.unity")]
             public async Task Run_InfiniteLoop_throwsInfiniteLoopException()
             {