CLI
Draft in Progress
This document is a draft and is under development.
Description
The CLI, or Command Line Interface provided by ETLUnit is a custom interface based on a shell called ClamShell.
From your chosen command shell, navigate to the bin/
folder of your project, then type "etlunit
." The ETLUnit-supplied CLI will be invoked.
userme@LO-PPBBKK55 /c/src/bi-legacy-qpt/bin (master) $ etlunit Project is out of date Updating meta data . . . Caching local copy . . . .d8888b. 888 .d8888b. 888 888 888 d88P Y88b 888 d88P Y88b 888 888 888 888 888 888 Y88b. 888 888 888 888 888 8888b. 88888b.d88b. :Y888b. 88888b. .d88b. 888 888 888 888 :88b 888 :888 :88b :Y88b. 888 :88b d8P Y8b 888 888 888 888 888 .d888888 888 888 888 :888 888 888 88888888 888 888 Y88b d88P 888 888 888 888 888 888 Y88b d88P 888 888 Y8b. 888 888 :Y8888P: 888 :Y888888 888 888 888 :Y8888P: 888 888 :Y8888 888 888 Command-Line Interpreter Java version: 1.7.0_21 Java Home: c:\Java\jdk1.7.0_21-x64\jre OS: Windows 7, Version: 6.1 userme >
This is the interface provided for running ETLUnit tests. Some configuration for the test environment may also be done using one of the available custom commands. For instance, the profile
command will allow you to instantly change the environment for running your test - the number of threads running, what features are installed etc. (TODO: Complete this link: SEE ETLUnit Test Profiles.)
The 'Test' Command
The test
command will cause one or more ETLUnit tests to be run. Usually whole test methods are run. There is an option to run a certain operation only within a test method.
Core syntax:
test myTest
Where test is the command and myTest is the test to run
te MyTest
Where te is the command and myTest is the test to run.
More Test Command Syntax
For more on test syntax, see CLI.
List of All Commands
List of Commands Provided by help
Command
You can see a list of available commands by using the help
command.
mbruton > help Available Commands ------------------ exit Exits ClamShell. help Displays help information for available commands. sysinfo Displays current JVM runtime information. sleep Sleeps for the specified number of seconds time Prints current date/time list-installed-features Lists all installed features lif Synonym for list-installed-features list-available-features Lists all available features laf Synonym for list-available-features describe Displays meta information about a feature and / or operations test Runs tests te Synonym for test set Displays or sets options for system or for a feature s Synonym for set update Updates external binaries add-feature Adds a known feature to the project (listed in list-available-features) report Opens the test report for the last run r Synonym for report reports Opens the test report for the last run rs Synonym for reports migrate Migrates data files from one fml to another versions Prints the version info of all installed bitbucket modules open Opens the project directory in a file window o Synonym for open profile Changes to a specific profile or colon-separated list of profiles. Similar to u aven profile). Leave profile name blank to switch to the default. p Synonym for profile list-reference-types Lists all reference type catalogs lrt Synonym for list-reference-types tag Sets the name of the tag to be used for the history for the next run only ta Synonym for tag verify-reference-types Verifies all reference type catalogs vrt Synonym for verify-reference-types mbruton >
Command Usage
Command | Alias | Usage | Description | |
---|---|---|---|---|
add-feature |
| Adds a known feature to the project (listed in list-available-features).
| ||
describe |
| Displays meta information about a feature and/or operations.
| ||
exit |
| Exits ClamShell. | ||
help |
| Displays help information for available commands.
| ||
list-available-features | laf |
| Lists all available features. COMPARE with list of etlunit features among the POM dependencies. | |
list-installed-features | lif |
| Lists all installed features. SEE etlunit.json in your project. | |
list-reference-types | lrt |
| Lists all reference type catalogs. Presents a menu for drill-down. | |
migrate |
| Migrates data files from one FML to another.
May not be fully implemented. | ||
open | o |
| Opens a directory in a file window. If no argument, opens the project root directory. If
| |
profile | p |
|
| |
report | r |
| Opens the test report for the last run.
| |
reports | rs |
| Provides list of test reports to choose from. | |
set | s |
| Displays or sets options for system or for a feature. Invokes a menu. | |
sleep |
| Sleeps for the specified number of seconds. | ||
sysinfo |
| Displays current JVM runtime information. Options may be combined. | ||
tag | ta |
| Sets the recallable tag name to be attached to the next run only.
| |
test | te | SEE Test Specification Reference SEE CLI
| Runs ETLUnit custom tests. | |
time |
| Prints current date/time. | ||
update |
| Updates external binaries. | ||
| vrt |
| Verifies all reference type catalogs. | |
|
| Prints the version information of all installed Bitbucket modules. |