From 3064b58719060a145058ab295792d8c97128b433 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Thu, 10 Feb 2022 22:03:09 -0500
Subject: add basic unit tests for API interface proxying

---
 .../Framework/BaseApi.cs                           |  12 +++
 .../Framework/SimpleApi.cs                         | 108 +++++++++++++++++++++
 src/SMAPI.Tests.ModApiProvider/ProviderMod.cs      |  38 ++++++++
 src/SMAPI.Tests.ModApiProvider/README.md           |   3 +
 .../SMAPI.Tests.ModApiProvider.csproj              |   7 ++
 5 files changed, 168 insertions(+)
 create mode 100644 src/SMAPI.Tests.ModApiProvider/Framework/BaseApi.cs
 create mode 100644 src/SMAPI.Tests.ModApiProvider/Framework/SimpleApi.cs
 create mode 100644 src/SMAPI.Tests.ModApiProvider/ProviderMod.cs
 create mode 100644 src/SMAPI.Tests.ModApiProvider/README.md
 create mode 100644 src/SMAPI.Tests.ModApiProvider/SMAPI.Tests.ModApiProvider.csproj

(limited to 'src/SMAPI.Tests.ModApiProvider')

diff --git a/src/SMAPI.Tests.ModApiProvider/Framework/BaseApi.cs b/src/SMAPI.Tests.ModApiProvider/Framework/BaseApi.cs
new file mode 100644
index 00000000..8092e3e7
--- /dev/null
+++ b/src/SMAPI.Tests.ModApiProvider/Framework/BaseApi.cs
@@ -0,0 +1,12 @@
+namespace SMAPI.Tests.ModApiProvider.Framework
+{
+    /// <summary>The base class for <see cref="SimpleApi"/>.</summary>
+    public class BaseApi
+    {
+        /*********
+        ** Test interface
+        *********/
+        /// <summary>A property inherited from a base class.</summary>
+        public string InheritedProperty { get; set; }
+    }
+}
diff --git a/src/SMAPI.Tests.ModApiProvider/Framework/SimpleApi.cs b/src/SMAPI.Tests.ModApiProvider/Framework/SimpleApi.cs
new file mode 100644
index 00000000..1100af36
--- /dev/null
+++ b/src/SMAPI.Tests.ModApiProvider/Framework/SimpleApi.cs
@@ -0,0 +1,108 @@
+using System;
+using System.Collections.Generic;
+using System.Reflection;
+
+namespace SMAPI.Tests.ModApiProvider.Framework
+{
+    /// <summary>A mod-provided API which provides basic events, properties, and methods.</summary>
+    public class SimpleApi : BaseApi
+    {
+        /*********
+        ** Test interface
+        *********/
+        /****
+        ** Events
+        ****/
+        /// <summary>A simple event field.</summary>
+        public event EventHandler<int> OnEventRaised;
+
+        /// <summary>A simple event property with custom add/remove logic.</summary>
+        public event EventHandler<int> OnEventRaisedProperty
+        {
+            add => this.OnEventRaised += value;
+            remove => this.OnEventRaised -= value;
+        }
+
+
+        /****
+        ** Properties
+        ****/
+        /// <summary>A simple numeric property.</summary>
+        public int NumberProperty { get; set; }
+
+        /// <summary>A simple object property.</summary>
+        public object ObjectProperty { get; set; }
+
+        /// <summary>A simple list property.</summary>
+        public List<string> ListProperty { get; set; }
+
+        /// <summary>A simple list property with an interface.</summary>
+        public IList<string> ListPropertyWithInterface { get; set; }
+
+        /// <summary>A property with nested generics.</summary>
+        public IDictionary<string, IList<string>> GenericsProperty { get; set; }
+
+        /// <summary>A property using an enum available to both mods.</summary>
+        public BindingFlags EnumProperty { get; set; }
+
+        /// <summary>A read-only property.</summary>
+        public int GetterProperty => 42;
+
+
+        /****
+        ** Methods
+        ****/
+        /// <summary>A simple method with no return value.</summary>
+        public void GetNothing() { }
+
+        /// <summary>A simple method which returns a number.</summary>
+        public int GetInt(int value)
+        {
+            return value;
+        }
+
+        /// <summary>A simple method which returns an object.</summary>
+        public object GetObject(object value)
+        {
+            return value;
+        }
+
+        /// <summary>A simple method which returns a list.</summary>
+        public List<string> GetList(string value)
+        {
+            return new() { value };
+        }
+
+        /// <summary>A simple method which returns a list with an interface.</summary>
+        public IList<string> GetListWithInterface(string value)
+        {
+            return new List<string> { value };
+        }
+
+        /// <summary>A simple method which returns nested generics.</summary>
+        public IDictionary<string, IList<string>> GetGenerics(string key, string value)
+        {
+            return new Dictionary<string, IList<string>>
+            {
+                [key] = new List<string> { value }
+            };
+        }
+
+        /// <summary>A simple method which returns a lambda.</summary>
+        public Func<string, string> GetLambda(Func<string, string> value)
+        {
+            return value;
+        }
+
+
+        /*********
+        ** Helper methods
+        *********/
+        /// <summary>Raise the <see cref="OnEventRaised"/> event.</summary>
+        /// <param name="value">The value to pass to the event.</param>
+        public void RaiseEventField(int value)
+        {
+            this.OnEventRaised?.Invoke(null, value);
+        }
+    }
+}
diff --git a/src/SMAPI.Tests.ModApiProvider/ProviderMod.cs b/src/SMAPI.Tests.ModApiProvider/ProviderMod.cs
new file mode 100644
index 00000000..c36e1c6d
--- /dev/null
+++ b/src/SMAPI.Tests.ModApiProvider/ProviderMod.cs
@@ -0,0 +1,38 @@
+using System.Collections.Generic;
+using System.Reflection;
+using SMAPI.Tests.ModApiProvider.Framework;
+
+namespace SMAPI.Tests.ModApiProvider
+{
+    /// <summary>A simulated mod instance.</summary>
+    public class ProviderMod
+    {
+        /// <summary>The underlying API instance.</summary>
+        private readonly SimpleApi Api = new();
+
+        /// <summary>Get the mod API instance.</summary>
+        public object GetModApi()
+        {
+            return this.Api;
+        }
+
+        /// <summary>Raise the <see cref="SimpleApi.OnEventRaised"/> event.</summary>
+        /// <param name="value">The value to send as an event argument.</param>
+        public void RaiseEvent(int value)
+        {
+            this.Api.RaiseEventField(value);
+        }
+
+        /// <summary>Set the values for the API property.</summary>
+        public void SetPropertyValues(int number, object obj, string listValue, string listWithInterfaceValue, string dictionaryKey, string dictionaryListValue, BindingFlags enumValue, string inheritedValue)
+        {
+            this.Api.NumberProperty = number;
+            this.Api.ObjectProperty = obj;
+            this.Api.ListProperty = new List<string> { listValue };
+            this.Api.ListPropertyWithInterface = new List<string> { listWithInterfaceValue };
+            this.Api.GenericsProperty = new Dictionary<string, IList<string>> { [dictionaryKey] = new List<string> { dictionaryListValue } };
+            this.Api.EnumProperty = enumValue;
+            this.Api.InheritedProperty = inheritedValue;
+        }
+    }
+}
diff --git a/src/SMAPI.Tests.ModApiProvider/README.md b/src/SMAPI.Tests.ModApiProvider/README.md
new file mode 100644
index 00000000..c79838e0
--- /dev/null
+++ b/src/SMAPI.Tests.ModApiProvider/README.md
@@ -0,0 +1,3 @@
+This project contains simulated [mod-provided APIs] used in the API proxying unit tests.
+
+[mod-provided APIs]: https://stardewvalleywiki.com/Modding:Modder_Guide/APIs/Integrations
diff --git a/src/SMAPI.Tests.ModApiProvider/SMAPI.Tests.ModApiProvider.csproj b/src/SMAPI.Tests.ModApiProvider/SMAPI.Tests.ModApiProvider.csproj
new file mode 100644
index 00000000..70d5a0ce
--- /dev/null
+++ b/src/SMAPI.Tests.ModApiProvider/SMAPI.Tests.ModApiProvider.csproj
@@ -0,0 +1,7 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFramework>net5.0</TargetFramework>
+  </PropertyGroup>
+
+  <Import Project="..\..\build\common.targets" />
+</Project>
-- 
cgit