Revamp of CI and first tests targeting stage

This is a squashed commit of a too big commit.
This commit consists of:
1. Initial workflow that targets stage
2. Added CI specific utils to store created users and games
3. Testing on Guest login
4. Testing on White Label Login
5. Testing on Leaderboard details and rewards
6. Testing on submitting scores to Leaderboards
7. Testing on Leaderboard listing, types, and metadata
8. Testing on Player Info
9. Testing on Pinging LootLocker's server
10. Testing on Player Storage, private, public and update
11. Removed ratelimiting while targeting stage

Author: AlmightyMikkel

.github/workflows/run-tests-and-package.yml

@@ -59,3 +59,10 @@ sysinfo.txt
 crashlytics-build.properties
 
 .DS_Store
+
+#IDE generated files
+.idea
+.vscode
+
+#Specific meta files to ignore
+Tests.meta

.gitignore

@@ -102,7 +102,8 @@ IEnumerator coroutine()
                         yield break;
                     }
 
-                    LogResponse(request, webRequest.responseCode, webRequest.downloadHandler.text, startTime);
+
+                    LogResponse(request, webRequest.responseCode, webRequest.downloadHandler.text, startTime, webRequest.error);
 
                     if (WebRequestSucceeded(webRequest))
                     {
@@ -168,8 +169,17 @@ private static bool ShouldRetryRequest(long statusCode, int timesRetried)
             return (statusCode == 401 || statusCode == 403) && LootLockerConfig.current.allowTokenRefresh && CurrentPlatform.Get() != Platforms.Steam && timesRetried < MaxRetries;
         }
 
