[dotnet] Added tests, fixed bugs #17979

stephen-hawley · 2023-04-05T20:05:34Z

Stunt testing!

What happens is this: we write a string of C# to a file. This C# acts as a mock of the ObjCRuntime namespace it also includes a one or more classes that act internally like NSObject descendants at least as far as the class_ptr field is concerned.

The test compiles this code, runs the rewriter, then executes the final code collecting the output.
The tests include the following:

tool not run, code works as expected
tool run, ClassHandle now returns a different value
tool run, a class not listed for changing stays the same
tool run on a more authentic cctor, the cctor gets removed entirely

The code to run a process and collect its output was taken from the binding-tools-for-swift tests.

All tests pass.

github-actions · 2023-04-05T20:09:43Z

⚠️ Your code has been reformatted. ⚠️

If this is not desired, add the actions-disable-autoformat label, and revert the reformatting commit.

If files unrelated to your change were modified, try reverting the reformatting commit + merging with the target branch (and push those changes).

tj-devel709

Few very small things, but otherwise LGTM :)

tj-devel709 · 2023-04-06T20:55:14Z

tools/class-redirector/class-redirector-tests/Compiler.cs

+		Directory.CreateDirectory (path);
+		return path;
+	}
+


Suggested change

nit: reformatter may grab this :)

tj-devel709 · 2023-04-06T20:56:11Z

tools/class-redirector/class-redirector-tests/Compiler.cs

+		if (workingDirectory != null)
+			info.WorkingDirectory = workingDirectory;
+
+		if (output == null)


Suggested change

if (output == null)

if (output is null)

tj-devel709 · 2023-04-06T20:56:23Z

tools/class-redirector/class-redirector-tests/Compiler.cs

+		info.RedirectStandardInput = false;
+		info.RedirectStandardOutput = true;
+		info.RedirectStandardError = true;
+		if (workingDirectory != null)


Suggested change

if (workingDirectory != null)

if (workingDirectory is not null)

tj-devel709 · 2023-04-06T20:56:43Z

tools/class-redirector/class-redirector-tests/Compiler.cs

