|
1 |
| -# Welcome to GrimoireELK [](https://github.com/chaoss/grimoirelab-elk/actions?query=workflow:tests+branch:master+event:push) [](https://coveralls.io/github/chaoss/grimoirelab-elk?branch=master) [](https://badge.fury.io/py/grimoire-elk) |
| 1 | +# Welcome to GrimoireELK [](https://github.com/chaoss/grimoirelab-elk/actions?query=workflow:tests+branch:main+event:push) [](https://coveralls.io/github/chaoss/grimoirelab-elk?branch=main) [](https://badge.fury.io/py/grimoire-elk) |
2 | 2 |
|
3 | 3 | GrimoireELK is the component of [GrimoireLab](https://github.com/chaoss/grimoirelab) that interacts with the ElasticSearch database. Its goal is two-fold, first it aims at offering a convenient
|
4 | 4 | way to store the data coming from Perceval, second it processes and enriches the data in a format that can be consumed by Kibiter.
|
@@ -115,7 +115,7 @@ profile information (i.e., identity fields) or (iv) to the project listed in the
|
115 | 115 | - **extra_** (anything): Extra fields added using the `enrich_extra_data` study.
|
116 | 116 |
|
117 | 117 | #### Data source specific fields
|
118 |
| -Details of the fields of each data source is available in the [Schema](https://github.com/chaoss/grimoirelab-elk/tree/master/schema) folder. |
| 118 | +Details of the fields of each data source is available in the [Schema](https://github.com/chaoss/grimoirelab-elk/tree/main/schema) folder. |
119 | 119 |
|
120 | 120 | ## Installation
|
121 | 121 |
|
@@ -165,18 +165,18 @@ $ poetry shell
|
165 | 165 |
|
166 | 166 | ## Running tests
|
167 | 167 |
|
168 |
| -Tests are located in the folder [tests](https://github.com/chaoss/grimoirelab-elk/tree/master/tests). |
| 168 | +Tests are located in the folder [tests](https://github.com/chaoss/grimoirelab-elk/tree/main/tests). |
169 | 169 | In order to run them, you need to have in your machine instances (or Docker containers) of ElasticSearch and MySQL
|
170 | 170 |
|
171 | 171 | Then you need to:
|
172 |
| -- update the file [tests.conf](https://github.com/chaoss/grimoirelab-elk/blob/master/tests/tests.conf) file: |
| 172 | +- update the file [tests.conf](https://github.com/chaoss/grimoirelab-elk/blob/main/tests/tests.conf) file: |
173 | 173 | - in case your ElasticSearch instance isn't available at `http://localhost:9200`. For example, if you are using the secure edition of elasticsearch, it will be located at `https://admin:admin@localhost:9200`
|
174 | 174 | - in case you are using non-default credentials for your SortingHat database, you will need to include the `[Database]` section of the file with both `user` and `password` parameters
|
175 | 175 | - create the databases `test_sh` and `test_projects` in your MySQL instance (e.g., `mysql -u root -e "create database test_sh"`, if you are running mysql in a container use `docker exec -i <container id> mysql -u root -e "create database test_sh"`)
|
176 |
| -- populate the database `test_projects` with the SQL file [test_projects.sql](https://github.com/chaoss/grimoirelab-elk/blob/master/tests/test_projects.sql) (e.g., `mysql -u root test_projects < tests/test_projects.sql`) |
| 176 | +- populate the database `test_projects` with the SQL file [test_projects.sql](https://github.com/chaoss/grimoirelab-elk/blob/main/tests/test_projects.sql) (e.g., `mysql -u root test_projects < tests/test_projects.sql`) |
177 | 177 |
|
178 |
| -The full battery of tests can be executed with [run_tests.py](https://github.com/chaoss/grimoirelab-elk/blob/master/tests/run_tests.py). However, it is also possible to execute |
179 |
| -a sub-set of tests by running the single test files (`test_*` files in the [tests folder](https://github.com/chaoss/grimoirelab-elk/tree/master/tests)) |
| 178 | +The full battery of tests can be executed with [run_tests.py](https://github.com/chaoss/grimoirelab-elk/blob/main/tests/run_tests.py). However, it is also possible to execute |
| 179 | +a sub-set of tests by running the single test files (`test_*` files in the [tests folder](https://github.com/chaoss/grimoirelab-elk/tree/main/tests)) |
180 | 180 |
|
181 | 181 | The tests can be run in combination with the Python package `coverage`. The steps below show how to do it:
|
182 | 182 | ```buildoutcfg
|
|
0 commit comments