Toolbox Documentation

configure

Commands relating to TOPSAIL testing configuration

• apply Applies a preset (or a list of presets) to the current configuration file

• enter Enter into a custom configuration file for a TOPSAIL project

• get Gives the value of a given key, in the current configuration file

• name Gives the name of the current configuration

run

Run `topsail` toolbox commands from a single config file.

plotter

Commands related to the current role

• main Run the plotter role

repo

Commands to perform consistency validations on this repo itself

• generate_ansible_default_settings Generate the defaults/main/config.yml file of the Ansible roles, based on the Python definition.

• generate_middleware_ci_secret_boilerplate Generate the boilerplace code to include a new secret in the Middleware CI configuration

• generate_toolbox_related_files Generate the rst document and Ansible default settings, based on the Toolbox Python definition.

• generate_toolbox_rst_documentation Generate the doc/toolbox.generated/*.rst file, based on the Toolbox Python definition.

• send_job_completion_notification Send a job completion notification to github and/or slack about the completion of a test job.

• validate_no_broken_link Ensure that all the symlinks point to a file

• validate_no_wip Ensures that none of the commits have the WIP flag in their message title.

• validate_role_files Ensures that all the Ansible variables defining a filepath (project/*/toolbox/) do point to an existing file.

• validate_role_vars_used Ensure that all the Ansible variables defined are actually used in their role (with an exception for symlinks)

smigather

Commands related to the current role

• main Run the Smigather role

tests

Commands related to the current role

• main Run the tests role

• whisper Run the tests role

whisper

Commands related to the current role

• main Run the whisper role