gazebosim/sdformat

Should validate the contents of <include>

Open

#661 opened on Aug 9, 2021

View on GitHub
 (0 comments) (1 reaction) (1 assignee)C++ (122 forks)auto 404
bughelp wanted

Repository metrics

Stars
 (216 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently, sdf::readXml is not called on the <include> element, so its contents are not validated according to the SDFormat spec. Any unknown elements are silently ignored by the parser except when using the interface API. This is different behavior than when unknown elements are encountered elsewhere (e.g. in ).

For example:

<sdf version='1.8'>
  <world name='default'>
     <include>
        <uri>test_model</uri>
        <name>override_model_name</name>
         <pose>4 5 6 0 0 0</pose>
         <foo>bar</foo>
      </include>
   </world>
</sdf>

The element <foo> should trigger a warning/error depending on the configuration of the parser.

Contributor guide

Research direction
Examine the SDFormat parser's handling of the <include> element to ensure unknown sub elements trigger validation errors or warnings, similar to other elements like <model>. Look at the code path for <include> and compare with <model> to identify differences.
Tech stack
cpp
Domain
api
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++XML parsing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60