Getting Started

Learn the basic concepts required to automate FlexLogger tests using the Python API.

Prerequisites

Before using the FlexLogger Python API, complete the following tasks.

• Install FlexLogger 2022 Q2 or later and create a FlexLogger project with one or more input channels.

• Enable the Automation server preference in FlexLogger. In FlexLogger, navigate to File>>Preferences and check Enable FlexLogger to receive remote automation commands in the Automation server section of the General tab.

• Download and install Python 3.6 or later from python.org/downloads. For more information on installing and using Python, refer to the Python documentation on docs.python.org. During installation, enable Add Python to PATH so you can execute Python commands more easily.

• Install the FlexLogger Automation Python module, niflexlogger-automation, using the method described below or one of the methods described in the Readme.

If you are new to Python, start by creating and running your first script. If you an experienced Python user, refer to the examples and API reference.

Installing the FlexLogger Automation Python module

Install the FlexLogger Automation Python module so you can control FlexLogger tests programatically.

1. Open the command prompt.

2. Execute the following command to install the module.

   pip install niflexlogger-automation

Creating and running your first script

Use the Start and Stop a Test example code to automate a FlexLogger test. The steps below describe how to perform this task with a text editor and the command prompt. You can also use your favorite integrated development environment (IDE).

1. Close FlexLogger if it is running.

2. Open a text editor.

3. Copy and paste the code provided below.

import os
import sys

from flexlogger.automation import Application


def main(project_path):
    """Launch FlexLogger and open a project."""
    # Note that using the "with" statement here means that when the block
    # goes out of scope, the application will be closed.  To prevent this,
    # call app.disconnect() before the scope ends.
    with Application.launch() as app:
        versions = app.get_version()
        print("FlexLogger version: " + versions[1])
        project = app.open_project(path=project_path, timeout=180)
        print("Press Enter to close project...")
        input()
        project.close()
    return 0


if __name__ == "__main__":
    argv = sys.argv
    if len(argv) < 2:
        print("Usage: %s <path of project to open>" % os.path.basename(__file__))
        sys.exit()
    project_path_arg = argv[1]
    sys.exit(main(project_path_arg))

4. Save the file with a .py extension. For example, my_script.py. Enclose file paths in quotation marks if you have spaces in your folder or file names.

5. Open the command prompt as an administrator.

6. Change the directory to the location where you saved your script. For example,

   cd C:\Users\Desktop

7. Run the script with the python command. The Start and Stop a Test example requires that you provide the path to the project you want to control as an input. Use quotation marks when specifying the path. For example,

   python my_script.py "C:\Users\Desktop\my_FlexLogger_Project.flxproj"

   The Python script launches FlexLogger, opens the project you specified, and starts running a test. The command prompt displays a status message and provides you with the option to stop the test and close the project.

Examples

Communicating with FlexLogger

Launch FlexLogger and open a project

import os
import sys

from flexlogger.automation import Application


def main(project_path):
    """Launch FlexLogger and open a project."""
    # Note that using the "with" statement here means that when the block
    # goes out of scope, the application will be closed.  To prevent this,
    # call app.disconnect() before the scope ends.
    with Application.launch() as app:
        versions = app.get_version()
        print("FlexLogger version: " + versions[1])
        project = app.open_project(path=project_path, timeout=180)
        print("Press Enter to close project...")
        input()
        project.close()
    return 0


if __name__ == "__main__":
    argv = sys.argv
    if len(argv) < 2:
        print("Usage: %s <path of project to open>" % os.path.basename(__file__))
        sys.exit()
    project_path_arg = argv[1]
    sys.exit(main(project_path_arg))

Connect to FlexLogger when it is already running

import sys

from flexlogger.automation import Application


def main():
    """Connect to an already running instance of FlexLogger with an open project

    Note that before connecting to an already running instance of FlexLogger,
    the Automation server preference must be enabled. You can enable this preference by opening the
    "File>>Preferences" menu item, and then enabling the "Automation server" preference in the
    "General" tab.
    """
    app = Application()
    project = app.get_active_project()
    if project is None:
        print("No project is open in FlexLogger!")
        return 1
    test_session_state = project.test_session.state
    print("The test session state is:")
    print(test_session_state)
    print("Press Enter to disconnect from FlexLogger...")
    input()
    app.disconnect()
    return 0


