Nested publication validator project to test actual dependencies on kotlinx.coroutines
diff --git a/binary-compatibility-validator/resources/api.properties b/binary-compatibility-validator/resources/api.properties
index e459861..690989a 100644
--- a/binary-compatibility-validator/resources/api.properties
+++ b/binary-compatibility-validator/resources/api.properties
@@ -4,6 +4,6 @@
module.roots=/ integration reactive ui
module.marker=build.gradle
-module.ignore=kotlinx-coroutines-rx-example stdlib-stubs benchmarks knit binary-compatibility-validator site
+module.ignore=kotlinx-coroutines-rx-example stdlib-stubs benchmarks knit binary-compatibility-validator site publication-validator
packages.internal=kotlinx.coroutines.internal
\ No newline at end of file
diff --git a/publication-validator/README.md b/publication-validator/README.md
new file mode 100644
index 0000000..7437513
--- /dev/null
+++ b/publication-validator/README.md
@@ -0,0 +1,9 @@
+# Publication validator
+
+This is a supplementary subproject of kotlinx.coroutines to test its publication correctness.
+
+It is used as part of "Dependency validation" build chain on TeamCity:
+* kotlinx.corotoutines are built with `publishToMavenLocal`
+* kotlinx.coroutines are built with `npmPublish -PdryRun=true` to have a packed publication
+* `NpmPublicationValidator` tests that version of NPM artifact is correct and that it has neither source nor package dependencies on atomicfu
+* `MavenPublicationValidator` depends on the published artifacts and tests artifacts binary content and absence of atomicfu in the classpath
diff --git a/publication-validator/build.gradle b/publication-validator/build.gradle
new file mode 100644
index 0000000..cc19ae4
--- /dev/null
+++ b/publication-validator/build.gradle
@@ -0,0 +1,35 @@
+/*
+ * Copyright 2016-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+plugins {
+ id 'org.jetbrains.kotlin.jvm' version '1.3.30'
+}
+
+def deployVersion = properties['DeployVersion']
+ext.coroutines_version = deployVersion
+println "Checking coroutines version $coroutines_version"
+
+group 'org.jetbrains.kotlinx'
+version '1.0-SNAPSHOT'
+
+repositories {
+ mavenLocal()
+ mavenCentral()
+}
+
+dependencies {
+ implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8"
+ testCompile 'junit:junit:4.12'
+ testCompile 'org.apache.commons:commons-compress:1.18'
+ testCompile 'com.google.code.gson:gson:2.8.5'
+ testCompile "org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutines_version"
+ testCompile "org.jetbrains.kotlinx:kotlinx-coroutines-android:$coroutines_version"
+}
+
+compileKotlin {
+ kotlinOptions.jvmTarget = "1.8"
+}
+compileTestKotlin {
+ kotlinOptions.jvmTarget = "1.8"
+}
diff --git a/publication-validator/gradle.properties b/publication-validator/gradle.properties
new file mode 100644
index 0000000..29e08e8
--- /dev/null
+++ b/publication-validator/gradle.properties
@@ -0,0 +1 @@
+kotlin.code.style=official
\ No newline at end of file
diff --git a/publication-validator/gradle/wrapper/gradle-wrapper.jar b/publication-validator/gradle/wrapper/gradle-wrapper.jar
new file mode 100644
index 0000000..94336fc
--- /dev/null
+++ b/publication-validator/gradle/wrapper/gradle-wrapper.jar
Binary files differ
diff --git a/publication-validator/gradle/wrapper/gradle-wrapper.properties b/publication-validator/gradle/wrapper/gradle-wrapper.properties
new file mode 100644
index 0000000..ecc6986
--- /dev/null
+++ b/publication-validator/gradle/wrapper/gradle-wrapper.properties
@@ -0,0 +1,6 @@
+#Wed May 08 12:45:59 MSK 2019
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.3-all.zip
diff --git a/publication-validator/gradlew b/publication-validator/gradlew
new file mode 100755
index 0000000..cccdd3d
--- /dev/null
+++ b/publication-validator/gradlew
@@ -0,0 +1,172 @@
+#!/usr/bin/env sh
+
+##############################################################################
+##
+## Gradle start up script for UN*X
+##
+##############################################################################
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+ ls=`ls -ld "$PRG"`
+ link=`expr "$ls" : '.*-> \(.*\)$'`
+ if expr "$link" : '/.*' > /dev/null; then
+ PRG="$link"
+ else
+ PRG=`dirname "$PRG"`"/$link"
+ fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
+
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$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=""
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn () {
+ echo "$*"
+}
+
+die () {
+ echo
+ echo "$*"
+ echo
+ exit 1
+}
+
+# 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
+ ;;
+ 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" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
+ MAX_FD_LIMIT=`ulimit -H -n`
+ if [ $? -eq 0 ] ; then
+ if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+ MAX_FD="$MAX_FD_LIMIT"
+ fi
+ ulimit -n $MAX_FD
+ if [ $? -ne 0 ] ; then
+ warn "Could not set maximum file descriptor limit: $MAX_FD"
+ fi
+ else
+ warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+ fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+ GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin, switch paths to Windows format before running java
+if $cygwin ; then
+ APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+ CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+ JAVACMD=`cygpath --unix "$JAVACMD"`
+
+ # We build the pattern for arguments to be converted via cygpath
+ ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+ SEP=""
+ for dir in $ROOTDIRSRAW ; do
+ ROOTDIRS="$ROOTDIRS$SEP$dir"
+ SEP="|"
+ done
+ OURCYGPATTERN="(^($ROOTDIRS))"
+ # Add a user-defined pattern to the cygpath arguments
+ if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+ OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+ fi
+ # Now convert the arguments - kludge to limit ourselves to /bin/sh
+ i=0
+ for arg in "$@" ; do
+ CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+ CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
+
+ if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
+ eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+ else
+ eval `echo args$i`="\"$arg\""
+ fi
+ i=$((i+1))
+ done
+ case $i in
+ (0) set -- ;;
+ (1) set -- "$args0" ;;
+ (2) set -- "$args0" "$args1" ;;
+ (3) set -- "$args0" "$args1" "$args2" ;;
+ (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+ (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+ (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+ (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+ (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+ (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+ esac
+fi
+
+# Escape application args
+save () {
+ for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+ echo " "
+}
+APP_ARGS=$(save "$@")
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
+if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
+ cd "$(dirname "$0")"
+fi
+
+exec "$JAVACMD" "$@"
diff --git a/publication-validator/gradlew.bat b/publication-validator/gradlew.bat
new file mode 100644
index 0000000..f955316
--- /dev/null
+++ b/publication-validator/gradlew.bat
@@ -0,0 +1,84 @@
+@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 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=
+
+@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 init
+
+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 init
+
+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
+
+:init
+@rem Get command-line arguments, handling Windows variants
+
+if not "%OS%" == "Windows_NT" goto win9xME_args
+
+:win9xME_args
+@rem Slurp the command line arguments.
+set CMD_LINE_ARGS=
+set _SKIP=2
+
+:win9xME_args_slurp
+if "x%~1" == "x" goto execute
+
+set CMD_LINE_ARGS=%*
+
+: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 %CMD_LINE_ARGS%
+
+: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/publication-validator/settings.gradle b/publication-validator/settings.gradle
new file mode 100644
index 0000000..5520306
--- /dev/null
+++ b/publication-validator/settings.gradle
@@ -0,0 +1,8 @@
+pluginManagement {
+ repositories {
+ mavenLocal()
+ mavenCentral()
+ maven { url 'https://plugins.gradle.org/m2/' }
+ }
+}
+rootProject.name = 'kotlinx-coroutines-validator'
diff --git a/publication-validator/src/test/kotlin/kotlinx/coroutines/tools/MavenPublicationValidator.kt b/publication-validator/src/test/kotlin/kotlinx/coroutines/tools/MavenPublicationValidator.kt
new file mode 100644
index 0000000..b7f97f0
--- /dev/null
+++ b/publication-validator/src/test/kotlin/kotlinx/coroutines/tools/MavenPublicationValidator.kt
@@ -0,0 +1,53 @@
+/*
+ * Copyright 2016-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package kotlinx.coroutines.validator
+
+import org.junit.*
+import org.junit.Assert.*
+import java.io.*
+import java.util.jar.*
+
+class MavenPublicationValidator {
+ private val ATOMIC_FU_REF = "Lkotlinx/atomicfu/".toByteArray()
+
+ @Test
+ fun testNoAtomicfuInClasspath() {
+ val result = runCatching { Class.forName("kotlinx.atomicfu.AtomicInt") }
+ assertTrue(result.exceptionOrNull() is ClassNotFoundException)
+ }
+
+ @Test
+ fun testNoAtomicfuInMppJar() {
+ val clazz = Class.forName("kotlinx.coroutines.Job")
+ JarFile(clazz.protectionDomain.codeSource.location.file).checkForAtomicFu()
+ }
+
+ @Test
+ fun testNoAtomicfuInAndroidJar() {
+ val clazz = Class.forName("kotlinx.coroutines.android.HandlerDispatcher")
+ JarFile(clazz.protectionDomain.codeSource.location.file).checkForAtomicFu()
+ }
+
+ private fun JarFile.checkForAtomicFu() {
+ val foundClasses = mutableListOf<String>()
+ for (e in entries()) {
+ if (!e.name.endsWith(".class")) continue
+ val bytes = getInputStream(e).use { it.readBytes() }
+ loop@for (i in 0 until bytes.size - ATOMIC_FU_REF.size) {
+ for (j in 0 until ATOMIC_FU_REF.size) {
+ if (bytes[i + j] != ATOMIC_FU_REF[j]) continue@loop
+ }
+ foundClasses += e.name // report error at the end with all class names
+ break@loop
+ }
+ }
+ if (foundClasses.isNotEmpty()) {
+ error("Found references to atomicfu in jar file $name in the following class files: ${
+ foundClasses.joinToString("") { "\n\t\t" + it }
+ }")
+ }
+ close()
+ }
+}
diff --git a/publication-validator/src/test/kotlin/kotlinx/coroutines/tools/NpmPublicationValidator.kt b/publication-validator/src/test/kotlin/kotlinx/coroutines/tools/NpmPublicationValidator.kt
new file mode 100644
index 0000000..2c2351f
--- /dev/null
+++ b/publication-validator/src/test/kotlin/kotlinx/coroutines/tools/NpmPublicationValidator.kt
@@ -0,0 +1,71 @@
+/*
+ * Copyright 2016-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package kotlinx.coroutines.validator
+
+import com.google.gson.*
+import org.apache.commons.compress.archivers.tar.*
+import org.junit.*
+import org.junit.Assert.*
+import java.io.*
+import java.util.zip.*
+
+class NpmPublicationValidator {
+ private val VERSION = System.getenv("DeployVersion")
+ private val BUILD_DIR = System.getenv("teamcity.build.checkoutDir")
+ private val NPM_ARTIFACT = "$BUILD_DIR/kotlinx-coroutines-core/build/npm/kotlinx-coroutines-core-$VERSION.tgz"
+
+ @Test
+ fun testPackageJson() {
+ println("Checking dependencies of $NPM_ARTIFACT")
+ val visited = visit("package.json") {
+ val json = JsonParser().parse(content()).asJsonObject
+ assertEquals(VERSION, json["version"].asString)
+ assertNull(json["dependencies"])
+ val peerDependencies = json["peerDependencies"].asJsonObject
+ assertEquals(1, peerDependencies.size())
+ assertNotNull(peerDependencies["kotlin"])
+ }
+ assertEquals(1, visited)
+ }
+
+ @Test
+ fun testAtomicfuDependencies() {
+ println("Checking contents of $NPM_ARTIFACT")
+ val visited = visit(".js") {
+ val content = content()
+ assertFalse(content, content.contains("atomicfu", true))
+ assertFalse(content, content.contains("atomicint", true))
+ assertFalse(content, content.contains("atomicboolean", true))
+ }
+ assertEquals(2, visited)
+ }
+
+ private fun InputStream.content(): String {
+ val bais = ByteArrayOutputStream()
+ val buffer = ByteArray(DEFAULT_BUFFER_SIZE)
+ var read = read(buffer, 0, DEFAULT_BUFFER_SIZE)
+ while (read >= 0) {
+ bais.write(buffer, 0, read)
+ read = read(buffer, 0, DEFAULT_BUFFER_SIZE)
+ }
+ return bais.toString()
+ }
+
+ private inline fun visit(fileSuffix: String, block: InputStream.(entry: TarArchiveEntry) -> Unit): Int {
+ var visited = 0
+ TarArchiveInputStream(GZIPInputStream(FileInputStream(NPM_ARTIFACT))).use { tais ->
+ var entry: TarArchiveEntry? = tais.nextTarEntry ?: return 0
+ do {
+ if (entry!!.name.endsWith(fileSuffix)) {
+ ++visited
+ tais.block(entry)
+ }
+ entry = tais.nextTarEntry
+ } while (entry != null)
+
+ return visited
+ }
+ }
+}