Avoid a StackOverflow and properly fail on cyclic references in CRD generation

[andreaTP]

Description

This is an initial improvement for #3651 , it mainly adds the failing test and output some human friendly information.
I'm still eager to discuss a proper solution for the underlying issue.

Type of change

• Bug fix (non-breaking change which fixes an issue)
• Feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change
• Chore (non-breaking change which doesn't affect codebase;
  test, version modification, documentation, etc.)

Checklist

• Code contributed by me aligns with current project license: Apache 2.0
• I Added CHANGELOG entry regarding this change
• I have implemented unit tests to cover my changes
• I have added/updated the javadocs and other documentation accordingly
• No new bugs, code smells, etc. in SonarCloud report
• I tested my code in Kubernetes
• I tested my code in OpenShift

[centos-ci]

Can one of the admins verify this patch?

[metacosm]

This is a good first step but I think that the issue should be addressed at the sundrio level… What do you think @iocanel ?

[andreaTP]

@metacosm I'm not sure that the underlying issue is in sundrio, Kubernetes API and OpenAPI v3 are not allowing cyclic references but it's extremely common to have those in POJOs.
I think we need to come up with a design decision on how to move forward in this case.

[andreaTP]

Moving this PR to Draft since I found more edge cases.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

91.3% Coverage
0.0% Duplication

[andreaTP]

@metacosm this should be ready for a final review now.
Tested also locally against the Keycloak model and added to the local tests all the edge cases I found, now is good to go 🙂

[metacosm]

LGTM

[andreaTP]

cc. @manusa @rohanKanojia this should e ready to merge AFAIU.

[manusa]

From the code, I understand that the fix consists on detecting cyclic references and throwing a human readable exception with the identification of the problematic field/entity in case on is found.

[manusa]

LGTM, thx!