+		if (output == null)
+			output = new StringBuilder ();
+
+		if (env != null) {


Suggested change

if (env != null) {

if (env is not null) {

tj-devel709 · 2023-04-06T20:56:54Z

tools/class-redirector/class-redirector-tests/Compiler.cs

+
+		if (env != null) {
+			foreach (var kvp in env) {
+				if (kvp.Value == null) {


Suggested change

if (kvp.Value == null) {

if (kvp.Value is null) {

…n-macios into moar-tests

rolfbjarne · 2023-04-10T14:50:24Z

tools/class-redirector/class-redirector-tests/Compiler.cs

+	static string GetTempDirectory ()
+	{
+		var unique = Interlocked.Increment (ref counter).ToString ();
+		var path = Path.Combine (root, unique);
+		Directory.CreateDirectory (path);
+		return path;
+	}


Use Cache.CreateTemporaryDirectory instead:

xamarin-macios/tests/mtouch/Cache.cs

Line 47 in ada4d2c

public static string CreateTemporaryDirectory (string? name = null)

rolfbjarne · 2023-04-10T14:51:47Z

tools/class-redirector/class-redirector-tests/Compiler.cs

+	public static string Run (string path, string args, string? workingDirectory = null, bool verbose = false)
+	{
+		var output = new StringBuilder ();
+		var exitCode = RunCommand (path, args, output: output, verbose: verbose, workingDirectory: workingDirectory);
+		if (exitCode != 0)
+			throw new Exception ($"Failed to execute (exit code {exitCode}): {path} {string.Join (" ", args)}\n{output.ToString ()}");
+		return output.ToString ();
+	}
+
+	static void ReadStream (Stream stream, StringBuilder sb, ManualResetEvent completed)
+	{
+		var encoding = Encoding.UTF8;
+		var decoder = encoding.GetDecoder ();
+		var buffer = new byte [1024];
+		var characters = new char [encoding.GetMaxCharCount (buffer.Length)];
+
+		AsyncCallback? callback = null;
+		callback = new AsyncCallback ((IAsyncResult ar) => {
+			var read = stream.EndRead (ar);
+
+			var chars = decoder.GetChars (buffer, 0, read, characters, 0);
+			lock (sb)
+				sb.Append (characters, 0, chars);
+
+			if (read > 0) {
+				stream.BeginRead (buffer, 0, buffer.Length, callback, null);
+			} else {
+				completed.Set ();
+			}
+		});
+		stream.BeginRead (buffer, 0, buffer.Length, callback, null);
+	}
+
+	public static int RunCommand (string path, string args, IDictionary<string, string>? env = null, StringBuilder? output = null, bool verbose = false, string? workingDirectory = null)
+	{
+		var info = new ProcessStartInfo (path, args);
+		info.UseShellExecute = false;
+		info.RedirectStandardInput = false;
+		info.RedirectStandardOutput = true;
+		info.RedirectStandardError = true;
+		if (workingDirectory is not null)
+			info.WorkingDirectory = workingDirectory;
+
+		if (output is null)
+			output = new StringBuilder ();
+
+		if (env is not null) {
+			foreach (var kvp in env) {
+				if (kvp.Value is null) {
+					if (info.EnvironmentVariables.ContainsKey (kvp.Key))
+						info.EnvironmentVariables.Remove (kvp.Key);
+				} else {
+					info.EnvironmentVariables [kvp.Key] = kvp.Value;
+				}
+			}
+		}
+
+		if (verbose) {
+			var envOut = new StringBuilder ();
+			foreach (var k in info.EnvironmentVariables.Keys) {
+				if (k is string key) {
+					var value = info.EnvironmentVariables [key];
+					envOut.AppendLine ($"export {key}={value}");
+				}
+			}
+			envOut.AppendLine ($"{path} {args}");
+			Console.Write (envOut.ToString ());
+			Console.WriteLine ("{0} {1}", path, args);
+		}
+
+		using (var p = Process.Start (info)) {
+			var error_output = new StringBuilder ();
+			var stdout_completed = new ManualResetEvent (false);
+			var stderr_completed = new ManualResetEvent (false);
+
+			ReadStream (p.StandardOutput.BaseStream, output, stdout_completed);
+			ReadStream (p.StandardError.BaseStream, error_output, stderr_completed);
+
+			p.WaitForExit ();
+
+			stderr_completed.WaitOne (TimeSpan.FromMinutes (1));
+			stdout_completed.WaitOne (TimeSpan.FromMinutes (1));
+
+			if (verbose) {
+				if (output.Length > 0)
+					Console.WriteLine (output);
+				if (error_output.Length > 0)
+					Console.WriteLine (error_output);
+				if (p.ExitCode != 0)
+					Console.Error.WriteLine ($"Process exited with code {p.ExitCode}");
+			}
+			if (p.ExitCode != 0 && error_output.Length > 0)
+				output.Append (error_output);
+			return p.ExitCode;
+		}
+	}


Use the Execution class in tools/common/Execution.cs instead:

xamarin-macios/tools/common/Execution.cs

Lines 185 to 190 in ada4d2c

public static Task<Execution> RunAsync (string filename, IList<string> arguments, Dictionary<string, string?>? environment = null, bool mergeOutput = false, string? workingDirectory = null, TextWriter? log = null, TimeSpan? timeout = null, CancellationToken? cancellationToken = null)

{

var standardOutput = new StringWriter ();

var standardError = mergeOutput ? standardOutput : new StringWriter ();

return RunAsync (filename, arguments, environment, standardOutput, standardError, log, workingDirectory, timeout, cancellationToken);

}

rolfbjarne · 2023-04-10T14:53:13Z

tools/class-redirector/class-redirector-tests/CompileResult.cs

+		static void DeleteDirectoryAndContents (string path)
+		{
+			var directories = new Stack<string> ();
+			directories.Push (path);
+			while (directories.Count > 0) {
+				var currDirectory = directories.Pop ();
+				PushAll (directories, Directory.EnumerateDirectories (currDirectory));
+				foreach (var file in Directory.EnumerateFiles (currDirectory))
+					File.Delete (file);
+				Directory.Delete (currDirectory);
+			}
+		}
+


This is unnecessary if you use Cache.CreateTemporaryDirectory (as suggested below)

rolfbjarne · 2023-04-14T09:05:01Z

tools/class-redirector/class-redirector-tests/Compiler.cs

+		using var writer = new StreamWriter (inputpath);
+		writer.Write (code);
+		writer.Flush ();


This is somewhat simpler:

Suggested change

using var writer = new StreamWriter (inputpath);

writer.Write (code);

writer.Flush ();

File.WriteAllText (inputPath, code);

Added tests, fixed bugs

781c1a0

stephen-hawley added not-notes-worthy Ignore for release notes dotnet An issue or pull request related to .NET (6) labels Apr 5, 2023

stephen-hawley self-assigned this Apr 5, 2023

Auto-format source code

d728b8a

This comment has been minimized.

Sign in to view

tj-devel709 reviewed Apr 6, 2023

View reviewed changes

stephen-hawley added 2 commits April 10, 2023 10:21

null tests

81310bf

Merge branch 'moar-tests' of https://github.com/stephen-hawley/xamari…

3dbeb08

…n-macios into moar-tests

rolfbjarne requested changes Apr 10, 2023

View reviewed changes

This comment has been minimized.

Sign in to view

use existing code

e64db85

This comment has been minimized.

Sign in to view

Merge branch 'main' into moar-tests

73ddc1b

This comment has been minimized.

Sign in to view

rolfbjarne approved these changes Apr 14, 2023

View reviewed changes

minor tweak

b504d13

stephen-hawley merged commit 7f82266 into xamarin:main Apr 14, 2023

stephen-hawley deleted the moar-tests branch April 14, 2023 14:16

	if (workingDirectory != null)
	if (workingDirectory is not null)

	public static Task<Execution> RunAsync (string filename, IList<string> arguments, Dictionary<string, string?>? environment = null, bool mergeOutput = false, string? workingDirectory = null, TextWriter? log = null, TimeSpan? timeout = null, CancellationToken? cancellationToken = null)
	{
	var standardOutput = new StringWriter ();
	var standardError = mergeOutput ? standardOutput : new StringWriter ();
	return RunAsync (filename, arguments, environment, standardOutput, standardError, log, workingDirectory, timeout, cancellationToken);
	}

[dotnet] Added tests, fixed bugs #17979

[dotnet] Added tests, fixed bugs #17979

Conversation

stephen-hawley commented Apr 5, 2023

github-actions bot commented Apr 5, 2023

⚠️ Your code has been reformatted. ⚠️

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

tj-devel709 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Choose a reason for hiding this comment