Robocop
Robocop is a tool that performs static code analysis of Robot Framework code.
It uses official Robot Framework parsing API to parse files and run number of checks, looking for potential errors or violations to code quality standards.
Values
Original RoboCop - a fictional cybernetic police officer :policeman: - was following 3 prime directives
which also drive the progress of Robocop linter:
First Directive: Serve the public trust :family_man_woman_girl_boy:
Which lies behind the creation of the project - to serve developers and testers as a tool to build applications they can trust.
Second Directive: Protect the innocent :baby:
The innocent testers and developers have no intention to produce ugly code but sometimes, you know, it just happens,
so Robocop is there to protect them.
Third Directive: Uphold the law :classical_building:
Following the coding guidelines established in the project are something very important to keep the code clean,
readable and understandable by others and Robocop can help to uphold the law.
Requirements
Python 3.6+ :snake: and Robot Framework 3.2.2+ :robot:.
Installation
You can install Robocop simply by running::
pip install robotframework-robocop
Usage
Robocop runs by default from the current directory and it discovers supported files recursively.
You can simply run::
robocop
All command line options can be displayed in help message by executing::
robocop -h
Example Output
Executing command::
robocop --report rules_by_error_type tests\test.robot
Will result in following output::
C:\OCP_project\tests\test.robot:7:0 [W] 0509 Section is empty (empty-section)
C:\OCP_project\tests\test.robot:22:0 [E] 0801 Multiple test cases with name "Simple Test" in suite (duplicated-test-case)
C:\OCP_project\tests\test.robot:42:0 [E] 0810 Both Task(s) and Test Case(s) section headers defined in file (both-tests-and-tasks)
C:\OCP_project\tests\test.robot:48:0 [W] 0302 Keyword name should be capitalized (not-capitalized-keyword-name)
C:\OCP_project\tests\test.robot:51:13 [I] 0606 This tag is already set by Force Tags in suite settings (tag-already-set-in-force-tags)
Found 5 issue(s): 2 WARNING(s), 2 ERROR(s), 1 INFO(s).
