New test for node group versioning #111800

Lukas Tönne · 2023-09-01T18:55:47+02:00

Lukas Tönne commented

2023-09-01 18:55:47 +02:00

This simply loads a blend file and tests that the node group interface
as well as a node group instance have all the expected sockets and
default values.

The test files are attached below temporarily for code review,
these will be uploaded to the svn test files repo in time.

Test case for 2.5:
Test case for 3.6:

This simply loads a blend file and tests that the node group interface as well as a node group instance have all the expected sockets and default values. The test files are attached below temporarily for code review, these will be uploaded to the svn test files repo in time. Test case for 2.5: ![image](/attachments/43d56d46-ae61-450d-9dc9-0c0a8d3d81ba) Test case for 3.6: ![image](/attachments/bf0478f2-2b91-4bcb-98d9-b7f733e2f499)

image.png

437 KiB

image.png

277 KiB

nodegroup25.blend

402 KiB

nodegroup36.blend

1.2 MiB

Lukas Tönne added 1 commit 2023-09-01 18:56:02 +02:00

New test for node group versioning. e828dfa5c4

This simply loads a blend file and tests that the node group interface
as well as a node group instance have all the expected sockets and
default values.

Lukas Tönne added 1 commit 2023-09-01 19:00:05 +02:00

Cleanup: Removed debugging code. b234d07105

Lukas Tönne referenced this pull request

2023-09-03 15:12:25 +02:00

Fix versioning old 2.6 node groups, causing dangling link pointers #111704

Lukas Tönne added 1 commit 2023-09-04 10:23:26 +02:00

Merge branch 'main' into test_nodegroup_compat 3f82287faa

Lukas Tönne added 2 commits 2023-09-04 11:19:56 +02:00

Added external links to the node group instance and test for count. 792350a108

Test for node links as well to cover possible identifier mismatch. fa8a74ab85

Lukas Tönne added 1 commit 2023-09-04 11:26:17 +02:00

Started a versioning test for 2.5 node groups. e1fab5a55b

Lukas Tönne added 1 commit 2023-09-04 16:32:47 +02:00

Completed test for 2.5 nodes as much as possible. 50c1d1af9b

Links get broken in 2.5 files but fixing is too complicated. Ignore
links to and from the node group for testing.

Jacques Lucke approved these changes 2023-09-04 16:46:45 +02:00

Jacques Lucke left a comment

Added a few inline comments, but generally looks good to me.

tests/python/bl_node_group_compat.py

						
				@ -0,0 +64,4 @@

				    @property

				    def idname(self):

				        global type_info

Jacques Lucke commented

2023-09-04 16:40:34 +02:00

Is this global really necessary?

Is this `global` really necessary?

Lukas Tönne commented

2023-09-04 17:48:28 +02:00

No it's not, removed it.

LukasTonne marked this conversation as resolved

tests/python/bl_node_group_compat.py Outdated

						
				@ -0,0 +90,4 @@

				        else:

				            self.assertAlmostEqual(value, expected)

				    def compare_spec(self, item, node, spec: SocketSpec, test_links=True):

Jacques Lucke commented

2023-09-04 16:42:49 +02:00

Think the function name can be improved to make it more clear that we are only checking a single socket here. It's not necessarily obvious by looking at the signature.

Lukas Tönne commented

2023-09-04 17:52:55 +02:00

changed to

    # Test properties of a node group item and associated node socket with spec data.
    def compare_group_socket_to_spec(self, item, node, spec: SocketSpec, test_links=True):

changed to ```python # Test properties of a node group item and associated node socket with spec data. def compare_group_socket_to_spec(self, item, node, spec: SocketSpec, test_links=True): ```

LukasTonne marked this conversation as resolved

tests/python/bl_node_group_compat.py Outdated

						
				@ -0,0 +93,4 @@

				    def compare_spec(self, item, node, spec: SocketSpec, test_links=True):

				        group = item.id_data

				        # Examine the interface item

Jacques Lucke commented

2023-09-04 16:41:31 +02:00

End comments with dot.

LukasTonne marked this conversation as resolved

tests/python/bl_node_group_compat.py Outdated

						
				@ -0,0 +181,4 @@

				class NodeGroupVersioning36Test(AbstractNodeGroupInterfaceTest):

				    def open_file(self):

				        bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "nodegroup36.blend"))

Jacques Lucke commented

2023-09-04 16:45:22 +02:00

