komputing/trulesk

Android test-rules for kotlin

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.ligi:trulesk:4.3'
	}
	dependencies {
		implementation("com.github.ligi:trulesk:4.3")
	}
	<dependency>
	    <groupId>com.github.ligi</groupId>
	    <artifactId>trulesk</artifactId>
	    <version>4.3</version>
	</dependency>

                            
    libraryDependencies += "com.github.ligi" % "trulesk" % "4.3"
        
        

                            
    :dependencies [[com.github.ligi/trulesk "4.3"]]

Readme

TRulesK

Test Rules Kotlin

Why?

I had some code that was the same over several Android Apps of mine - this library is created to DRY this out and provide some test-rules with common functionality.

These are test-rules that do the following:

  • Install a SpooningFailureHandler ( Making screenshots with falcon-spoon - so you easily see in the report when the test failed because of some system dialog)
  • Set the FLAG_TURN_SCREEN_ON or FLAG_DISMISS_KEYGUARD
  • Provide screenshot facade as extension function ( I was switching from native spoon to falcon-spoon once - with this extension function there is a single place to change the implementation )
  • Delete TraceDroid stacktrace files
  • Base for custom Runner which lets you replace the Application class easily
  • Activate and Deactivate TestButtler ( And verify animations are disabled )

These functions come from one ActivityTestRule and one IntentTestRule

Example

A very simple usage:

class TheHelpActivity {

    @get:Rule
    val rule = TruleskActivityRule(HelpActivity::class.java)

    @Test
    fun test_version_is_shown() {
        onView(withText("v" + BuildConfig.VERSION_NAME)).check(matches(isDisplayed()))
        
        rule.screenShot("help")
    }
}

Find more in PassAndroid and GobanDroid

Where?

get it via jitpack:

Release

License

MIT License