Refuse a null chord in BindChord, ExecuteChord and FindCommandByChord whatever the profile [patch]

Keybinding.Test/NullChordArgumentTests.cs

@@ -0,0 +1,70 @@
+// Copyright (c) 2023-2026 ktsu-dev contributors
+
+namespace ktsu.Keybinding.Test;
+
+using ktsu.Keybinding.Core.Models;
+using ktsu.Keybinding.Core.Services;
+
+[TestClass]
+public class NullChordArgumentTests
+{
+	private ProfileManager _profiles = null!;
+	private CommandRegistry _commands = null!;
+	private KeybindingService _service = null!;
+
+	[TestInitialize]
+	public void Setup()
+	{
+		_profiles = new ProfileManager();
+		_commands = new CommandRegistry();
+		_commands.RegisterCommand(new Command("save", "Save"));
+		_service = new KeybindingService(_commands, _profiles);
+	}
+
+	[TestMethod]
+	public void ActiveProfileOverloads_NullChord_ThrowWithNoActiveProfile()
+	{
+		Assert.IsNull(_service.ActiveProfile);
+
+		Assert.ThrowsExactly<ArgumentNullException>(() => _service.BindChord("save", null!));
+		Assert.ThrowsExactly<ArgumentNullException>(() => _service.ExecuteChord(null!));
+		Assert.ThrowsExactly<ArgumentNullException>(() => _service.FindCommandByChord(null!));
+	}
+
+	[TestMethod]
+	public void ActiveProfileOverloads_NullChord_ThrowWithAnActiveProfile()
+	{
+		_profiles.CreateProfile("default", "Default");
+		_profiles.SetActiveProfile("default");
+		Assert.IsNotNull(_service.ActiveProfile);
+
+		Assert.ThrowsExactly<ArgumentNullException>(() => _service.BindChord("save", null!));
+		Assert.ThrowsExactly<ArgumentNullException>(() => _service.ExecuteChord(null!));
+		Assert.ThrowsExactly<ArgumentNullException>(() => _service.FindCommandByChord(null!));
+	}
+
+	[TestMethod]
+	[DataRow("")]
+	[DataRow("  ")]
+	[DataRow(null)]
+	[DataRow("missing")]
+	public void ProfileIdOverloads_NullChord_ThrowWhateverTheProfileId(string? profileId)
+	{
+		Assert.ThrowsExactly<ArgumentNullException>(() => _service.BindChord(profileId!, "save", null!));
+		Assert.ThrowsExactly<ArgumentNullException>(() => _service.ExecuteChord(profileId!, null!));
+		Assert.ThrowsExactly<ArgumentNullException>(() => _service.FindCommandByChord(profileId!, null!));
+	}
+
+	[TestMethod]
+	[DataRow("")]
+	[DataRow("  ")]
+	[DataRow(null)]
+	public void BindChord_NullChord_ThrowsWhateverTheCommandId(string? commandId)
+	{
+		_profiles.CreateProfile("default", "Default");
+		_profiles.SetActiveProfile("default");
+
+		Assert.ThrowsExactly<ArgumentNullException>(() => _service.BindChord(commandId!, null!));
+		Assert.ThrowsExactly<ArgumentNullException>(() => _service.BindChord(_service.ActiveProfile!.Id, commandId!, null!));
+	}
+}

Keybinding/Contracts/IKeybindingService.cs

@@ -60,6 +60,7 @@ public interface IKeybindingService
 	/// A chord runs one command per profile. Binding a chord that another command in the profile already uses
 	/// moves it: the other command loses that binding, as rebinding a shortcut does in most editors.
 	/// </remarks>
+	/// <exception cref="ArgumentNullException">Thrown when chord is null, whether or not a profile is active and whatever the profile ID</exception>
 	public bool BindChord(string commandId, Chord chord);
 
 	/// <summary>
@@ -73,6 +74,7 @@ public interface IKeybindingService
 	/// A chord runs one command per profile. Binding a chord that another command in the profile already uses
 	/// moves it: the other command loses that binding, as rebinding a shortcut does in most editors.
 	/// </remarks>
