Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions app/src/main/res/values-qq/strings.xml
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,7 @@
<string name="title_page_bookmarks_locations">Tab in bookmark view.</string>
<string name="title_page_bookmarks_categories">Tab in bookmark view.</string>
<string name="menu_bookmark">Call to action.</string>
<string name="documentation_without_source">ONLY HERE TO TEST THAT IT WORKS IN GITHUB, MUST NOT BE MERGED.</string>
<string name="provider_bookmarks">Provider name.</string>
<string name="bookmark_empty">Notice when there are no bookmarks.</string>
<string name="provider_bookmarks_location">Provider title.</string>
Expand Down
60 changes: 60 additions & 0 deletions app/src/test/kotlin/resources/StringsDocumentationTest.kt
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
package resources

import org.junit.Test
import org.junit.Assert.assertTrue
import org.w3c.dom.Element
import java.io.File
import javax.xml.parsers.DocumentBuilderFactory

class StringsDocumentationTest {

@Test
fun `string resources and qq documentation are in sync`() {
val projectRoot = File(System.getProperty("user.dir") ?: ".")
val sourceFile = File(projectRoot, "src/main/res/values/strings.xml")
val docFile = File(projectRoot, "src/main/res/values-qq/strings.xml")

assertTrue("Source strings.xml not found", sourceFile.exists())
assertTrue("Documentation strings.xml (qq) not found", docFile.exists())

val sourceKeys = parseStringKeys(sourceFile)
val docKeys = parseStringKeys(docFile)

val extraDocs = docKeys - sourceKeys

assertTrue(
"Documentation exists for ${extraDocs.size} non-existent string(s): " +
extraDocs.joinToString(", "),
extraDocs.isEmpty()
)

val missingDocs = sourceKeys - docKeys

assertTrue(
"Missing documentation for ${missingDocs.size} string(s): " +
missingDocs.joinToString(", "),
missingDocs.isEmpty()
)
}

private fun parseStringKeys(file: File): Set<String> {
val factory = DocumentBuilderFactory.newInstance()
val builder = factory.newDocumentBuilder()
val doc = builder.parse(file)

val keys = mutableSetOf<String>()

listOf("string", "plurals").forEach { tagName ->
val elements = doc.getElementsByTagName(tagName)
for (i in 0 until elements.length) {
val element = elements.item(i) as Element
val name = element.getAttribute("name")
if (name.isNotEmpty()) {
keys.add(name)
}
}
}

return keys
}
}
Loading