#5319 - gbXML Reverse Translator - Scan for the gbxml Schema version: skip schema validation with a warning when not 7.03 #5320
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
macumber
reviewed
Dec 18, 2024
src/gbxml/ReverseTranslator.cpp
Outdated
| LOG(Warn, "gbXML has no `version` attribute for the schema version, assuming 7.03."); | ||
| version = "7.03"; | ||
| } | ||
| if (version == "7.03") { |
Contributor
There was a problem hiding this comment.
Only suggestion I would have is to put "7.03" in XMLValidator since that is the thing that knows which version of the schema it has. Then if version != 7.03, a call to gbxmlValidator.validate would log something like Cannot validate #{version}.
Contributor
There was a problem hiding this comment.
Or keep the code as is but return "7.03" from a XMLValidator::gbxmlValidatorExpectedVersion() method or something
Collaborator
Author
Contributor
|
Thanks @jmarrec looks good to me! |
5059797 to
ccffa37
Compare
Collaborator
|
CI Results for ecb6a53:
|
jmarrec
commented
Dec 19, 2024
| XMLValidator& operator=(XMLValidator&& other) noexcept = default; | ||
|
|
||
| static XMLValidator gbxmlValidator(); | ||
| static XMLValidator gbxmlValidator(const VersionString& schemaVersion = VersionString(7, 3)); |
Collaborator
Author
There was a problem hiding this comment.
Make it clearer that this is 7.03 schema, and reserve use for supporting more schemas.
Comment on lines
+480
to
+486
| if (schemaVersion != VersionString(7, 3)) { | ||
| LOG_AND_THROW("Unexpected gbXML Schema Version: accepted = [7.03]"); | ||
| } | ||
| const bool quiet = true; | ||
| ::openstudio::embedded_files::extractFile(":/xml/resources/GreenBuildingXML_Ver7.03.xsd", openstudio::toString(tmpDir), quiet); | ||
| auto validator = XMLValidator(tmpDir / "GreenBuildingXML_Ver7.03.xsd"); | ||
| std::string schemaName = fmt::format("GreenBuildingXML_Ver{}.{:02}.xsd", schemaVersion.major(), schemaVersion.minor()); | ||
| ::openstudio::embedded_files::extractFile(fmt::format(":/xml/resources/{}", schemaName), openstudio::toString(tmpDir), quiet); | ||
| auto validator = XMLValidator(tmpDir / schemaName); |
Collaborator
Author
There was a problem hiding this comment.
Clearly throw if anything else that schema version 7.03 is passed for now
Comment on lines
+94
to
+122
| auto root = doc.document_element(); | ||
| if (std::string_view{root.name()} != "gbXML") { | ||
| LOG(Error, "Expected the root element to be <gbXML>"); | ||
| return boost::none; | ||
| } | ||
| // Scan version of gbxml schema | ||
| std::string version = root.attribute("version").value(); | ||
| VersionString schemaVersion(7, 3); | ||
| if (version.empty()) { | ||
| LOG(Warn, "gbXML has no `version` attribute for the schema version, assuming 7.03."); | ||
| } else { | ||
| try { | ||
| schemaVersion = VersionString(version); | ||
| } catch (...) { | ||
| LOG(Warn, "gbXML has `version` '" << version << "' which was not understood, assuming 7.03."); | ||
| } | ||
| } | ||
| if (schemaVersion == VersionString(7, 3)) { | ||
| // validate the gbxml prior to reverse translation | ||
| auto gbxmlValidator = XMLValidator::gbxmlValidator(schemaVersion); | ||
| gbxmlValidator.validate(path); | ||
| } else { | ||
| LOG(Error, | ||
| "Version of schema specified: " << version | ||
| << ", expected 7.03. gbXML Schema Validation skipped. Note that ReverseTranslator rules are built " | ||
| "for 7.03 and older versions are not officially supported, check resulting model with care."); | ||
| }; | ||
|
|
||
| result = this->convert(root); |
Collaborator
Author
There was a problem hiding this comment.
Skip gbXMLValidation with a clear message when the version is not 7.03.
Warn if the gbXML attribute "version" is missing (it's required) and still assume 7.03
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull request overview
Pull Request Author
src/model/test)src/energyplus/Test)src/osversion/VersionTranslator.cpp)Labels:
IDDChangeAPIChangePull Request - Ready for CIso that CI builds your PRReview Checklist
This will not be exhaustively relevant to every PR.