GDScript-based unit testing #19

limbonaut · 2024-11-15T12:02:47Z

Adding gdUnit4 unit testing framework to the demo project and a couple of test suites. The framework supports headless mode, and has a marketplace CI action. However, it can't be deployed as a submodule, unless we use symlink (it's not cross-platform then).

Review notes: First commit is the framework source (those 26K lines is this commit alone).

EDIT:

Now importing as a submodule. See GDScript-based unit testing #19 (comment) below.
Creating a symlink for the testing framework during the build process on Linux and macOS.
- Creating an NTFS junction on Windows due to elevated permissions required for symlinks.

limbonaut · 2024-11-15T13:44:35Z

Can we use git-subtree as a potential alternative to submodule here?

bruno-garcia · 2024-11-15T19:47:47Z

Can we use git-subtree as a potential alternative to submodule here?

Doesn't look like we're using git submodule though, right? The files were added directly

Review notes: First commit is the framework source (those 26K lines is this commit alone).

Can this be a submodule?

limbonaut · 2024-11-15T19:50:05Z

Can this be a submodule?

No, because we need a subfolder from that repo at a specific location in our repo.
We need their addons/gdUnit4 at ours project/addons/gdUnit4. It's a common problem with Godot add-ons.

EDIT:
I also mentioned above, that we can use a symlink, but it won't be cross-platform. The way how it can be done is this:
We add it as a submodule: project/modules/gdunit. And we symlink project/addons/gdUnit4/ => project/modules/gdunit/addons/gdUnit4. However, it will not work on Windows then.

bruno-garcia · 2024-11-17T03:15:07Z

You suggested git-tree, is that an alternative?

It might be worth excluding development from Windows then, I dunno. Vendoring all this code seems quite suboptimal, it's 26kloc. And keeping things updated then with upstream will be painful this way

limbonaut · 2024-11-17T13:09:41Z

It might be worth excluding development from Windows then, I dunno. Vendoring all this code seems quite suboptimal, it's 26kloc.

Both GDScript frameworks have this disadvantage, maybe the other one is smaller LoC-wise.

And keeping things updated then with upstream will be painful this way

There is a built-in update routine, which checks for the update when you launch the Godot project. So it's a semi-automated process, and perhaps it handles the compatibility of the plugin version vs Godot version.

You suggested git-tree, is that an alternative?

git-subtree is an alternative to submodule, and I'm wondering if it could be utilized here to better solve this issue. It's tailored for the same use-case as submodule, but much different in implementation - you keep the history locally. This history can be squashed, synced with upstream, so like a submodule that is in-tree. This command can also extract history of a specific subfolder from a repository into a separate tree, but I couldn't find a way to "import" history from a subfolder, which is what we need.

limbonaut · 2024-11-20T21:48:38Z

Changes

Import gdUnit4 testing framework as a submodule
Creating a symlink for the testing framework during the build process (on Linux and macOS)
- Can also run scons project/addons/gdUnit4 to create the symlink manually
New PowerShell script to create the symlink on Windows
- The script prompts for elevated privileges, as Windows requires them to create a symlink.
- Note: This operation is not performed during the build process, as it requires elevated privileges, and prompting for them during the build would be confusing.

src/sentry_sdk.cpp

bitsandfoxes · 2024-11-21T13:16:26Z

SConstruct

