https://github.com/peergramming/learning-bot
A GitLab bot for providing programming advice from code repair tools.
https://github.com/peergramming/learning-bot
gitlab gitlab-bot peer-programming static-code-analysis
Last synced: about 1 month ago
JSON representation
A GitLab bot for providing programming advice from code repair tools.
- Host: GitHub
- URL: https://github.com/peergramming/learning-bot
- Owner: peergramming
- License: agpl-3.0
- Created: 2020-03-25T10:59:52.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-25T11:10:00.000Z (about 6 years ago)
- Last Synced: 2024-05-10T07:32:55.254Z (about 2 years ago)
- Topics: gitlab, gitlab-bot, peer-programming, static-code-analysis
- Language: Go
- Homepage: https://humaidq.ae/projects/learning-bot/
- Size: 197 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Learning bot
## Purpose
The aim of this project is to create a GitLab bot which would download
students code and generate a report containing advice on repairing
issues found in the source code.
### Plan
Currently, the plan is to use [checkstyle] to list issues in the code,
which is parsed by this program, detecting which type of error it is
and on which line and file.
Then an issue will be created on the project's issue tracker with a
link to the report. The report would contain a list of all the issues
in the source code, each of which would give a preview of the code and
a suggestion on how to fix it.
Alternatively, a CI-based add-on would be built into GitLab which would
add a badge to each commit, which would redirect to the report page.
## Requirements
The following packages must be installed on your system.
- git
- Go *(tested with 1.12)*
- GNU make
- OpenJDK Runtime Environment *(tested with 1.8.0)*
- unzip *(Unix utility)*
- checkstyle *(jar, tested with 8.22)*
The program supports MySQL, but it is optional requirement as an SQLite
option is available. No additional packages are needed to be installed for
database functionality.
## Installation from source
### Downloading
```
$ git clone https://github.com/peergramming/learning-bot.git
$ cd learning-bot
$ make clean all
```
**Note:** You have to run the binary in the directory, so the program
is able to find web files required to render the web pages.
### Configuring
Before running the web server, the program has to be configured using
the `config` command-line option.
```
$ ./learning-bot config
```
The program will guide you through the process on creating a new configuration
file. You'll have to specify the SQL driver/server, checkstyle jar and configuration
location, bot private token, and so on...
Once configured, the program would generate a `config.toml` file (which can be later
edited, if required).
#### Adding projects to check
The bot will not check any projects by default, but it can be added using the interactive
`manage` tool. This can be automated with scripts by using the add and
remove subcommands:
```
$ learning-bot manage [add/remove] [project]
```
The project consists of the user and project name separated with a slash, such as
`humaid/dsa-cw-1`. The projects list is stored in the `active-projects.toml` file.
### Running the bot
The bot can be run using the following command, this would also start a web server
to display reports (unless if you start it with `--no-web`).
```
$ ./learning-bot run
```
By default, the bot would automatically check all active repositories at start, and
it would repeat on interval as configured.
## Further configuration
There are some default configuration values which aren't setup in the wizard. Here
is the documentation for `config.toml`.
- `site_title`: Title of the website and bot.
- `site_url`: The URL of the bot website, including port, used in issue tracker link.
- `bot_private_access_token`: Bot account's private access token.
- `checkstyle_jar_path`: Path for the checkstyle JAR file, must be downloaded separately.
- `checkstyle_config_path`: Path for the checkstyle configuration file, provided by the project.
- `gitlab_instance_url`: The URL of the GitLab instance for the API, links and integration.
- `gitlab_skip_verify_check`: Skip verification with authenticating with GitLab API via HTTPS.
- `lms_title`: Optional LMS link title.
- `lms_url`: Optional LMS link URL.
- `check_active_repositories_cron`: Cron job schedule interval. Learn more about format [here](https://godoc.org/github.com/robfig/cron#hdr-Predefined_schedules).
- `timezone`: Timezone used for report and database.
- `code_snippet_include_previous_lines`: Maximum number of lines to include before troubled line in report code snippet.
- `database`: Database configuration field.
- `type`: Driver type; 0 for SQLite, 1 for MySQL.
- `host`: [MySQL] The host of the MySQL server.
- `name`: [MySQL] The name of the MySQL user.
- `ssl_mode`: [MySQL] The SSL/TLS mode of the MySQL connection.
- `path`: [SQLite] The path for the SQLite database file.
- `limits`: Limitations configuration field.
- `max_check_workers`: Maximum number of concurrent workers checking repositories.
- `max_issues_per_report`: Maximum number of issues per report (-1 for no limit).
- `max_issues_per_type_per_report`: Maximum number of issues per type in a report (-1 for no limit).
[checkstyle]: https://checkstyle.org/