AlignTemplatedTestCases

Align suites with Test Template to columns.

For non-templated test cases use AlignTestCasesSection formatter. Test cases that are templated with [Template] setting should also use AlignTestCasesSection.

Enabling the formatter

AlignTemplatedTestCases is not included in default formatters.

You can enable it by using --select and --extend-select options.

robocop format --select AlignTemplatedTestCases

robocop format --extend-select AlignTemplatedTestCases

Examples:

BeforeAfter

*** Settings ***
Test Template    Templated Keyword

*** Test Cases ***    baz    qux
# some comment
test1    hi    hello
test2 long test name    asdfasdf    asdsdfgsdfg

*** Settings ***
Test Template    Templated Keyword

*** Test Cases ***      baz         qux
# some comment
test1                   hi          hello
test2 long test name    asdfasdf    asdsdfgsdfg
                        bar1        bar2

Any argument in the same line as the test case name will be used as a column header for the alignment:

BeforeAfter

*** Settings ***
Test Template    Dummy

*** Test Cases ***
Test1    ARG1
    [Tags]    sanity
    [Documentation]  Validate Test1
Test2    ARG2
    [Tags]    smoke
    [Documentation]  Validate Test2

*** Settings ***
Test Template    Dummy

*** Test Cases ***
Test1     ARG1
          [Tags]              sanity
          [Documentation]     Validate Test1
Test2     ARG2
          [Tags]              smoke
          [Documentation]     Validate Test2

Align only the test case section with named headers

If you don't want to align test case section that does not contain header names then configure only_with_headers parameter:

cli toml

robocop format --select AlignTemplatedTestCases -c AlignTemplatedTestCases.only_with_headers=True

[tool.robocop.format]
select = [
    "AlignTemplatedTestCases"
]
configure = [
    "AlignTemplatedTestCases.only_with_headers=True"
]

Fixed the width of the column

It's possible to set a fixed minimal width of a column. To configure it use min_width parameter:

cli toml

robocop format --select AlignTemplatedTestCases -c AlignTemplatedTestCases.min_width=30

[tool.robocop.format]
select = [
    "AlignTemplatedTestCases"
]
configure = [
    "AlignTemplatedTestCases.min_width=30"
]

This configuration respects up_to_column parameter which only aligns columns up to configured up_to_column column.

BeforeAfter

*** Test Cases ***    baz    qux
# some comment
test1    hi    hello
test2 long test name    asdfasdf    asdsdfgsdfg
    bar1  bar2

*** Test Cases ***            baz                           qux
# some comment
test1                         hi                            hello
test2 long test name          asdfasdf                      asdsdfgsdfg
                              bar1                          bar2