https://github.com/saeedmasoumi/mock-location-automator

Allow to mock locations during Android instrumentation tests.
https://github.com/saeedmasoumi/mock-location-automator

android kotlin location location-tracking test

Last synced: 3 months ago
JSON representation

Allow to mock locations during Android instrumentation tests.

• Host: GitHub
• URL: https://github.com/saeedmasoumi/mock-location-automator
• Owner: SaeedMasoumi
• License: apache-2.0
• Created: 2019-08-31T17:39:56.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-09-09T18:31:50.000Z (about 6 years ago)
• Last Synced: 2025-04-05T10:51:10.844Z (6 months ago)
• Topics: android, kotlin, location, location-tracking, test
• Language: Kotlin
• Homepage:
• Size: 1.07 MB
• Stars: 13
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Mock Location Automator

[![codecov](https://codecov.io/gh/SaeedMasoumi/mock-location-automator/branch/master/graph/badge.svg)](https://codecov.io/gh/SaeedMasoumi/mock-location-automator)

[![Download](https://api.bintray.com/packages/smasoumi/maven/mock-location-automator/images/download.svg)](https://bintray.com/smasoumi/maven/mock-location-automator/_latestVersion)

Enabling mock locations for [LocationManager](https://developer.android.com/reference/kotlin/android/location/LocationManager) and [FusedLocationProvider](https://developers.google.com/location-context/fused-location-provider/) before running any Android instrumentation tests.

It providers a Junit-rule to grant needed permissions by executing adb commands and setting mock mode enabled for different location providers.

![Demo](video.gif)

## Download

```groovy

dependencies {

    androidTestImplementation 'io.saeid.automator:mock-location-automator:1.0.0'

}

```

## Example

```kotlin

@RunWith(AndroidJUnit4::class)

@LargeTest

class YourScenarioTest {

    @get:Rule

    val mockLocationRule = MockLocationRule()

    

    @Test

    fun test_scenario_x() {

        // ...

        mockLocation(latitude, longitude)

        // ...

    }

}

```

## Usage

### Apply MockLocationRule

In order to use this library, you must add `MockLocationRule` into your test class.

This rule do the following steps:

1. Add test apk to `Settings > Developer Options > Select Mock location app`, So all mock locations can be applied from test classes.

2. Grant `android.permission.ACCESS_FINE_LOCATION` and `android.permission.ACCESS_COARSE_LOCATION` to avoid any permission errors.

### Mock a single point

You can mock a location by calling `mockLocation` method. To avoid jumping back to the real position, It will preserve it periodically.

 

 If you don't want this behaviour, you can simply disable preserving mode:

  

```kotlin

mockLocation(latitude = 12.45, longitude = 56.78, preserve = false)

```

### Mock multiple points

You can also mock multiple locations by passing a list of `DelayedLocation`. It will mock each location after a deplay which specified in the `DelayedLocation`.

Here is an example:

```kotlin

mockLocations(

    listOf(

        DelayedLocation(location1, 1000),

        DelayedLocation(location2, 2000),

        DelayedLocation(location3, 3000)

   )

)

```

So after the execution of this method, `location1` will be applied after 1 second, then 3 seconds (1+2) later `locations2` will be applied and so on.