+        os.symlink(src, dst)
+        return 0
+
+    gdunit_symlink = env.Command(


Can't we env.command(powershell.exe...) from here on Windows as well? I guess Scons will need to run with elevated privileges but there does not seem to be a way around this on windows anyway?

Also, did you consider another approach? Like this: https://stackoverflow.com/questions/58038683/allow-mklink-for-a-non-admin-user

@bruno-garcia
Not sure which one of those you mean 😕
Developer mode is not default, so failing a build without it seems unreasonable to me, at least for this.
With the hard link, I get "Access denied".

> mklink /H LinkedMusic Music Access is denied.

EDIT:
#19 (comment) worked like a charm.

bruno-garcia · 2024-11-21T14:19:31Z

Note: This operation is not performed during the build process, as it requires elevated privileges, and prompting for them during the build would be confusing.

How do we make it work in CI in this case?

scripts/link-testing-framework.ps1

limbonaut · 2024-11-21T15:31:22Z

Note: This operation is not performed during the build process, as it requires elevated privileges, and prompting for them during the build would be confusing.

How do we make it work in CI in this case?

Easy. We'll see if we have the privileges, if not: cp -R or mv should do the job.

EDIT:
#19 (comment) worked.

limbonaut · 2024-11-21T16:43:04Z

Changes

Creating an NTFS junction instead of a symlink on Windows during SCons build
Removed the unneeded PowerShell script

bruno-garcia

Just a note on the README.md, other than that, LGTM

.gitmodules

README.md

Junction doesn't require elevated privileges.

limbonaut added enhancement New feature or request testing labels Nov 15, 2024

limbonaut requested review from bruno-garcia and bitsandfoxes November 15, 2024 12:04

limbonaut linked an issue Nov 15, 2024 that may be closed by this pull request

Add GDScript-based unit testing #17

Closed

limbonaut force-pushed the feat/gdscript-unit-testing branch 4 times, most recently from 09b6b9e to 93eface Compare November 20, 2024 21:24

bitsandfoxes approved these changes Nov 21, 2024

View reviewed changes

bruno-garcia reviewed Nov 21, 2024

View reviewed changes

scripts/link-testing-framework.ps1 Outdated Show resolved Hide resolved

limbonaut requested review from bitsandfoxes and bruno-garcia November 21, 2024 16:43

bruno-garcia approved these changes Nov 22, 2024

View reviewed changes

.gitmodules Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

limbonaut force-pushed the feat/gdscript-unit-testing branch from bf3e200 to 62d56aa Compare November 22, 2024 11:25

limbonaut mentioned this pull request Nov 22, 2024

Implement GHA workflow to build the Godot SDK #23

Merged

limbonaut added 5 commits November 22, 2024 16:38

Fix user data not reset in runtime config on remove_user()

7813e8b

Suppress irrelevant warning in main.gd

349a4a3

Test SentryUser

432d2d8

Test capture_message()

a13bcb1

gdUnit4 setting

770f1f4

limbonaut added 2 commits November 22, 2024 16:38

Add gdUnit4 testing framework as submodule

7474884

Create symlink for testing framework in SCons build

b4afea3

limbonaut force-pushed the feat/gdscript-unit-testing branch from 62d56aa to 234b8ab Compare November 22, 2024 15:41

limbonaut added 5 commits November 22, 2024 16:42

Don't use C++20 designated intializer lists

35d08a0

PS script to create a symlink for gdUnit4

ff91bb0

Don't create symlink during SCons build on Windows

7c19767

Fix lib name

4b15a59

Create NTFS junction instead during SCons build on Windows

234b8ab

Junction doesn't require elevated privileges.

limbonaut merged commit 17b9db3 into main Nov 22, 2024
3 checks passed

limbonaut deleted the feat/gdscript-unit-testing branch November 22, 2024 15:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GDScript-based unit testing #19

GDScript-based unit testing #19

limbonaut commented Nov 15, 2024 •

edited

Loading

limbonaut commented Nov 15, 2024

bruno-garcia commented Nov 15, 2024

limbonaut commented Nov 15, 2024 •

edited

Loading

bruno-garcia commented Nov 17, 2024

limbonaut commented Nov 17, 2024 •

edited

Loading

limbonaut commented Nov 20, 2024

bitsandfoxes Nov 21, 2024

bruno-garcia Nov 21, 2024

limbonaut Nov 21, 2024 •

edited

Loading

bruno-garcia commented Nov 21, 2024

limbonaut commented Nov 21, 2024 •

edited

Loading

limbonaut commented Nov 21, 2024 •

edited

Loading

bruno-garcia left a comment

GDScript-based unit testing #19

GDScript-based unit testing #19

Conversation

limbonaut commented Nov 15, 2024 • edited Loading

limbonaut commented Nov 15, 2024

bruno-garcia commented Nov 15, 2024

limbonaut commented Nov 15, 2024 • edited Loading

bruno-garcia commented Nov 17, 2024

limbonaut commented Nov 17, 2024 • edited Loading

limbonaut commented Nov 20, 2024

Changes

bitsandfoxes Nov 21, 2024

Choose a reason for hiding this comment

bruno-garcia Nov 21, 2024

Choose a reason for hiding this comment

limbonaut Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

bruno-garcia commented Nov 21, 2024

limbonaut commented Nov 21, 2024 • edited Loading

limbonaut commented Nov 21, 2024 • edited Loading

Changes

bruno-garcia left a comment

Choose a reason for hiding this comment

limbonaut commented Nov 15, 2024 •

edited

Loading

limbonaut commented Nov 15, 2024 •

edited

Loading

limbonaut commented Nov 17, 2024 •

edited

Loading

limbonaut Nov 21, 2024 •

edited

Loading

limbonaut commented Nov 21, 2024 •

edited

Loading

limbonaut commented Nov 21, 2024 •

edited

Loading