[LD-139] chore: test coverage report #162

trOnk12 · 2023-10-24T12:23:52Z

Pull-Request

Description

Add per pull request code coverage report generation.

Why?

There is no way to monitor the code coverage increase of decrease, in order to maintain high quality code, we want to have a tool allowing us to monitor the changes.

What?

Add a gradle configuration allowing to generate the report and add a task correctly configuring the coverage report settings.

Links to related issues

(https://loudius.atlassian.net/browse/LD-139)

Demo

How to test

Try to add some code uncovered by unit tests
Push the changes, there should be a PR comment added indicating a decrease in code coverage

Documentation

Github action used to create a PR comment
Jacoco Library genereting the coverage report

Checklist

Functionality is covered by unit tests ( not applicable )
Functionality is covered by integration tests ( not applicable )
I've updated PR description with relevant information
I've done self code review
I've manually tested if the code and app works

github-actions · 2023-10-24T12:27:58Z

🦙 MegaLinter status: ✅ SUCCESS

Descriptor	Linter	Files	Fixed	Errors	Elapsed time
✅ ACTION	actionlint	1		0	0.06s
✅ COPYPASTE	jscpd	yes		no	2.51s
✅ REPOSITORY	checkov	yes		no	11.92s
✅ REPOSITORY	devskim	yes		no	0.99s
✅ REPOSITORY	dustilock	yes		no	0.23s
✅ REPOSITORY	gitleaks	yes		no	1.25s
✅ REPOSITORY	git_diff	yes		no	0.06s
✅ REPOSITORY	secretlint	yes		no	2.19s
✅ REPOSITORY	syft	yes		no	0.23s
✅ SPELL	misspell	1	0	0	0.1s
✅ YAML	prettier	1	0	0	0.77s
✅ YAML	v8r	1		0	2.09s
✅ YAML	yamllint	1		0	0.29s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by

Krzysiudan · 2023-10-24T15:38:48Z

Overall Project	72.41%	❌

There is no coverage information present for the Files changed

nowakweronika

Can you describe a little what the crucial part of code is doing?😅

nowakweronika · 2023-10-25T09:50:18Z

.github/workflows/run-test.yml

@@ -36,14 +38,30 @@ jobs:
        uses: ./.github/actions/prepare-android-env

      - name: Run test
-        run: ./gradlew test


Question: Why is this removed?

it is replaced by a task that I created codeCoverage

trOnk12 · 2023-10-25T09:59:56Z

.github/workflows/run-test.yml

+        uses: madrapps/[email protected]
+        with:
+          paths: |
+            */build/reports/jacoco/codeCoverage/codeCoverage.xml


here we pass the path to the codeCoverage report in xml format to the action

trOnk12 · 2023-10-25T10:06:50Z

app/build.gradle

@@ -93,6 +94,50 @@ android {
    }
 }

