ipa role update for vfido add register

vfido_passkey_add_register was failing occasionally due to some
flakiness in the virtual fido emulation.  Adding a retry loop to the
function to make it more resilient.

Author: spoore1

sssd_test_framework/roles/ipa.py

@@ -5,6 +5,7 @@
 import os
 import re
 import shlex
+import time
 import uuid
 from itertools import groupby
 from textwrap import dedent
@@ -1129,46 +1130,55 @@ def vfido_passkey_add_register(
 
         client.host.conn.exec(["kinit", f"{self.host.adminuser}@{self.host.realm}"], input=self.host.adminpw)
 
-        result = client.host.conn.expect(
-            f"""
-            set pin "{pin}"
-            set timeout 60
-
-            spawn ipa user-add-passkey {self.name} --register
-            set ID_reg $spawn_id
+        def run_expect():
+            return client.host.conn.expect(
+                f"""
+                set pin "{pin}"
+                set timeout 60
+                spawn ipa user-add-passkey {self.name} --register
+                set ID_reg $spawn_id
+
+                if {{ ($pin ne "empty") }} {{
+                    expect {{
+                        -i $ID_reg -re "Enter PIN:*" {{}}
+                        -i $ID_reg timeout {{puts "expect result: Unexpected output"; exit 201}}
+                        -i $ID_reg eof {{puts "expect result: Unexpected end of file"; exit 202}}
+                    }}
+
+                    puts "Entering PIN\n"
+                    send -i $ID_reg "{pin}\r"
+                }}
 
-            if {{ ($pin ne "empty") }} {{
                 expect {{
-                    -i $ID_reg -re "Enter PIN:*" {{}}
-                    -i $ID_reg timeout {{puts "expect result: Unexpected output"; exit 201}}
-                    -i $ID_reg eof {{puts "expect result: Unexpected end of file"; exit 202}}
+                    -i $ID_reg -re "Please touch the device.*" {{}}
+                    -i $ID_reg timeout {{puts "expect result: Unexpected output"; exit 203}}
+                    -i $ID_reg eof {{puts "expect result: Unexpected end of file"; exit 204}}
                 }}
 
-                puts "Entering PIN\n"
-                send -i $ID_reg "{pin}\r"
-            }}
-
-            expect {{
-                -i $ID_reg -re "Please touch the device.*" {{}}
-                -i $ID_reg timeout {{puts "expect result: Unexpected output"; exit 203}}
-                -i $ID_reg eof {{puts "expect result: Unexpected end of file"; exit 204}}
-            }}
-
-            puts "Touching device"
-            spawn {test_venv_bin}/vfido_touch
-            set ID_touch $spawn_id
+                puts "Touching device"
+                spawn {test_venv_bin}/vfido_touch
+                set ID_touch $spawn_id
+                expect {{
+                    -i $ID_reg -re "Added passkey mappings.*" {{}}
+                    -i $ID_reg timeout {{puts "expect result: Unexpected output"; exit 205}}
+                    -i $ID_reg eof {{puts "expect result: Unexpected end of file"; exit 206}}
+                }}
 
-            expect {{
-                -i $ID_reg -re "Added passkey mappings.*" {{}}
-                -i $ID_reg timeout {{puts "expect result: Unexpected output"; exit 205}}
-                -i $ID_reg eof {{puts "expect result: Unexpected end of file"; exit 206}}
-            }}
+                expect -i $ID_reg eof
+                expect -i $ID_touch eof
+                """,
+                raise_on_error=False,
+            )
 
-            expect -i $ID_reg eof
-            expect -i $ID_touch eof
-            """,
-            raise_on_error=True,
-        )
+        retry = 0
+        max_retries = 5
+        result = run_expect()
+        while result.rc != 0:
+            if retry == max_retries:
+                raise AssertionError("Unable to register passkey for IPA user")
+            result = run_expect()
+            retry += 1
+            time.sleep(1)
 
         return result.stdout_lines[-1].strip()