unity-mcp/TestProjects/UnityMCPTests/Assets/Tests/EditMode/MCPToolParameterTests.cs

169 lines
7.1 KiB
C#
Raw Normal View History

Harden MCP tool parameter handling + add material workflow tests (TDD) (#343) * Add TDD tests for MCP material management issues - MCPMaterialTests.cs: Tests for material creation, assignment, and data reading - MCPParameterHandlingTests.cs: Tests for JSON parameter parsing issues - SphereMaterialWorkflowTests.cs: Tests for complete sphere material workflow These tests document the current issues with: - JSON parameter parsing in manage_asset and manage_gameobject tools - Material creation with properties - Material assignment to GameObjects - Material component data reading All tests currently fail (Red phase of TDD) and serve as specifications for what needs to be fixed in the MCP system. * Refine TDD tests to focus on actual MCP tool parameter parsing issues - Removed redundant tests that verify working functionality (GameObjectSerializer, Unity APIs) - Kept focused tests that document the real issue: MCP tool parameter validation - Tests now clearly identify the root cause: JSON string parsing in MCP tools - Tests specify exactly what needs to be fixed: parameter type flexibility The issue is NOT in Unity APIs or serialization (which work fine), but in MCP tool parameter validation being too strict. * Fix port discovery protocol mismatch - Update _try_probe_unity_mcp to recognize Unity bridge welcome message - Unity bridge sends 'WELCOME UNITY-MCP' instead of JSON pong response - Maintains backward compatibility with JSON pong format - Fixes MCP server connection to Unity Editor * Resolve merge: unify manage_gameobject param coercion and schema widening * Tests: add MaterialParameterToolTests; merge port probe fix; widen tool schemas for JSON-string params * refactor: extract JSON coercion helper; docs + exception narrowing\nfix: fail fast on bad component_properties JSON\ntest: unify setup, avoid test-to-test calls\nchore: use relative MCP package path * chore(tests): track MCPToolParameterTests.cs.meta to keep GUID stable * test: decouple MaterialParameterToolTests with helpers (no inter-test calls)
2025-10-24 08:57:27 +08:00
using NUnit.Framework;
using UnityEngine;
using UnityEngine.TestTools;
using System.Collections;
using UnityEditor;
using Newtonsoft.Json.Linq;
using MCPForUnity.Editor.Tools;
using System;
namespace Tests.EditMode
{
/// <summary>
/// Tests specifically for MCP tool parameter handling issues.
/// These tests focus on the actual problems we encountered:
/// 1. JSON parameter parsing in manage_asset and manage_gameobject tools
/// 2. Material creation with properties through MCP tools
/// 3. Material assignment through MCP tools
/// </summary>
public class MCPToolParameterTests
{
private const string TempDir = "Assets/Temp/MCPToolParameterTests";
[SetUp]
public void SetUp()
{
if (!AssetDatabase.IsValidFolder("Assets/Temp"))
{
AssetDatabase.CreateFolder("Assets", "Temp");
}
if (!AssetDatabase.IsValidFolder(TempDir))
{
AssetDatabase.CreateFolder("Assets/Temp", "MCPToolParameterTests");
}
}
[Test]
public void Test_ManageAsset_ShouldAcceptJSONProperties()
{
var matPath = $"{TempDir}/JsonMat_{Guid.NewGuid().ToString("N")}.mat";
// Build params with properties as a JSON string (to be coerced)
var p = new JObject
{
["action"] = "create",
["path"] = matPath,
["assetType"] = "Material",
["properties"] = "{\"shader\": \"Universal Render Pipeline/Lit\", \"color\": [0,0,1,1]}"
};
try
{
var raw = ManageAsset.HandleCommand(p);
var result = raw as JObject ?? JObject.FromObject(raw);
Assert.IsNotNull(result, "Handler should return a JObject result");
Assert.IsTrue(result!.Value<bool>("success"), result.ToString());
var mat = AssetDatabase.LoadAssetAtPath<Material>(matPath);
Assert.IsNotNull(mat, "Material should be created at path");
if (mat.HasProperty("_Color"))
{
Assert.AreEqual(Color.blue, mat.GetColor("_Color"));
}
}
finally
{
if (AssetDatabase.LoadAssetAtPath<UnityEngine.Object>(matPath) != null)
{
AssetDatabase.DeleteAsset(matPath);
}
AssetDatabase.Refresh();
}
}
[Test]
public void Test_ManageGameObject_ShouldAcceptJSONComponentProperties()
{
var matPath = $"{TempDir}/JsonMat_{Guid.NewGuid().ToString("N")}.mat";
// Create a material first (object-typed properties)
var createMat = new JObject
{
["action"] = "create",
["path"] = matPath,
["assetType"] = "Material",
["properties"] = new JObject { ["shader"] = "Universal Render Pipeline/Lit", ["color"] = new JArray(0,0,1,1) }
};
var createMatRes = ManageAsset.HandleCommand(createMat);
var createMatObj = createMatRes as JObject ?? JObject.FromObject(createMatRes);
Assert.IsTrue(createMatObj.Value<bool>("success"), createMatObj.ToString());
// Create a sphere
var createGo = new JObject { ["action"] = "create", ["name"] = "MCPParamTestSphere", ["primitiveType"] = "Sphere" };
var createGoRes = ManageGameObject.HandleCommand(createGo);
var createGoObj = createGoRes as JObject ?? JObject.FromObject(createGoRes);
Assert.IsTrue(createGoObj.Value<bool>("success"), createGoObj.ToString());
try
{
// Assign material via JSON string componentProperties (coercion path)
var compJsonObj = new JObject { ["MeshRenderer"] = new JObject { ["sharedMaterial"] = matPath } };
var compJson = compJsonObj.ToString(Newtonsoft.Json.Formatting.None);
var modify = new JObject
{
["action"] = "modify",
["target"] = "MCPParamTestSphere",
["searchMethod"] = "by_name",
["componentProperties"] = compJson
};
var raw = ManageGameObject.HandleCommand(modify);
var result = raw as JObject ?? JObject.FromObject(raw);
Assert.IsTrue(result.Value<bool>("success"), result.ToString());
}
finally
{
var go = GameObject.Find("MCPParamTestSphere");
if (go != null) UnityEngine.Object.DestroyImmediate(go);
if (AssetDatabase.LoadAssetAtPath<UnityEngine.Object>(matPath) != null) AssetDatabase.DeleteAsset(matPath);
AssetDatabase.Refresh();
}
}
[Test]
public void Test_JSONParsing_ShouldWorkInMCPTools()
{
var matPath = $"{TempDir}/JsonMat_{Guid.NewGuid().ToString("N")}.mat";
// manage_asset with JSON string properties (coercion path)
var createMat = new JObject
{
["action"] = "create",
["path"] = matPath,
["assetType"] = "Material",
["properties"] = "{\"shader\": \"Universal Render Pipeline/Lit\", \"color\": [0,0,1,1]}"
};
var createResRaw = ManageAsset.HandleCommand(createMat);
var createRes = createResRaw as JObject ?? JObject.FromObject(createResRaw);
Assert.IsTrue(createRes.Value<bool>("success"), createRes.ToString());
// Create sphere and assign material (object-typed componentProperties)
var go = new JObject { ["action"] = "create", ["name"] = "MCPParamJSONSphere", ["primitiveType"] = "Sphere" };
var goRes = ManageGameObject.HandleCommand(go);
var goObj = goRes as JObject ?? JObject.FromObject(goRes);
Assert.IsTrue(goObj.Value<bool>("success"), goObj.ToString());
try
{
var compJsonObj = new JObject { ["MeshRenderer"] = new JObject { ["sharedMaterial"] = matPath } };
var compJson = compJsonObj.ToString(Newtonsoft.Json.Formatting.None);
var modify = new JObject
{
["action"] = "modify",
["target"] = "MCPParamJSONSphere",
["searchMethod"] = "by_name",
["componentProperties"] = compJson
};
var modResRaw = ManageGameObject.HandleCommand(modify);
var modRes = modResRaw as JObject ?? JObject.FromObject(modResRaw);
Assert.IsTrue(modRes.Value<bool>("success"), modRes.ToString());
}
finally
{
var goObj2 = GameObject.Find("MCPParamJSONSphere");
if (goObj2 != null) UnityEngine.Object.DestroyImmediate(goObj2);
if (AssetDatabase.LoadAssetAtPath<UnityEngine.Object>(matPath) != null) AssetDatabase.DeleteAsset(matPath);
AssetDatabase.Refresh();
}
}
}
}