Skip to main content

Settings Reference

This page is a quick reference for TestBench extension settings.

  • Use the Setting column when browsing settings in VS Code.
  • Use the Setting ID column when editing .vscode/settings.json or searching by ID.

For deeper behavior of generation and import related options (provided by the bundled TestBench2RobotFramework tooling), see the TestBench2RobotFramework documentation.

Settings are grouped in VS Code under these categories:

  • Login
  • Logger
  • TestBench2RobotFramework
  • Test Generation
  • Connection

Login

SettingSetting IDValue TypeDefaultDescription
Automatic Login After Extension ActivationtestbenchExtension.automaticLoginAfterExtensionActivationBooleanfalseAutomatically attempts login on startup using the last active connection, if one is available.

Logger

SettingSetting IDValue TypeDefaultDescription
Testbench Log LeveltestbenchExtension.testbenchLogLevelEnumInfoMinimum log level. Options: No logging, Trace, Debug, Info, Warn, Error.

TestBench2RobotFramework

SettingSetting IDValue TypeDefaultDescription
Clean Files Before Test GenerationtestbenchExtension.cleanFilesBeforeTestGenerationBooleantrueDeletes existing files in the output directory before generating new suites.
Fully Qualified KeywordstestbenchExtension.fullyQualifiedKeywordsBooleanfalseUses fully qualified keyword calls in generated suites, for example ResourceOrLibrary.Keyword.
Output DirectorytestbenchExtension.outputDirectoryStringtestsOutput location for generated suites (relative to workspace). A ZIP archive path is also supported by the underlying generator.
Compound Keyword LoggingtestbenchExtension.compoundKeywordLoggingEnumGROUPLogging mode for compound keywords: GROUP, COMMENT, NONE.
Log Suite NumberingtestbenchExtension.logSuiteNumberingBooleantrueAdds numbering prefixes to generated suite folder and file names, for example 1_Name.robot.
Resource Directory PathtestbenchExtension.resourceDirectoryPathStringemptyBase directory for generated or managed .resource files (relative to workspace).
Resource Root RegextestbenchExtension.resourceRootRegexString.*Regex anchor used when mapping subdivision hierarchy to local resource folder paths and imports.
Library MarkertestbenchExtension.libraryMarkerList of strings["[Robot-Library]"]Marker suffixes used to identify library subdivisions.
Library RoottestbenchExtension.libraryRootList of strings["RF", "RF-Library"]Root nodes used to identify the library hierarchy.
Resource MarkertestbenchExtension.resourceMarkerList of strings["[Robot-Resource]"]Marker suffixes used to identify resource subdivisions.
Resource RoottestbenchExtension.resourceRootList of strings["RF-Resource"]Root nodes used to identify the resource hierarchy.
Library MappingtestbenchExtension.libraryMappingList of strings[]Optional subdivision-to-library import mappings in the form <Subdivision>:<Library Import>.
Resource MappingtestbenchExtension.resourceMappingList of strings[]Optional subdivision-to-resource import mappings in the form <Subdivision>:<Resource Import>.
Output Xml File PathtestbenchExtension.outputXmlFilePathStringresults/output.xmlPath to the Robot Framework output XML used for execution result import (relative to workspace).

Test Generation

SettingSetting IDValue TypeDefaultDescription
Clear Internal Testbench Directory Before Test GenerationtestbenchExtension.clearInternalTestbenchDirectoryBeforeTestGenerationBooleanfalseClears internal .testbench files before generation (except protected internal artifacts).
Open Testing View After Test GenerationtestbenchExtension.openTestingViewAfterTestGenerationBooleanfalseOpens the VS Code Testing view automatically after generation.

Connection

SettingSetting IDValue TypeDefaultDescription
Certificate PathtestbenchExtension.certificatePathStringemptyOptional custom PEM certificate path. Supports relative or absolute path.

Path rules

  • All path settings are workspace-relative except certificatePath.
  • certificatePath supports both absolute and relative values.

Example:

  • workspace: C:\\MyWorkspace
  • outputDirectory value for C:\\MyWorkspace\\tests: tests

Certificate and TLS configuration

Use certificatePath only when your TestBench server uses a self-signed or private CA certificate.

Certificate validation behavior:

  1. If certificatePath is configured, extension validation uses both the provided certificate and system trust.
  2. If certificatePath is empty, NODE_EXTRA_CA_CERTS is checked.
  3. If neither is configured, only system trust is used.

Alternative environment variable approach:

  • Windows: set NODE_EXTRA_CA_CERTS=C:\\path\\to\\certificate.pem and restart VS Code.
  • Linux/macOS: export NODE_EXTRA_CA_CERTS=/path/to/certificate.pem, then restart terminal and VS Code.

Logging behavior

  • Logs are stored under .testbench in workspace.
  • Up to 3 log files are retained.
  • Each log file rotates at 10 MB.