-        private static void LogResponse(LootLockerServerRequest request, long statusCode, string responseBody, float startTime)
+        private static void LogResponse(LootLockerServerRequest request, long statusCode, string responseBody, float startTime, string unityWebRequestError)
         {
+            if (statusCode == 0 && string.IsNullOrEmpty(responseBody) && !string.IsNullOrEmpty(unityWebRequestError))
+            {
+                LootLockerLogger.GetForLogLevel(LootLockerLogger.LogLevel.Verbose)("Unity Web request failed, request to " +
+                    request.endpoint + " completed in " +
+                    (Time.time - startTime).ToString("n4") +
+                    " secs.\nWeb Request Error: " + unityWebRequestError);
+                return;
+            }
+
             try
             {
                 LootLockerLogger.GetForLogLevel(LootLockerLogger.LogLevel.Verbose)("Server Response: " +
@@ -184,8 +194,7 @@ private static void LogResponse(LootLockerServerRequest request, long statusCode
             {
                 LootLockerLogger.GetForLogLevel(LootLockerLogger.LogLevel.Error)(request.httpMethod.ToString());
                 LootLockerLogger.GetForLogLevel(LootLockerLogger.LogLevel.Error)(request.endpoint);
-                LootLockerLogger.GetForLogLevel(LootLockerLogger.LogLevel.Error)(
-                    LootLockerObfuscator.ObfuscateJsonStringForLogging(responseBody));
+                LootLockerLogger.GetForLogLevel(LootLockerLogger.LogLevel.Error)(LootLockerObfuscator.ObfuscateJsonStringForLogging(responseBody));
             }
         }
 

Runtime/Client/LootLockerServerApi.cs

@@ -414,6 +414,12 @@ private int MoveCurrentBucket(DateTime now)
 
         public virtual bool AddRequestAndCheckIfRateLimitHit()
         {
+            //Disable local ratelimiter when not targeting production
+            if (!LootLockerConfig.IsTargetingProductionEnvironment())
+            {
+                return false;
+            }
+
             DateTime now = GetTimeNow();
             var currentBucket = MoveCurrentBucket(now);
 

Runtime/Client/LootLockerServerRequest.cs

@@ -113,6 +113,7 @@ public class LootLockerCommonAsset : LootLockerResponse
     {
         public int id { get; set; }
         public string uuid { get; set; }
+        public string ulid { get; set; }
         public string name { get; set; }
         public bool active { get; set; }
         public bool purchasable { get; set; }

Runtime/Game/Requests/AssetRequest.cs

@@ -7,6 +7,7 @@
 using UnityEditor.PackageManager.UI;
 #endif
 using UnityEngine;
+using static LootLocker.LootLockerConfig;
 
 namespace LootLocker
 {
@@ -22,10 +23,10 @@ public static LootLockerConfig Get()
         {
             if (settingsInstance != null)
             {
-                settingsInstance.ConstructUrls();
 #if LOOTLOCKER_COMMANDLINE_SETTINGS
                 settingsInstance.CheckForSettingOverrides();
 #endif
+                settingsInstance.ConstructUrls();
                 return settingsInstance;
             }
 
@@ -62,37 +63,32 @@ public static LootLockerConfig Get()
                 throw new ArgumentException("LootLocker config does not exist. To fix this, play once in the Unity Editor before making a build.");
             }
 #endif
-            settingsInstance.ConstructUrls();
 #if LOOTLOCKER_COMMANDLINE_SETTINGS
             settingsInstance.CheckForSettingOverrides();
 #endif
+            settingsInstance.ConstructUrls();
             return settingsInstance;
         }
 
         private void CheckForSettingOverrides()
         {
 #if LOOTLOCKER_COMMANDLINE_SETTINGS
             string[] args = System.Environment.GetCommandLineArgs();
-            string _apiKey = null;
-            string _domainKey = null;
             for (int i = 0; i < args.Length; i++)
             {
                 if (args[i] == "-apikey")
                 {
-                    _apiKey = args[i + 1];
+                    apiKey = args[i + 1];
                 }
                 else if (args[i] == "-domainkey")
                 {
-                    _domainKey = args[i + 1];
+                    domainKey = args[i + 1];
+                }
+                else if (args[i] == "-lootlockerurl")
+                {
+                    UrlCoreOverride = args[i + 1];
                 }
             }
-
-            if (string.IsNullOrEmpty(_apiKey) || string.IsNullOrEmpty(_domainKey))
-            {
-                return;
-            }
-            apiKey = _apiKey;
-            domainKey = _domainKey;
 #endif
         }
 
@@ -184,10 +180,37 @@ public static bool CreateNewSettings(string apiKey, string gameVersion, string d
             _current.currentDebugLevel = debugLevel;
             _current.allowTokenRefresh = allowTokenRefresh;
             _current.domainKey = domainKey;
+            _current.token = null;
+#if UNITY_EDITOR
+            _current.adminToken = null;
+#endif //UNITY_EDITOR
+            _current.refreshToken = null;
+            _current.gameID = 0;
+            _current.deviceID = null;
+#if LOOTLOCKER_COMMANDLINE_SETTINGS
+            _current.CheckForSettingOverrides();
+#endif
             _current.ConstructUrls();
             return true;
         }
 
+        public static bool ClearSettings()
+        {
+            _current.apiKey = null;
+            _current.game_version = null;
+            _current.currentDebugLevel = DebugLevel.All;
+            _current.allowTokenRefresh = true;
+            _current.domainKey = null;
+            _current.token = null;
+#if UNITY_EDITOR
+            _current.adminToken = null;
+#endif //UNITY_EDITOR
+            _current.refreshToken = null;
+            _current.gameID = 0;
+            _current.deviceID = null;
+            return true;
+        }
+
         private void ConstructUrls()
         {
             string startOfUrl = UrlProtocol;
@@ -222,7 +245,7 @@ public static LootLockerConfig current
         public string token;
 #if UNITY_EDITOR
         [HideInInspector]
-        public string adminToken;
+        public string adminToken = null;
 #endif
         [HideInInspector]
         public string refreshToken;
@@ -238,13 +261,19 @@ public static LootLockerConfig current
 
         [HideInInspector] private static readonly string UrlProtocol = "https://";
         [HideInInspector] private static readonly string UrlCore = "api.lootlocker.io";
-        [HideInInspector] private static readonly string UrlCoreOverride =
+        [HideInInspector] private static string UrlCoreOverride =
 #if LOOTLOCKER_TARGET_STAGE_ENV
            "api.stage.internal.dev.lootlocker.cloud";
 #else
             null;
 #endif
         private static string GetUrlCore() { return string.IsNullOrEmpty(UrlCoreOverride) ? UrlCore : UrlCoreOverride; }
+
+        public static bool IsTargetingProductionEnvironment()
+        {
+            return string.IsNullOrEmpty(UrlCoreOverride) || UrlCoreOverride.Equals(UrlCore);
+
+        }
         [HideInInspector] private static readonly string UrlAppendage = "/v1";
         [HideInInspector] private static readonly string AdminUrlAppendage = "/admin";
         [HideInInspector] private static readonly string PlayerUrlAppendage = "/player";

Runtime/Game/Resources/LootLockerConfig.cs

@@ -0,0 +1,40 @@
+using LootLocker;
+using System;
+using System.Collections.Generic;
+
+namespace LootLockerTestConfigurationUtils
+{
+    public class ApiKey
+    {
+        public class CreateApiKeyRequest
+        {
+            public string name { get; set; }
+            public string api_type { get; set; } = "game";
+        }
+
+        public class CreateApiKeyResponse : LootLockerResponse
+        {
+            public string api_key { get; set; }
+        }
+
+        public static void CreateKey(string keyName, int gameId, Action<CreateApiKeyResponse> onComplete)
+        {
+            if (string.IsNullOrEmpty(LootLockerConfig.current.adminToken))
+            {
+                // Not signed in
+                onComplete?.Invoke(new CreateApiKeyResponse { success = false, errorData = new LootLockerErrorData{message = "Not logged in"}});
+                return;
+            }
+
+            EndPointClass endPoint = LootLockerTestConfigurationEndpoints.CreateKey;
+            var formattedEndpoint = string.Format(endPoint.endPoint, gameId);
+
+            CreateApiKeyRequest request = new CreateApiKeyRequest { name = keyName };
+
+            string json = LootLockerJson.SerializeObject(request);
+
+            LootLockerAdminRequest.Send(formattedEndpoint, endPoint.httpMethod, json,
+                onComplete: (serverResponse) => LootLockerResponse.Deserialize(onComplete, serverResponse), true);
+        }
+    }
+}

Tests/LootLockerTestUtils.meta

@@ -0,0 +1,44 @@
+using LootLocker;
+using LootLocker.Requests;
+using System;
+using System.Collections.Generic;
+using Debug = UnityEngine.Debug;
+
+namespace LootLockerTestConfigurationUtils
+{
+
+    public class LootLockerTestAssetResponse : LootLockerResponse
+    {
+        public LootLockerCommonAsset asset { get; set; }
+    }
+
+    public class LootLockerRewardResponse : LootLockerResponse
+    {
+        public string id { get; set; }
+    }
+
+    public class LootLockerRewardRequest
+    {
+        public string entity_id { get; set; }
+        public string entity_kind { get; set;}
+    }
+
+    public class LootLockerTestContextResponse : LootLockerResponse
+    {
+        public LootLockerTestContext[] contexts { get; set; }
+    }
+
+    public class LootLockerTestContext
+    {
+        public int id { get; set; }
+        public string uuid { get; set; }
+        public string name { get; set; }
+    }
+
+    public class CreateLootLockerTestAsset
+    {
+        public int context_id { get; set; }
+        public string name { get; set; }
+    }
+
+}