I wonder if we can check bpy.data.version to make sure that the file hasn't been saved in a newer version already accidentally.

I wonder if we can check `bpy.data.version` to make sure that the file hasn't been saved in a newer version already accidentally.

Lukas Tönne commented

2023-09-04 17:47:08 +02:00

Added a test for this, works fine.

LukasTonne marked this conversation as resolved

tests/python/bl_node_group_compat.py Outdated

						
				@ -0,0 +193,4 @@

				        self.assertEqual(node.node_tree, group, "Node group must use compositor node tree")

				        # autopep8: off

				        self.compare_spec( group.interface.ui_items[0], node, SocketSpec( "Output Float", "Output_9", "VALUE", hide_value=True, default_value=3.0, min_value=1.0, max_value=1.0))

Jacques Lucke commented

2023-09-04 16:43:46 +02:00

Break into multiple lines.

Lukas Tönne commented

2023-09-04 17:36:14 +02:00

I find it more readable with a single line per socket and the auto-formatting disabled. Can turn that back on if you feel strongly about it.

After make format:

        self.compare_spec(
            group.interface.ui_items[0], node, SocketSpec(
                "Color", "Color", "RGBA", default_value=(
                    0, 0, 0, 1)), test_links=False)
        self.compare_spec(
            group.interface.ui_items[1], node, SocketSpec(
                "Color", "Color.001", "RGBA", default_value=(
                    0, 0, 0, 1)), test_links=False)
        self.compare_spec(
            group.interface.ui_items[2],
            node,
            SocketSpec(
                "Vector",
                "Vector",
                "VECTOR",
                default_value=(
                    0,
                    0,
                    0),
                min_value=0.0,
                max_value=0.0),
            test_links=False)
        self.compare_spec(
            group.interface.ui_items[3],
            node,
            SocketSpec(
                "Value",
                "Value",
                "VALUE",
                default_value=0.0,
                min_value=0.0,
                max_value=0.0),
            test_links=False)

        self.compare_spec(
            group.interface.ui_items[4],
            node,
            SocketSpec(
                "Fac",
                "Fac",
                "VALUE",
                default_value=0.5,
                min_value=0.0,
                max_value=0.0),
            test_links=False)

I find it more readable with a single line per socket and the auto-formatting disabled. Can turn that back on if you feel strongly about it. After make format: ```python self.compare_spec( group.interface.ui_items[0], node, SocketSpec( "Color", "Color", "RGBA", default_value=( 0, 0, 0, 1)), test_links=False) self.compare_spec( group.interface.ui_items[1], node, SocketSpec( "Color", "Color.001", "RGBA", default_value=( 0, 0, 0, 1)), test_links=False) self.compare_spec( group.interface.ui_items[2], node, SocketSpec( "Vector", "Vector", "VECTOR", default_value=( 0, 0, 0), min_value=0.0, max_value=0.0), test_links=False) self.compare_spec( group.interface.ui_items[3], node, SocketSpec( "Value", "Value", "VALUE", default_value=0.0, min_value=0.0, max_value=0.0), test_links=False) self.compare_spec( group.interface.ui_items[4], node, SocketSpec( "Fac", "Fac", "VALUE", default_value=0.5, min_value=0.0, max_value=0.0), test_links=False) ```

Jacques Lucke commented

2023-09-05 10:42:37 +02:00

I think just moving the SocketSpec on the next line is good enough as well (so that the long line is approximately split in half). Autoformatting can still be disabled.

I think just moving the `SocketSpec` on the next line is good enough as well (so that the long line is approximately split in half). Autoformatting can still be disabled.

Lukas Tönne commented

2023-09-05 12:17:13 +02:00

I've realized that i can just put all the specs in a list since i'm testing all the sockets one by one anyway. Nice and compact now.

LukasTonne marked this conversation as resolved

Lukas Tönne added 2 commits 2023-09-04 17:37:09 +02:00

Cleanup: formatting. 10e1bfd963

Merge branch 'main' into test_nodegroup_compat 34d36f30ed

Lukas Tönne added 12 commits 2023-09-04 17:46:51 +02:00

Fix for versioning old 2.6 node groups, causing dangling link pointers. a0cb03b5d3

In 2.6 the old method of using bNodeSocket lists in bNodeTree directly
as group sockets was replaced with new group input/output nodes. This
required versioning to create those input/output nodes and then redirect
links to the new node sockets. Because creating nodes relies heavily on
node typeinfo this versioning was done in the `_after_linking` section
of the 2.6 versioning code, running after _all other versioning_
(including for much newer versions!) has already happended.