if __name__ == "__main__":
    sys.exit(main())

Test session

Start and stop a test

import os
import sys

from flexlogger.automation import Application


def main(project_path):
    """Launch FlexLogger, open a project, start and stop the test session."""
    with Application.launch() as app:
        project = app.open_project(path=project_path)
        test_session = project.test_session
        test_session.start()
        print("Test started. Press Enter to stop the test and close the project...")
        input()
        test_session.stop()
        project.close()
    return 0


if __name__ == "__main__":
    argv = sys.argv
    if len(argv) < 2:
        print("Usage: %s <path of project to open>" % os.path.basename(__file__))
        sys.exit()
    project_path_arg = argv[1]
    sys.exit(main(project_path_arg))

Adding a note to a log file

import os
import sys

from flexlogger.automation import Application


def main(project_path):
    """Launch FlexLogger, open a project, start the test session and add a note."""
    with Application.launch() as app:
        project = app.open_project(path=project_path)
        test_session = project.test_session
        test_session.start()
        note = input("Test started. Enter a note to log: ")
        test_session.add_note(note)
        print("Note added. Press Enter to stop the test and close the project...")
        input()

        test_session.stop()
        project.close()
    return 0


if __name__ == "__main__":
    argv = sys.argv
    if len(argv) < 2:
        print("Usage: %s <path of project to open>" % os.path.basename(__file__))
        sys.exit()
    project_path_arg = argv[1]
    sys.exit(main(project_path_arg))

Channels

Getting the value of a channel

import os
import sys

from flexlogger.automation import Application


def main(project_path):
    """Launch FlexLogger, open a project, and get the value of a channel."""
    with Application.launch() as app:
        project = app.open_project(path=project_path)
        channel_name = input("Enter the name of the channel to get the value of: ")
        channel_specification = project.open_channel_specification_document()
        channel_value = channel_specification.get_channel_value(channel_name)
        print("Channel value:")
        print(channel_value)
        print("Press Enter to close the project...")
        input()
        project.close()
    return 0


if __name__ == "__main__":
    argv = sys.argv
    if len(argv) < 2:
        print("Usage: %s <path of project to open>" % os.path.basename(__file__))
        sys.exit()
    project_path_arg = argv[1]
    sys.exit(main(project_path_arg))

Setting the value of a channel

import os
import sys

from flexlogger.automation import Application


def main(project_path):
    """Launch FlexLogger, open a project, and sets the value of a channel."""
    with Application.launch() as app:
        project = app.open_project(path=project_path)
        channel_name = input("Enter the name of the channel to set the value of: ")
        channel_value = input("Enter the new channel value: ")
        channel_specification = project.open_channel_specification_document()
        channel_specification.set_channel_value(channel_name, float(channel_value))
        print("Channel value set. Press Enter to close the project...")
        input()
        project.close()
    return 0


if __name__ == "__main__":
    argv = sys.argv
    if len(argv) < 2:
        print("Usage: %s <path of project to open>" % os.path.basename(__file__))
        sys.exit()
    project_path_arg = argv[1]
    sys.exit(main(project_path_arg))

Logging

Getting the log file base path and name

import os
import sys

from flexlogger.automation import Application


def main(project_path):
    """Launch FlexLogger, open a project, and gets the log file base path and name."""
    with Application.launch() as app:
        project = app.open_project(path=project_path)
        logging_specification = project.open_logging_specification_document()
        log_file_base_path = logging_specification.get_log_file_base_path()
        log_file_name = logging_specification.get_log_file_name()
        print("Log file base path: " + log_file_base_path)
        print("Log file name: " + log_file_name)
        print("Press Enter to close the project...")
        input()
        project.close()
    return 0


