Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mauriciotogneri/green-coffee
Green Coffee
https://github.com/mauriciotogneri/green-coffee
Last synced: 3 months ago
JSON representation
Green Coffee
- Host: GitHub
- URL: https://github.com/mauriciotogneri/green-coffee
- Owner: mauriciotogneri
- License: mit
- Created: 2016-08-22T11:52:37.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-02-15T21:14:24.000Z (over 3 years ago)
- Last Synced: 2024-04-25T22:34:45.900Z (6 months ago)
- Language: Java
- Homepage:
- Size: 317 KB
- Stars: 230
- Watchers: 10
- Forks: 24
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-android - Green Coffee - Run your Cucumber tests in your Android instrumentation tests. (Libraries / Testing)
- awesome-android-libraries - green-coffee
- awesome-android - Green Coffee - Run your Cucumber tests in your Android instrumentation tests. (Libraries / Testing)
README
[](https://github.com/mauriciotogneri/green-coffee/blob/master/LICENSE.md)
[](https://android-arsenal.com/details/1/4313)
# Green Coffee
**Green Coffee** is a library that allows you to run your acceptance tests written in Gherkin in your Android instrumentation tests using the step definitions that you declare. Visit the [wiki](https://github.com/mauriciotogneri/green-coffee/wiki) for more detailed information.
## Example
Given the following feature:
```gherkin
Feature: Login screen to authenticate users
Scenario: Invalid username and password
Given I see an empty login form
When I introduce an invalid username
And I introduce an invalid password
And I press the login button
Then I see an error message saying 'Invalid credentials'
```
First, create a class that extends from `GreenCoffeeTest` and declare the Activity, the feature and the step definitions that will be used:
```java
@RunWith(Parameterized.class)
public class LoginFeatureTest extends GreenCoffeeTest
{
@Rule
public ActivityTestRule activity = new ActivityTestRule<>(LoginActivity.class);
public LoginFeatureTest(ScenarioConfig scenarioConfig)
{
super(scenarioConfig);
}
@Parameters(name = "{0}")
public static Iterable scenarios() throws IOException
{
return new GreenCoffeeConfig()
.withFeatureFromAssets("assets/login.feature")
.takeScreenshotOnFail()
.scenarios(
new Locale("en", "GB"),
new Locale("es", "ES")
); // the locales used to run the scenarios (optional)
}
@Test
public void test()
{
start(new LoginSteps());
}
}
```
Next, create a class containing the steps definitions:
```java
public class LoginSteps extends GreenCoffeeSteps
{
@Given("^I see an empty login form$")
public void iSeeAnEmptyLoginForm()
{
onViewWithId(R.id.login_input_username).isEmpty();
onViewWithId(R.id.login_input_password).isEmpty();
}
@When("^I introduce an invalid username$")
public void iIntroduceAnInvalidUsername()
{
onViewWithId(R.id.login_input_username).type("guest");
}
@When("^I introduce an invalid password$")
public void iIntroduceAnInvalidPassword()
{
onViewWithId(R.id.login_input_password).type("1234");
}
@When("^I press the login button$")
public void iPressTheLoginButton()
{
onViewWithId(R.id.login_button_doLogin).click();
}
@Then("^I see an error message saying 'Invalid credentials'$")
public void iSeeAnErrorMessageSayingInvalidCredentials()
{
onViewWithText(R.string.login_credentials_error).isDisplayed();
}
}
```
And that's it, now you can create your own tests using Green Coffee. This is how it looks when you run a more complex test:
You can see an example applied to a full app [here](https://github.com/vndly/green-coffee-example).
## Installation
Add the following code to your root `build.gradle`:
```groovy
allprojects
{
repositories
{
maven
{
url 'https://jitpack.io'
}
}
}
```
Add the following code to your module `build.gradle` file:
```groovy
dependencies
{
androidTestImplementation 'androidx.test:runner:1.3.0'
androidTestImplementation 'androidx.test:rules:1.3.0'
androidTestImplementation 'com.github.mauriciotogneri:green-coffee:3.6.0'
}
```
And the following test instrumentation runner:
```groovy
defaultConfig
{
testInstrumentationRunner 'androidx.test.runner.AndroidJUnitRunner'
}
```