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.

Sign up for GitHub

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

Jump to bottom

Updates XmlToJson parsing to be more inja-friendly #4478

Merged
merged 2 commits into from
May 20, 2021
Merged

Updates XmlToJson parsing to be more inja-friendly #4478

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10636e4
Updates XmlToJson parsing to indicate XML attributes and text values …
kberryUSGS May 19, 2021
b96c7c7
Update XmlToJson tests
kberryUSGS May 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions isis/src/base/objs/XmlToJson/XmlToJson.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,11 @@ namespace Isis {
* JSON: {tag: value}
*
* XML: <tag attributeName="attributeValue">textValue</tag>
* JSON: {tag: {@attributeName: "attributeValue, "#text":textValue } }
* JSON: {tag: {attrib_attributeName: "attributeValue,
* "_text":textValue } }
*
* XML: <tag attributeName="attributeValue" />
* JSON: {tag: {@attributeName: "attributeValue"} }
* JSON: {tag: {attrib_attributeName: "attributeValue"} }
*
* XML: <tag />
* JSON: tag: null
Expand All @@ -97,24 +98,24 @@ namespace Isis {
QDomNamedNodeMap attrMap = element.attributes();
for (int i=0; i < attrMap.size(); i++) {
QDomAttr attr = attrMap.item(i).toAttr();
attributeSection["@"+attr.name().toStdString()] = attr.value().toStdString();
attributeSection["attrib_"+attr.name().toStdString()] = attr.value().toStdString();
}
// If there is no textValue, don't include it
// <tag attributeName="attributeValue" />
if (!element.text().isEmpty()) {
attributeSection["#text"] = element.text().toStdString();
attributeSection["_text"] = element.text().toStdString();
}
newJson[element.tagName().toStdString()] = attributeSection;
newJson[element.tagName().replace(":", "_").toStdString()] = attributeSection;
}
else {
// Just add element and its value
// <tag>value</tag>
if (!element.text().isEmpty()) {
newJson[element.tagName().toStdString()] = element.text().toStdString();
newJson[element.tagName().replace(":", "_").toStdString()] = element.text().toStdString();
}
else {
// <tag /> no value case
newJson[element.tagName().toStdString()];
newJson[element.tagName().replace(":", "_").toStdString()];
}
}
return newJson;
Expand Down Expand Up @@ -157,9 +158,9 @@ namespace Isis {
if (!output[element.tagName().toStdString()].is_array()) {
json repeatedArray;
repeatedArray.push_back(output[element.tagName().toStdString()]);
output[element.tagName().toStdString()] = repeatedArray;
output[element.tagName().replace(":", "_").toStdString()] = repeatedArray;
}
output[element.tagName().toStdString()].push_back(converted[element.tagName().toStdString()]);
output[element.tagName().replace(":", "_").toStdString()].push_back(converted[element.tagName().toStdString()]);
}
}
else {
Expand All @@ -175,25 +176,25 @@ namespace Isis {
if (!output[element.tagName().toStdString()].is_array()) {
json repeatedArray;
repeatedArray.push_back(output[element.tagName().toStdString()]);
output[element.tagName().toStdString()] = repeatedArray;
output[element.tagName().replace(":", "_").toStdString()] = repeatedArray;
}
output[element.tagName().toStdString()].push_back(temporaryJson);
output[element.tagName().replace(":", "_").toStdString()].push_back(temporaryJson);
}
else {
if (element.hasAttributes()) {
json tempArea;
QDomNamedNodeMap attrMap = element.attributes();
for (int j=0; j < attrMap.size(); j++) {
QDomAttr attr = attrMap.item(j).toAttr();
tempArea["@"+attr.name().toStdString()] = attr.value().toStdString();
tempArea["attrib_"+attr.name().toStdString()] = attr.value().toStdString();
}
tempArea.update(
convertXmlToJson(next, output[element.tagName().toStdString()]));
output[element.tagName().toStdString()] = tempArea;
output[element.tagName().replace(":", "_").toStdString()] = tempArea;
}
else {
output[element.tagName().toStdString()] =
convertXmlToJson(next, output[element.tagName().toStdString()]);
convertXmlToJson(next, output[element.tagName().replace(":", "_").toStdString()]);
}
}
}
Expand Down
56 changes: 28 additions & 28 deletions isis/tests/XmlToJsonTests.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ TEST(XmlToJson, XmlNoAttributeWithTextValue) {
}

// XML: <tag attributeName="attributeValue">textValue</tag>
// JSON: {tag: {@attributeName: "attributeValue, "#text":textValue } }
// JSON: {tag: {attrib_attributeName: "attributeValue, "_text":textValue } }
TEST(XmlToJson, XmlAttributeWithTextValue) {
QString xmlInput = R"(<Tag>
<TagWithAttribute attribute="attributeValue">textValue</TagWithAttribute>
Expand All @@ -32,12 +32,12 @@ TEST(XmlToJson, XmlAttributeWithTextValue) {
xmlDocument.setContent(xmlInput);
json result = xmlToJson(xmlDocument);

EXPECT_EQ(result["Tag"]["TagWithAttribute"]["@attribute"], "attributeValue");
EXPECT_EQ(result["Tag"]["TagWithAttribute"]["#text"], "textValue");
EXPECT_EQ(result["Tag"]["TagWithAttribute"]["attrib_attribute"], "attributeValue");
EXPECT_EQ(result["Tag"]["TagWithAttribute"]["_text"], "textValue");
}

// XML: <tag attributeName="attributeValue" />
// JSON: {tag: {@attributeName: "attributeValue"} }
// JSON: {tag: {attrib_attributeName: "attributeValue"} }
TEST(XmlToJson, XmlAttributeButNoText) {
QString xmlInput = R"(<Tag>
<TagWithAttribute attribute="attributeValue" />>
Expand All @@ -47,8 +47,8 @@ TEST(XmlToJson, XmlAttributeButNoText) {
xmlDocument.setContent(xmlInput);
json result = xmlToJson(xmlDocument);

EXPECT_EQ(result["Tag"]["TagWithAttribute"]["@attribute"], "attributeValue");
EXPECT_EQ(result["Tag"]["TagWithAttribute"]["#text"], nullptr);
EXPECT_EQ(result["Tag"]["TagWithAttribute"]["attrib_attribute"], "attributeValue");
EXPECT_EQ(result["Tag"]["TagWithAttribute"]["_text"], nullptr);
}

// XML: <tag />
Expand Down Expand Up @@ -111,9 +111,9 @@ TEST(XmlToJson, TestRepeatedTagNoChildren){

EXPECT_EQ(result["Tag"]["A"][0], "A1");
EXPECT_EQ(result["Tag"]["A"][1], "A2");
EXPECT_EQ(result["Tag"]["A"][2]["@attribute"], "value");
EXPECT_EQ(result["Tag"]["A"][3]["@otherAttribute"], "otherValue");
EXPECT_EQ(result["Tag"]["A"][3]["#text"], "textValue");
EXPECT_EQ(result["Tag"]["A"][2]["attrib_attribute"], "value");
EXPECT_EQ(result["Tag"]["A"][3]["attrib_otherAttribute"], "otherValue");
EXPECT_EQ(result["Tag"]["A"][3]["_text"], "textValue");
EXPECT_EQ(result["Tag"]["A"][4]["B"][0], "b1");
EXPECT_EQ(result["Tag"]["A"][4]["B"][1], "b2");
EXPECT_EQ(result["Tag"]["A"][4]["C"], "c1");
Expand Down Expand Up @@ -204,12 +204,12 @@ TEST(XmlToJson, TestXMLEverythingTogether) {
EXPECT_EQ(result["TagLevel0"]["TagLevel1A"]["TagLevel2C"]["TagLevel3"]["TagLevel4C"]["TagLevel4D"]["TagLevel4E"], "DeepValue");

// Test attributes (uncomplicated)
EXPECT_EQ(result["TagLevel0"]["TagLevel1A"]["TagLevel2D"]["@attributeTag2D"], "Attribute value");
EXPECT_EQ(result["TagLevel0"]["TagLevel1A"]["TagLevel2D"]["#text"], "TagLevel2DValue");
EXPECT_EQ(result["TagLevel0"]["TagLevel1A"]["TagLevel2D"]["attrib_attributeTag2D"], "Attribute value");
EXPECT_EQ(result["TagLevel0"]["TagLevel1A"]["TagLevel2D"]["_text"], "TagLevel2DValue");

// Test no-text value cases <tag /> and <tag attributeName="attributeValue" />
EXPECT_EQ(result["TagLevel0"]["TagLevel1A"]["TagLevel2ExtraExtra"], nullptr);
EXPECT_EQ(result["TagLevel0"]["TagLevel1A"]["TagLevel2Extra"]["@attr"], "justAnAttribute");
EXPECT_EQ(result["TagLevel0"]["TagLevel1A"]["TagLevel2Extra"]["attrib_attr"], "justAnAttribute");

// Test list creation for repeated tags at the same level

Expand All @@ -223,9 +223,9 @@ TEST(XmlToJson, TestXMLEverythingTogether) {
// including lots of possible combinations
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["First"][0]["A"][0], "A1");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["First"][0]["A"][1], "A2");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["First"][0]["A"][2]["@attribute"], "value");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["First"][0]["A"][3]["@attr"], "val");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["First"][0]["A"][3]["#text"], "zoom");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["First"][0]["A"][2]["attrib_attribute"], "value");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["First"][0]["A"][3]["attrib_attr"], "val");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["First"][0]["A"][3]["_text"], "zoom");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["First"][0]["A"][5], "A3");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["First"][0]["A"][6], nullptr);

