CA-358870: Fix 1: filter_xapi_clusterd_db: remove token from the report

The 'token' is an API token that is used to authenticate all API
requests to the xapi-clusterd daemon.

- Apply the fix originally developed and tested by Edwin.
- Update the tests:

  - Ensure that the fix works and keeps working across future changes.

Co-authored-by: Bernhard Kaindl <[email protected]>
Signed-off-by: Edwin Török <[email protected]>

tests/unit/test_filter_xapi_clusterd_db.py

@@ -94,7 +94,7 @@
 # Same as original, but with passwords and private data replaced by: "REMOVED"
 # BUG: "secret-token" has to be replaced by "REMOVED"
 EXPECTED = r"""{
-    "token": "secret-token",
+    "token": "REMOVED",
     "cluster_config": {
         "pems": {
             "blobs": "REMOVED"
@@ -197,7 +197,6 @@ def test_pems_blobs(bugtool):
 
 
 # CA-358870: filter_xapi_clusterd_db: remove token from the report
-@pytest.mark.xfail(reason="bugtool currently fails to remove the token")
 @pytest.mark.usefixtures("tmpdir")
 def test_remove_token(bugtool):
     """CA-358870: Assert that filter_xapi_clusterd_db() removes the token"""

xen-bugtool

@@ -1512,6 +1512,8 @@ def filter_xapi_clusterd_db(cap):
                 clusterd_data[config_key]['pems']['blobs'] = "REMOVED"
                 clusterd_data[config_key]['authkey'] = "REMOVED"
 
+        if "token" in clusterd_data:
+            clusterd_data["token"] = "REMOVED"
         output_str = json.dumps(clusterd_data)
     except Exception:
         output_str = ''