Create your first test

Let's create a first test script in under five minutes.

OpenHTF documentation header showing how to create and run your first test script.

Installation

Install OpenHTF and its dependencies using pip:

pip install openhtf six setuptools

We recommend setting up a Python virtual environment to better manage dependencies.

First run

Create a main.py file in your virtual environment and copy this code.

main.py

import openhtf as htf

def hello_world(test):              # Define "hello_world" phase
    print('Hello world!')
    return htf.PhaseResult.CONTINUE # Continue to next phase

def main():
    test = htf.Test(hello_world)    # Define test with hello_world
    test.execute(lambda: "PCB001")  # Execute with DUT serial

if __name__ == '__main__':
    main()                          # Run main function

Run it with:

python main.py

Terminal

(venv) C:\tofupilot > python main.py
Hello world!

======================= test: openhtf_test  outcome: PASS ======================

🎉 Congratulations! You just ran your first OpenHTF test and it’s a pass! Easy, right?

This is a very simple OpenHTF test, running through the command line without the Operator UI yet. You'll learn to connect instruments, add measurements, and more in the next sections.

Was this page helpful?