if __name__ == "__main__":
    argv = sys.argv
    if len(argv) < 2:
        print("Usage: %s <path of project to open>" % os.path.basename(__file__))
        sys.exit()
    project_path_arg = argv[1]
    sys.exit(main(project_path_arg))

Setting the log file base path and name

import os
import sys

from flexlogger.automation import Application


def main(project_path):
    """Launch FlexLogger, open a project, and sets the log file base path and name."""
    with Application.launch() as app:
        project = app.open_project(path=project_path)
        log_file_base_path = input("Enter the log file base path: ")
        log_file_name = input("Enter the log file name: ")
        logging_specification = project.open_logging_specification_document()
        logging_specification.set_log_file_base_path(log_file_base_path)
        logging_specification.set_log_file_name(log_file_name)
        print("Log file base path and name set. Press Enter to close the project...")
        input()
        project.close()
    return 0


if __name__ == "__main__":
    argv = sys.argv
    if len(argv) < 2:
        print("Usage: %s <path of project to open>" % os.path.basename(__file__))
        sys.exit()
    project_path_arg = argv[1]
    sys.exit(main(project_path_arg))

Getting a test property

import os
import sys

from flexlogger.automation import Application


def main(project_path):
    """Launch FlexLogger, open a project, and gets the value of a test property."""
    with Application.launch() as app:
        project = app.open_project(path=project_path)
        test_property_name = input("Enter the name of the test property to get the value of: ")
        logging_specification = project.open_logging_specification_document()
        test_property = logging_specification.get_test_property(test_property_name)
        print("Test property:")
        print(test_property)
        print("Press Enter to close the project...")
        input()
        project.close()
    return 0


if __name__ == "__main__":
    argv = sys.argv
    if len(argv) < 2:
        print("Usage: %s <path of project to open>" % os.path.basename(__file__))
        sys.exit()
    project_path_arg = argv[1]
    sys.exit(main(project_path_arg))

Setting a test property

import os
import sys

from flexlogger.automation import Application


def main(project_path):
    """Launch FlexLogger, open a project, and sets the value of a test property."""
    with Application.launch() as app:
        project = app.open_project(path=project_path)
        test_property_name = input("Enter the name of the test property to set the value of: ")
        test_property_value = input("Enter the test property value: ")
        logging_specification = project.open_logging_specification_document()
        logging_specification.set_test_property(test_property_name, test_property_value)
        print("Test property set. Press Enter to close the project...")
        input()
        project.close()
    return 0


if __name__ == "__main__":
    argv = sys.argv
    if len(argv) < 2:
        print("Usage: %s <path of project to open>" % os.path.basename(__file__))
        sys.exit()
    project_path_arg = argv[1]
    sys.exit(main(project_path_arg))

Troubleshooting

Can’t connect to running FlexLogger

If you get an error connecting to an already running instance of FlexLogger, the Automation server preference may not be enabled. You can enable this preference by opening the “File>>Preferences” menu item, and then enabling the “Automation server” preference in the “General” tab.

Exception on first call into FlexLogger

If you see an exception on the first call into FlexLogger similar to:

grpc._channel._InactiveRpcError: <_InactiveRpcError of RPC that terminated with:
      status = StatusCode.UNAVAILABLE
      details = "failed to connect to all addresses"
      debug_error_string = "{"created":"@1608052709.612000000","description":"Failed to pick subchannel","file":"src/core/ext/filters/client_channel/client_channel.cc","file_line":4143,"referenced_errors":[{"created":"@1608052633.077000000","description":"failed to connect to all addresses","file":"src/core/ext/filters/client_channel/lb_policy/pick_first/pick_first.cc","file_line":398,"grpc_status":14}]}"

the problem may be an HTTP proxy. To test this, in your Python script add the following lines before your FlexLogger API calls:

if os.environ.get('https_proxy'):
   del os.environ['https_proxy']
if os.environ.get('http_proxy'):
   del os.environ['http_proxy']

If this fixes the problem, try configuring your proxy to not affect traffic to localhost. See this GitHub issue for an example.