diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..f04f136 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,4 @@ +[*.{kt,kts}] +indent_size=4 +max_line_length=off +disabled_rules=import-ordering, no-wildcard-imports diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bfaed50 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +*.iml +.gradle +/local.properties +/.idea/* +.DS_Store +/build +.externalNativeBuild +.cxx +github_credentials.properties diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..cfc7a56 --- /dev/null +++ b/Makefile @@ -0,0 +1,29 @@ +clean: + ./gradlew clean + +lint: + ./gradlew ktlint + +run-lint-rules: + ./gradlew ktlintFormat + +unit-test: + ./gradlew sample:test --parallel + +instrumentation-test: clean disable-animations + ./gradlew connectedAndroidTest + +disable-animations: + adb shell settings put global window_animation_scale 0 + adb shell settings put global transition_animation_scale 0 + adb shell settings put global animator_duration_scale 0 + +enable-animations: + adb shell settings put global window_animation_scale 1 + adb shell settings put global transition_animation_scale 1 + adb shell settings put global animator_duration_scale 1 + +publish-test-lib-prod: clean + ./gradlew build publish --stacktrace + +run-all-sanitycheck-steps: lint unit-test instrumentation-test diff --git a/README.md b/README.md index 407a533..fced5a0 100644 --- a/README.md +++ b/README.md @@ -1 +1,45 @@ -# Nat-Test-Commons \ No newline at end of file +# Nat Test Commons Android + +### What for +Library with helper classes designed to speed up the test-creating process. + +### Setup +Copy and paste the file **github_credentials.properties.sample** and rename it to **github_credentials.properties**. Updating the fields **github.username** and **github.password**. For getting your GitHub password see the [Tutorial](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). Its important to check **read:packages** and when generating you password. + +**Important:** The file **github_credentials.properties** can not be commited. + +### Sample +In construction + +## How to contribute + +You can contribute submitting [pull requests](https://github.com/natura-cosmeticos/Nat-Test-Commons/pulls). + +### How to create a new version +In the file **publish.gradle** update field in the method **getVersionName** with the new version number. Example, for the version 1.0.1: + + def getVersionName = { -> + return "1.0.1" + } + +## How to use +Copy and paste the file **github_credentials.properties.sample** and rename it to **github_credentials.properties**. Updating the fields **github.username** and **github.password**. For getting your GitHub password see the [Tutorial](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). Its important to check **read:packages** when generating you password. +In the file build.gradle, insert the informations: + + repositories { + maven { + name = "nat-test-commons" + url = uri("https://maven.pkg.github.com/natura-cosmeticos/Nat-Test-Commons") + credentials { + username = githubProperties['github.username'] ?: System.getenv("GITHUB_USERNAME") + password = githubProperties['github.password'] ?: System.getenv("GITHUB_API_KEY") + } + } + } + +And: + + dependencies { + androidTestImplementation "com.natura.android:test-commons:" + testImplementation "com.natura.android:test-commons:" + } diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..b6f90fd --- /dev/null +++ b/build.gradle @@ -0,0 +1,63 @@ +// Top-level build file where you can add configuration options common to all sub-projects/modules. + +buildscript { + ext.kotlin_version = '1.3.72' + ext.android_tools_gradle = '3.5.1' + + repositories { + google() + jcenter() + + } + dependencies { + classpath "com.android.tools.build:gradle:$android_tools_gradle" + classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" + classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" + classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1' + } +} + +allprojects { + repositories { + google() + jcenter() + + def githubProperties = new Properties() + githubProperties.load(new FileInputStream(rootProject.file("github_credentials.properties"))) + maven { + name = "natds-android" + url = uri("https://maven.pkg.github.com/natura-cosmeticos/natds-android") + credentials { + username = githubProperties['github.username'] + password = githubProperties['github.password'] + } + } + } +} + +task clean(type: Delete) { + delete rootProject.buildDir +} + +ext { + // Sdk and tools + minSdkVersion = 21 + targetSdkVersion = 29 + compileSdkVersion = 29 + buildToolsVersion = '29.0.2' + + // App dependencies + androidXJunitVersion = '1.1.1' + androidXTestVersion = '1.2.0' + archLifecycleVersion = '2.1.0' + constraintLayoutVersion = '1.1.3' + coreKtxVersion = '1.3.0' + designSystemVersion = '0.5.0' + espressoVersion = '3.2.0' + junitExtVersion = '1.1.0' + junitJupiterVersion = '5.3.1' + junitVersion = '4.12' + koinVersion = '2.1.5' + ktlintVersion = '0.35.0' + materialVersion = '1.1.0' +} \ No newline at end of file diff --git a/github_credentials.properties.sample b/github_credentials.properties.sample new file mode 100644 index 0000000..26e7308 --- /dev/null +++ b/github_credentials.properties.sample @@ -0,0 +1,2 @@ +github.username=seunome +github.password=suasenha diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..23339e0 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,21 @@ +# Project-wide Gradle settings. +# IDE (e.g. Android Studio) users: +# Gradle settings configured through the IDE *will override* +# any settings specified in this file. +# For more details on how to configure your build environment visit +# http://www.gradle.org/docs/current/userguide/build_environment.html +# Specifies the JVM arguments used for the daemon process. +# The setting is particularly useful for tweaking memory settings. +org.gradle.jvmargs=-Xmx1536m +# When configured, Gradle will run in incubating parallel mode. +# This option should only be used with decoupled projects. More details, visit +# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects +# org.gradle.parallel=true +# AndroidX package structure to make it clearer which packages are bundled with the +# Android operating system, and which are packaged with your app's APK +# https://developer.android.com/topic/libraries/support-library/androidx-rn +android.useAndroidX=true +# Automatically convert third-party libraries to use AndroidX +android.enableJetifier=true +# Kotlin code style for this project: "official" or "obsolete": +kotlin.code.style=official diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..f6b961f Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..261ea04 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Wed Jun 24 09:21:48 BRT 2020 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.1.1-all.zip diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..cccdd3d --- /dev/null +++ b/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/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..e95643d --- /dev/null +++ b/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/settings.gradle b/settings.gradle new file mode 100644 index 0000000..89037dd --- /dev/null +++ b/settings.gradle @@ -0,0 +1,2 @@ +include ':testcommons' +rootProject.name = 'nat-test-commons-android' diff --git a/testcommons/.gitignore b/testcommons/.gitignore new file mode 100644 index 0000000..567609b --- /dev/null +++ b/testcommons/.gitignore @@ -0,0 +1 @@ +build/ diff --git a/testcommons/build.gradle b/testcommons/build.gradle new file mode 100644 index 0000000..27359d0 --- /dev/null +++ b/testcommons/build.gradle @@ -0,0 +1,75 @@ +apply plugin: 'com.android.library' +apply plugin: 'kotlin-android' +apply from: "$rootDir/tools/publish.gradle" +apply from: "$rootDir/tools/ktlint.gradle" + +android { + compileSdkVersion project.compileSdkVersion + buildToolsVersion project.buildToolsVersion + + defaultConfig { + minSdkVersion project.minSdkVersion + targetSdkVersion project.targetSdkVersion + + testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" + consumerProguardFiles 'consumer-rules.pro' + + multiDexEnabled true + } + + compileOptions { + sourceCompatibility JavaVersion.VERSION_1_8 + targetCompatibility JavaVersion.VERSION_1_8 + } + + kotlinOptions { + jvmTarget = JavaVersion.VERSION_1_8.toString() + } + + testOptions { + execution 'ANDROIDX_TEST_ORCHESTRATOR' + } + + buildTypes { + debug { + testCoverageEnabled true + } + + release { + minifyEnabled false + proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' + } + } + + sourceSets { + main.java.srcDirs += 'src/main/kotlin' + } + + packagingOptions { + exclude 'META-INF/LICENSE*' + exclude 'META-INF/proguard/androidx-annotations.pro' + } +} + +dependencies { + implementation fileTree(dir: 'libs', include: ['*.jar']) + + implementation "androidx.arch.core:core-testing:$rootProject.archLifecycleVersion" + implementation "androidx.core:core-ktx:$rootProject.coreKtxVersion" + implementation "androidx.constraintlayout:constraintlayout:$rootProject.constraintLayoutVersion" + implementation "androidx.test.espresso:espresso-core:$rootProject.espressoVersion" + implementation "androidx.test.espresso:espresso-intents:$rootProject.espressoVersion" + implementation "androidx.test.ext:junit:$rootProject.androidXJunitVersion" + implementation "androidx.test:runner:$rootProject.androidXTestVersion" + implementation "com.google.android.material:material:$rootProject.materialVersion" + implementation "com.natura.android:designsystem:$rootProject.designSystemVersion" + implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" + implementation "org.junit.jupiter:junit-jupiter-api:$rootProject.junitJupiterVersion" + implementation "org.koin:koin-android:$rootProject.koinVersion" +} + +kotlin { + experimental { + coroutines "enable" + } +} diff --git a/testcommons/consumer-rules.pro b/testcommons/consumer-rules.pro new file mode 100644 index 0000000..4c04167 --- /dev/null +++ b/testcommons/consumer-rules.pro @@ -0,0 +1,4 @@ +-keepattributes *Annotation* +-keepattributes SourceFile,LineNumberTable +-keep public class * extends java.lang.Exception +-renamesourcefileattribute SourceFile \ No newline at end of file diff --git a/testcommons/proguard-rules.pro b/testcommons/proguard-rules.pro new file mode 100644 index 0000000..fd28590 --- /dev/null +++ b/testcommons/proguard-rules.pro @@ -0,0 +1,26 @@ +# Add project specific ProGuard rules here. +# You can control the set of applied configuration files using the +# proguardFiles setting in build.gradle. +# +# For more details, see +# http://developer.android.com/guide/developing/tools/proguard.html + +# If your project uses WebView with JS, uncomment the following +# and specify the fully qualified class name to the JavaScript interface +# class: +#-keepclassmembers class fqcn.of.javascript.interface.for.webview { +# public *; +#} + +# Uncomment this to preserve the line number information for +# debugging stack traces. +#-keepattributes SourceFile,LineNumberTable + +# If you keep the line number information, uncomment this to +# hide the original source file name. +#-renamesourcefileattribute SourceFile + +-keepattributes *Annotation* +-keepattributes SourceFile,LineNumberTable +-keep public class * extends java.lang.Exception +-renamesourcefileattribute SourceFile \ No newline at end of file diff --git a/testcommons/src/main/AndroidManifest.xml b/testcommons/src/main/AndroidManifest.xml new file mode 100644 index 0000000..cd0f37c --- /dev/null +++ b/testcommons/src/main/AndroidManifest.xml @@ -0,0 +1,2 @@ + + diff --git a/tools/ktlint.gradle b/tools/ktlint.gradle new file mode 100644 index 0000000..111ae97 --- /dev/null +++ b/tools/ktlint.gradle @@ -0,0 +1,22 @@ +configurations { + ktlint +} + +dependencies { + ktlint "com.pinterest:ktlint:$rootProject.ktlintVersion" +} + +task ktlint(type: JavaExec, group: "verification") { + description = "Check Kotlin code style." + classpath = configurations.ktlint + main = "com.pinterest.ktlint.Main" + args "src/**/*.kt" +} +check.dependsOn ktlint + +task ktlintFormat(type: JavaExec, group: "formatting") { + description = "Fix Kotlin code style deviations." + classpath = configurations.ktlint + main = "com.pinterest.ktlint.Main" + args "-F", "src/**/*.kt" +} diff --git a/tools/publish.gradle b/tools/publish.gradle new file mode 100644 index 0000000..ef1ebc7 --- /dev/null +++ b/tools/publish.gradle @@ -0,0 +1,39 @@ +apply plugin: 'maven-publish' + +def githubProperties = new Properties() +if (file("github_credentials.properties").file) { + githubProperties.load(new FileInputStream(rootProject.file("github_credentials.properties"))) +} + +def getVersionName = { -> + return "1.0.0" +} + +def getGroupId = { -> + return "com.natura.android" +} + +def getArtifactId = { -> + return "test-commons" +} + +publishing { + publications { + bar(MavenPublication) { + groupId getGroupId() + artifactId getArtifactId() + version getVersionName() + artifact("$buildDir/outputs/aar/${getArtifactId()}-release.aar") + } + } + repositories { + maven { + name = "nat-test-commons" + url = uri("https://maven.pkg.github.com/natura-cosmeticos/Nat-Test-Commons") + credentials { + username = githubProperties['github.username'] ?: System.getenv("GITHUB_USERNAME") + password = githubProperties['github.password'] ?: System.getenv("GITHUB_API_KEY") + } + } + } +}