Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix part of #5343: Generate Code Coverage Report in HTML and MARKDOWN formats #5443

Merged
merged 128 commits into from
Jun 28, 2024
Merged
Changes from 1 commit
Commits
Show all changes
128 commits
Select commit Hold shift + click to select a range
6ec35a7
Fix lint new line and kdoc checks
Rd4dev Jun 4, 2024
1ec224a
Execute Bazel Command to run coverage on the test target
Rd4dev Jun 5, 2024
ee92168
Parse the coverage execution result to acquire the generated coverage…
Rd4dev Jun 5, 2024
075c77c
Implemented functionality to TestBazelWorkspace utility to add source…
Rd4dev Jun 7, 2024
d0519d6
Sample Test data and Listing all contents
Rd4dev Jun 9, 2024
b15b7bb
Added Test for BazelClient - for sample target and non target executions
Rd4dev Jun 9, 2024
f441d11
Added Coverage Runner functionality tests
Rd4dev Jun 10, 2024
cc86309
Added tests for the RunCoverageForTestTarget utility
Rd4dev Jun 11, 2024
4a6073b
Replaced Java Test Sources with Kotlin Sources
Rd4dev Jun 13, 2024
13534a1
Fix Static Checks / Lint warnings
Rd4dev Jun 13, 2024
fc52d82
Fix Buildifier Lint checks
Rd4dev Jun 13, 2024
0226baa
Added tests for TestBazelWorkspaceTest to check addition of source an…
Rd4dev Jun 13, 2024
2fe7485
Fix Lint warnings with TestBazelWorkspaceTest
Rd4dev Jun 13, 2024
bd683b5
Fix Regex Pattern checks
Rd4dev Jun 13, 2024
d410d17
Prototyped parsing and reading the extracted file data as byte array
Rd4dev Jun 15, 2024
ece147a
Updated the runCoverageForTestTarget to parse the data file and read …
Rd4dev Jun 15, 2024
b101ec8
Updated Bazel Client Tests with updated execution to return byte array
Rd4dev Jun 15, 2024
5db0650
Updated BazelClientTest for ParseCoverageDataFile and readDatFileAsBi…
Rd4dev Jun 17, 2024
87be114
Updated CoverageRunnerTest to check with updated getCoverage result r…
Rd4dev Jun 17, 2024
456e81b
Updated RunCoverageForTestTargetTest to check the returned coverage data
Rd4dev Jun 17, 2024
2c65524
Update kdoc to match the function paramaters
Rd4dev Jun 17, 2024
62f9e1d
Removing suspend while keeping the async operations
Rd4dev Jun 17, 2024
5e6d2ef
Updated RunCoverageForTestTarget to take in custom process timeout as…
Rd4dev Jun 17, 2024
31b6401
Initialized bazelClient using lazy field
Rd4dev Jun 17, 2024
81d6855
Adjusted visibility and removed unnecessary documentation for private…
Rd4dev Jun 17, 2024
6cb1da7
Revoking visibility of bazelClient functions as that is called outsid…
Rd4dev Jun 17, 2024
b41fb01
Fix Lint Check issues
Rd4dev Jun 17, 2024
e66ac12
Merge branch 'develop' of https://github.com/Rd4dev/oppia-android int…
Rd4dev Jun 17, 2024
c646840
Merge branch 'develop' of https://github.com/Rd4dev/oppia-android int…
Rd4dev Jun 18, 2024
1ffc83d
Introduce new script RunCoverage.kt to later take in source filename …
Rd4dev Jun 18, 2024
248a20a
Merge branch 'develop' of https://github.com/Rd4dev/oppia-android int…
Rd4dev Jun 19, 2024
d817c85
Map file names to appropriate test and localTest names
Rd4dev Jun 19, 2024
7f1be37
Running Multiple test targets using hardcoded test target names
Rd4dev Jun 19, 2024
9e78d1a
Added Kdoc and processTimeout custom argument with basic clean up
Rd4dev Jun 19, 2024
cc5e981
Seperated logic as class and functions, introduced test file with set…
Rd4dev Jun 20, 2024
5075a1a
Added tests for findTestFile()
Rd4dev Jun 20, 2024
fdaf9cb
Added tests case for RunCoverage to check execution of coverage and f…
Rd4dev Jun 20, 2024
8e28f1d
Cleanup of RunCoverageTest
Rd4dev Jun 20, 2024
92bf266
Fix kdoc lint checks and TestBazelWorkspace Tests
Rd4dev Jun 20, 2024
eb7cdc2
Fix Lint Checks on indentation
Rd4dev Jun 20, 2024
ee078e2
Refactored BazelClient coverage execution to return data as list of s…
Rd4dev Jun 21, 2024
f15e087
Fix Lint checks
Rd4dev Jun 21, 2024
506916d
Removed ending periods in KDoc Strings
Rd4dev Jun 21, 2024
c68487d
Merge branch 'develop' of https://github.com/Rd4dev/oppia-android int…
Rd4dev Jun 21, 2024
0f5cffd
Resolved with conflicts to the code_coverage_bazel_command_execution …
Rd4dev Jun 21, 2024
87d34ad
Update the script to align with changes in BazelClient PR 1.1 to retu…
Rd4dev Jun 21, 2024
0735c64
Introduced coverage.proto and parsed the coverage data and store them…
Rd4dev Jun 21, 2024
307214a
Added sha hash and hit count for branches
Rd4dev Jun 21, 2024
bb2cbb2
Isolate the coverage data to only contain the target coverage data
Rd4dev Jun 21, 2024
653ec68
Fix Lint Checks
Rd4dev Jun 21, 2024
46cc3ff
Include coverage data to proto for any related tests - LocalTest and …
Rd4dev Jun 21, 2024
25a064e
Updated the tests to now check with the CoverageReport proto result
Rd4dev Jun 22, 2024
ba1c66a
Fix KDoc String punctuations, more clearer variable names and simplif…
Rd4dev Jun 22, 2024
438476c
Removed unused Paths import
Rd4dev Jun 22, 2024
ac30ca7
Merge branch 'develop' of https://github.com/Rd4dev/oppia-android int…
Rd4dev Jun 22, 2024
c7c2f2f
Fixed indentation and line spaces for better readability
Rd4dev Jun 22, 2024
1eac413
Merge branch 'code_coverage_bazel_command_execution' of https://githu…
Rd4dev Jun 22, 2024
6a2a029
For Reference: Multiple test cases with LocalTest and Test works but …
Rd4dev Jun 22, 2024
e4ede82
For Reference: Added package group for sharedTest and Test, yet multi…
Rd4dev Jun 22, 2024
9e0189d
Added implementation for script module test content files (to be refa…
Rd4dev Jun 22, 2024
d477d20
Refactored the addSourceAndTestFileWithContent to be suitable for mul…
Rd4dev Jun 22, 2024
6720de7
For Reference: Added App cases, but just having sharedTest in package…
Rd4dev Jun 22, 2024
04243f1
KDoC and reverting sharedTest to test, this passes test
Rd4dev Jun 22, 2024
985e861
For Reference: Even doing app/test fails with NPE
Rd4dev Jun 22, 2024
33f9a0b
Made findTestFile private and removed related tests
Rd4dev Jun 22, 2024
5229ecd
Used kotlin patterns to simplify the and make it more readable
Rd4dev Jun 22, 2024
d9ad634
Returning the coverageDataList as immutable list
Rd4dev Jun 22, 2024
ac4c82b
Fix Lint Checks
Rd4dev Jun 23, 2024
6eb90c7
Fixed Multi Level Source and Test File coverage execution by adding t…
Rd4dev Jun 23, 2024
68c714b
Fix Lint Check
Rd4dev Jun 23, 2024
e0be83a
Removed RunCoverageForTestTarget as it is redundant
Rd4dev Jun 23, 2024
c834aa7
Removed the RunCoverageForTestTarget as the functionality will be re-…
Rd4dev Jun 23, 2024
47a6197
Resolved merge conflicts with upstream code_coverage_bazel_command_ex…
Rd4dev Jun 23, 2024
c654eed
Removed the RunCoverageForTestTarget Build inclusions
Rd4dev Jun 23, 2024
3ab4e1e
Resolved merge conflict while syncing with upstream
Rd4dev Jun 23, 2024
0306258
Refactor execute to use separate helper functions
Rd4dev Jun 23, 2024
6179699
Used mapNotNull to avoid mutability
Rd4dev Jun 23, 2024
0c79e4d
Updated with upstream and removed all the optional declarations to ju…
Rd4dev Jun 24, 2024
73f553d
Merge branch 'develop' into code_coverage_bazel_command_execution
BenHenning Jun 24, 2024
0f63469
Merge branch 'develop' into code_coverage_bazel_command_execution
BenHenning Jun 24, 2024
83eb035
Updated with the revised proto structure and added docs
Rd4dev Jun 24, 2024
bc9a5c0
Throw runtime exception when no coverage result is retrieved
Rd4dev Jun 24, 2024
7e10505
Introduced Coverage Reporter script to generate HTML and MARKDOWN rep…
Rd4dev Jun 24, 2024
9bfeeff
Saving the MARKDOWN reports
Rd4dev Jun 24, 2024
5441356
Generate HTML reports - hardcoded messy implementation for base layout
Rd4dev Jun 25, 2024
aed9857
Generate HTML for just one target
Rd4dev Jun 25, 2024
1b9426d
Fix instrumentation and throw error on invalid path
Rd4dev Jun 26, 2024
85b4bcd
Throw error on missing test files
Rd4dev Jun 26, 2024
356e4fb
Removed accidentally added coverage_reports folder
Rd4dev Jun 26, 2024
b4abdde
Restructuring coverage proto to just compute line coverage
Rd4dev Jun 26, 2024
8e07f50
Updated with upstream
Rd4dev Jun 26, 2024
9734a84
Lint fix and Fix failing Test
Rd4dev Jun 26, 2024
f36eb83
Merge branch 'develop' of https://github.com/Rd4dev/oppia-android int…
Rd4dev Jun 26, 2024
6488d53
Merge branch 'code_coverage_bazel_command_execution' of https://githu…
Rd4dev Jun 26, 2024
6f4b76f
Merge branch 'code_coverage_bazel_command_execution' of https://githu…
Rd4dev Jun 26, 2024
7a020a1
Update the test file exemption list retrieval
Rd4dev Jun 26, 2024
4d8b250
Updated from upstream code_coverage_using_filename
Rd4dev Jun 26, 2024
c123365
Updated tests with the proto structure, multi test cases are still fa…
Rd4dev Jun 26, 2024
d6c1f33
Changed mutable lists to lists
Rd4dev Jun 26, 2024
3b6b049
Removed print statement and refactored same package deps
Rd4dev Jun 26, 2024
d88edf6
Fixed improper dep assignment
Rd4dev Jun 26, 2024
4e89da1
Updated with upstream code_coverage_using_filename
Rd4dev Jun 26, 2024
7a837ea
Refactor runCoverageForTarget to return non-nullable CoverageReport
Rd4dev Jun 26, 2024
cba0815
Fix tests in CoverageRunner and Lint checks
Rd4dev Jun 26, 2024
f6b4620
Fix Lint checks
Rd4dev Jun 26, 2024
cf405c6
Added tests for local and sharedTests separately
Rd4dev Jun 26, 2024
88f286b
Fix Lint check, missed separator
Rd4dev Jun 26, 2024
c4c7ead
Updated with upstream code_coverage_store_proto
Rd4dev Jun 26, 2024
32d9ae4
Fix Coverage Runner Test
Rd4dev Jun 26, 2024
402f33f
Merge branch 'code_coverage_store_as_proto' of https://github.com/opp…
Rd4dev Jun 26, 2024
a17377a
Cleaned the md report generation to just hold line coverage data
Rd4dev Jun 26, 2024
12eecfe
Cleaned the html report generation to just hold line coverage data
Rd4dev Jun 26, 2024
9b28dca
Code cleanup - refactored redundant code
Rd4dev Jun 26, 2024
266d0f4
Resolved conflicts with develop branch
Rd4dev Jun 26, 2024
a0bc41c
Resolved conflicting overloads
Rd4dev Jun 26, 2024
098a057
Resolve merge conflicts with upstream code_coverage_store_proto
Rd4dev Jun 26, 2024
01e0ad9
Added tests for CoverageReporter utility
Rd4dev Jun 27, 2024
6416569
Renamed test case names to be more crisp and clear
Rd4dev Jun 27, 2024
3bf9919
Added tests for RunCoverage to check md and html reports
Rd4dev Jun 27, 2024
e1e2db3
Fix Lint checks and added kdocs
Rd4dev Jun 27, 2024
821725f
Fixed failing tests and fixed kdoc checks
Rd4dev Jun 27, 2024
2b97b51
Fix test cases that failed due to wrong output path
Rd4dev Jun 27, 2024
d6fb599
Fix test case that had mis-matched outputs
Rd4dev Jun 27, 2024
036ab34
Resolved conflicts with develop branch
Rd4dev Jun 27, 2024
032abcd
Fix Lint checks on unused imports
Rd4dev Jun 27, 2024
f080cba
Refactor to ignore case formats and updated the html styling with tests
Rd4dev Jun 28, 2024
a2273ec
Updated RunCoverageTest with update to html stylings
Rd4dev Jun 28, 2024
5d0bb7e
Fixed failing test case that failed due to changes in file and unchan…
Rd4dev Jun 28, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Sample Test data and Listing all contents
Rd4dev committed Jun 13, 2024
commit d0519d684ec1d98c9793f54a8686618e01d1bd87
37 changes: 35 additions & 2 deletions scripts/src/java/org/oppia/android/scripts/common/BazelClient.kt
Original file line number Diff line number Diff line change
@@ -136,11 +136,44 @@ class BazelClient(private val rootDirectory: File, private val commandExecutor:
* @param bazelTestTarget Bazel test target for which code coverage will be run.
* @return generated coverageResult output
*/
fun runCoverageForTestTarget(bazelTestTarget: String): List<String> {
return executeBazelCommand(
// fun runCoverageForTestTarget(bazelTestTarget: String): List<String> {
fun runCoverageForTestTarget(bazelTestTarget: String): String? {
/*return executeBazelCommand(
"coverage",
bazelTestTarget
)*/
val result = executeBazelCommand(
"coverage",
bazelTestTarget
)

println("Coverage data from exe: $result")
val filedata = parseCoverageDataFile(result)

println("Coverage data path from exe: $filedata")
val file = File(filedata)

if (file.exists() && file.isFile) {
val contents = file.readText()
println(contents)
} else {
println("File does not exist or is not a valid file: $filedata")
}

return filedata
}

fun parseCoverageDataFile(data: List<String>) : String? {
val regex = ".*coverage\\.dat$".toRegex()
for (line in data) {
val match = regex.find(line)
val extractedPath = match?.value?.substringAfterLast(",")?.trim()
if (extractedPath != null) {
println("Parsed Coverage Data File: $extractedPath")
return extractedPath
}
}
return null
}

/**
Original file line number Diff line number Diff line change
@@ -20,7 +20,7 @@ import java.util.concurrent.TimeUnit
* The default amount of time that should be waited before considering a process as 'hung', in
* milliseconds.
*/
const val WAIT_PROCESS_TIMEOUT_MS = 60_000L
const val WAIT_PROCESS_TIMEOUT_MS = 600_000L

/** Default implementation of [CommandExecutor]. */
class CommandExecutorImpl(
Original file line number Diff line number Diff line change
@@ -50,6 +50,97 @@ class TestBazelWorkspace(private val temporaryRootFolder: TemporaryFolder) {
assertThat(bazelRcFile.exists()).isTrue()
}

fun addSampleSourceAndTestFile(
filename: String,
sourceContent: String,
testContent: String,
subpackage: String
) {
val sourceSubpackage = "$subpackage/main/java/com/example"
addSampleSourceContentAndBuildFile(filename, sourceContent, sourceSubpackage)

val testSubpackage = "$subpackage/test/java/com/example"
val testFileName = "Test${filename}"
addSampleTestContentAndBuildFile(testFileName, testContent, testSubpackage)
}

fun addSampleSourceContentAndBuildFile(
filename: String,
sourceContent: String,
sourceSubpackage: String
) {
initEmptyWorkspace()

// Create the source subpackage directory if it doesn't exist
if (!File(temporaryRootFolder.root, sourceSubpackage.replace(".", "/")).exists()) {
temporaryRootFolder.newFolder(*(sourceSubpackage.split(".")).toTypedArray())
}

// Create the source file
val sourceFile = temporaryRootFolder.newFile("${sourceSubpackage.replace(".", "/")}/$filename.java")
sourceFile.writeText(sourceContent)

// Create or update the BUILD file for the source file
val buildFileRelativePath = "${sourceSubpackage.replace(".", "/")}/BUILD.bazel"
val buildFile = File(temporaryRootFolder.root, buildFileRelativePath)
if (!buildFile.exists()) {
temporaryRootFolder.newFile(buildFileRelativePath)
}

//prepareBuildFileForLibraries(buildFile)

//val libTargetName = "//${sourceSubpackage}:${filename}_lib"
buildFile.appendText(
"""
package(
default_visibility = ["//visibility:public"],
)

java_library(
name = "collatz_lib",
srcs=["Collatz.java"],
)
""".trimIndent() + "\n"
)
}

fun addSampleTestContentAndBuildFile(
testName: String,
testContent: String,
testSubpackage: String
) {
initEmptyWorkspace()

// Create the test subpackage directory for the test file if it doesn't exist
if (!File(temporaryRootFolder.root, testSubpackage.replace(".", "/")).exists()) {
temporaryRootFolder.newFolder(*(testSubpackage.split(".")).toTypedArray())
}

// Create the test file
val testFile = temporaryRootFolder.newFile("${testSubpackage.replace(".", "/")}/$testName.java")
testFile.writeText(testContent)

// Create or update the BUILD file for the test file
val testBuildFileRelativePath = "${testSubpackage.replace(".", "/")}/BUILD.bazel"
val testBuildFile = File(temporaryRootFolder.root, testBuildFileRelativePath)
if (!testBuildFile.exists()) {
temporaryRootFolder.newFile(testBuildFileRelativePath)
}
//prepareBuildFileForTests(testBuildFile)

// Add the test file to the BUILD file with appropriate dependencies
testBuildFile.appendText(
"""
java_test(
name = "test",
srcs = ["TestCollatz.java"],
test_class = "com.example.TestCollatz",
deps = ["//coverage/main/java/com/example:collatz_lib"],
)
""".trimIndent() + "\n"
)
}

/**
* Adds a source file with the specified name and content to the specified subpackage,
* and updates the corresponding build configuration.
@@ -65,6 +156,7 @@ class TestBazelWorkspace(private val temporaryRootFolder: TemporaryFolder) {
sourceSubpackage: String
): String {
initEmptyWorkspace() // Ensure the workspace is at least initialized.
ensureWorkspaceIsConfiguredForKotlin()

// Create the source subpackage directory if it doesn't exist
if (!File(temporaryRootFolder.root, sourceSubpackage.replace(".", "/")).exists()) {
@@ -84,9 +176,9 @@ class TestBazelWorkspace(private val temporaryRootFolder: TemporaryFolder) {

prepareBuildFileForLibraries(buildFile)

val libTargetName = "${sourceSubpackage}:${filename}_lib"
val libTargetName = "//${sourceSubpackage}:${filename}_lib"
buildFile.appendText(
""""
"""
kt_jvm_library(
name = "${filename}_lib",
srcs=["$filename}.kt"],
@@ -112,6 +204,7 @@ class TestBazelWorkspace(private val temporaryRootFolder: TemporaryFolder) {
testSubpackage: String
) {
initEmptyWorkspace() // Ensure the workspace is at least initialized.
ensureWorkspaceIsConfiguredForKotlin()

// Create the test subpackage directory for the test file if it doesn't exist
if (!File(temporaryRootFolder.root, testSubpackage.replace(".", "/")).exists()) {
@@ -137,14 +230,47 @@ class TestBazelWorkspace(private val temporaryRootFolder: TemporaryFolder) {
name = "$testName",
srcs = ["${testName}.kt"],
deps = [
"//third_party:org_jetbrains_kotlin_kotlin-test-junit",
"@maven//:junit_junit",
"$libTargetName",
],
)
""".trimIndent() + "\n"
)
}

fun setupGeneralCoverageBuildFile(
sourceLibTargetName: String,
testTargetName: String,
coverageSubpackage: String
) {
initEmptyWorkspace() // Ensure the workspace is at least initialized.
ensureWorkspaceIsConfiguredForKotlin() // Ensure Kotlin rules are set up.

// Create the coverage subpackage directory if it doesn't exist
if (!File(temporaryRootFolder.root, coverageSubpackage.replace(".", "/")).exists()) {
temporaryRootFolder.newFolder(*(coverageSubpackage.split(".")).toTypedArray())
}

// Create or update the BUILD file for the coverage package
val coverageBuildFileRelativePath = "${coverageSubpackage.replace(".", "/")}/BUILD.bazel"
val coverageBuildFile = File(temporaryRootFolder.root, coverageBuildFileRelativePath)
if (!coverageBuildFile.exists()) {
temporaryRootFolder.newFile(coverageBuildFileRelativePath)
}

coverageBuildFile.appendText(
"""
kt_jvm_binary(
name = "coverage_runner",
srcs = ["//${coverageSubpackage.replace(".", "/")}:$testTargetName"],
deps = [
"$sourceLibTargetName",
],
)
""".trimIndent() + "\n"
)
}

/**
* Adds a file with the specified name and content, along with its corresponding test file and
* test content, to the specified subpackage. Ensures the appropriate build configurations are created.
@@ -166,6 +292,8 @@ class TestBazelWorkspace(private val temporaryRootFolder: TemporaryFolder) {
val testSubpackage = "$subpackage/test"
val testFileName = "${filename}Test"
addTestContentAndBuildFile(testFileName, testContent, libTargetName, testSubpackage)

setupGeneralCoverageBuildFile(libTargetName, testFileName, subpackage)
}

/**
Loading