Skip to content

robot

A set of tasks for Robot Framework projects.

List of tasks

Tasks Description
robot:badge Create a badge from the results of the tests. Arguments: FILE|F=output.xml [DIR|D=.] [STYLE|S=plastic] (*)
robot:cop Static code analysis of Robot Framework language with Robocop. Arguments: DIR|D=tests [ARG|A="--check"] [IMG|I=jfxs/robot-framework:latest] [PULL|P=] (*)
robot:mask Mask sensitive data of a file. Arguments: FILE|F=file.txt DATA|D=paswword1,password2 (*)
robot:tidy Format Robot Framework files. Arguments: DIR|D=tests [ARG|A="--check"] [IMG|I=jfxs/robot-framework:latest] [PULL|P=] (*)

global variables

Variables Description Default value
IMAGE_ROBOT Default Robot Framework image jfxs/robot-framework

robot:badge

Create a badge from the results of the tests. Arguments: FILE|F=output.xml [DIR|D=.] [STYLE|S=plastic] (*)

[ROBOT] Create a badge all_tests.svg from the results of the Robot Framework tests with shields.io service
Usage: task robot:badge FILE|F=<output_file_path> [DIR|D=<badge_directory>] [STYLE|S=<badge_style>]
Arguments Description
FILE | F Output XML results file (required)
DIR | D Generated badge directory (optional, current directory by default)
STYLE | S Docker Robot Framework image to use (optional, by default {{.IMAGE_ROBOT}})

Requirements:

  • curl
  • Internet connexion

robot:cop

Static code analysis of Robot Framework language with Robocop. Arguments: DIR|D=tests [ARG|A="--check"] [IMG|I=jfxs/robot-framework:latest] [PULL|P=] (*)

[ROBOT] Static code analysis of Robot Framework language with Robocop.
Usage: task robot:cop DIR|D=<tests_dir> [ARG|A="cli_arguments"] [IMG|I=<docker_image:tag>] [PULL|P=<n|N>]
Arguments Description
DIR | D Directory or file to format (required)
ARG | A Arguments and options (optional)
IMG | I Docker Robot Framework image to use (optional, by default {{.IMAGE_ROBOT}})
PULL | P Pull docker image (optional, by default yes)

Requirements:

  • robocop or docker

robot:mask

Mask sensitive data of a file. Arguments: FILE|F=file.txt DATA|D=paswword1,password2 (*)

[ROBOT] Mask sensitive data of a file.
Usage: task robot:mask FILE|F=<file_path> DATA|D=paswword1,password2
Arguments Description
FILE | F Fix files (required)
DATA | D Data to mask separated by comma (required)

Requirements:

  • None

robot:tidy

Format Robot Framework files. Arguments: DIR|D=tests [ARG|A="--check"] [IMG|I=jfxs/robot-framework:latest] [PULL|P=] (*)

[ROBOT] Format Robot Framework files with Robotidy.
Usage: task robot:tidy DIR|D=<tests_dir> [ARG|A="cli_arguments"] [IMG|I=<docker_image:tag>] [PULL|P=<n|N>]
Arguments Description
DIR | D Directory or file to format (required)
ARG | A Arguments and options (optional)
IMG | I Docker Robot Framework image to use (optional, by default {{.IMAGE_ROBOT}})
PULL | P Pull docker image (optional, by default yes)

Requirements:

  • robotidy or docker