[6.18.z] Fix httpboot provisioning test

[Satellite-QE]

Cherrypick of PR: #19906

Fix httpboot provisioning test failing due to BoxKeyError

[Satellite-QE]

trigger: test-robottelo
pytest: tests/foreman/api/test_provisioning.py -k test_rhel_httpboot_provisioning
provisioning: true

[sourcery-ai]

Hey there - I've reviewed your changes - here's some feedback:

• The new log check relies on a fixed time.sleep(20) before reading the shell output, which may introduce flakiness across slower/faster environments; consider using wait_for or another condition-based wait on the HTTP request line instead of a hard-coded delay.
• The sequence shell.close() followed by shell.read() may not be safe depending on the shell API semantics; consider reading the buffer before closing, or explicitly confirming that read() on a closed shell is supported and deterministic.
• The assertions previously wrapped timeout handling and produced a clear error when the log line was not found; with the new direct assert ... in str(shell.read()) you lose that context, so consider adding a more descriptive assertion message or explicit handling when the expected HTTP request is missing.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- The new log check relies on a fixed `time.sleep(20)` before reading the shell output, which may introduce flakiness across slower/faster environments; consider using `wait_for` or another condition-based wait on the HTTP request line instead of a hard-coded delay.
- The sequence `shell.close()` followed by `shell.read()` may not be safe depending on the shell API semantics; consider reading the buffer before closing, or explicitly confirming that `read()` on a closed shell is supported and deterministic.
- The assertions previously wrapped timeout handling and produced a clear error when the log line was not found; with the new direct `assert ... in str(shell.read())` you lose that context, so consider adding a more descriptive assertion message or explicit handling when the expected HTTP request is missing.

## Individual Comments

### Comment 1
<location> `tests/foreman/api/test_provisioning.py:393-397` </location>
<code_context>
+    host_mac_addr = host_mac_addr.replace(":", "-")
+    shell = sat.session.shell()
     shell.send('foreman-tail')
+    time.sleep(20)
     shell.close()
-    assert_host_logs(shell, f'GET /httpboot/grub2/grub.cfg-{host_mac_addr} with 200')
+    assert f'GET /httpboot/host-config/{host_mac_addr}/grub2/boot.efi with 200' in str(shell.read())
+
     # Host should do call back to the Satellite reporting
</code_context>

<issue_to_address>
**suggestion (testing):** Fixed `time.sleep` with a single assertion makes this e2e test brittle and timing-sensitive

A fixed `time.sleep(20)` followed by a single `assert ... in shell.read()` introduces a race: if the log line appears just after 20s, the test fails even though behavior is correct. Instead, wrap the log check in a `wait_for`-style loop that repeatedly reads the shell buffer until the substring appears or a timeout is reached, similar to the previous `assert_host_logs` behavior. This will make the test more robust and less timing-dependent.

```suggestion
    shell = sat.session.shell()
    shell.send('foreman-tail')

    def _httpboot_log_present():
        """
        Poll the remote foreman-tail output until the expected HTTPBoot request
        shows up in the logs or the wait_for timeout is reached.
        """
        return (
            f'GET /httpboot/host-config/{host_mac_addr}/grub2/boot.efi with 200'
            in str(shell.read())
        )

    # Wait for the provisioning HTTPBoot request to appear in the logs instead
    # of relying on a fixed sleep, to avoid timing-sensitive flakes.
    wait_for(_httpboot_log_present, timeout=60, delay=5)

    shell.close()
```
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[Satellite-QE]

PRT Result

Build Number: 13617
Build Status: UNSTABLE
PRT Comment: pytest tests/foreman/api/test_provisioning.py -k test_rhel_httpboot_provisioning --external-logging --include-onprem-provisioning
Test Result : ========== 33 deselected, 21 warnings, 4 errors in 1509.10s (0:25:09) ==========

[Gauravtalreja1]

trigger: test-robottelo
pytest: tests/foreman/api/test_provisioning.py -k test_rhel_httpboot_provisioning
provisioning: true

[Satellite-QE]

PRT Result

Build Number: 13783
Build Status: UNSTABLE
PRT Comment: pytest tests/foreman/api/test_provisioning.py -k test_rhel_httpboot_provisioning --external-logging --include-onprem-provisioning
Test Result : ==== 1 failed, 3 passed, 33 deselected, 514 warnings in 8981.69s (2:29:41) =====