Merge pull request #36 from chrisyarbrough/#32-cant-open-project-on-windows

Fix #32 cant open project on windows

Author: chrisyarbrough

README.md

@@ -8,7 +8,7 @@ A terminal command to open Unity projects quickly from the command line.
 
 - macOS
 - Windows
-- Linux
+- Linux (TBD)
 
 ## Commands
 
@@ -44,32 +44,7 @@ If the `version` argument is omitted, an interactive prompt shows all installed
 
 ## Installation
 
-### NuGet Global Tool
-
-The easiest way to install `ucll` is as a .NET global tool via NuGet:
-
-```shell
-dotnet tool install --global UnityCommandLineLauncher
-```
-
-**Requirements:**
-- [.NET 10.0](https://dotnet.microsoft.com/download) or newer
-
-> If you don't want to install .NET just for this tool, you can use a self-contained (standalone) binary, see below.
-
-**Updating:**
-```shell
-dotnet tool update --global UnityCommandLineLauncher
-```
-
-**Uninstalling:**
-```shell
-dotnet tool uninstall --global UnityCommandLineLauncher
-```
-
-After installation, the `ucll` command will be available globally in your terminal.
-
-### From Source
+### From Source (recommended)
 
 1. Clone the repository.
 2. Checkout a release tag and take note of the signature, e.g. `git tag -v v1.0.0`.

src/ucll.build/Publishing.md

@@ -1,43 +1,14 @@
 # Publishing (for Maintainers)
 
-## GitHub Release (Self-Contained Binary)
-
-The GitHub `release.yml` workflow takes care of running this project to produce binaries for each platform and then
+The GitHub `release.yml` workflow takes care of running this project to produce binaries and then
 signs them before uploading a new release.
 
-If this is not available, and we need to publish locally:
+To publish locally:
+
 Install the `gpg` utility to let the publish process sign release artifacts with your personal key.
 
 ```shell
 dotnet run
 ```
 
-Artifacts are signed with the default key which you have configured (or the first secret key it finds).
-
-## Dotnet Tool
-
-```shell
-PACK_DIR=bin/pack
-BUILD_DIR=$PACK_DIR/build
-dotnet pack ../ucll/ucll.csproj \
-  -p:PackAsTool=true \
-  -p:ToolCommandName=ucll \
-  -p:PackageId=UnityCommandLineLauncher \
-  -p:Authors="Chris Yarbrough" \
-  -p:PackageLicenseExpression=MIT \
-  -p:PackageReadmeFile=README.md \
-  -p:PackageTags="Unity CLI Hub" \
-  -p:RepositoryUrl=https://github.com/chrisyarbrough/UnityCommandLineLauncher \
-  -p:RepositoryType=git \
-  -p:OutputPath=$BUILD_DIR \
-  -p:PublishDir=$BUILD_DIR \
-  --output ../ucll/$PACK_DIR
-```
-
-```shell
-dotnet nuget push ../ucll/bin/pack/UnityCommandLineLauncher.*.nupkg --api-key <your-key> --source https://apiint.nugettest.org/v3/index.json
-```
-
-```
-https://api.nuget.org/v3/index.json
-```
+Artifacts are signed with the default key which you have configured (or the first secret key it finds).

src/ucll.tests/PlatformSupportTests.cs

@@ -1,25 +1,16 @@
-using System.Runtime.InteropServices;
-
 public class PlatformSupportTests
 {
-	[Fact_PlatformOSX]
-	public void FindInstallationRootReturnsValidRoot()
+	[Theory]
+	[InlineData(typeof(MacSupport),
+		"/Applications/Unity/Hub/Editor/2022.3.10f1/Unity.app/Contents/MacOS/Unity",
+		"/Applications/Unity/Hub/Editor/2022.3.10f1")]
+	[InlineData(typeof(WindowsSupport),
+		@"C:\Program Files\Unity\Hub\Editor\6000.0.59f2\Editor\Unity.exe",
+		@"C:\Program Files\Unity\Hub\Editor\6000.0.59f2")]
+	public void FindInstallationRootReturnsValidRoot(Type platformSupportType, string editorPath, string expectedRoot)
 	{
-		PlatformSupport platformSupport = PlatformSupport.Create();
-		const string editorPath = "/Applications/Unity/Hub/Editor/2022.3.10f1/Unity.app/Contents/MacOS/Unity";
+		PlatformSupport platformSupport = (Activator.CreateInstance(platformSupportType) as PlatformSupport)!;
 		string root = platformSupport.FindInstallationRoot(editorPath);
-		Assert.Equal("/Applications/Unity/Hub/Editor/2022.3.10f1", root);
-	}
-
-	// ReSharper disable once InconsistentNaming
-	private sealed class Fact_PlatformOSX : FactAttribute
-	{
-		public Fact_PlatformOSX()
-		{
-			if (!RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
-			{
-				Skip = "Test only runs on macOS";
-			}
-		}
+		Assert.Equal(expectedRoot, root);
 	}
 }

src/ucll/Shared/Platform/LinuxSupport.cs

@@ -1,5 +1,10 @@
 internal sealed class LinuxSupport : PlatformSupport
 {
+	public override string FindInstallationRoot(string editorPath)
+	{
+		throw new NotImplementedException();
+	}
+
 	public override string FormatHubArgs(string args)
 		=> args; // Linux doesn't need the "--" prefix
 
@@ -11,8 +16,6 @@ public override ProcessStartInfo OpenFileWithApp(string filePath, string applica
 		return new ProcessStartInfo(applicationPath, filePath);
 	}
 
-	public override string RelativeEditorPathToExecutable => "Editor/Unity";
-
 	public override string UnityHubConfigDirectory => Path.Combine(UserHome, ".config/UnityHub");
 
 	public override ProcessStartInfo GetUnityProjectSearchProcess()

src/ucll/Shared/Platform/MacSupport.cs

@@ -8,7 +8,15 @@ public override ProcessStartInfo OpenFileWithApp(string filePath, string applica
 		return new ProcessStartInfo("open", $"-a \"{applicationPath}\" \"{filePath}\"");
 	}
 
-	public override string RelativeEditorPathToExecutable => "Contents/MacOS/Unity";
+	public override string FindInstallationRoot(string editorPath)
+	{
+		return editorPath.Replace("/Unity.app/Contents/MacOS/Unity", string.Empty);
+	}
+
+	public override string GetUnityExecutablePath(string path)
+	{
+		return Path.Combine(path, "Contents/MacOS/Unity");
+	}
 
 	public override string UnityHubConfigDirectory => Path.Combine(UserHome, "Library/Application Support/UnityHub");
 

src/ucll/Shared/Platform/PlatformSupport.cs

@@ -34,8 +34,7 @@ public static PlatformSupport Create()
 	/// <summary>
 	/// Given the path to an editor executable, returns the root directory path of the installation.
 	/// </summary>
-	public string FindInstallationRoot(string editorPath)
-		=> new DirectoryInfo(editorPath.Replace(RelativeEditorPathToExecutable, string.Empty)).Parent!.FullName;
+	public abstract string FindInstallationRoot(string editorPath);
 
 	/// <summary>
 	/// Path to the Unity Hub executable or null if it doesn't exist (or couldn't be found).
@@ -69,9 +68,9 @@ public string FindInstallationRoot(string editorPath)
 	public abstract ProcessStartInfo OpenFileWithApp(string filePath, string applicationPath);
 
 	/// <summary>
-	/// The path from the installation bundle (macOS) or root (Windows) to the executable.
+	/// Converts an installation bundle path (macOS) to a path to the binary, if needed.
 	/// </summary>
-	public abstract string RelativeEditorPathToExecutable { get; }
+	public virtual string GetUnityExecutablePath(string path) => path;
 
 	/// <summary>
 	/// The path to the directory that contains Unity Hub config files.

src/ucll/Shared/Platform/WindowsSupport.cs

@@ -12,7 +12,10 @@ public override ProcessStartInfo OpenFileWithApp(string filePath, string applica
 		return new ProcessStartInfo(applicationPath, $"\"{filePath}\"");
 	}
 
-	public override string RelativeEditorPathToExecutable => @"Editor\Unity.exe";
+	public override string FindInstallationRoot(string editorPath)
+	{
+		return editorPath.Replace(@"Editor\Unity.exe", string.Empty).TrimEnd('\\');
+	}
 
 	public override string UnityHubConfigDirectory =>
 		Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "UnityHub");

src/ucll/Shared/UnityHub.cs

@@ -23,18 +23,19 @@ internal class UnityHub(PlatformSupport platformSupport)
 	public string GetEditorPath(string version)
 	{
 		// Fast: try the default install location first.
-		string? executablePath = platformSupport.FindDefaultEditorPath(version);
-		if (executablePath != null)
-			return executablePath;
+		string? editorPathDefault = platformSupport.FindDefaultEditorPath(version);
+		if (editorPathDefault != null)
+			return editorPathDefault;
 
 		// Fallback: query Unity Hub for custom installation locations.
 		var editors = ListInstalledEditors();
-		string? appBundlePath = editors.FirstOrDefault(p => p.Version == version).Path;
+		string? editorPathHub = editors.FirstOrDefault(p => p.Version == version).Path;
 
-		if (appBundlePath == null)
+		if (editorPathHub == null)
 			throw new UserException($"Unity version {version} is not installed.");
 
-		return Path.Combine(appBundlePath, platformSupport.RelativeEditorPathToExecutable);
+		// On macOS, the Unity Hub returns a path to the app bundle (Unity.app), but we need the binary within.
+		return platformSupport.GetUnityExecutablePath(editorPathHub);
 	}
 
 	public IEnumerable<string> GetRecentProjects(bool favoriteOnly = false)

src/ucll/ucll.csproj

@@ -40,8 +40,4 @@
 	<ItemGroup>
 		<InternalsVisibleTo Include="ucll.Tests" />
 	</ItemGroup>
-
-	<ItemGroup>
-		<None Include="../../README.md" Pack="true" PackagePath="\" />
-	</ItemGroup>
 </Project>