Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[20733] Fix support for @key annotation in Dynamic types (backport #4694) #4749

Open
wants to merge 1 commit into
base: 2.6.x
Choose a base branch
from

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Apr 30, 2024

Description

This PR:

  • Fixes various things regarding the handling of @key annotation on dynamic types:
    • Copy the type annotations when creating MemberDescriptors
    • Fix AnnotationDescriptor::key_annotation() implementation
    • Fix population of is_key_defined_ in DynamicType::copy_from_builder()
    • Simplify DynamicType::key_annotation() implementation
  • On loading types from XML, add the @key annotation only to the member builder and not to the dynamic type, as @key only makes sense for members but not types.
  • Adds the key attribute to members in XSD

@Mergifyio backport 2.13.x 2.10.x 2.6.x

Contributor Checklist

  • Commit messages follow the project guidelines.
  • The code follows the style guidelines of this project.
  • Tests that thoroughly check the new feature have been added/Regression tests checking the bug and its fix have been added; the added tests pass locally
  • N/A: Any new/modified methods have been properly documented using Doxygen.
  • N/A: Any new configuration API has an equivalent XML API (with the corresponding XSD extension)
  • Changes are ABI compatible.
  • Changes are API compatible.
  • N/A: New feature has been added to the versions.md file (if applicable).
  • New feature has been documented/Current behavior is correctly described in the documentation.
  • Applicable backports have been included in the description.

Reviewer Checklist

  • The PR has a milestone assigned.
  • The title and description correctly express the PR's purpose.
  • Check contributor checklist is correct.
  • Check CI results: changes do not issue any warning.
  • Check CI results: failing tests are unrelated with the changes.

This is an automatic backport of pull request #4694 done by [Mergify](https://mergify.com).

* Refs #20733: Fix support for key annotation in XML types

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #20733: Add test

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #20733: Move implementations to cpp

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #20733: Properly fix key annotation handling

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #20733: Apply Miguel's suggestions

Signed-off-by: eduponz <eduardoponz@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit eaa23db)

# Conflicts:
#	resources/xsd/fastRTPS_profiles.xsd
#	test/system/tools/xmlvalidation/XMLTesterExample_profile.xml
#	test/system/tools/xmlvalidation/all_profile.xml
#	test/system/tools/xmlvalidation/types_profile.xml
@mergify mergify bot added the conflicts Backport PR wich git cherry pick failed label Apr 30, 2024
Copy link
Contributor Author

mergify bot commented Apr 30, 2024

Cherry-pick of eaa23db has failed:

On branch mergify/bp/2.6.x/pr-4694
Your branch is up to date with 'origin/2.6.x'.

You are currently cherry-picking commit eaa23dbde.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   include/fastrtps/types/MemberDescriptor.h
	modified:   include/fastrtps/xmlparser/XMLProfileManager.h
	modified:   src/cpp/dynamic-types/AnnotationDescriptor.cpp
	modified:   src/cpp/dynamic-types/DynamicType.cpp
	modified:   src/cpp/dynamic-types/MemberDescriptor.cpp
	modified:   src/cpp/rtps/xmlparser/XMLDynamicParser.cpp
	modified:   src/cpp/rtps/xmlparser/XMLProfileManager.cpp
	modified:   test/unittest/dynamic_types/DynamicTypesTests.cpp
	modified:   test/unittest/dynamic_types/types.xml

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	both modified:   resources/xsd/fastRTPS_profiles.xsd
	deleted by us:   test/system/tools/xmlvalidation/XMLTesterExample_profile.xml
	deleted by us:   test/system/tools/xmlvalidation/all_profile.xml
	deleted by us:   test/system/tools/xmlvalidation/types_profile.xml

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@MiguelCompany MiguelCompany added this to the v2.6.9 milestone May 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conflicts Backport PR wich git cherry pick failed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants