Merge pull request #79 from nowsprinting/feature/screenshot_unique_ag…

…entname

Change UGUIMonkeyAgent default screenshot filename strategy to TwoTieredCounterStrategy

README.md

@@ -481,7 +481,7 @@ Note that it is convenient to set the `[CreateAssetMenu]` attribute to create an
 
 ### Game title-specific pre-processing
 
-If your title requires its own initialization process, add the `InitializeOnLaunchAutopilot` attribute to the `public static` method that does the initialization.
+If your title requires its own initialization process, add the `InitializeOnLaunchAutopilot` attribute to the `static` method that does the initialization.
 An added method is called from the autopilot launch process.
 
 ```csharp
@@ -496,7 +496,7 @@ Async methods are also supported.
 
 ```csharp
 [InitializeOnLaunchAutopilot]
-public static async UniTask InitializeOnLaunchAutopilotMethod()
+private static async UniTask InitializeOnLaunchAutopilotMethod()
 {
     // initialize code for your game.
 }

README_ja.md

@@ -484,7 +484,7 @@ Assembly Definition File (asmdef) のAuto Referencedをoff、Define Constraints
 
 ### タイトル独自事前処理
 
-タイトル独自の初期化処理が必要な場合、初期化を行なう `public static` メソッドに `InitializeOnLaunchAutopilot` 属性を付与してください。
+タイトル独自の初期化処理が必要な場合、初期化を行なう `static` メソッドに `InitializeOnLaunchAutopilot` 属性を付与してください。
 オートパイロットの起動処理の中でメソッドを呼び出します。
 
 ```csharp
@@ -499,7 +499,7 @@ public static void InitializeOnLaunchAutopilotMethod()
 
 ```csharp
 [InitializeOnLaunchAutopilot]
-public static async UniTask InitializeOnLaunchAutopilotMethod()
+private static async UniTask InitializeOnLaunchAutopilotMethod()
 {
     // プロジェクト固有の初期化処理
 }

Runtime/Agents/UGUIMonkeyAgent.cs

@@ -6,11 +6,11 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Threading;
 using Cysharp.Threading.Tasks;
+using DeNA.Anjin.Strategies;
 using TestHelper.Monkey;
 using TestHelper.Monkey.Annotations.Enums;
 using TestHelper.Monkey.Operators;
 using TestHelper.Monkey.Random;
-using TestHelper.Monkey.ScreenshotFilenameStrategies;
 using TestHelper.Random;
 using UnityEngine;
 
