Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jaredsburrows/gradle-spoon-plugin
Gradle plugin that provides a task to run Android instrumentation tests via Spoon.
https://github.com/jaredsburrows/gradle-spoon-plugin
Last synced: 7 days ago
JSON representation
Gradle plugin that provides a task to run Android instrumentation tests via Spoon.
- Host: GitHub
- URL: https://github.com/jaredsburrows/gradle-spoon-plugin
- Owner: jaredsburrows
- License: apache-2.0
- Created: 2017-11-02T20:28:26.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T11:42:27.000Z (6 months ago)
- Last Synced: 2024-05-01T21:37:53.896Z (6 months ago)
- Language: Groovy
- Homepage: https://search.maven.org/artifact/com.jaredsburrows/gradle-spoon-plugin
- Size: 553 KB
- Stars: 124
- Watchers: 10
- Forks: 29
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-android-testing - spoon-gradle-plugin (Gradle plugin 3.x)
README
# Gradle Spoon Plugin
[](https://www.apache.org/licenses/LICENSE-2.0)
[](https://search.maven.org/artifact/com.jaredsburrows/gradle-spoon-plugin)
[](https://plugins.gradle.org/plugin/com.jaredsburrows.spoon)
[](https://github.com/jaredsburrows/gradle-spoon-plugin/actions/workflows/build.yml)
[](https://twitter.com/jaredsburrows)
Gradle plugin for [Spoon](https://github.com/square/spoon) 2+ and [Android Gradle Plugin](https://developer.android.com/studio/releases/gradle-plugin.html) 3+.
## Download
**Release:**
```groovy
buildscript {
repositories {
mavenCentral()
// For Spoon snapshot, until 2.0.0 is released
maven { url 'https://oss.sonatype.org/content/repositories/snapshots' }
}
dependencies {
classpath 'com.jaredsburrows:gradle-spoon-plugin:1.6.2'
}
}
repositories {
// For Spoon snapshot, until 2.0.0 is released
maven { url 'https://oss.sonatype.org/content/repositories/snapshots' }
}
apply plugin: 'com.android.application'
apply plugin: 'com.jaredsburrows.spoon'
dependencies {
// For Spoon snapshot, until 2.0.0 is released
androidTestCompile 'com.squareup.spoon:spoon-client:2.0.0-SNAPSHOT'
}
```
Release versions are available in the [Sonatype's release repository](https://repo1.maven.org/maven2/com/jaredsburrows/gradle-spoon-plugin/).
**Snapshot:**
```groovy
buildscript {
repositories {
maven { url 'https://oss.jfrog.org/artifactory/oss-snapshot-local/' }
// For Spoon snapshot, until 2.0.0 is released
maven { url 'https://oss.sonatype.org/content/repositories/snapshots' }
}
dependencies {
classpath 'com.jaredsburrows:gradle-spoon-plugin:1.6.3-SNAPSHOT'
}
}
repositories {
// For Spoon snapshot, until 2.0.0 is released
maven { url 'https://oss.sonatype.org/content/repositories/snapshots' }
}
apply plugin: 'com.android.application'
apply plugin: 'com.jaredsburrows.spoon'
dependencies {
// For Spoon snapshot, until 2.0.0 is released
androidTestCompile 'com.squareup.spoon:spoon-client:2.0.0-SNAPSHOT'
}
```
Snapshot versions are available in the [Sonatype's snapshots repository](https://oss.sonatype.org/content/repositories/snapshots/com/jaredsburrows/gradle-spoon-plugin/).
**Library modules:**
This plugin allows Spoon to be run on library modules too!
```groovy
apply plugin: 'com.android.library'
apply plugin: 'com.jaredsburrows.spoon'
dependencies {
// For Spoon snapshot, until 2.0.0 is released
androidTestCompile 'com.squareup.spoon:spoon-client:2.0.0-SNAPSHOT'
}
```
## Tasks
Entire project:
- **`gradlew spoon{variant}`**
or per module:
- **`gradlew app:spoon{variant}`**
- **`gradlew library:spoon{variant}`**
## Usage
**Optional extension:**
```groovy
spoon {
// Identifying title for this execution. ("Spoon Execution" by default)
title = "My tests"
// Path to output directory. ("$buildDir/spoon-output" by default)
baseOutputDir = "spoonTests"
// Whether or not debug logging is enabled. (false by default)
debug = true
// Whether or not animations are enabled. Disable animated gif generation. (false by default)
noAnimations = true
// Set ADB timeout. (minutes) (default is 10 mins)
adbTimeout = 5
// Add device serials for test execution
devices = ["emulator-5554", "emulator-5556"]
// Add device serials for skipping test execution.
skipDevices = ["emulator-5555"]
// Extra arguments to pass to instrumentation.
instrumentationArgs = ["listener:com.foo.Listener,com.foo.Listener2", "classLoader:com.foo.CustomClassLoader"]
// Test class name to run (fully-qualified).
className = "com.android.foo.FooClassName"
// Run annotated tests - small, medium, large
testSize = "large"
// Allow no devices to be connected. (false by default)
allowNoDevices = true
// Execute the tests device by device. (false by default)
sequential = true
// Grant all runtime permissions during installation on Marshmallow and above devices. (false by default)
grantAll = true
// Test method name to run (must also use className)
methodName = "testMethodName"
// Code coverage flag. For Spoon to calculate coverage file your app must have the `WRITE_EXTERNAL_STORAGE` permission. (false by default)
codeCoverage = true
// Toggle sharding. (false by default)
shard = true
// The number of separate shards to create.
numShards = 10
// The shardIndex option to specify which shard to run.
shardIndex = 2
// Run tests in separate instrumentation calls.
singleInstrumentationCall = true
// Do not fail build if a test fails, let all the tests run and finish. (false by default)
ignoreFailures = true
// Clear app data before each test. (false by default)
clearAppDataBeforeEachTest = true
}
```
## License
```
Copyright (C) 2017 Jared Burrows
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.
```