config_disassembler/xml/builders/

build_xml_string.rs

//! Build XML string from XmlElement structure.

use quick_xml::escape::partial_escape;
use quick_xml::events::{BytesCData, BytesDecl, BytesEnd, BytesStart, BytesText, Event};
use quick_xml::Writer;
use serde_json::{Map, Value};

use crate::xml::types::XmlElement;

fn value_to_string(v: &Value) -> String {
    match v {
        Value::String(s) => s.clone(),
        Value::Number(n) => n.to_string(),
        Value::Bool(b) => b.to_string(),
        Value::Null => String::new(),
        _ => serde_json::to_string(v).unwrap_or_default(),
    }
}

fn write_element<W: std::io::Write>(
    writer: &mut Writer<W>,
    name: &str,
    content: &Value,
    indent_level: usize,
) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    let indent = "    ".repeat(indent_level);
    let child_indent = "    ".repeat(indent_level + 1);

    match content {
        Value::Object(obj) => {
            let (attrs, children): (Vec<_>, Vec<_>) =
                obj.iter().partition(|(k, _)| k.starts_with('@'));

            let attr_name = |k: &str| k.trim_start_matches('@').to_string();

            let mut text_content = String::new();
            let mut raw_text_content = String::new();
            let mut comment_content = String::new();
            let mut text_tail_content = String::new();
            let mut cdata_content = String::new();
            let mut is_compact = false;
            let child_elements: Vec<(&String, &Value)> = children
                .iter()
                .filter_map(|(k, v)| {
                    if *k == "#text" {
                        text_content = value_to_string(v);
                        None
                    } else if *k == "#raw-text" {
                        raw_text_content = value_to_string(v);
                        None
                    } else if *k == "#comment" {
                        comment_content = value_to_string(v);
                        None
                    } else if *k == "#text-tail" {
                        text_tail_content = value_to_string(v);
                        None
                    } else if *k == "#cdata" {
                        cdata_content = value_to_string(v);
                        None
                    } else if *k == "#compact" {
                        is_compact = v.as_bool().unwrap_or(false);
                        None
                    } else {
                        Some((*k, *v))
                    }
                })
                .collect();

            let attrs: Vec<(String, String)> = attrs
                .iter()
                .map(|(k, v)| (attr_name(k), value_to_string(v)))
                .collect();

            let mut start = BytesStart::new(name);
            for (k, v) in &attrs {
                start.push_attribute((k.as_str(), v.as_str()));
            }
            writer.write_event(Event::Start(start))?;

            let has_mixed_content = !cdata_content.is_empty()
                || !text_content.is_empty()
                || !raw_text_content.is_empty()
                || !comment_content.is_empty()
                || !text_tail_content.is_empty();

            if is_compact
                && child_elements.len() == 1
                && matches!(child_elements[0].1, Value::Object(_))
            {
                // Single-element wrapper with zero surrounding whitespace in the source
                // (e.g. `<connector><targetReference>X</targetReference></connector>`) --
                // render the wrapper and its one child on the same line, with no
                // indent/newline in between, matching the original formatting.
                let (child_name, child_value) = child_elements[0];
                write_element(writer, child_name, child_value, indent_level)?;
            } else {
                if !child_elements.is_empty() {
                    writer.write_event(Event::Text(BytesText::new(
                        format!("\n{}", child_indent).as_str(),
                    )))?;

                    let child_count = child_elements.len();
                    for (idx, (child_name, child_value)) in child_elements.iter().enumerate() {
                        let is_last = idx == child_count - 1;
                        match child_value {
                            Value::Array(arr) => {
                                let arr_len = arr.len();
                                for (i, item) in arr.iter().enumerate() {
                                    let arr_last = i == arr_len - 1;
                                    write_element(writer, child_name, item, indent_level + 1)?;
                                    if !arr_last {
                                        writer.write_event(Event::Text(BytesText::new(
                                            format!("\n{}", child_indent).as_str(),
                                        )))?;
                                    }
                                }
                                if !is_last {
                                    writer.write_event(Event::Text(BytesText::new(
                                        format!("\n{}", child_indent).as_str(),
                                    )))?;
                                }
                            }
                            Value::Object(_) => {
                                write_element(writer, child_name, child_value, indent_level + 1)?;
                                if !is_last {
                                    writer.write_event(Event::Text(BytesText::new(
                                        format!("\n{}", child_indent).as_str(),
                                    )))?;
                                }
                            }
                            _ => {
                                writer.write_event(Event::Start(BytesStart::new(
                                    child_name.as_str(),
                                )))?;
                                writer.write_event(Event::Text(BytesText::new(
                                    value_to_string(child_value).as_str(),
                                )))?;
                                writer
                                    .write_event(Event::End(BytesEnd::new(child_name.as_str())))?;
                                if !is_last {
                                    writer.write_event(Event::Text(BytesText::new(
                                        format!("\n{}", child_indent).as_str(),
                                    )))?;
                                }
                            }
                        }
                    }

                    writer.write_event(Event::Text(BytesText::new(
                        format!("\n{}", indent).as_str(),
                    )))?;
                }

                // A single element can carry both real child elements *and* its own
                // direct mixed content (e.g. `<item><fullName>X</fullName><![CDATA[..]]></item>`).
                // child_elements and the various *_content locals are mutually
                // populated from disjoint keys (see the filter_map above), so this
                // must run independently of the child_elements branch rather than as
                // an `else if` - otherwise a real child element sibling silently
                // discards any #text/#cdata/#comment/#text-tail on the same element.
                if has_mixed_content {
                    // Add newline+indent before content when no leading text and no
                    // child elements already provided one (keeps CDATA/comment on
                    // their own line without doubling up on the child_elements
                    // branch's own trailing newline+indent above).
                    if child_elements.is_empty()
                        && text_content.is_empty()
                        && raw_text_content.is_empty()
                        && comment_content.is_empty()
                    {
                        writer.write_event(Event::Text(BytesText::new(
                            format!("\n{}", child_indent).as_str(),
                        )))?;
                    }
                    // Output in order: #text, #raw-text, #comment, #text-tail, #cdata
                    if !text_content.is_empty() {
                        writer.write_event(Event::Text(BytesText::new(text_content.as_str())))?;
                    }
                    // #raw-text: sidecar content injected pre-unescaped; use partial_escape so
                    // literal " in YAML is not converted to &quot; but < > & are still safe.
                    if !raw_text_content.is_empty() {
                        writer.write_event(Event::Text(BytesText::from_escaped(
                            partial_escape(raw_text_content.as_str()),
                        )))?;
                    }
                    if !comment_content.is_empty() {
                        // XML comment content is never subject to entity resolution on
                        // read (the reader stores it raw - see parse_xml_cdata.rs's
                        // Event::Comment handling), so it must never be escaped on
                        // write either. `BytesText::new` escapes (quick-xml treats it
                        // like text content); `from_escaped` writes the bytes verbatim.
                        // Using `new` here made every `&` in a comment gain one more
                        // `&amp;` layer on each successive disassemble/reassemble cycle.
                        writer.write_event(Event::Comment(BytesText::from_escaped(
                            comment_content.as_str(),
                        )))?;
                    }
                    if !text_tail_content.is_empty() {
                        writer
                            .write_event(Event::Text(BytesText::new(text_tail_content.as_str())))?;
                    }
                    if !cdata_content.is_empty() {
                        writer
                            .write_event(Event::CData(BytesCData::new(cdata_content.as_str())))?;
                    }
                    // Add newline+indent before closing tag only for CDATA (keeps compact
                    // for text-only), and only when child_elements didn't already add its
                    // own trailing newline+indent above.
                    if !cdata_content.is_empty() && child_elements.is_empty() {
                        writer.write_event(Event::Text(BytesText::new(
                            format!("\n{}", indent).as_str(),
                        )))?;
                    }
                }
            }

            writer.write_event(Event::End(BytesEnd::new(name)))?;
        }
        Value::Array(arr) => {
            for item in arr {
                write_element(writer, name, item, indent_level)?;
            }
        }
        _ => {
            writer.write_event(Event::Start(BytesStart::new(name)))?;
            writer.write_event(Event::Text(BytesText::new(
                value_to_string(content).as_str(),
            )))?;
            writer.write_event(Event::End(BytesEnd::new(name)))?;
        }
    }

    Ok(())
}

