diff --git a/.github/workflows/test-parsers.yml b/.github/workflows/test-parsers.yml index d2964204..4479e758 100644 --- a/.github/workflows/test-parsers.yml +++ b/.github/workflows/test-parsers.yml @@ -20,7 +20,8 @@ jobs: distribution: 'temurin' cache: 'gradle' - run: ./gradlew :test --tests "org.koitharu.kotatsu.parsers.MangaParserTest" || true + - run: ./gradlew generateTestsReport - uses: actions/upload-artifact@v3 with: name: Report - path: build/reports/tests/test \ No newline at end of file + path: build/test-results-html/TEST-org.koitharu.kotatsu.parsers.MangaParserTest.htm \ No newline at end of file diff --git a/.idea/kotlinc.xml b/.idea/kotlinc.xml new file mode 100644 index 00000000..7e340a77 --- /dev/null +++ b/.idea/kotlinc.xml @@ -0,0 +1,6 @@ + + + + + \ No newline at end of file diff --git a/build.gradle b/build.gradle index a8a75c61..276677c7 100644 --- a/build.gradle +++ b/build.gradle @@ -1,3 +1,5 @@ +import tasks.ReportGenerateTask + plugins { id 'java-library' id 'org.jetbrains.kotlin.jvm' @@ -65,4 +67,6 @@ dependencies { testImplementation 'org.junit.jupiter:junit-jupiter-params:5.8.2' testImplementation 'org.jetbrains.kotlinx:kotlinx-coroutines-test:1.6.2' testImplementation 'io.webfolder:quickjs:1.1.0' -} \ No newline at end of file +} + +task generateTestsReport(type: ReportGenerateTask) \ No newline at end of file diff --git a/buildSrc/build.gradle b/buildSrc/build.gradle new file mode 100644 index 00000000..eb5ac57d --- /dev/null +++ b/buildSrc/build.gradle @@ -0,0 +1,12 @@ +plugins { + id('org.jetbrains.kotlin.jvm') version '1.6.21' +} +repositories { + mavenCentral() +} + +dependencies { + implementation 'org.simpleframework:simple-xml:2.7.1' + implementation 'com.soywiz.korlibs.korte:korte-jvm:3.0.0-Beta5' + implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.2' +} \ No newline at end of file diff --git a/buildSrc/gradle/wrapper/gradle-wrapper.jar b/buildSrc/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..41d9927a Binary files /dev/null and b/buildSrc/gradle/wrapper/gradle-wrapper.jar differ diff --git a/buildSrc/gradle/wrapper/gradle-wrapper.properties b/buildSrc/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..41dfb879 --- /dev/null +++ b/buildSrc/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/buildSrc/gradlew b/buildSrc/gradlew new file mode 100755 index 00000000..1b6c7873 --- /dev/null +++ b/buildSrc/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/buildSrc/gradlew.bat b/buildSrc/gradlew.bat new file mode 100644 index 00000000..ac1b06f9 --- /dev/null +++ b/buildSrc/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/buildSrc/src/main/kotlin/tasks/ReportGenerateTask.kt b/buildSrc/src/main/kotlin/tasks/ReportGenerateTask.kt new file mode 100644 index 00000000..72b1587a --- /dev/null +++ b/buildSrc/src/main/kotlin/tasks/ReportGenerateTask.kt @@ -0,0 +1,68 @@ +package tasks + +import com.soywiz.korte.Template +import kotlinx.coroutines.runBlocking +import org.gradle.api.DefaultTask +import org.gradle.api.tasks.TaskAction +import org.simpleframework.xml.Serializer +import org.simpleframework.xml.core.Persister +import tasks.model.TestCase +import tasks.model.TestSuite +import java.io.File +import kotlin.math.roundToInt + +open class ReportGenerateTask : DefaultTask() { + + @TaskAction + fun execute() { + val reportsRoot = File(project.rootDir, "build/test-results/test") + val outputRoot = File(project.rootDir, "build/test-results-html") + outputRoot.deleteRecursively() + outputRoot.mkdir() + for (file in checkNotNull(reportsRoot.listFiles()) { + "No files found in $reportsRoot" + }) { + if (file.isDirectory) { + continue + } + val report = makeReport(file) + val output = File(outputRoot, file.nameWithoutExtension + ".htm") + output.writeText(report) + println("Report generated: ${output.absolutePath}") + } + } + + private fun makeReport(file: File): String { + val serializer: Serializer = Persister() + val testSuite = serializer.read(TestSuite::class.java, file) + val templateText = javaClass.classLoader.getResourceAsStream("report.html")?.use { + it.bufferedReader().readText() + } + + val results = LinkedHashMap>() + val tests = LinkedHashSet() + for (case in testSuite.testCases) { + tests.add(case.testName) + val map = results.getOrPut(case.source) { LinkedHashMap() } + val oldValue = map.put(case.testName, case) + check(oldValue == null) + } + + val failPercent = (testSuite.failures.toDouble() / testSuite.tests * 100.0).roundToInt() + val errorPercent = (testSuite.errors.toDouble() / testSuite.tests * 100.0).roundToInt() + return runBlocking { + val template = Template(requireNotNull(templateText)) + template( + mapOf( + "testSuite" to testSuite, + "tests" to tests, + "results" to results, + "success_percent" to 100 - (failPercent + errorPercent), + "error_percent" to errorPercent, + "fail_percent" to failPercent, + "success" to testSuite.tests - (testSuite.failures + testSuite.errors), + ), + ) + } + } +} diff --git a/buildSrc/src/main/kotlin/tasks/model/Failure.kt b/buildSrc/src/main/kotlin/tasks/model/Failure.kt new file mode 100644 index 00000000..aa2ab3f9 --- /dev/null +++ b/buildSrc/src/main/kotlin/tasks/model/Failure.kt @@ -0,0 +1,24 @@ +package tasks.model + +import org.simpleframework.xml.Attribute +import org.simpleframework.xml.Root +import org.simpleframework.xml.Text + +@Root(name = "failure", strict = false) +class Failure { + @JvmField + @field:Attribute(name = "message") + var message: String = "" + + @JvmField + @field:Attribute(name = "type") + var type: String = "" + + @JvmField + @field:Text + var text: String = "" + + fun textHtml(): String { + return text.replace("\n", "
") + } +} \ No newline at end of file diff --git a/buildSrc/src/main/kotlin/tasks/model/TestCase.kt b/buildSrc/src/main/kotlin/tasks/model/TestCase.kt new file mode 100644 index 00000000..3ac54c36 --- /dev/null +++ b/buildSrc/src/main/kotlin/tasks/model/TestCase.kt @@ -0,0 +1,32 @@ +package tasks.model + +import org.simpleframework.xml.Attribute +import org.simpleframework.xml.Element +import org.simpleframework.xml.Root + +@Root(name = "testcase", strict = false) +class TestCase { + @JvmField + @field:Attribute(name = "name") + var name: String = "" + + @JvmField + @field:Attribute(name = "time") + var time: Float = 0f + + @JvmField + @field:Element(name = "failure", required = false) + var failure: Failure? = null + + val index by lazy { + name.split('|')[0].toInt() + } + + val testName by lazy { + name.split('|')[1] + } + + val source by lazy { + name.split('|')[2] + } +} \ No newline at end of file diff --git a/buildSrc/src/main/kotlin/tasks/model/TestSuite.kt b/buildSrc/src/main/kotlin/tasks/model/TestSuite.kt new file mode 100644 index 00000000..09cc6efc --- /dev/null +++ b/buildSrc/src/main/kotlin/tasks/model/TestSuite.kt @@ -0,0 +1,27 @@ +package tasks.model + +import org.simpleframework.xml.Attribute +import org.simpleframework.xml.ElementList +import org.simpleframework.xml.Root + +@Root(name = "testsuite", strict = false) +class TestSuite { + @JvmField + @field:Attribute(name = "name") + var name: String = "" + + @JvmField + @field:Attribute(name = "tests") + var tests: Int = 0 + + @JvmField + @field:Attribute(name = "failures") + var failures: Int = 0 + + @JvmField + @field:Attribute(name = "errors") + var errors: Int = 0 + + @field:ElementList(entry = "testcase", inline = true) + lateinit var testCases: List +} \ No newline at end of file diff --git a/buildSrc/src/main/resources/report.html b/buildSrc/src/main/resources/report.html new file mode 100644 index 00000000..0a6c8dbf --- /dev/null +++ b/buildSrc/src/main/resources/report.html @@ -0,0 +1,91 @@ + + + + + + {{ testSuite.name }} + + + + + +
+

{{ testSuite.name }}

+
+
+ {{ success }} ({{ success_percent }}%) +
+
+ {{ testSuite.failures }} ({{ fail_percent }}%) +
+
+ {{ testSuite.errors }} ({{ error_percent }}%) +
+
+
+ + + + + {% for test in tests %} + + {% endfor %} + + + {% for name, cases in results %} + + + {% for test in tests %} + {% set case = cases[test] %} + {% if case.failure == null %} + + {% else %} + {% if case.failure.type == 'java.lang.AssertionError' %} + + {% else %} + + {% endif %} + + + {% endif %} + {% endfor %} + + {% endfor %} +
Source{{ test }}
{{ name }} + + + + + +
+
+
+ + + \ No newline at end of file diff --git a/src/test/kotlin/org/koitharu/kotatsu/parsers/MangaParserTest.kt b/src/test/kotlin/org/koitharu/kotatsu/parsers/MangaParserTest.kt index 52200929..f062d890 100644 --- a/src/test/kotlin/org/koitharu/kotatsu/parsers/MangaParserTest.kt +++ b/src/test/kotlin/org/koitharu/kotatsu/parsers/MangaParserTest.kt @@ -15,12 +15,13 @@ import org.koitharu.kotatsu.test_util.isDistinctBy import org.koitharu.kotatsu.test_util.isUrlAbsolute import org.koitharu.kotatsu.test_util.maxDuplicates + @ExtendWith(AuthCheckExtension::class) internal class MangaParserTest { private val context = MangaLoaderContextMock() - @ParameterizedTest + @ParameterizedTest(name = "{index}|list|{0}") @MangaSources fun list(source: MangaSource) = runTest { val parser = source.newParser(context) @@ -29,7 +30,7 @@ internal class MangaParserTest { assert(list.all { it.source == source }) } - @ParameterizedTest + @ParameterizedTest(name = "{index}|search|{0}") @MangaSources fun search(source: MangaSource) = runTest { val parser = source.newParser(context) @@ -46,7 +47,7 @@ internal class MangaParserTest { assert(list.all { it.source == source }) } - @ParameterizedTest + @ParameterizedTest(name = "{index}|tags|{0}") @MangaSources fun tags(source: MangaSource) = runTest { val parser = source.newParser(context) @@ -66,7 +67,7 @@ internal class MangaParserTest { assert(list.all { it.source == source }) } - @ParameterizedTest + @ParameterizedTest(name = "{index}|details|{0}") @MangaSources fun details(source: MangaSource) = runTest { val parser = source.newParser(context) @@ -95,7 +96,7 @@ internal class MangaParserTest { } } - @ParameterizedTest + @ParameterizedTest(name = "{index}|pages|{0}") @MangaSources fun pages(source: MangaSource) = runTest { val parser = source.newParser(context) @@ -115,7 +116,7 @@ internal class MangaParserTest { checkImageRequest(pageUrl, page.referer) } - @ParameterizedTest + @ParameterizedTest(name = "{index}|favicon|{0}") @MangaSources fun favicon(source: MangaSource) = runTest { val parser = source.newParser(context) @@ -124,7 +125,7 @@ internal class MangaParserTest { checkImageRequest(faviconUrl, null) } - @ParameterizedTest + @ParameterizedTest(name = "{index}|domain|{0}") @MangaSources fun domain(source: MangaSource) = runTest { val parser = source.newParser(context) @@ -142,7 +143,7 @@ internal class MangaParserTest { } } - @ParameterizedTest + @ParameterizedTest(name = "{index}|authorization|{0}") @MangaSources @Disabled fun authorization(source: MangaSource) = runTest { diff --git a/src/test/resources/junit-platform.properties b/src/test/resources/junit-platform.properties new file mode 100644 index 00000000..82de190b --- /dev/null +++ b/src/test/resources/junit-platform.properties @@ -0,0 +1,2 @@ +junit.jupiter.execution.parallel.enabled = true +junit.jupiter.execution.parallel.mode.default = concurrent \ No newline at end of file