SabertoothA VSCode extension for WiredTiger development. Installation Launch VS Code Quick Open ( Ctrl+P), paste the following command, and press enter.Copied to clipboard |
SabertoothA VSCode extension integrating tools used by the WiredTiger team into the editor. RequirementsMany features rely on the wt utility binary. This can be built automatically with WiredTiger or can be built using the MongoDB build command. The extension will attempt to find the utility in your workspace, alternatively you can specify it's
location in the settings: FeaturesTools
WiredTiger Development
Sidebar ViewThe extension provides a sidebar view that will list all the database files found in the specified directory and group them by their home directory. 
Switch to Catalog Namespace
Dump BSON
Quick Access Tools
Sidebar Context Menu
WT Testing TreeviewThe extension provides a dedicated treeview in the WiredTiger sidebar for running various test suites. Each test category includes:
This makes it easy to configure and run tests directly from the sidebar without navigating through menus or command palette. WT Utility CommandsThe wt tool is a command-line utility that provides access to various pieces of the WiredTiger functionality. This extension exposes the utility through VSCode commands that can be accessed through the command palette. The command palette will prompt the user for configurations through input fields and selection items. Currently only dump and verify are partially supported, however, future updates will add support for additional commands. Usage
WiredTiger DevelopmentBuilding WiredTigerYou can use the extension to build wiredtiger with the build tasks provided. These tasks
can be access through the
The tasks will have paths to the build tools set by default, however, these can be changed in the settings which can be access by CallgraphAccess to the WiredTiger callgraph tool for plotting function calls in WiredTiger. The location of the callgraph script must be specified in the extension settings. 
SnippetsThe extension provides common snippets useful for WiredTiger developers. 
TestsPython TestsSimilar to the build tasks the python test suite can be run as tasks using the Run Tasks command or using the keybindings mentioned above. These are the python tasks available:
You can quickly access these tests and their settings through the WT Testing treeview in the sidebar. 
Test FormatTest format can also be run as a task. The task will use the format.sh script to run the tests and can be configured in the "format" section of the extension settings.
The extension also provides a Test Explorer integration for format tests, which discovers and displays all CONFIG.* files in the test/format directory. You can run individual format test configurations or all of them at once from the Test Explorer. The extension also provides a command CTestsThe extension integrates with CTest (CMake's test runner) to discover and run C/C++ tests in the build directory. Tests are discovered automatically and displayed in the Test Explorer panel. Features:
Tests are refreshed when the extension activates and can be manually refreshed through the Test Explorer interface. KeybindingsKeybindings can be used to quickly access tasks from the extension. The default keybindings
for the extension use a key chord starting with
Users can also configure their own key bindings in the VSCode Preferences: SettingsYou can change the settings for many of the tasks and commands listed above. The settings will use the mongodbtoolchain for many of the tasks and commands by default. However, these can be changed to use different binaries for python, cmake and other tools. 
ContributingRequirementsSteps
ResourcesEnjoy! |