fn build_xml_from_object(
    element: &Map<String, Value>,
) -> Result<String, Box<dyn std::error::Error + Send + Sync>> {
    // Use Writer::new (no indent) so leaf elements stay compact and match fixture format
    let mut writer = Writer::new(Vec::new());

    let (declaration, root_key, root_value) = if let Some(decl) = element.get("?xml") {
        let root_key = element
            .keys()
            .find(|k| *k != "?xml")
            .cloned()
            .unwrap_or_else(|| "root".to_string());
        let root_value = element
            .get(&root_key)
            .cloned()
            .unwrap_or_else(|| Value::Object(Map::new()));
        (Some(decl), root_key, root_value)
    } else {
        let root_key = element
            .keys()
            .next()
            .cloned()
            .unwrap_or_else(|| "root".to_string());
        let root_value = element
            .get(&root_key)
            .cloned()
            .unwrap_or_else(|| Value::Object(Map::new()));
        (None, root_key, root_value)
    };

    if let Some(obj) = declaration.and_then(|d| d.as_object()) {
        let version = obj
            .get("@version")
            .and_then(|v| v.as_str())
            .unwrap_or("1.0");
        let encoding = obj.get("@encoding").and_then(|v| v.as_str());
        let standalone = obj.get("@standalone").and_then(|v| v.as_str());
        writer.write_event(Event::Decl(BytesDecl::new(version, encoding, standalone)))?;
        writer.write_event(Event::Text(BytesText::new("\n")))?;
    }

    write_element(&mut writer, &root_key, &root_value, 0)?;

    let result = String::from_utf8(writer.into_inner())?;
    Ok(result.trim_end().to_string())
}

