Fix instrumentation and throw error on invalid path

oppia · adhiamboperes · Jun 27, 2024 · Jun 4, 2024 · Jun 5, 2024 · Jun 5, 2024
commit 1b9426d196a1d790fc31e70721be88c52506a0b1
diff --git a/..._reports/utility/src/main/java/org/oppia/android/util/parser/math/MathModel/coverage.html b/..._reports/utility/src/main/java/org/oppia/android/util/parser/math/MathModel/coverage.html
@@ -0,0 +1,115 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="UTF-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <title>Coverage Report</title>
+ <style>
+ body {
+ font-family: Arial, sans-serif;
+ line-height: 1.6;
+ padding: 20px;
+ }
+ .covered-line, .not-covered-line, .uncovered-line {
+ display: inline-block;
+ width: auto;
+ padding: 2px 4px;
+ margin: 0;
+ }
+ .covered-line {
+ background-color: #c8e6c9; /* Light green */
+ }
+ .not-covered-line {
+ background-color: #ffcdd2; /* Light red */
+ }
+ .uncovered-line {
+ background-color: #ffffff; /* White */
+ }
+ .coverage-summary {
+ margin-bottom: 20px;
+ }
+ pre {
+ white-space: pre-wrap;
+ word-wrap: break-word;
+ }
+ </style>
+</head>
+<body>
+ <h1>Coverage Report</h1>
+ <div class="coverage-summary">
+ <h2>Total coverage:</h2>
+ <ul>
+ <li><strong>Files covered:</strong> 1</li>
+ <li><strong>Covered File:</strong> utility/src/main/java/org/oppia/android/util/parser/math/MathModel.kt</li>
+ <li><strong>Coverage percentage:</strong> 87.50% covered</li>
+ <li><strong>Line coverage:</strong> 0 covered / 0 found</li>
+ <li><strong>Function coverage:</strong> 0 covered / 0 found</li>
+ <li><strong>Branch coverage:</strong> 0 covered / 0 found</li>
+ </ul>
+ </div>
+ <pre><div class="uncovered-line"> 1: package org.oppia.android.util.parser.math</div>
+<div class="uncovered-line"> 2: </div>
+<div class="uncovered-line"> 3: import com.bumptech.glide.load.Key</div>
+<div class="uncovered-line"> 4: import java.nio.ByteBuffer</div>
+<div class="uncovered-line"> 5: import java.security.MessageDigest</div>
+<div class="uncovered-line"> 6: </div>
+<div class="uncovered-line"> 7: /**</div>
+<div class="uncovered-line"> 8: * Represents a set of LaTeX that can be rendered as a single bitmap.</div>
+<div class="uncovered-line"> 9: *</div>
+<div class="uncovered-line"> 10: * @property rawLatex the LaTeX to render</div>
+<div class="uncovered-line"> 11: * @property lineHeight the height (in pixels) of a text line (to help scale the LaTeX)</div>
+<div class="uncovered-line"> 12: * @property useInlineRendering whether the LaTeX will be inlined with text</div>
+<div class="uncovered-line"> 13: */</div>
+<div class="covered-line"> 14: data class MathModel(</div>
+<div class="covered-line"> 15: val rawLatex: String,</div>
+<div class="covered-line"> 16: val lineHeight: Float,</div>
+<div class="covered-line"> 17: val useInlineRendering: Boolean</div>
+<div class="uncovered-line"> 18: ) {</div>
+<div class="uncovered-line"> 19: /** Returns a Glide [Key] signature (see [MathModelSignature] for specifics). */</div>
+<div class="uncovered-line"> 20: fun toKeySignature(): MathModelSignature =</div>
+<div class="covered-line"> 21: MathModelSignature.createSignature(rawLatex, lineHeight, useInlineRendering)</div>
+<div class="uncovered-line"> 22: </div>
+<div class="uncovered-line"> 23: /**</div>
+<div class="uncovered-line"> 24: * Glide [Key] that provides caching support by allowing individual renderable math scenarios to</div>
+<div class="uncovered-line"> 25: * be comparable based on select parameters.</div>
+<div class="uncovered-line"> 26: *</div>
+<div class="uncovered-line"> 27: * @property rawLatex the raw LaTeX string used to render a cached bitmap</div>
+<div class="uncovered-line"> 28: * @property lineHeightHundredX an [Int] representation of the 100x scaled line height from</div>
+<div class="uncovered-line"> 29: * [MathModel] (this is used to preserve up to 2 digits of the height, but any past that will</div>
+<div class="uncovered-line"> 30: * be truncated to reduce cache size for highly reusable cached renders)</div>
+<div class="uncovered-line"> 31: * @property useInlineRendering whether the render is formatted to be displayed in-line with text</div>
+<div class="uncovered-line"> 32: */</div>
+<div class="covered-line"> 33: data class MathModelSignature(</div>
+<div class="covered-line"> 34: val rawLatex: String,</div>
+<div class="covered-line"> 35: val lineHeightHundredX: Int,</div>
+<div class="covered-line"> 36: val useInlineRendering: Boolean</div>
+<div class="uncovered-line"> 37: ) : Key {</div>
+<div class="uncovered-line"> 38: // Impl reference: http:https://bumptech.github.io/glide/doc/caching.html#custom-cache-invalidation.</div>
+<div class="uncovered-line"> 39: </div>
+<div class="uncovered-line"> 40: override fun updateDiskCacheKey(messageDigest: MessageDigest) {</div>
+<div class="covered-line"> 41: val rawLatexBytes = rawLatex.encodeToByteArray()</div>
+<div class="covered-line"> 42: messageDigest.update(</div>
+<div class="covered-line"> 43: ByteBuffer.allocate(rawLatexBytes.size + Int.SIZE_BYTES + 1).apply {</div>
+<div class="covered-line"> 44: put(rawLatexBytes)</div>
+<div class="covered-line"> 45: putInt(lineHeightHundredX)</div>
+<div class="covered-line"> 46: put(if (useInlineRendering) 1 else 0)</div>
+<div class="covered-line"> 47: }.array()</div>
+<div class="uncovered-line"> 48: )</div>
+<div class="covered-line"> 49: }</div>
+<div class="uncovered-line"> 50: </div>
+<div class="uncovered-line"> 51: internal companion object {</div>
+<div class="uncovered-line"> 52: /** Returns a new [MathModelSignature] for the specified [MathModel] properties. */</div>
+<div class="uncovered-line"> 53: internal fun createSignature(</div>
+<div class="uncovered-line"> 54: rawLatex: String,</div>
+<div class="uncovered-line"> 55: lineHeight: Float,</div>
+<div class="uncovered-line"> 56: useInlineRendering: Boolean</div>
+<div class="uncovered-line"> 57: ): MathModelSignature {</div>
+<div class="covered-line"> 58: val lineHeightHundredX = (lineHeight * 100f).toInt()</div>
+<div class="covered-line"> 59: return MathModelSignature(rawLatex, lineHeightHundredX, useInlineRendering)</div>
+<div class="uncovered-line"> 60: }</div>
+<div class="uncovered-line"> 61: }</div>
+<div class="uncovered-line"> 62: }</div>
+<div class="uncovered-line"> 63: }</div>
+ </pre>
+</body>
+</html>
diff --git a/.../utility/src/main/java/org/oppia/android/util/parser/math/MathModel/coverage.md b/.../utility/src/main/java/org/oppia/android/util/parser/math/MathModel/coverage.md
@@ -0,0 +1,9 @@
+# Coverage Report
+
+**Total coverage:**
+- **Files covered:** 1
+- **Covered File:** utility/src/main/java/org/oppia/android/util/parser/math/MathModel.kt
+- **Coverage percentage:** 87.50% covered
+- **Line coverage:** 19 covered / 19 found
+- **Function coverage:** 7 covered / 11 found
+- **Branch coverage:** 2 covered / 2 found
diff --git a/...e_reports/utility/src/test/java/org/oppia/android/util/math/FloatExtensions/coverage.html b/...e_reports/utility/src/test/java/org/oppia/android/util/math/FloatExtensions/coverage.html
@@ -0,0 +1,95 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="UTF-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <title>Coverage Report</title>
+ <style>
+ body {
+ font-family: Arial, sans-serif;
+ line-height: 1.6;
+ padding: 20px;
+ }
+ .covered-line, .not-covered-line, .uncovered-line {
+ display: inline-block;
+ width: auto;
+ padding: 2px 4px;
+ margin: 0;
+ }
+ .covered-line {
+ background-color: #c8e6c9; /* Light green */
+ }
+ .not-covered-line {
+ background-color: #ffcdd2; /* Light red */
+ }
+ .uncovered-line {
+ background-color: #ffffff; /* White */
+ }
+ .coverage-summary {
+ margin-bottom: 20px;
+ }
+ pre {
+ white-space: pre-wrap;
+ word-wrap: break-word;
+ }
+ </style>
+</head>
+<body>
+ <h1>Coverage Report</h1>
+ <div class="coverage-summary">
+ <h2>Total coverage:</h2>
+ <ul>
+ <li><strong>Files covered:</strong> 1</li>
+ <li><strong>Covered File:</strong> utility/src/main/java/org/oppia/android/util/math/FloatExtensions.kt</li>
+ <li><strong>Coverage percentage:</strong> 80.00% covered</li>
+ <li><strong>Line coverage:</strong> 0 covered / 0 found</li>
+ <li><strong>Function coverage:</strong> 0 covered / 0 found</li>
+ <li><strong>Branch coverage:</strong> 0 covered / 0 found</li>
+ </ul>
+ </div>
+ <pre><div class="uncovered-line"> 1: package org.oppia.android.util.math</div>
+<div class="uncovered-line"> 2: </div>
+<div class="uncovered-line"> 3: import kotlin.math.abs</div>
+<div class="uncovered-line"> 4: </div>
+<div class="uncovered-line"> 5: /**</div>
+<div class="uncovered-line"> 6: * The error margin used for approximately [Float] equality checking, that is, the largest distance</div>
+<div class="uncovered-line"> 7: * from any particular number before a new value will be considered unequal (i.e. all values between</div>
+<div class="uncovered-line"> 8: * a float and (float-interval, float+interval) will be considered equal to the float).</div>
+<div class="uncovered-line"> 9: *</div>
+<div class="uncovered-line"> 10: * Note that the machine epsilon value from https://en.wikipedia.org/wiki/Machine_epsilon is defined</div>
+<div class="uncovered-line"> 11: * defined as the smallest value that, when added to, or subtract from, 1, will result in a value</div>
+<div class="uncovered-line"> 12: * that is exactly equal to 1. A larger value is picked here for more allowance in variance.</div>
+<div class="uncovered-line"> 13: */</div>
+<div class="uncovered-line"> 14: const val FLOAT_EQUALITY_EPSILON: Float = 1e-6f</div>
+<div class="uncovered-line"> 15: </div>
+<div class="uncovered-line"> 16: /**</div>
+<div class="uncovered-line"> 17: * The error margin used for approximately [Double] equality checking.</div>
+<div class="uncovered-line"> 18: *</div>
+<div class="uncovered-line"> 19: * See [FLOAT_EQUALITY_EPSILON] for an explanation of this value.</div>
+<div class="uncovered-line"> 20: */</div>
+<div class="uncovered-line"> 21: const val DOUBLE_EQUALITY_EPSILON: Double = 1e-13</div>
+<div class="uncovered-line"> 22: </div>
+<div class="uncovered-line"> 23: /**</div>
+<div class="uncovered-line"> 24: * Returns whether this float approximately equals another based on a consistent epsilon value</div>
+<div class="uncovered-line"> 25: * ([FLOAT_EQUALITY_EPSILON]).</div>
+<div class="uncovered-line"> 26: */</div>
+<div class="uncovered-line"> 27: fun Float.isApproximatelyEqualTo(other: Float): Boolean {</div>
+<div class="covered-line"> 28: return abs(this - other) < FLOAT_EQUALITY_EPSILON</div>
+<div class="uncovered-line"> 29: }</div>
+<div class="uncovered-line"> 30: </div>
+<div class="uncovered-line"> 31: /**</div>
+<div class="uncovered-line"> 32: * Returns whether this double approximately equals another based on a consistent epsilon value</div>
+<div class="uncovered-line"> 33: * ([DOUBLE_EQUALITY_EPSILON]).</div>
+<div class="uncovered-line"> 34: */</div>
+<div class="uncovered-line"> 35: fun Double.isApproximatelyEqualTo(other: Double): Boolean {</div>
+<div class="covered-line"> 36: return abs(this - other) < DOUBLE_EQUALITY_EPSILON</div>
+<div class="uncovered-line"> 37: }</div>
+<div class="uncovered-line"> 38: </div>
+<div class="uncovered-line"> 39: /**</div>
+<div class="uncovered-line"> 40: * Returns a string representation of this [Double] that keeps the double in pure decimal and never</div>
+<div class="uncovered-line"> 41: * relies on scientific notation (unlike [Double.toString]).</div>
+<div class="uncovered-line"> 42: */</div>
+<div class="not-covered-line"> 43: fun Double.toPlainString(): String = toBigDecimal().toPlainString()</div>
+ </pre>
+</body>
+</html>
diff --git a/...s/utility/src/test/java/org/oppia/android/util/math/FloatExtensions/coverage.md b/...s/utility/src/test/java/org/oppia/android/util/math/FloatExtensions/coverage.md
@@ -0,0 +1,9 @@
+# Coverage Report
+
+**Total coverage:**
+- **Files covered:** 1
+- **Covered File:** utility/src/main/java/org/oppia/android/util/math/FloatExtensions.kt
+- **Coverage percentage:** 80.00% covered
+- **Line coverage:** 2 covered / 3 found
+- **Function coverage:** 2 covered / 3 found
+- **Branch coverage:** 4 covered / 4 found
diff --git a/scripts/src/java/org/oppia/android/scripts/common/BazelClient.kt b/scripts/src/java/org/oppia/android/scripts/common/BazelClient.kt
@@ -142,10 +142,11 @@ class BazelClient(private val rootDirectory: File, private val commandExecutor:
  * or null if the coverage data file could not be parsed
  */
  fun runCoverageForTestTarget(bazelTestTarget: String): List<String>? {
+ val computeInstrumentation = bazelTestTarget.split("/").let{"//${it[2]}/..."}
  val coverageCommandOutputLines = executeBazelCommand(
  "coverage",
  bazelTestTarget,
- "--instrumentation_filter=//"
+ "--instrumentation_filter=$computeInstrumentation"
  )
  return parseCoverageDataFilePath(coverageCommandOutputLines)?.let { path ->
  File(path).readLines()

@@ -31,6 +31,10 @@ fun main(vararg args: String) {
  val repoRoot = args[0]
  val filePath = args[1]
 
+ if (!File(repoRoot, filePath).exists()) {
+ error("File doesn't exist.")
+ }
+
  ScriptBackgroundCoroutineDispatcher().use { scriptBgDispatcher ->
  val processTimeout: Long = args.find { it.startsWith("processTimeout=") }
  ?.substringAfter("=")
@@ -79,7 +83,7 @@ class RunCoverage(
  .getExemptedFilePathList()
 
  if (filePath in testFileExemptionList) {
- println("This file is exempted from having a test file. Hence No coverage!")
+ println("This file is exempted from having a test file; skipping coverage check.")
  return emptyList()
  }
 

@@ -8,10 +8,12 @@ import org.junit.Test
 import org.junit.rules.TemporaryFolder
 import org.oppia.android.scripts.common.CommandExecutorImpl
 import org.oppia.android.scripts.common.ScriptBackgroundCoroutineDispatcher
+import org.oppia.android.testing.assertThrows
 import org.oppia.android.scripts.testing.TestBazelWorkspace
 import java.io.ByteArrayOutputStream
 import java.io.PrintStream
 import java.util.concurrent.TimeUnit
+import java.io.File
 
 /** Tests for [RunCoverage]. */
 class RunCoverageTest {
@@ -40,6 +42,24 @@ class RunCoverageTest {
  scriptBgDispatcher.close()
  }
 
+ @Test
+ fun testRunCoverage_validFile_runsCoverage() {
+ testBazelWorkspace.initEmptyWorkspace()
+ val sampleFile = File(tempFolder.root.absolutePath, "file.kt")
+ sampleFile.createNewFile()
+ main(tempFolder.root.absolutePath, "file.kt")
+ }
+
+ @Test
+ fun testRunCoverage_invalidFile_runsCoverage() {
+ testBazelWorkspace.initEmptyWorkspace()
+ val exception = assertThrows<IllegalStateException>() {
+ main(tempFolder.root.absolutePath, "file.kt")
+ }
+
+ assertThat(exception).hasMessageThat().contains("File doesn't exist")
+ }
+
  @Test
  fun testRunCoverage_testFileExempted_noCoverage() {
  val exemptedFilePath = "app/src/main/java/org/oppia/android/app/activity/ActivityComponent.kt"
@@ -56,7 +76,7 @@ class RunCoverageTest {
  }
 
  @Test
- fun testRunCoverage_validSampleTestFile_returnsCoverageData() {
+ fun testRunCoverage_sampleTests_returnsCoverageData() {
  testBazelWorkspace.initEmptyWorkspace()
 
  val sourceContent =
@@ -139,7 +159,7 @@ class RunCoverageTest {
  }
 
  @Test
- fun testRunCoverage_validScriptPathSampleTestFile_returnsCoverageData() {
+ fun testRunCoverage_scriptTests_returnsCoverageData() {
  testBazelWorkspace.initEmptyWorkspace()
 
  val sourceContent =
@@ -222,7 +242,7 @@ class RunCoverageTest {
  }
 
  @Test
- fun testRunCoverage_validAppPathSampleTestFile_returnsCoverageData() {
+ fun testRunCoverage_appTests_returnsCoverageData() {
  testBazelWorkspace.initEmptyWorkspace()
 
  val sourceContent =
@@ -305,7 +325,7 @@ class RunCoverageTest {
  }
 
  @Test
- fun testRunCoverage_validMultiSampleTestFile_returnsCoverageData() {
+ fun testRunCoverage_sharedAndLocalTests_returnsCoverageData() {
  testBazelWorkspace.initEmptyWorkspace()
 
  val sourceContent =