Expand All @@ -237,21 +237,21 @@ TEST(XmlToJson, TestXMLEverythingTogether) {
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["First"][0]["ten"][1], "TEN");

// Test many attributes at one level
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Second"]["A"]["@attributeA"], "A");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Second"]["A"]["@attributeB"], "B");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Second"]["A"]["@attributeC"], "C");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Second"]["A"]["#text"], "ElementValue");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Second"]["A"]["attrib_attributeA"], "A");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Second"]["A"]["attrib_attributeB"], "B");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Second"]["A"]["attrib_attributeC"], "C");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Second"]["A"]["_text"], "ElementValue");

// Test multiple attributes at multiple levels
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Third"]["Greek"]["@otherattr"], "firstLetter");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Third"]["Greek"]["@attr"], "alphabet");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Third"]["Greek"]["Alpha"]["@attr2"], "attr2");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Third"]["Greek"]["Alpha"]["@attr1"], "attr1");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Third"]["Greek"]["Alpha"]["#text"], "AlphaValue");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Third"]["Greek"]["Beta"]["#text"], "BetaValue");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Third"]["Greek"]["Beta"]["@attrbeta2"], "beta2");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Third"]["Greek"]["AnotherLevel"]["Gamma"]["@attrgamma"], "gamma");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Third"]["Greek"]["AnotherLevel"]["Gamma"]["#text"], "GammaValue");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Third"]["Greek"]["attrib_otherattr"], "firstLetter");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Third"]["Greek"]["attrib_attr"], "alphabet");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Third"]["Greek"]["Alpha"]["attrib_attr2"], "attr2");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Third"]["Greek"]["Alpha"]["attrib_attr1"], "attr1");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Third"]["Greek"]["Alpha"]["_text"], "AlphaValue");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Third"]["Greek"]["Beta"]["_text"], "BetaValue");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Third"]["Greek"]["Beta"]["attrib_attrbeta2"], "beta2");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Third"]["Greek"]["AnotherLevel"]["Gamma"]["attrib_attrgamma"], "gamma");
EXPECT_EQ(result["TagLevel0"]["TagLevel1B"]["Third"]["Greek"]["AnotherLevel"]["Gamma"]["_text"], "GammaValue");
}