Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MarketSquare/robotframework-robocop
Tool for static code analysis of Robot Framework language
https://github.com/MarketSquare/robotframework-robocop
linter python robocop robotframework testing
Last synced: 3 months ago
JSON representation
Tool for static code analysis of Robot Framework language
- Host: GitHub
- URL: https://github.com/MarketSquare/robotframework-robocop
- Owner: MarketSquare
- License: apache-2.0
- Created: 2020-07-08T09:12:36.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-31T07:34:26.000Z (3 months ago)
- Last Synced: 2024-07-31T10:19:42.914Z (3 months ago)
- Topics: linter, python, robocop, robotframework, testing
- Language: Python
- Homepage:
- Size: 5.82 MB
- Stars: 179
- Watchers: 14
- Forks: 38
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-robotframework - Robocop - in rules that can be easily configured or switched off. (Tools)
README
[](https://github.com/MarketSquare/robotframework-robocop/actions/workflows/unit-tests.yml "GitHub Workflow Unit Tests Status")
[](https://pepy.tech/project/robotframework-robocop)
---
Robocop
===============
- [Introduction](#introduction)
- [Documentation](#documentation)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Example Output](#example-output)
- [Values](#values)
- [Fixing issues](#fixing-issues)
- [FAQ](#faq)
Watch our talks from
[RoboCon 2021](https://www.youtube.com/watch?v=vZoyi2ObM8E)
and
[RoboCon 2022](https://www.youtube.com/watch?v=t_R36N_4UBk)
about Robocop &
[Robotidy](https://github.com/MarketSquare/robotframework-tidy)
and learn more about these cool tools! :robot:
[](https://youtu.be/vZoyi2ObM8E "Robocop & Robotidy presentation at RoboCon 2021")
[](https://youtu.be/t_R36N_4UBk "Robocop presentation at RoboCon 2022")
---
Introduction
------------
Robocop is a tool that performs static code analysis of [Robot Framework](https://github.com/robotframework/robotframework) code.
It uses official [Robot Framework parsing API](https://robot-framework.readthedocs.io/en/stable/) to parse files and runs number of checks,
looking for potential errors or violations to code quality standards (commonly referred as *linting issues*).
> Hosted on [GitHub](https://github.com/MarketSquare/robotframework-robocop). :medal_military:
Documentation
-------------
Full documentation is available [here](https://robocop.readthedocs.io). :open_book:
Most common questions with answers can be found at the bottom ⬇ of this README file.
Requirements
------------
Python 3.8+ :snake: and Robot Framework 3.2.2+ :robot:.
Installation
------------
You can install the latest version of Robocop simply by running:
```
pip install -U 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 test.robot
```
Will result in following output:
```text
\Users\OCP\test.robot:7:1 [W] 0509 Section '*** Variables ***' is empty (empty-section)
\Users\OCP\test.robot:22:1 [E] 0801 Multiple test cases with name "Simple Test" (first occurrence in line 17) (duplicated-test-case)
\Users\OCP\test.robot:42:1 [E] 0810 Both Task(s) and Test Case(s) section headers defined in file (both-tests-and-tasks)
\Users\OCP\test.robot:48:1 [W] 0302 Keyword 'my keyword' does not follow case convention (wrong-case-in-keyword-name)
\Users\OCP\test.robot:51:13 [I] 0606 Tag 'mytag' is already set by Test Tags in suite settings (tag-already-set-in-test-tags)
Found 5 issues: 2 ERRORs, 2 WARNINGs, 1 INFO.
```
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**.
Fixing issues
--------------
Many issues in your code reported by Robocop can be fixed using auto-formatting tool, Robotidy.
Check out the Robotidy [documentation](https://robotidy.readthedocs.io/en/stable/).
FAQ
---
Can I integrate Robocop with my code editor (IDE)?
**Yes**, Robocop integrates nicely with popular IDEs like PyCharm or VSCode
thanks to [Robot Framework Language Server](https://github.com/robocorp/robotframework-lsp).
Read simple manual (README) in that project to figure out how to install & use it.
You can also use Robocop in PyCharm easily as an external tool.
To configure it, go to: `File` → `Settings` → `Tools` → `External Tools`
and click `+` icon. Then put values based on
[official instructions](https://www.jetbrains.com/help/pycharm/configuring-third-party-tools.html)
or this screenshot:
If you're using Python virtual environment in your project,
make sure to provide correct path to robocop.exe located in `venv\Scripts\robocop.exe`.
Now, you can run Robocop by right-clicking on a file or directory and choosing
`External tools` → `Robocop`.
We suggest also to add a keyboard shortcut (e.g. `Ctrl + , (comma)`)
to quickly run Robocop on selected files. You can map the shortcut in `Settings` → `Keymap`.
Can I load configuration from file?
**Yes**, there are multiple ways to configure Robocop:
**Argument file**
You can add command line options to an argument file, preferably one option with value for a line.
Such file can be used as an input for Robocop with `--argumentfile / -A` option, e.g.
```robocop -A robocop.cfg```. You can mix arguments from a file with ones provided in run command.
Example argument file:
```commandline
--exclude *doc*
--exclude 0510
--threshold W
--configure inconsistent-assignment:assignment_sign_type:equal_sign
--configure line-too-long:line_length:140
--reports all
--output robocop.log
```
---
**`.robocop` file**
It is a default file that is loaded only when no command line options are provided for Robocop.
When running plain `robocop` command, it looks for `.robocop` file from place where it was run
until it finds `.git` file. Options can be provided like in the example above.
---
**`pyproject.toml` file**
If there is no `.robocop` file and `toml` module is installed,
Robocop will try to load configuration from `pyproject.toml` file (if it exists).
Options have the same names as command line arguments
and need to be placed under `[tool.robocop]` section.
Example configuration file:
```commandline
[tool.robocop]
paths = [
"tests\\atest\\rules\\bad-indent",
"tests\\atest\\rules\\duplicated-library"
]
include = ['W0504', '*doc*']
exclude = ["0203"]
reports = [
"rules_by_id",
"scan_timer"
]
ignore = ["ignore_me.robot"]
ext-rules = ["path_to_external\\dir"]
filetypes = [".txt", ".tsv"]
threshold = "E"
format = "{source}:{line}:{col} [{severity}] {rule_id} {desc} (name)"
output = "robocop.log"
configure = [
"line-too-long:line_length:150",
"0201:severity:E"
]
no_recursive = true
```
I use different coding standards. Can I configure rules so that they fit my needs?
**Yes**, some rules are configurable. You can list them by running `robocop --list-configurables`
or just `robocop -lc`.
Configuring is done by using `-c / --configure` command line option followed by pattern
`::` where:
- `` can either be rule name or its id
- `` is a public name of the parameter
- `` is a desired value of the parameter
For example:
```commandline
--configure line-too-long:line_length:140
```
is equivalent to
```commandline
-c 0508:line_length:140
```
---
Each rule's severity can also be overwritten. Possible values are
`e/error`, `w/warning` or `i/info` and are case-insensitive. Example:
```commandline
-c too-long-test-case:severity:e
```
---
If there are special cases in your code that violate the rules,
you can also exclude them in the source code.
Example:
```
Keyword with lowercased name # robocop: disable
```
More about it in
[our documentation](https://robocop.readthedocs.io/en/stable/including_rules.html#ignore-rule-from-source-code).
Can I define custom rules?
**Yes**, you can define and include custom rules using `-rules / --ext-rules` command line option
by providing a path to a file containing your rule(s). The option accepts comma-separated list
of paths to files or directories, e.g.
```
robocop -rules my/own/rule.py --ext-rules rules.py,external_rules.py
```
If you feel that your rule is very helpful and should be included in Robocop permanently,
you can always share your solution by
[submitting a pull request](https://github.com/MarketSquare/robotframework-robocop/pulls).
You can also share your idea by
[creating an issue](https://github.com/MarketSquare/robotframework-robocop/issues/new/choose).
More about external rules with code examples in
[our documentation](https://robocop.readthedocs.io/en/stable/external_rules.html).
Can I use Robocop in continuous integration (CI) tools?
**Yes**, it is easy to integrate Robocop with CI and other tools.
For more details read [our documentation](https://robocop.readthedocs.io/en/stable/ci.html).
Can I configure return status / code?
**Yes**, by default Robocop returns code 0 if number of found issues does not exceed quality gates.
Quality gates are the number specified for each severity (error, warning, info) that cannot be
exceeded. Every violation of quality gates increases the return code by 1 up to maximum of 255.
Default values for quality gates are:
```
quality_gate = {
'E': 0,
'W': 0,
'I': -1
}
```
which shows the accepted number of issues by severity. In that case each error and warning
increases the return code. Rules with INFO severity do not affect the return code.
To configure quality gates, you simply use `-c / --configure` command line option
with following pattern ```--configure return_status:quality_gates:=limit```.
You can change all limits at once. Example:
```commandline
--configure return_status:quality_gates:E=0:W=100:I=-1
```
which means that no errors are accepted, up to 100 warnings are tolerated and issues with
INFO severity do not affect the return code.
What is the difference between Robocop and rflint?
Robocop is better in every case because it:
- has maaaaany rules that check the quality of your Robot Framework code
- is integrated with popular IDE tools
- is highly configurable
- has very good defaults that work out of the box
- can be configured in source code
- uses the latest [Robot Framework Parsing API](https://robot-framework.readthedocs.io/en/stable/)
- is actively developed & fixed
- is easy to integrate with external tools
- can redirect output to a file
- displays nice reports
- is easy to extend it with new rules
- is cool :nerd_face:
Still not convinced?
[Watch our talk](https://www.youtube.com/watch?v=vZoyi2ObM8E)
about Robocop &
[Robotidy](https://github.com/MarketSquare/robotframework-tidy)
and see for yourself! :monocle_face:
----
> Excuse me, I have to go. Somewhere there is a crime happening. - Robocop