+	/// <exception cref="ArgumentNullException">Thrown when chord is null, whether or not a profile is active and whatever the profile ID</exception>
 	public bool BindChord(string profileId, string commandId, Chord chord);
 
 	/// <summary>
@@ -151,6 +153,7 @@ public interface IKeybindingService
 	/// </summary>
 	/// <param name="chord">The chord that was pressed</param>
 	/// <returns>The command ID that was executed, null if no binding found</returns>
+	/// <exception cref="ArgumentNullException">Thrown when chord is null, whether or not a profile is active and whatever the profile ID</exception>
 	public string? ExecuteChord(Chord chord);
 
 	/// <summary>
@@ -159,6 +162,7 @@ public interface IKeybindingService
 	/// <param name="profileId">The profile ID</param>
 	/// <param name="chord">The chord that was pressed</param>
 	/// <returns>The command ID that was executed, null if no binding found</returns>
+	/// <exception cref="ArgumentNullException">Thrown when chord is null, whether or not a profile is active and whatever the profile ID</exception>
 	public string? ExecuteChord(string profileId, Chord chord);
 
 	/// <summary>
@@ -182,6 +186,7 @@ public interface IKeybindingService
 	/// </summary>
 	/// <param name="chord">The chord to search for</param>
 	/// <returns>The command ID if found, null otherwise</returns>
+	/// <exception cref="ArgumentNullException">Thrown when chord is null, whether or not a profile is active and whatever the profile ID</exception>
 	public string? FindCommandByChord(Chord chord);
 
 	/// <summary>
@@ -191,5 +196,6 @@ public interface IKeybindingService
 	/// <param name="profileId">The profile ID</param>
 	/// <param name="chord">The chord to search for</param>
 	/// <returns>The command ID if found, null otherwise</returns>
+	/// <exception cref="ArgumentNullException">Thrown when chord is null, whether or not a profile is active and whatever the profile ID</exception>
 	public string? FindCommandByChord(string profileId, Chord chord);
 }

Keybinding/Services/KeybindingService.cs

@@ -36,7 +36,7 @@
 			throw new ArgumentException("Profile ID cannot be null or whitespace", nameof(id));
 		}
 
 		ArgumentException.ThrowIfNullOrWhiteSpace(name, nameof(name));
 
 		return _profileManager.CreateProfile(id, name, description);
 	}
@@ -52,13 +52,17 @@
 	/// <inheritdoc/>
 	public bool BindChord(string commandId, Chord chord)
 	{
+		Ensure.NotNull(chord);
+
 		Profile? activeProfile = _profileManager.GetActiveProfile();
 		return activeProfile is not null && BindChord(activeProfile.Id, commandId, chord);
 	}
 
 	/// <inheritdoc/>
 	public bool BindChord(string profileId, string commandId, Chord chord)
 	{
+		Ensure.NotNull(chord);
+
 		if (string.IsNullOrWhiteSpace(profileId))
 		{
 			return false;
@@ -69,8 +73,6 @@
 			return false;
 		}
 
-		Ensure.NotNull(chord);
-
 		Profile? profile = _profileManager.GetProfile(profileId);
 		if (profile is null)
 		{
@@ -201,6 +203,8 @@
 	/// <inheritdoc/>
 	public string? ExecuteChord(Chord chord)
 	{
+		Ensure.NotNull(chord);
+
 		Profile? activeProfile = _profileManager.GetActiveProfile();
 		return activeProfile is not null ? ExecuteChord(activeProfile.Id, chord) : null;
 	}
@@ -249,6 +253,8 @@
 	/// <inheritdoc/>
 	public string? FindCommandByChord(Chord chord)
 	{
+		Ensure.NotNull(chord);
+
 		Profile? activeProfile = _profileManager.GetActiveProfile();
 		return activeProfile is not null ? FindCommandByChord(activeProfile.Id, chord) : null;
 	}