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 +++++++++++++++++++++
 2 files changed, 120 insertions(+)
 create mode 100644 src/SMAPI.Tests.ModApiProvider/Framework/BaseApi.cs
 create mode 100644 src/SMAPI.Tests.ModApiProvider/Framework/SimpleApi.cs

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

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);
+        }
+    }
+}
-- 
cgit 


From 2e7c233f6c9bf6430672b39f970a3324deba79dd Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Wed, 6 Apr 2022 21:48:55 -0400
Subject: enable nullable annotations by default (#837)

This adds `#nullable disable` to all existing code (except where null is impossible like enum files), so it can be migrated incrementally.
---
 src/SMAPI.Tests.ModApiProvider/Framework/BaseApi.cs   | 2 ++
 src/SMAPI.Tests.ModApiProvider/Framework/SimpleApi.cs | 2 ++
 2 files changed, 4 insertions(+)

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

diff --git a/src/SMAPI.Tests.ModApiProvider/Framework/BaseApi.cs b/src/SMAPI.Tests.ModApiProvider/Framework/BaseApi.cs
index 8092e3e7..b5870baa 100644
--- a/src/SMAPI.Tests.ModApiProvider/Framework/BaseApi.cs
+++ b/src/SMAPI.Tests.ModApiProvider/Framework/BaseApi.cs
@@ -1,3 +1,5 @@
+#nullable disable
+
 namespace SMAPI.Tests.ModApiProvider.Framework
 {
     /// <summary>The base class for <see cref="SimpleApi"/>.</summary>
diff --git a/src/SMAPI.Tests.ModApiProvider/Framework/SimpleApi.cs b/src/SMAPI.Tests.ModApiProvider/Framework/SimpleApi.cs
index 1100af36..82e902f5 100644
--- a/src/SMAPI.Tests.ModApiProvider/Framework/SimpleApi.cs
+++ b/src/SMAPI.Tests.ModApiProvider/Framework/SimpleApi.cs
@@ -1,3 +1,5 @@
+#nullable disable
+
 using System;
 using System.Collections.Generic;
 using System.Reflection;
-- 
cgit 


From 5f7a92a74592a53529890eebb1ee9fe519afd92f Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Tue, 12 Apr 2022 20:52:01 -0400
Subject: enable nullable annotations in unit tests (#837)

---
 src/SMAPI.Tests.ModApiProvider/Framework/BaseApi.cs   |  4 +---
 src/SMAPI.Tests.ModApiProvider/Framework/SimpleApi.cs | 12 ++++++------
 2 files changed, 7 insertions(+), 9 deletions(-)

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

diff --git a/src/SMAPI.Tests.ModApiProvider/Framework/BaseApi.cs b/src/SMAPI.Tests.ModApiProvider/Framework/BaseApi.cs
index b5870baa..77001e4c 100644
--- a/src/SMAPI.Tests.ModApiProvider/Framework/BaseApi.cs
+++ b/src/SMAPI.Tests.ModApiProvider/Framework/BaseApi.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 namespace SMAPI.Tests.ModApiProvider.Framework
 {
     /// <summary>The base class for <see cref="SimpleApi"/>.</summary>
@@ -9,6 +7,6 @@ namespace SMAPI.Tests.ModApiProvider.Framework
         ** Test interface
         *********/
         /// <summary>A property inherited from a base class.</summary>
-        public string InheritedProperty { get; set; }
+        public string? InheritedProperty { get; set; }
     }
 }
diff --git a/src/SMAPI.Tests.ModApiProvider/Framework/SimpleApi.cs b/src/SMAPI.Tests.ModApiProvider/Framework/SimpleApi.cs
index 82e902f5..e7e1ccef 100644
--- a/src/SMAPI.Tests.ModApiProvider/Framework/SimpleApi.cs
+++ b/src/SMAPI.Tests.ModApiProvider/Framework/SimpleApi.cs
@@ -1,4 +1,4 @@
-#nullable disable
+// ReSharper disable UnusedMember.Global -- used dynamically through proxies
 
 using System;
 using System.Collections.Generic;
@@ -16,7 +16,7 @@ namespace SMAPI.Tests.ModApiProvider.Framework
         ** Events
         ****/
         /// <summary>A simple event field.</summary>
-        public event EventHandler<int> OnEventRaised;
+        public event EventHandler<int>? OnEventRaised;
 
         /// <summary>A simple event property with custom add/remove logic.</summary>
         public event EventHandler<int> OnEventRaisedProperty
@@ -33,16 +33,16 @@ namespace SMAPI.Tests.ModApiProvider.Framework
         public int NumberProperty { get; set; }
 
         /// <summary>A simple object property.</summary>
-        public object ObjectProperty { get; set; }
+        public object? ObjectProperty { get; set; }
 
         /// <summary>A simple list property.</summary>
-        public List<string> ListProperty { get; set; }
+        public List<string>? ListProperty { get; set; }
 
         /// <summary>A simple list property with an interface.</summary>
-        public IList<string> ListPropertyWithInterface { get; set; }
+        public IList<string>? ListPropertyWithInterface { get; set; }
 
         /// <summary>A property with nested generics.</summary>
-        public IDictionary<string, IList<string>> GenericsProperty { get; set; }
+        public IDictionary<string, IList<string>>? GenericsProperty { get; set; }
 
         /// <summary>A property using an enum available to both mods.</summary>
         public BindingFlags EnumProperty { get; set; }
-- 
cgit 


From 20224d293d03d34860505980cabdb4bc5cf13319 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Sat, 16 Apr 2022 16:59:53 -0400
Subject: add unit test for proxied out parameters

---
 src/SMAPI.Tests.ModApiProvider/Framework/SimpleApi.cs | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

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

diff --git a/src/SMAPI.Tests.ModApiProvider/Framework/SimpleApi.cs b/src/SMAPI.Tests.ModApiProvider/Framework/SimpleApi.cs
index e7e1ccef..c8781da5 100644
--- a/src/SMAPI.Tests.ModApiProvider/Framework/SimpleApi.cs
+++ b/src/SMAPI.Tests.ModApiProvider/Framework/SimpleApi.cs
@@ -3,6 +3,7 @@
 using System;
 using System.Collections.Generic;
 using System.Reflection;
+using StardewModdingAPI.Utilities;
 
 namespace SMAPI.Tests.ModApiProvider.Framework
 {
@@ -96,6 +97,20 @@ namespace SMAPI.Tests.ModApiProvider.Framework
             return value;
         }
 
+        /// <summary>A simple method which returns out parameters.</summary>
+        public bool TryGetOutParameter(int inputNumber, out int outNumber, out string outString, out PerScreen<int> outReference, out IDictionary<int, PerScreen<int>> outComplexType)
+        {
+            outNumber = inputNumber;
+            outString = inputNumber.ToString();
+            outReference = new PerScreen<int>(() => inputNumber);
+            outComplexType = new Dictionary<int, PerScreen<int>>
+            {
+                [inputNumber] = new PerScreen<int>(() => inputNumber)
+            };
+
+            return true;
+        }
+
 
         /*********
         ** Helper methods
-- 
cgit