diff --git a/commonmark-android-test/.gitignore b/commonmark-android-test/.gitignore new file mode 100644 index 000000000..b738a69b4 --- /dev/null +++ b/commonmark-android-test/.gitignore @@ -0,0 +1,5 @@ +.gradle +local.properties +test.properties +gradle.properties +build diff --git a/commonmark-android-test/README.md b/commonmark-android-test/README.md new file mode 100644 index 000000000..eb65c6f67 --- /dev/null +++ b/commonmark-android-test/README.md @@ -0,0 +1,95 @@ +commonmark-android-test +======================= + +This module ensures that commonmark-java is supported on Android + +Requirements: + +* Java 7 or above +* Android SDK 15 +* Running emulator or connected android device + +Configuration +----- + +1. Download Android SDK +2. Be sure that SDK Platform 15 and emulator for this platform (system image) are installed. It's recommended to use x86 +3. Export to PATH: `path_to_android_sdk/platform-tools` and `path_to_android_sdk/tools` +4. Create 2 properties files in commonmark-android-test + +/local.properties +```properties +sdk.dir=/path_to_android_sdk +``` + +/test.properties +```properties +# Absolute or relative (./ == /app) path to test reports. +path.report=../report + +# Version number of commonmark and extensions in maven central. +version.maven=0.4.0 + +# Version number of commonmark and extensions in project. +version.snapshot=0.4.1-SNAPSHOT +# Version number of autolink for snapshots (since it's not contained in extension jar). +version.snapshot_autolink=0.3.0 +``` + +If you're going to test on device with Android 15 then you can skip downloading emulator. + +Usage +----- + +#### Run test with MAVEN version + +on Mac/Linux: +```shell +./gradlew :app:connectedMavenDebugAndroidTest +``` + +on Windows: +```bat +.\gradlew :app:connectedMavenDebugAndroidTest +``` + +#### Run test with SNAPSHOT version + +Before running tests you need to run `maven install` + +on Mac/Linux: +```shell +./gradlew :app:connectedSnapshotDebugAndroidTest +``` + +on Windows: +```bat +.\gradlew :app:connectedSnapshotDebugAndroidTest +``` + + +#### Testing in CI + +on Mac/Linux: +```shell +echo no | android create avd --force -n test -t "android-15" +emulator -avd test & +adb wait-for-device +./gradlew :app:clean :app:connectedSnapshotDebugAndroidTest +adb emu kill +``` + +on Windows: +```bat +echo no | android create avd --force -n test -t "android-15" +start emulator -avd test +adb wait-for-device +gradlew :app:clean :app:connectedSnapshotDebugAndroidTest & adb emu kill +``` + +There could be problems with command `adb wait-for-device` which could be resolved by adding additional pause before running test. + +Links +----- +[Gradle Documentations](https://docs.gradle.org/current/userguide/userguide.html) +[Android Gradle Plugin Docs](http://tools.android.com/tech-docs/new-build-system) diff --git a/commonmark-android-test/app/build.gradle b/commonmark-android-test/app/build.gradle new file mode 100644 index 000000000..1ca49f9be --- /dev/null +++ b/commonmark-android-test/app/build.gradle @@ -0,0 +1,74 @@ +apply plugin: 'com.android.application' + +def testProperties +def testPropertiesFile = file('../test.properties') +if (testPropertiesFile.canRead()) { + testProperties = new Properties() + testPropertiesFile.withInputStream { + stream -> testProperties.load(stream) + } +} + +android { + compileSdkVersion 15 + buildToolsVersion "23.0.2" + + defaultConfig { + applicationId "com.atlassian.commonmark.android.test" + minSdkVersion 15 + targetSdkVersion 15 + versionCode 1 + versionName "1.0" + + testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" + } + + productFlavors { + maven + snapshot + } + + compileOptions { + sourceCompatibility JavaVersion.VERSION_1_7 + targetCompatibility JavaVersion.VERSION_1_7 + } + + packagingOptions { + exclude 'META-INF/LICENSE' + exclude 'META-INF/LICENSE.txt' + exclude 'META-INF/NOTICE' + exclude 'META-INF/NOTICE.txt' + } + + testOptions { + resultsDir = testProperties['path.report'] + } +} + +repositories { + flatDir { + dirs '../../commonmark/target', + '../../commonmark-ext-autolink/target', + '../../commonmark-ext-gfm-strikethrough/target', + '../../commonmark-ext-gfm-tables/target', + '../../commonmark-test-util/target' + } +} + +dependencies { + androidTestCompile 'com.android.support.test:runner:0.4.1' + androidTestCompile 'com.android.support.test:rules:0.4.1' + + androidTestCompile ':commonmark-test-util-' + testProperties['version.snapshot'] + + androidTestMavenCompile 'com.atlassian.commonmark:commonmark:' + testProperties['version.maven'] + androidTestMavenCompile 'com.atlassian.commonmark:commonmark-ext-autolink:' + testProperties['version.maven'] + androidTestMavenCompile 'com.atlassian.commonmark:commonmark-ext-gfm-strikethrough:' + testProperties['version.maven'] + androidTestMavenCompile 'com.atlassian.commonmark:commonmark-ext-gfm-tables:' + testProperties['version.maven'] + + androidTestSnapshotCompile 'org.nibor.autolink:autolink:' + testProperties['version.snapshot_autolink'] + androidTestSnapshotCompile ':commonmark-' + testProperties['version.snapshot'] + androidTestSnapshotCompile ':commonmark-ext-autolink-' + testProperties['version.snapshot'] + androidTestSnapshotCompile ':commonmark-ext-gfm-strikethrough-' + testProperties['version.snapshot'] + androidTestSnapshotCompile ':commonmark-ext-gfm-tables-' + testProperties['version.snapshot'] +} diff --git a/commonmark-android-test/app/src/androidTest/java/com/atlassian/commonmark/android/test/AndroidSupportTest.java b/commonmark-android-test/app/src/androidTest/java/com/atlassian/commonmark/android/test/AndroidSupportTest.java new file mode 100644 index 000000000..0308cf549 --- /dev/null +++ b/commonmark-android-test/app/src/androidTest/java/com/atlassian/commonmark/android/test/AndroidSupportTest.java @@ -0,0 +1,76 @@ +package com.atlassian.commonmark.android.test; + +import org.commonmark.Extension; +import org.commonmark.ext.autolink.AutolinkExtension; +import org.commonmark.ext.gfm.strikethrough.StrikethroughExtension; +import org.commonmark.ext.gfm.tables.TablesExtension; +import org.commonmark.html.HtmlRenderer; +import org.commonmark.node.Node; +import org.commonmark.parser.Parser; +import org.commonmark.spec.SpecReader; +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; + +import android.support.test.runner.AndroidJUnit4; +import android.test.suitebuilder.annotation.SmallTest; + +import java.util.Collections; + +import static org.junit.Assert.assertNotNull; + +@RunWith(AndroidJUnit4.class) +@SmallTest +public class AndroidSupportTest { + + private String spec; + + @Before + public void setUp() throws Exception { + spec = SpecReader.readSpec(); + } + + @Test + public void parseTest() throws Exception { + Parser parser = new Parser.Builder().build(); + + Node document = parser.parse(spec); + + assertNotNull(document); + } + + @Test + public void autolinkExtensionTest() throws Exception { + parseWithExtensionsTest(AutolinkExtension.create()); + } + + @Test + public void strikethroughExtensionTest() throws Exception { + parseWithExtensionsTest(StrikethroughExtension.create()); + } + + @Test + public void tablesExtensionTest() throws Exception { + parseWithExtensionsTest(TablesExtension.create()); + } + + @Test + public void htmlRendererTest() throws Exception { + Parser parser = new Parser.Builder().build(); + HtmlRenderer renderer = new HtmlRenderer.Builder().build(); + + String renderedString = renderer.render(parser.parse(spec)); + + assertNotNull(renderedString); + } + + private void parseWithExtensionsTest(Extension extension) throws Exception { + Parser parser = new Parser.Builder() + .extensions(Collections.singletonList(extension)) + .build(); + + Node document = parser.parse(spec); + + assertNotNull(document); + } +} diff --git a/commonmark-android-test/app/src/main/AndroidManifest.xml b/commonmark-android-test/app/src/main/AndroidManifest.xml new file mode 100644 index 000000000..de2cd5725 --- /dev/null +++ b/commonmark-android-test/app/src/main/AndroidManifest.xml @@ -0,0 +1,3 @@ + + + diff --git a/commonmark-android-test/build.gradle b/commonmark-android-test/build.gradle new file mode 100644 index 000000000..027fee4d9 --- /dev/null +++ b/commonmark-android-test/build.gradle @@ -0,0 +1,18 @@ +buildscript { + repositories { + jcenter() + } + dependencies { + classpath 'com.android.tools.build:gradle:1.5.0' + } +} + +allprojects { + repositories { + jcenter() + } +} + +task clean(type: Delete) { + delete rootProject.buildDir +} diff --git a/commonmark-android-test/gradle/wrapper/gradle-wrapper.jar b/commonmark-android-test/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 000000000..8c0fb64a8 Binary files /dev/null and b/commonmark-android-test/gradle/wrapper/gradle-wrapper.jar differ diff --git a/commonmark-android-test/gradle/wrapper/gradle-wrapper.properties b/commonmark-android-test/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 000000000..122a0dca2 --- /dev/null +++ b/commonmark-android-test/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Mon Dec 28 10:00:20 PST 2015 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-2.10-all.zip diff --git a/commonmark-android-test/gradlew b/commonmark-android-test/gradlew new file mode 100755 index 000000000..9d82f7891 --- /dev/null +++ b/commonmark-android-test/gradlew @@ -0,0 +1,160 @@ +#!/usr/bin/env bash + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# 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 +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; +esac + +# 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 + +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" ] ; 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 + +# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules +function splitJvmOpts() { + JVM_OPTS=("$@") +} +eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS +JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" + +exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" diff --git a/commonmark-android-test/gradlew.bat b/commonmark-android-test/gradlew.bat new file mode 100644 index 000000000..8a0b282aa --- /dev/null +++ b/commonmark-android-test/gradlew.bat @@ -0,0 +1,90 @@ +@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 + +@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= + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@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 Windowz variants + +if not "%OS%" == "Windows_NT" goto win9xME_args +if "%@eval[2+2]" == "4" goto 4NT_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=%* +goto execute + +:4NT_args +@rem Get arguments from the 4NT Shell from JP Software +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/commonmark-android-test/settings.gradle b/commonmark-android-test/settings.gradle new file mode 100644 index 000000000..e7b4def49 --- /dev/null +++ b/commonmark-android-test/settings.gradle @@ -0,0 +1 @@ +include ':app' diff --git a/commonmark-test-util/src/main/java/org/commonmark/spec/SpecReader.java b/commonmark-test-util/src/main/java/org/commonmark/spec/SpecReader.java index 551d8618a..77a2ead4e 100644 --- a/commonmark-test-util/src/main/java/org/commonmark/spec/SpecReader.java +++ b/commonmark-test-util/src/main/java/org/commonmark/spec/SpecReader.java @@ -4,7 +4,7 @@ import java.io.IOException; import java.io.InputStream; import java.io.InputStreamReader; -import java.nio.charset.StandardCharsets; +import java.nio.charset.Charset; import java.util.ArrayList; import java.util.List; import java.util.regex.Matcher; @@ -47,7 +47,7 @@ public static List readExamplesAsString() { public static String readSpec() { StringBuilder sb = new StringBuilder(); - try (BufferedReader reader = new BufferedReader(new InputStreamReader(getSpecInputStream(), StandardCharsets.UTF_8))) { + try (BufferedReader reader = new BufferedReader(new InputStreamReader(getSpecInputStream(), Charset.forName("UTF-8")))) { String line; while ((line = reader.readLine()) != null) { sb.append(line); @@ -71,7 +71,7 @@ private List read() throws IOException { resetContents(); try (BufferedReader reader = new BufferedReader( - new InputStreamReader(inputStream, StandardCharsets.UTF_8))) { + new InputStreamReader(inputStream, Charset.forName("UTF-8")))) { String line; while ((line = reader.readLine()) != null) { processLine(line);