Get Help

show

Prints what CAT sees in a project — a summary of its parts, or the list of tests it would run — without running anything.

Synopsis 

catcli show --summary [-p <path>] [-g] [-l <level>] [-q]
catcli show --tests [-f <text>] [-p <path>] [-g] [-l <level>] [-q]

Options

Short Long Value Meaning
-s --summary Print the project summary. Exactly one of -s / -t is required.
-t --tests Print the list of tests.
-f --filter text With -t only: list only tests whose full name contains the text. Substring match, not case-sensitive, no wildcards (* alone means all). Rejected together with -s.
-p --project path Project file, or a directory with exactly one *.cat.yaml. Default: the current directory.
-g --progress Show progress bars while the project loads. Honoured only when logging is None.
-l --loggingLevel level None (default), Error, Information, Debug, … — see Logging.
-q --quiet Hide the “working offline” notice.

What it does

Opens the project exactly as run would — loads data sources and tests from every list, expands metadata-driven tests — and then stops. Nothing is executed against the data beyond what loading requires (for example the queries of test lists stored in a database). That makes show the tool for two questions: what does CAT actually see in this project? and why does this project not open?

Output

--summary prints six panels:

Panel Content
Get list of data sources from The data-source lists of the project: name and provider.
Get list of tests from The test lists: name and provider.
Named sets The queries and their data source.
Settings Threads.
Test suites Each suite with its number of tests.
Data sources Each data source with its provider and in how many tests it is used.

--tests prints one table — Suite, Test Case, Order, Name — one row per test, in the order CAT loaded them:

╭──────────────────┬───────────┬───────┬──────────────────────────────────────────────╮
│ Suite            │ Test Case │ Order │ Name                                         │
├──────────────────┼───────────┼───────┼──────────────────────────────────────────────┤
│ SourceDataTests  │           │     0 │ Check if the table DIM.AIRLINES is not empty. │
│ SourceDataTests  │           │     1 │ Check if the table DIM.DATES is not empty.    │
╰──────────────────┴───────────┴───────┴──────────────────────────────────────────────╯

With logging on, the log of the loading phase precedes the panels or the table.

Exit code

0 when the project opened and was printed. 1 when it could not be opened (the error is printed; re-run with -l Information or -l Debug to see where loading stopped). 2–7 from the sign-in and plan check — see Exit codes.

Examples 

# summary of the project in the current directory
catcli show -s

# all tests of a specific project
catcli show -t -p "D:\Testing\DwhTests.cat.yaml"

# only tests whose full name contains "departures"
catcli show -t -f departures

# the project does not open — watch the loading step by step
catcli show -s -l Debug

# slow or many test sources — watch the progress instead
catcli show -t -g
← run
open →