Skip to content

Commit 9e8def1

Browse files
committed
[QA][Code Coverage] Team Assignment Docs Update
1 parent 46a5959 commit 9e8def1

File tree

2 files changed

+25
-5
lines changed

2 files changed

+25
-5
lines changed
Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,28 @@
1-
# Team Assignment Ingestion Pipeline
1+
# Team Assignments
22

3-
Team assignment will occur once per ci run.
4-
Team assignment uses an ingest pipeline.
3+
Team assignment occurs once per ci run.
54

6-
The coverage user has the coverage admin role.
5+
The "orchestration" entry point is a [Jenkinsfile Scripted Pipeline](https://github.com/elastic/kibana/blob/f73bc48b3bbbb5ad2042c1aa267aea2150b7b742/.ci/Jenkinsfile_coverage#L21)
6+
This Jenkinsfile runs a [shell script](https://github.com/elastic/kibana/blob/master/src/dev/code_coverage/shell_scripts/generate_team_assignments_and_ingest_coverage.sh#L33) that kicks everything off.
77

8-
This role must have the rights depicted below ![Cluster Rights](./security_privleges.png)
8+
## Team Assignment Data File Creation (Before Ingestion)
9+
We create a data file containing all paths in the repo, with a team assigned.
10+
Example Team Assignments Block:
11+
```
12+
src/dev/code_coverage/ingest_coverage/team_assignment/enumerate_patterns.js kibana-qa
13+
src/dev/code_coverage/ingest_coverage/team_assignment/enumeration_helpers.js kibana-qa
14+
src/dev/code_coverage/ingest_coverage/team_assignment/flush.js kibana-qa
15+
src/dev/code_coverage/ingest_coverage/team_assignment/index.js kibana-qa
16+
src/dev/code_coverage/ingest_coverage/team_assignment/parse_owners.js kibana-qa
17+
src/dev/code_coverage/ingest_coverage/team_assignment/parse_owners_helpers.js kibana-qa
18+
src/dev/code_coverage/ingest_coverage/team_assignment/parsing_helpers.js kibana-qa
19+
```
20+
21+
## Team Assignment Data File Usage (During Code Coverage Ingestion)
22+
23+
24+
Subsequently, we use the data file during ingestion.
25+
We search the data file, for any given "coveredFilePath"
26+
- Given the above assignments block, and lets say the "coveredFilePath" during ingestion is
27+
- `src/dev/code_coverage/ingest_coverage/team_assignment/enumerate_patterns.js`
28+
- The team assignment would be `kibana-qa`
Binary file not shown.

0 commit comments

Comments
 (0)