Mod UGUIMonkeyAgent default screenshot filename strategy to TwoTiered…

…CounterStrategy

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/Strategies/TwoTieredCounterStrategy.cs

@@ -0,0 +1,52 @@
+// Copyright (c) 2023-2024 DeNA Co., Ltd.
+// This software is released under the MIT License.
+
+using System.Collections.Generic;
+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/>
+        public TwoTieredCounterStrategy(string filenamePrefix = null, [CallerMemberName] string callerMemberName = null)
+            : base(filenamePrefix, callerMemberName)
+        {
+            var key = base.GetFilenamePrefix();
+            if (!s_prefixCounters.TryAdd(key, 1))
+            {
+                s_prefixCounters[key]++;
+            }
+
+            _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/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"));
+        }
+    }
+}