GD-352: Add support testing Godot Plugins `@tool` classes

[MarcMenghin]

Feature Type

API/Framework enhancement

Problem/Use Case

I am in the process of writing a Godot Editor Plugin. Some functionality can be tested fine with gdUnit, which is great. But I am missing the ability to test Godot Editor specific code parts (from C#). It seems this is not supported right now.

Proposed Solution

Similarly to the currently provided [RequireGodotRuntime] there could be a [RequireGodotEditor]. And if set on a test it ideally executes in a new Godot Editor instance. It might only be possible to execute such tests from an IDE, which would be sufficient.

Alternatives Considered

No response

Impact and Benefits

Possibility to see if activation and deactivation of a written plugin works as expected. Furthermore, integration into the Godot Editor UI could be tested.

Implementation Notes

No response

Examples and References

No response

Contribution

• I'm willing to contribute code for this feature
• I'm willing to help with testing/feedback
• I'm willing to help with documentation
• I would just like to request this feature

[MikeSchulze]

Hi, can you describe more in detail what and how you want to test it.
Only a new annotation would not help, because [RequireGodotRuntime] is already starting the Godot editor.

[MarcMenghin]

My Test fails to call EditorInterface.Singleton.IsPluginEnabled(..) with an exception "Object reference not set to an instance of an object". Which I assume is because the Test runs in the runtime and not the editor.

The plugin I am writing manages other plugins in the editor. I would like to write integration Tests that show that my plugin will correctly list, activate and deactivate other plugins.

Not working minimal sample test

[TestSuite]
public class EditorTests
{

    [TestCase]
    [RequireGodotRuntime]
    public void IsPluginEnabled()
    {
        var result = EditorInterface.Singleton.IsPluginEnabled("gdUnit4");
        AssertThat(result).IsTrue();
    }
}

[MikeSchulze]

I would say you can't call EditorInterface.Singleton because it needs the tooling annotation.
But I understand now your issue, I need time to dive into this topic.