/// Build XML string from XmlElement.
pub fn build_xml_string(element: &XmlElement) -> String {
    match element {
        Value::Object(obj) => build_xml_from_object(obj).unwrap_or_default(),
        _ => String::new(),
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    #[test]
    fn build_xml_string_non_object_returns_empty() {
        assert!(build_xml_string(&Value::Array(vec![])).is_empty());
        assert!(build_xml_string(&Value::Null).is_empty());
    }

    #[test]
    fn build_xml_string_simple_root() {
        let el = json!({
            "?xml": { "@version": "1.0", "@encoding": "UTF-8" },
            "root": { "child": "value" }
        });
        let out = build_xml_string(&el);
        assert!(out.contains("<?xml"));
        assert!(out.contains("<root>"));
        assert!(out.contains("<child>value</child>"));
        assert!(out.contains("</root>"));
    }

    #[test]
    fn build_xml_string_with_attributes() {
        let el = json!({
            "root": { "@xmlns": "http://example.com", "a": "b" }
        });
        let out = build_xml_string(&el);
        assert!(out.contains("xmlns"));
        assert!(out.contains("http://example.com"));
        assert!(out.contains("<a>b</a>"));
    }

    #[test]
    fn build_xml_string_with_array() {
        let el = json!({
            "root": { "item": [ { "x": "1" }, { "x": "2" } ] }
        });
        let out = build_xml_string(&el);
        assert!(out.contains("<item>"));
        assert!(out.contains("<x>1</x>"));
        assert!(out.contains("<x>2</x>"));
    }

    #[test]
    fn build_xml_string_without_declaration() {
        let el = json!({ "root": { "a": "b" } });
        let out = build_xml_string(&el);
        assert!(!out.contains("<?xml"));
        assert!(out.contains("<root>"));
    }

    #[test]
    fn build_xml_string_with_text_comment_cdata() {
        let root = json!({
            "#text": "text",
            "#comment": " a comment ",
            "#cdata": "<cdata>"
        });
        let el = json!({
            "?xml": { "@version": "1.0" },
            "root": root
        });
        let out = build_xml_string(&el);
        assert!(out.contains("text"));
        assert!(out.contains("<!--"));
        assert!(out.contains(" a comment "));
        assert!(out.contains("<![CDATA["));
        assert!(out.contains("<cdata>"));
    }

    #[test]
    fn build_xml_string_with_declaration_encoding_standalone() {
        let el = json!({
            "?xml": { "@version": "1.0", "@encoding": "UTF-8", "@standalone": "yes" },
            "root": { "a": "b" }
        });
        let out = build_xml_string(&el);
        assert!(out.contains("<?xml"));
        assert!(out.contains("UTF-8"));
        assert!(out.contains("standalone"));
        assert!(out.contains("<root>"));
    }

    #[test]
    fn build_xml_string_primitive_sibling_children() {
        // Root with multiple children: one object, one primitive (hits _ => branch)
        let el = json!({
            "root": { "obj": { "x": "1" }, "num": 42, "flag": true }
        });
        let out = build_xml_string(&el);
        assert!(out.contains("<obj>"));
        assert!(out.contains("<num>42</num>"));
        assert!(out.contains("<flag>true</flag>"));
    }

    #[test]
    fn build_xml_string_null_child_value() {
        let el = json!({
            "root": { "empty": null }
        });
        let out = build_xml_string(&el);
        assert!(out.contains("<empty>"));
        assert!(out.contains("</empty>"));
        // value_to_string maps Value::Null -> "" explicitly; without that
        // explicit arm it would fall through to serde_json::to_string and
        // emit the literal `null`, so guard against that regression.
        assert!(
            !out.contains("null"),
            "Value::Null child should render as empty content, not the string \"null\": {out}"
        );
        assert!(out.contains("<empty></empty>"));
    }

    #[test]
    fn build_xml_string_primitive_siblings_have_inter_element_indent() {
        // Two primitive sibling children: between the non-last `<a>` and the
        // last `<b>` the writer should emit a newline+indent. The `!is_last`
        // guard on the close-tag indent is otherwise unobservable from
        // single-sibling or array-only fixtures.
        let el = json!({ "root": { "a": 1, "b": 2 } });
        let out = build_xml_string(&el);
        assert!(
            out.contains("<a>1</a>\n    <b>2</b>"),
            "expected `<a>1</a>` to be followed by newline + 4-space indent then `<b>2</b>`, got:\n{out}"
        );
        // And the last sibling should NOT have a trailing inter-sibling indent
        // before `</root>` (only the closing-tag-level indent).
        assert!(
            out.contains("<b>2</b>\n</root>"),
            "expected `<b>2</b>` to be followed directly by the root close tag, got:\n{out}"
        );
    }

    #[test]
    fn build_xml_string_comment_only_leaf() {
        // Comment-only leaf isolates the `!comment_content.is_empty()` leg of
        // the leaf-content guard. Without it the comment branch is never
        // entered and the comment vanishes from the output.
        let el = json!({
            "?xml": { "@version": "1.0" },
            "root": { "#comment": " just a comment " }
        });
        let out = build_xml_string(&el);
        assert!(out.contains("<!--"), "expected comment open in: {out}");
        assert!(
            out.contains(" just a comment "),
            "expected comment text preserved verbatim in: {out}"
        );
        assert!(out.contains("-->"));
    }

    #[test]
    fn build_xml_string_text_tail_only_leaf() {
        // Text-tail-only leaf isolates both the `||` joiner and the
        // `!text_tail_content.is_empty()` check on the leaf-content guard.
        // Without either, the text-tail content is silently dropped.
        let el = json!({
            "?xml": { "@version": "1.0" },
            "root": { "#text-tail": "tail-only-content" }
        });
        let out = build_xml_string(&el);
        assert!(
            out.contains("tail-only-content"),
            "expected text-tail content rendered between root tags, got:\n{out}"
        );
        assert!(out.contains("<root>"));
        assert!(out.contains("</root>"));
    }

    #[test]
    fn build_xml_string_cdata_only_no_text_or_comment() {
        let root = json!({ "#cdata": "only cdata content" });
        let el = json!({ "?xml": { "@version": "1.0" }, "root": root });
        let out = build_xml_string(&el);
        assert!(out.contains("<![CDATA["));
        assert!(out.contains("only cdata content"));
    }

    #[test]
    fn build_xml_string_declaration_only_defaults_root_key() {
        let el = json!({ "?xml": { "@version": "1.0", "@encoding": "UTF-8" } });
        let out = build_xml_string(&el);
        assert!(out.contains("<?xml"));
        assert!(out.contains("<root>"));
    }

    #[test]
    fn build_xml_string_declaration_non_object_skips_decl_write() {
        let el = json!({ "?xml": "not-an-object", "root": { "a": "b" } });
        let out = build_xml_string(&el);
        assert!(!out.contains("<?xml"));
        assert!(out.contains("<root>"));
    }

    #[test]
    fn build_xml_string_root_value_array_sibling_elements() {
        // Root value is Array (write_element Value::Array branch)
        let el = json!({
            "root": [ { "a": "1" }, { "b": "2" } ]
        });
        let out = build_xml_string(&el);
        assert!(out.contains("<root>"));
        assert!(out.contains("<a>1</a>"));
        assert!(out.contains("<b>2</b>"));
        assert!(out.contains("</root>"));
    }

    #[test]
    fn build_xml_string_root_value_primitive() {
        // Root value is primitive (write_element _ branch for top-level content)
        let el = json!({ "root": 42 });
        let out = build_xml_string(&el);
        assert!(out.contains("<root>42</root>"));
    }

    #[test]
    fn build_xml_string_array_child_not_last_sibling_writes_inter_element_indent() {
        // When an array child is NOT the last sibling, `if !is_last` in the
        // Value::Array arm must write an inter-element indent after all array
        // items. Without this path covered, mutating `!is_last` to always-false
        // would drop the indent and merge consecutive tags in the output.
        let el = json!({
            "root": {
                "items": [{ "x": "1" }],
                "sibling": "y"
            }
        });
        let out = build_xml_string(&el);
        assert!(
            out.contains("<items>"),
            "items element must be present: {out}"
        );
        assert!(
            out.contains("<sibling>y</sibling>"),
            "sibling must be present: {out}"
        );
    }

    #[test]
    fn build_xml_string_empty_array_child_produces_no_elements() {
        // A child whose value is an empty array: the inner for-loop body never
        // executes (arr_len == 0) but the is_last/not-is_last indent logic still runs.
        let el = json!({ "root": { "items": [] } });
        let out = build_xml_string(&el);
        // No <items> tags should appear since there are no items
        assert!(
            !out.contains("<items>"),
            "no elements for empty array: {out}"
        );
        assert!(
            out.contains("<root>"),
            "root element must be present: {out}"
        );
    }

    #[test]
    fn build_xml_string_attribute_value_array_uses_serde_fallback() {
        // An attribute value that is an Array hits value_to_string's `_` arm.
        let el = json!({
            "root": { "@tags": ["a", "b"], "child": "v" }
        });
        let out = build_xml_string(&el);
        assert!(
            out.contains("child"),
            "child element must be present: {out}"
        );
    }

    #[test]
    fn build_xml_string_attribute_value_object_uses_serde_fallback() {
        // Attribute value that is Object hits value_to_string _ branch (serde_json::to_string)
        let el = json!({
            "root": { "@complex": { "nested": true }, "child": "v" }
        });
        let out = build_xml_string(&el);
        assert!(out.contains("child"));
        assert!(out.contains("v"));
    }
}