While typinfo is available at that point, doing such late versioning
causes severe problems when the data structure changes, as is the case
with the recent node panels patch (#111348). The new node group
interface also has versioning code for 4.0, but this runs _before_ the
`_after_linking` code for 2.6! Versioning for node panels expects
sockets in bNodeTree to not have any links pointing at them, but this is
not true for old 2.6 files which have not yet been fully versioned at
that point, because of the late versioning stage. Subsequently 2.6
`_after_linking` code crashes when trying to modify node links with
dangling pointers.

The solution here is to move the old versioning code out of the
`after_linking` stage to restore the expected versioning chain. This
requires creating nodes and node sockets without any typeinfo, but
luckily we only need to create simple known group input/output nodes
which don't have much complicated behavior.

Merge branch 'main' into fix-versioning-26-node-groups 1b259a2045

Merge branch 'main' into fix-versioning-26-node-groups be0a597b32

Merge branch 'main' into fix-versioning-26-node-groups cd1522f184

Removed old 2.5 after_linking code that is already broken. bf3c7aedc0

2.5 versioning would require an after_linking step to construct correct
socket identifiers of node groups, which would preserve links to and
from the group. This has been broken for a long time and cannot be
easily restored. The code is not running anyway because it depends on
outdated bNodeLink format, so its better to just remove entirely.

Removed invalid nodeUniqueName calls. 57b17483e8

This function is supposed to only be called once, or the tree topology
will fail on assert. node names are made unique later on already.

Use warning instead of error for modifier issues to avoid test crash. 4f84995bca

CLOG_ERROR aborts in debug mode, which makes all tests fail (in this
case because a nodes modifier does not have a geometry output, which
should just disable it).

Initialize socket typeinfo before node typeinfo. bad7e18689

Creating nodes relies on socket typeinfo to be valid before node
typeinfo itself.

Added missing 'compact' flag for sockets.

buildbot/vexp-code-patch-coordinator Build done.

Details

58ea865f09

Also fixed use of an incorrect flag for interface sockets.

Merge branch 'main' into fix-versioning-26-node-groups cc23d2cd07

Merge branch 'fix-versioning-26-node-groups' into test_nodegroup_compat a5de408021

Added test for file versions to detect possible save with wrong version. 9e8c6386f8

Lukas Tönne added 3 commits 2023-09-04 17:52:04 +02:00

Removed unnecessary global. 05dbe238e3

Renamed function and added comment for clarity. d98fe9a370

Cleanup: Dots after comments. 169c42965c

Lukas Tönne referenced this pull request

2023-09-05 09:27:02 +02:00

Fix #111950: missing "hide value" and "compact" flags for group sockets #111956

Lukas Tönne added 1 commit 2023-09-05 11:58:41 +02:00

Merge branch 'main' into test_nodegroup_compat 85e64e3d15

Lukas Tönne added 1 commit 2023-09-05 12:15:53 +02:00

Cleanup: More compact form of defining socket specs in the test. 78078e266d

Lukas Tönne added 1 commit 2023-09-05 12:38:05 +02:00

Merge branch 'main' into test_nodegroup_compat

buildbot/vexp-code-patch-coordinator Build done.

Details

abcdbc871f

Lukas Tönne commented

2023-09-05 12:42:37 +02:00

@blender-bot build

Lukas Tönne added 1 commit 2023-09-05 13:32:58 +02:00

Merge branch 'main' into test_nodegroup_compat

buildbot/vexp-code-patch-coordinator Build done.

Details

60a5e6f426

Lukas Tönne changed title from ~~WIP: New test for node group versioning~~ to New test for node group versioning

2023-09-05 13:35:34 +02:00

Lukas Tönne commented

2023-09-05 13:35:47 +02:00

@blender-bot build

Lukas Tönne merged commit 851a32adb5 into main

2023-09-05 14:27:26 +02:00

Lukas Tönne referenced this issue from a commit

2023-09-05 14:27:27 +02:00

Nodes: New test for node group versioning

Lukas Tönne deleted branch test_nodegroup_compat

2023-09-05 14:27:28 +02:00

Stefan Werner referenced this issue from a commit

2023-09-07 15:02:39 +02:00

Nodes: New test for node group versioning

Sign in to join this conversation.

No reviewers

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

New test for node group versioning #111800