Support recursive definitions in scanner

Summary

Motivated by #16 (moved) I created two tests. One of them is failing, the second one is a workaround - but not completely identical, because the Experiment record is created on another level.

Bidirectional linking should be supported also on the same level.

There still is the issue (in pylib) that recursive definitions of records cannot be displayed/printed and lead to a RecursionError.

Important: This implementation only works if there aren't any recursively defined identifying properties.

Focus

Have a close look at the tests, whether there might be cases that need special treatment. The actual fix was much easier than expected.

Test Environment

There is a unit test and an integration test.

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related issues
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

assigned to @salexan

mentioned in issue #16 (moved)

mentioned in issue #175 (closed)

added 1 commit

• 5cca4956 - TST: added tests for recursively defined records

Compare with previous version

added 166 commits

• 5cca4956...d5706303 - 165 commits from branch dev
• 0e4e1283 - Merge branch 'dev' into f-recursive-definition

Compare with previous version

added 1 commit

• a9353737 - ENH(scanner): allow recursive references to records on the same level in the cfood

Compare with previous version

marked this merge request as ready

marked the checklist item Reference related issues as completed

marked the checklist item Appropriate user and developer documentation (or not necessary) as completed

marked the checklist item Annotations in code (Gitlab comments) as completed

requested review from @florian

added 1 commit

• 7df6e3e6 - DOC: changelog updated

Compare with previous version

added 1 commit

• cb87b6e8 - TST(scanner): test for bi-directional definition only works if the identifying...

Compare with previous version

changed the description

marked the checklist item Up-to-date CHANGELOG.md (or not necessary) as completed

marked the checklist item All automated tests pass as completed

marked the checklist item I understand the intent of this MR as completed

marked the checklist item All automated tests pass as completed

marked the checklist item Up-to-date CHANGELOG.md (or not necessary) as completed

marked the checklist item Appropriate user and developer documentation (or not necessary) as completed

marked the checklist item The test environment setup works and the intended behavior is reproducible in the test as completed

marked the checklist item Appropriate user and developer documentation (or not necessary) as incomplete

marked the checklist item Appropriate user and developer documentation (or not necessary) as completed

marked the checklist item In-code documentation and comments are up-to-date. as completed

added 1 commit

• dcbfe3dc - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

added 1 commit

• f452017a - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

added 1 commit

• 5f5f3c4a - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

added 2 commits

• 73f1a84b - TST: simplified data needed for integration test
• 5f73baea - TST: added test that bidirectional reference was inserted correctly

Compare with previous version

resolved all threads

mentioned in commit 96ae0ada

merged