@@ -112,7 +112,7 @@ public override async UniTask Run(CancellationToken token)
                     ? new ScreenshotOptions
                     {
                         Directory = defaultScreenshotDirectory ? null : screenshotDirectory,
-                        FilenameStrategy = new CounterBasedStrategy(
+                        FilenameStrategy = new TwoTieredCounterStrategy(
                             defaultScreenshotFilenamePrefix ? this.name : screenshotFilenamePrefix
                         ),
                         SuperSize = screenshotSuperSize,

Runtime/Launcher.cs

@@ -5,6 +5,7 @@
 
 using System;
 using System.Linq;
+using System.Reflection;
 using System.Threading.Tasks;
 using Cysharp.Threading.Tasks;
 using DeNA.Anjin.Attributes;
@@ -59,9 +60,10 @@ public static async UniTaskVoid Run()
 
         private static async UniTask CallAttachedInitializeOnLaunchAutopilotAttributeMethods()
         {
+            const BindingFlags MethodBindingFlags = BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic;
             foreach (var methodInfo in AppDomain.CurrentDomain.GetAssemblies()
                          .SelectMany(x => x.GetTypes())
-                         .SelectMany(x => x.GetMethods())
+                         .SelectMany(x => x.GetMethods(MethodBindingFlags))
                          .Where(x => x.GetCustomAttributes(typeof(InitializeOnLaunchAutopilotAttribute), false).Any()))
             {
                 switch (methodInfo.ReturnType.Name)

Runtime/Strategies/TwoTieredCounterStrategy.cs

@@ -0,0 +1,58 @@
+// Copyright (c) 2023-2024 DeNA Co., Ltd.
+// This software is released under the MIT License.
+
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
+using System.Runtime.CompilerServices;
+using DeNA.Anjin.Attributes;
+using TestHelper.Monkey.ScreenshotFilenameStrategies;
+
+namespace DeNA.Anjin.Strategies
+{
+    /// <summary>
+    /// Screenshot filename strategy that adds a unique counter to the prefix.
+    /// </summary>
+    public class TwoTieredCounterStrategy : AbstractPrefixAndUniqueIDStrategy
+    {
+        private static readonly Dictionary<string, int> s_prefixCounters = new Dictionary<string, int>();
+        private readonly int _uniqueNumberOfPrefix;
+        private int _count;
+
+        [InitializeOnLaunchAutopilot]
+        internal static void ResetPrefixCounters()
+        {
+            s_prefixCounters.Clear();
+        }
+
+        /// <inheritdoc/>
+        [SuppressMessage("ReSharper", "CanSimplifyDictionaryLookupWithTryAdd")]
+        public TwoTieredCounterStrategy(string filenamePrefix = null, [CallerMemberName] string callerMemberName = null)
+            : base(filenamePrefix, callerMemberName)
+        {
+            var key = base.GetFilenamePrefix();
+            if (s_prefixCounters.ContainsKey(key))
+            {
+                s_prefixCounters[key]++;
+            }
+            else
+            {
+                s_prefixCounters[key] = 1;
+            }
+
+            _uniqueNumberOfPrefix = s_prefixCounters[key];
+            _count = 0;
+        }
+
+        /// <inheritdoc/>
+        protected override string GetFilenamePrefix()
+        {
+            return $"{base.GetFilenamePrefix()}{_uniqueNumberOfPrefix:D2}";
+        }
+
+        /// <inheritdoc/>
+        protected override string GetUniqueID()
+        {
+            return $"{++_count:D4}";
+        }
+    }
+}

Tests/Runtime/Agents/UGUIMonkeyAgentTest.cs

@@ -84,7 +84,7 @@ public async Task Run_lifespanPassed_stopAgent()
         public async Task Run_DefaultScreenshotFilenamePrefix_UseAgentName()
         {
             const string AgentName = "MyMonkeyAgent";
-            var filename = $"{AgentName}_0001.png";
+            var filename = $"{AgentName}01_0001.png";
             var path = Path.Combine(_defaultOutputDirectory, filename);
             if (File.Exists(path))
             {

Tests/Runtime/DeNA.Anjin.Tests.asmdef

@@ -9,7 +9,8 @@
         "UniTask",
         "DeNA.Anjin.Editor",
         "TestHelper",
-        "TestHelper.RuntimeInternals"
+        "TestHelper.RuntimeInternals",
+        "TestHelper.Monkey"
     ],
     "includePlatforms": [],
     "excludePlatforms": [],

Tests/Runtime/LauncherTest.cs

@@ -94,7 +94,7 @@ public async Task Launch_InitializeOnLaunchAutopilotAttribute_Called()
         }
 
         [Test]
-        public async Task Launch_InitializeOnLaunchAutopilotAttributeAttachToAsyncMethod_Called()
+        public async Task Launch_InitializeOnLaunchAutopilotAttributeAttachToNonPublicMethod_Called()
         {
             SpyInitializeOnLaunchAutopilot.Reset();
 
@@ -103,7 +103,20 @@ public async Task Launch_InitializeOnLaunchAutopilotAttributeAttachToAsyncMethod
             settings.lifespanSec = 1;
             await LauncherFromTest.AutopilotAsync(settings); // TODO: Renamed in another PR
 
-            Assert.That(SpyInitializeOnLaunchAutopilot.IsCallInitializeOnLaunchAutopilotMethodAsync, Is.True);
+            Assert.That(SpyInitializeOnLaunchAutopilot.IsCallInitializeOnLaunchAutopilotMethodNonPublic, Is.True);
+        }
+
+        [Test]
+        public async Task Launch_InitializeOnLaunchAutopilotAttributeAttachToTaskAsyncMethod_Called()
+        {
+            SpyInitializeOnLaunchAutopilot.Reset();
+
+            var settings = ScriptableObject.CreateInstance(typeof(AutopilotSettings)) as AutopilotSettings;
+            settings.sceneAgentMaps = new List<SceneAgentMap>();
+            settings.lifespanSec = 1;
+            await LauncherFromTest.AutopilotAsync(settings); // TODO: Renamed in another PR
+
+            Assert.That(SpyInitializeOnLaunchAutopilot.IsCallInitializeOnLaunchAutopilotMethodTaskAsync, Is.True);
         }
 
         [Test]

Tests/Runtime/Strategies/TwoTieredCounterStrategyTest.cs

@@ -0,0 +1,58 @@
+// Copyright (c) 2023-2024 DeNA Co., Ltd.
+// This software is released under the MIT License.
+
+using NUnit.Framework;
+
+namespace DeNA.Anjin.Strategies
+{
+    public class TwoTieredCounterStrategyTest
+    {
+        [SetUp]
+        public void SetUp()
+        {
+            TwoTieredCounterStrategy.ResetPrefixCounters();
+        }
+
+        [Test]
+        public void GetFilename_WithPrefix_ReturnsUniqueFilename()
+        {
+            var sut = new TwoTieredCounterStrategy("MyPrefix");
+
+            Assert.That(sut.GetFilename(), Is.EqualTo("MyPrefix01_0001.png"));
+            Assert.That(sut.GetFilename(), Is.EqualTo("MyPrefix01_0002.png"));
+        }
+
+        [Test]
+        public void GetFilename_WithoutPrefix_ReturnsFilenameUsingTestName()
+        {
+            var sut = new TwoTieredCounterStrategy();
+
+            Assert.That(sut.GetFilename(), Is.EqualTo($"{TestContext.CurrentContext.Test.Name}01_0001.png"));
+            Assert.That(sut.GetFilename(), Is.EqualTo($"{TestContext.CurrentContext.Test.Name}01_0002.png"));
+        }
+
+        [Test]
+        public void GetFilename_WithSamePrefix_ReturnsFilenameUsingUniqueNumberByPrefix()
+        {
+            var sut = new TwoTieredCounterStrategy("MyPrefix");
+            var sut2 = new TwoTieredCounterStrategy("MyPrefix");
+
+            Assert.That(sut.GetFilename(), Is.EqualTo("MyPrefix01_0001.png"));
+            Assert.That(sut.GetFilename(), Is.EqualTo("MyPrefix01_0002.png"));
+            Assert.That(sut2.GetFilename(), Is.EqualTo("MyPrefix02_0001.png"));
+            Assert.That(sut2.GetFilename(), Is.EqualTo("MyPrefix02_0002.png"));
+        }
+
+        [Test]
+        public void GetFilename_WithAnotherPrefix_ReturnsUniqueFilenameByPrefix()
+        {
+            var sut = new TwoTieredCounterStrategy("MyPrefix");
+            var sut2 = new TwoTieredCounterStrategy("AnotherPrefix");
+
+            Assert.That(sut.GetFilename(), Is.EqualTo("MyPrefix01_0001.png"));
+            Assert.That(sut.GetFilename(), Is.EqualTo("MyPrefix01_0002.png"));
+            Assert.That(sut2.GetFilename(), Is.EqualTo("AnotherPrefix01_0001.png"));
+            Assert.That(sut2.GetFilename(), Is.EqualTo("AnotherPrefix01_0002.png"));
+        }
+    }
+}

Tests/Runtime/TestDoubles/SpyInitializeOnLaunchAutopilot.cs

@@ -10,13 +10,15 @@ namespace DeNA.Anjin.TestDoubles
     public static class SpyInitializeOnLaunchAutopilot
     {
         public static bool IsCallInitializeOnLaunchAutopilotMethod { get; private set; }
-        public static bool IsCallInitializeOnLaunchAutopilotMethodAsync { get; private set; }
+        public static bool IsCallInitializeOnLaunchAutopilotMethodNonPublic { get; private set; }
+        public static bool IsCallInitializeOnLaunchAutopilotMethodTaskAsync { get; private set; }
         public static bool IsCallInitializeOnLaunchAutopilotMethodUniTaskAsync { get; private set; }
 
         public static void Reset()
         {
             IsCallInitializeOnLaunchAutopilotMethod = false;
-            IsCallInitializeOnLaunchAutopilotMethodAsync = false;
+            IsCallInitializeOnLaunchAutopilotMethodNonPublic = false;
+            IsCallInitializeOnLaunchAutopilotMethodTaskAsync = false;
             IsCallInitializeOnLaunchAutopilotMethodUniTaskAsync = false;
         }
 
@@ -27,10 +29,16 @@ public static void InitializeOnLaunchAutopilotMethod()
         }
 
         [InitializeOnLaunchAutopilot]
-        public static async Task InitializeOnLaunchAutopilotMethodAsync()
+        private static void InitializeOnLaunchAutopilotMethodNonPublic()
+        {
+            IsCallInitializeOnLaunchAutopilotMethodNonPublic = true;
+        }
+
+        [InitializeOnLaunchAutopilot]
+        public static async Task InitializeOnLaunchAutopilotMethodTaskAsync()
         {
             await Task.Delay(0);
-            IsCallInitializeOnLaunchAutopilotMethodAsync = true;
+            IsCallInitializeOnLaunchAutopilotMethodTaskAsync = true;
         }
 
         [InitializeOnLaunchAutopilot]