Handle explicit mobile platforms for the CLI builder arg + Add optional testDataSetIndex arg to select (#165)

Author: sierpinskid

Assets/Plugins/StreamChat/EditorTools/Builders/BuildTargetPlatform.cs

@@ -3,6 +3,8 @@
     public enum BuildTargetPlatform
     {
         Standalone,
-        Mobile
+        Mobile,
+        Android,
+        IOS
     }
 }

Assets/Plugins/StreamChat/EditorTools/CommandLineParsers/BuildSettingsCommandLineParser.cs

@@ -17,6 +17,7 @@ public class BuildSettingsCommandLineParser : CommandLineParserBase<(BuildSettin
         public const string BuildTargetPathArgKey = "-buildTargetPath";
 
         public const string StreamBase64TestDataArgKey = "-streamBase64TestDataSet";
+        public const string TestDataSetIndexArgKey = "-testDataSetIndex";
 
         protected override (BuildSettings buildSettings, AuthCredentials authCredentials) Parse(
             IDictionary<string, string> args)
@@ -53,39 +54,56 @@ protected override (BuildSettings buildSettings, AuthCredentials authCredentials
             var scriptingImplementation = GetScriptingImplementation(scriptingBackend);
             var targetPath = args[BuildTargetPathArgKey];
 
-            var testAuthDataSet = ParseTestAuthDataSetArg(args);
+            var testAuthDataSet = ParseTestAuthDataSetArg(args, out var optionalTestDataIndex);
 
             return (new BuildSettings(buildTargetGroup, apiCompatibilityLevel, scriptingImplementation, targetPath),
-                testAuthDataSet.GetAdminData());
+                testAuthDataSet.GetAdminData(forceIndex: optionalTestDataIndex));
+            
+
         }
 
-        public TestAuthDataSet ParseTestAuthDataSetArg(IDictionary<string, string> args)
+        public TestAuthDataSet ParseTestAuthDataSetArg(IDictionary<string, string> args, out int? forceDataSetIndex)
         {
             if (!args.ContainsKey(StreamBase64TestDataArgKey))
             {
                 throw new ArgumentException($"Missing argument: `{StreamBase64TestDataArgKey}`");
             }
 
+            forceDataSetIndex = GetOptionalTestDataIndex();
             var rawTestDataSet = GetTestDataSet(args);
             var serializer = new NewtonsoftJsonSerializer();
             return serializer.Deserialize<TestAuthDataSet>(rawTestDataSet);
+            
+            int? GetOptionalTestDataIndex()
+            {
+                if (!args.TryGetValue(TestDataSetIndexArgKey, out var arg))
+                {
+                    return default;
+                }
+
+                return int.Parse(arg);
+            }
         }
 
-        private BuildTargetGroup GetBuildTargetGroup(BuildTargetPlatform targetPlatform)
+        private static BuildTargetGroup GetBuildTargetGroup(BuildTargetPlatform targetPlatform)
         {
-            if (targetPlatform == BuildTargetPlatform.Standalone)
+            switch (targetPlatform)
             {
-                return BuildTargetGroup.Standalone;
-            }
-
+                case BuildTargetPlatform.Standalone: return BuildTargetGroup.Standalone;
+                case BuildTargetPlatform.Mobile:
 #if UNITY_STANDALONE_OSX
-            return BuildTargetGroup.iOS;
+                    return BuildTargetGroup.iOS;
 #else
-            return BuildTargetGroup.Android;
+                    return BuildTargetGroup.Android;
 #endif
+                case BuildTargetPlatform.Android: return BuildTargetGroup.Android;
+                case BuildTargetPlatform.IOS: return BuildTargetGroup.iOS;
+                default:
+                    throw new ArgumentOutOfRangeException(nameof(targetPlatform), targetPlatform, null);
+            }
         }
 