+tasks.register('codeCoverage', JacocoReport) {
+    dependsOn 'testDebugUnitTest'


dependsOn means that it will execute testDebugUnitTest when triggering codeCoverage and then all that is defined here

trOnk12 · 2023-10-25T10:12:09Z

app/build.gradle

+                    "src/main/kotlin/**"
+            ]))
+
+    executionData.setFrom(fileTree(


The location of "execution data", i.e. the coverage data collected by the unit test runner when running the tests against classes instrumented by the JaCoCo agent.

trOnk12 · 2023-10-25T10:13:46Z

app/build.gradle

+        xml.required.set(true)
+    }
+
+    classDirectories.setFrom(


: The compiled class files without instrumentation. Execution data references instructions in these classes, so they're necessary for locating the actual instructions.

trOnk12 · 2023-10-25T10:14:18Z

app/build.gradle

+    classDirectories.setFrom(
+            fileTree(project.buildDir) {
+                include("**/tmp/kotlin-classes/debug/**")
+                exclude(


we can exclude some classes so that we they are not included in the code coverage report

trOnk12 · 2023-10-25T10:14:50Z

app/build.gradle

+            }
+    )
+
+    sourceDirectories.setFrom(fileTree(


the location of the original source code files. Optional, but allows the reporter to map bytecode instructions back to the original sources in order to include them into the report with coverage annotations.

Krzysiudan · 2023-10-25T10:19:19Z

Overall Project	72.41%	❌

There is no coverage information present for the Files changed

Krzysiudan · 2023-10-25T10:25:42Z

Overall Project	72.41%	❌

There is no coverage information present for the Files changed

jacek-marchwicki · 2023-10-25T11:45:12Z

.github/workflows/run-test.yml

+        with:
+          paths: |
+            */build/reports/jacoco/codeCoverage/codeCoverage.xml
+          token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}


question: why we have here: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}?

github-actions · 2023-11-16T12:31:35Z

Overall Project	72.53%	❌

There is no coverage information present for the Files changed

jacek-marchwicki

lgtm, but keep in mind that we need to continue to work on this subject to add support for merging test reports

add gradle task for jacoco test report

cc1a50f

trOnk12 changed the title ~~chore: coverage_test_report~~ chore: test coverage report Oct 24, 2023

trOnk12 marked this pull request as draft October 24, 2023 12:36

add gradle loggin

1a2db58

trOnk12 force-pushed the chore/report_test_coverage branch from 78f859f to 1a2db58 Compare October 24, 2023 14:52

add scan to gradle

3506171

trOnk12 force-pushed the chore/report_test_coverage branch from cf8774d to 3506171 Compare October 24, 2023 15:12

add plugin

a6f123a

trOnk12 force-pushed the chore/report_test_coverage branch from 452c7ed to a6f123a Compare October 24, 2023 15:24

fix stuff

88b733d

trOnk12 marked this pull request as ready for review October 25, 2023 09:42

trOnk12 requested review from jacek-marchwicki and nowakweronika October 25, 2023 09:42

nowakweronika reviewed Oct 25, 2023

View reviewed changes

trOnk12 commented Oct 25, 2023

View reviewed changes

trOnk12 force-pushed the chore/report_test_coverage branch from 8f27463 to 88b733d Compare October 25, 2023 10:15

enable coverage report generation

9c8baa7

[MegaLinter] Apply linters fixes

bf84b88

trOnk12 changed the title ~~chore: test coverage report~~ [LD-138] chore: test coverage report Oct 25, 2023

trOnk12 changed the title ~~[LD-138] chore: test coverage report~~ [LD-139] chore: test coverage report Oct 25, 2023

trOnk12 requested a review from nowakweronika October 25, 2023 10:40

merge develop

13f4e3f

jacek-marchwicki reviewed Oct 25, 2023

View reviewed changes

remove unncessary secret access and debug flag

fc7dca8

trOnk12 force-pushed the chore/report_test_coverage branch from 8f6feb5 to fc7dca8 Compare October 26, 2023 11:08

Merge branch 'develop' into chore/report_test_coverage

5060651

jacek-marchwicki approved these changes Nov 21, 2023

View reviewed changes

nowakweronika merged commit 28846e2 into develop Nov 21, 2023
10 checks passed

nowakweronika deleted the chore/report_test_coverage branch January 16, 2024 09:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[LD-139] chore: test coverage report #162

[LD-139] chore: test coverage report #162

trOnk12 commented Oct 24, 2023 •

edited

Loading

github-actions bot commented Oct 24, 2023 •

edited

Loading

Krzysiudan commented Oct 24, 2023

nowakweronika left a comment

nowakweronika Oct 25, 2023

trOnk12 Oct 25, 2023

trOnk12 Oct 25, 2023

trOnk12 Oct 25, 2023

trOnk12 Oct 25, 2023

trOnk12 Oct 25, 2023

trOnk12 Oct 25, 2023

trOnk12 Oct 25, 2023

Krzysiudan commented Oct 25, 2023

Krzysiudan commented Oct 25, 2023

jacek-marchwicki Oct 25, 2023

github-actions bot commented Nov 16, 2023

jacek-marchwicki left a comment •

edited

Loading

[LD-139] chore: test coverage report #162

[LD-139] chore: test coverage report #162

Conversation

trOnk12 commented Oct 24, 2023 • edited Loading

Pull-Request

Description

Why?

What?

Links to related issues

Demo

How to test

Documentation

Checklist

github-actions bot commented Oct 24, 2023 • edited Loading

🦙 MegaLinter status: ✅ SUCCESS

Krzysiudan commented Oct 24, 2023

nowakweronika left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Krzysiudan commented Oct 25, 2023

Krzysiudan commented Oct 25, 2023

Choose a reason for hiding this comment

github-actions bot commented Nov 16, 2023

jacek-marchwicki left a comment • edited Loading

Choose a reason for hiding this comment

trOnk12 commented Oct 24, 2023 •

edited

Loading

github-actions bot commented Oct 24, 2023 •

edited

Loading

jacek-marchwicki left a comment •

edited

Loading