From 956b03422df96dff8dfca0af419dd17167633947 Mon Sep 17 00:00:00 2001
From: Jeff McKenzie <heroinbob@users.noreply.github.com>
Date: Fri, 1 Nov 2024 09:37:05 -0500
Subject: [PATCH] [DEV] Update XML tests to eliminate false failures (#206)

---
 test/http_test.exs        |  7 ++-
 test/xml/encoder_test.exs | 90 +++++++++++++++++++++++++++++++++++----
 2 files changed, 87 insertions(+), 10 deletions(-)

diff --git a/test/http_test.exs b/test/http_test.exs
index 549959f..4515353 100644
--- a/test/http_test.exs
+++ b/test/http_test.exs
@@ -46,8 +46,11 @@ defmodule Braintree.HTTPTest do
   test "encode_body/1 converts the request body to xml" do
     params = %{company: "Soren", first_name: "Parker"}
 
-    assert HTTP.encode_body(params) ==
-             ~s|<?xml version="1.0" encoding="UTF-8" ?>\n<company>Soren</company>\n<first-name>Parker</first-name>|
+    assert [xml_tag | nodes] = params |> HTTP.encode_body() |> String.split("\n")
+
+    assert xml_tag == ~s|<?xml version="1.0" encoding="UTF-8" ?>|
+    assert ~s|<company>Soren</company>| in nodes
+    assert ~s|<first-name>Parker</first-name>| in nodes
   end
 
   test "encode_body/1 ignores empty bodies" do
diff --git a/test/xml/encoder_test.exs b/test/xml/encoder_test.exs
index 2c4d6c6..fd2aa0f 100644
--- a/test/xml/encoder_test.exs
+++ b/test/xml/encoder_test.exs
@@ -5,21 +5,95 @@ defmodule Braintree.XML.EncoderTest do
 
   import Braintree.XML.Encoder, only: [dump: 1]
 
+  @xml_tag ~s|<?xml version="1.0" encoding="UTF-8" ?>|
+
   describe "dump/1" do
     test "with content" do
-      assert dump(%{company: "Soren", first_name: "Parker"}) ==
-               ~s|<?xml version="1.0" encoding="UTF-8" ?>\n<company>Soren</company>\n<first-name>Parker</first-name>|
+      assert [xml_tag | nodes] =
+               %{company: "Soren", first_name: "Parker"}
+               |> dump()
+               |> String.split("\n")
+
+      # Order isn't guaranteed when iterating on a map.
+      assert xml_tag == @xml_tag
+      assert ~s|<company>Soren</company>| in nodes
+      assert ~s|<first-name>Parker</first-name>| in nodes
     end
 
     test "with children" do
-      assert dump(%{company: "Soren", nested: %{name: "Parker"}}) ==
-               ~s|<?xml version="1.0" encoding="UTF-8" ?>\n<company>Soren</company>\n<nested>\n<name>Parker</name>\n</nested>|
+      assert [xml_tag | nodes] =
+               %{company: "Soren", nested: %{name: "Parker"}}
+               |> dump()
+               |> String.split("\n")
+
+      assert xml_tag == @xml_tag
+
+      assert nodes == ~w[<company>Soren</company> <nested> <name>Parker</name> </nested>] or
+               nodes == ~w[<nested> <name>Parker</name> </nested> <company>Soren</company>]
+
+      assert [xml_tag | nodes] =
+               %{company: "Soren", nested: [%{name: "Parker"}, %{name: "Shannon"}]}
+               |> dump()
+               |> String.split("\n")
+
+      assert xml_tag == @xml_tag
+
+      assert nodes in [
+               [
+                 "<company>Soren</company>",
+                 ~s|<nested type="array">|,
+                 "<item>",
+                 "<name>Parker</name>",
+                 "</item>",
+                 "<item>",
+                 "<name>Shannon</name>",
+                 "</item>",
+                 "</nested>"
+               ],
+               [
+                 ~s|<nested type="array">|,
+                 "<item>",
+                 "<name>Parker</name>",
+                 "</item>",
+                 "<item>",
+                 "<name>Shannon</name>",
+                 "</item>",
+                 "</nested>",
+                 "<company>Soren</company>"
+               ]
+             ]
+
+      assert [xml_tag | nodes] =
+               %{company: "Soren", pets: ["cat", "dog"]}
+               |> dump()
+               |> String.split("\n")
 
-      assert dump(%{company: "Soren", nested: [%{name: "Parker"}, %{name: "Shannon"}]}) ==
-               ~s|<?xml version="1.0" encoding="UTF-8" ?>\n<company>Soren</company>\n<nested type="array">\n<item>\n<name>Parker</name>\n</item>\n<item>\n<name>Shannon</name>\n</item>\n</nested>|
+      assert xml_tag == @xml_tag
 
-      assert dump(%{company: "Soren", pets: ["cat", "dog"]}) ==
-               ~s|<?xml version="1.0" encoding="UTF-8" ?>\n<company>Soren</company>\n<pets type="array">\n<item>\ncat\n</item>\n<item>\ndog\n</item>\n</pets>|
+      assert nodes in [
+               [
+                 "<company>Soren</company>",
+                 ~s|<pets type="array">|,
+                 "<item>",
+                 "cat",
+                 "</item>",
+                 "<item>",
+                 "dog",
+                 "</item>",
+                 "</pets>"
+               ],
+               [
+                 ~s|<pets type="array">|,
+                 "<item>",
+                 "cat",
+                 "</item>",
+                 "<item>",
+                 "dog",
+                 "</item>",
+                 "</pets>",
+                 "<company>Soren</company>"
+               ]
+             ]
     end
   end
 end