-        private ApiCompatibilityLevel GetApiCompatibilityLevel(ApiCompatibility apiCompatibility)
+        private static ApiCompatibilityLevel GetApiCompatibilityLevel(ApiCompatibility apiCompatibility)
         {
 #if UNITY_2021
             switch (apiCompatibility)
@@ -108,7 +126,7 @@ private ApiCompatibilityLevel GetApiCompatibilityLevel(ApiCompatibility apiCompa
 #endif
         }
 
-        private ScriptingImplementation GetScriptingImplementation(ScriptingBackend scriptingBackend)
+        private static ScriptingImplementation GetScriptingImplementation(ScriptingBackend scriptingBackend)
         {
             switch (scriptingBackend)
             {
@@ -119,7 +137,7 @@ private ScriptingImplementation GetScriptingImplementation(ScriptingBackend scri
             }
         }
 
-        private string GetTestDataSet(IDictionary<string, string> args)
+        private static string GetTestDataSet(IDictionary<string, string> args)
         {
             var decodedBytes = Convert.FromBase64String(args[StreamBase64TestDataArgKey]);
             return Encoding.UTF8.GetString(decodedBytes);

Assets/Plugins/StreamChat/EditorTools/TestAuthDataSet.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using StreamChat.Libs.Auth;
+using UnityEngine;
 using Random = UnityEngine.Random;
 
 namespace StreamChat.EditorTools
@@ -20,11 +21,25 @@ public TestAuthDataSet(IEnumerable<AuthCredentials> testAdminData, AuthCredentia
             TestGuestData = testGuestData;
         }
 
-        public AuthCredentials GetAdminData(string forcedAdminId = null)
+        public AuthCredentials GetAdminData(string forcedAdminId = default, int? forceIndex = default)
         {
-            return forcedAdminId != null
-                ? TestAdminData.First(_ => _.UserId == forcedAdminId)
-                : TestAdminData[Random.Range(0, TestAdminData.Length)];
+            if (!string.IsNullOrEmpty(forcedAdminId))
+            {
+                return TestAdminData.First(credentials => credentials.UserId == forcedAdminId);
+            }
+
+            if (forceIndex.HasValue)
+            {
+                if (forceIndex < TestAdminData.Length)
+                {
+                    return TestAdminData[forceIndex.Value];
+                }
+
+                Debug.LogWarning(
+                    $"{nameof(forceIndex)} is out of range -> given: {forceIndex}, max allowed: {TestAdminData.Length - 1}. Using random admin data instead.");
+            }
+
+            return TestAdminData[Random.Range(0, TestAdminData.Length)];
         }
 
         public AuthCredentials GetOtherThan(AuthCredentials authCredentials)

Assets/Plugins/StreamChat/Tests/StreamTestClients.cs

@@ -118,18 +118,29 @@ private StreamTestClients()
         {
             UnityTestRunnerCallbacks.RunFinishedCallback += OnRunFinishedCallback;
 
-            var testAuthDataSet = TestUtils.GetTestAuthCredentials();
+            var testAuthDataSet = TestUtils.GetTestAuthCredentials(out var optionalTestDataIndex);
             if (testAuthDataSet.TestAdminData.Length < 3)
             {
-                throw new ArgumentException("At least 3 admin credentials required");
+                throw new ArgumentException("At least 3 admin credentials are required");
             }
 
-            var adminData = testAuthDataSet.TestAdminData.OrderBy(_ => Random.value).ToList();
+            AuthCredentials primaryAdminSet;
+            if (optionalTestDataIndex.HasValue)
+            {
+                primaryAdminSet = testAuthDataSet.TestAdminData[optionalTestDataIndex.Value];
+            }
+            else
+            {
+                var shuffledSets = testAuthDataSet.TestAdminData.OrderBy(_ => Random.value);
+                primaryAdminSet = shuffledSets.First();
+            }
+
+            var otherAdminSets = testAuthDataSet.TestAdminData.Except(new[] { primaryAdminSet }).ToArray();
 
-            LowLevelClientCredentials = adminData[0];
-            _stateClientCredentials = adminData[1];
-            _otherUserCredentials = adminData[2];
-            _otherUsersCredentials = adminData.Skip(3).ToList();
+            LowLevelClientCredentials = primaryAdminSet;
+            _stateClientCredentials = primaryAdminSet;
+            _otherUserCredentials = otherAdminSets[1];
+            _otherUsersCredentials = otherAdminSets.Skip(2).ToList();
         }
 
         private static async Task<StreamChatClient> ConnectStateClientAsync(StreamChatClient client,

Assets/Plugins/StreamChat/Tests/TestUtils.cs

@@ -21,16 +21,17 @@ public static void GetTestAuthCredentials(out AuthCredentials guestAuthCredentia
             out AuthCredentials userAuthCredentials, out AuthCredentials adminAuthCredentials,
             out AuthCredentials otherUserAuthCredentials, string forcedAdminId = null)
         {
-            var testAuthDataSet = GetTestAuthCredentials();
+            var testAuthDataSet = GetTestAuthCredentials(out var forceDataSetIndex);
 
             guestAuthCredentials = testAuthDataSet.TestGuestData;
             userAuthCredentials = testAuthDataSet.TestUserData;
-            adminAuthCredentials = testAuthDataSet.GetAdminData(forcedAdminId);
+            adminAuthCredentials = testAuthDataSet.GetAdminData(forcedAdminId, forceDataSetIndex);
             otherUserAuthCredentials = testAuthDataSet.GetOtherThan(adminAuthCredentials);
         }
 
-        public static TestAuthDataSet GetTestAuthCredentials()
+        public static TestAuthDataSet GetTestAuthCredentials(out int? forceDataSetIndex)
         {
+            forceDataSetIndex = default;
             const string TestAuthDataFilePath = "test_auth_data_xSpgxW.txt";
 
             if (Application.isBatchMode)
@@ -40,7 +41,7 @@ public static TestAuthDataSet GetTestAuthCredentials()
                 var parser = new BuildSettingsCommandLineParser();
                 var argsDict = parser.GetParsedCommandLineArguments();
 
-                var testAuthDataSet = parser.ParseTestAuthDataSetArg(argsDict);
+                var testAuthDataSet = parser.ParseTestAuthDataSetArg(argsDict, out forceDataSetIndex);
 
                 Debug.Log("Data deserialized correctly. Sample: " + testAuthDataSet.TestAdminData[0].UserId);