TF Automate Debugger – TestFirst

1. Introduction

The TF Automate Debugger is a tool that allows you to pause and inspect your test executions in real time. Whether you're troubleshooting a failing step or verifying values mid-execution, the debugger helps you stay in control and fix issues faster.

This guide walks you through how to enable the debugger, use its features, and understand the tools available during a test run.

2. Enabling the Debugger

When you open one of the test cases in TF Automate, look for the toggle labeled "Debug" (located above the editor, next to the "Screenshots" toggle ).
Turn it ON to enable the debugger.

3. Using the Debugger During a Test Run

3.1 Adding and Removing Breakpoints

Breakpoints allow you to pause the test at specific steps.

To set a breakpoint, click on the line number of any step in your test.
To remove a breakpoint, click the line number again.

This lets you pause test execution exactly where you want to inspect the test behavior.

3.2 Pausing and Controlling Execution

When your test hits a breakpoint or when you pause it manually, you gain access to a set of controls:

Control	Description
Resume test	Continues running the test until the next breakpoint or the end of the test.
Run current step and move to next	Executes the current step and stops at the next step.
Run current step and stay on it	Re-runs the current step and pauses again on the same line (useful for retries).
Skip current step	Skips the current step and continues execution from the next step.
Stop test	Terminates the test immediately.

These options give you granular control over the flow of your test.

3.3 Actions Detail

You can pause the test by setting a breakpoint—just click on the line number of the desired step.

For example, in the following image, line number 9 has a breakpoint set. To remove the breakpoint, click on that line number again.

After setting the breakpoint and running the test, execution will stop when line number 9 is reached. See example in this image:

Once the test is paused, you can use the debugging actions:

In the debug console, you will see six action icons and a status indicator.

Pause test: Manually pauses the test run or triggers a pause at a breakpoint.

Resume test: Resumes test execution from the paused state.

Run current step and move to next: Executes the current step and pauses at the following step. For example, if paused at line 9 and you click this, it will run line 9 and pause at line 10.

Run current step and stay on it: Re-runs the current step (line 9) and pauses again at the same step—useful for retries or closer inspection.

Skip current step: Skips the current step and continues running from the next one.

Stop test: Immediately terminates the test run.

The status indicator shows "Paused" when the test is paused and "Running" when it is actively executing.

4. Debugging Tools and Information

4.1 Viewing Local Variables

When the test is paused, you can view all local variables and their values.
This helps you understand what data is being passed and how your test logic is behaving at each step.

4.2 Debug Log (Live View)

As your test runs, the debug log updates in real time, showing detailed execution data. This helps you trace the exact behavior of your test.

4.3 Execution Log

You can also access the traditional execution log to review test steps, timing, and outcomes as before. It complements the debug log for full traceability.

Tips for Best Use

Use breakpoints on critical steps where you expect something to go wrong.
Pause and inspect if something looks off instead of waiting for the whole test to finish.
Watch local variables to spot incorrect values early.