-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add MockSynchronizationSettings to fix duplicate DataStore file acces…
…s in tests
- Loading branch information
Showing
8 changed files
with
166 additions
and
121 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
27 changes: 27 additions & 0 deletions
27
datacapturing/src/androidTest/kotlin/de/cyface/datacapturing/MockSynchronizationSettings.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| package de.cyface.datacapturing | ||
|
|
||
| import de.cyface.synchronization.settings.SynchronizationSettings | ||
| import kotlinx.coroutines.flow.Flow | ||
| import kotlinx.coroutines.flow.MutableStateFlow | ||
| import kotlinx.coroutines.flow.asStateFlow | ||
| import org.json.JSONObject | ||
|
|
||
| class MockSynchronizationSettings : SynchronizationSettings { | ||
|
|
||
| private var _collectorUrl = MutableStateFlow("https://TEST_URL/") | ||
| private var _oAuthConfig = MutableStateFlow(JSONObject().put("discovery_uri", "https://TEST_URL/").toString()) | ||
|
|
||
| override suspend fun setCollectorUrl(value: String) { | ||
| _collectorUrl.value = value | ||
| } | ||
|
|
||
| override val collectorUrlFlow: Flow<String> | ||
| get() = _collectorUrl.asStateFlow() | ||
|
|
||
| override suspend fun setOAuthConfiguration(value: String) { | ||
| _oAuthConfig.value = value | ||
| } | ||
|
|
||
| override val oAuthConfigurationFlow: Flow<String> | ||
| get() = _oAuthConfig.asStateFlow() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
122 changes: 122 additions & 0 deletions
122
...tion/src/main/kotlin/de/cyface/synchronization/settings/DefaultSynchronizationSettings.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| /* | ||
| * Copyright 2023 Cyface GmbH | ||
| * | ||
| * This file is part of the Cyface SDK for Android. | ||
| * | ||
| * The Cyface SDK for Android is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * The Cyface SDK for Android is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with the Cyface SDK for Android. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
| package de.cyface.synchronization.settings | ||
|
|
||
| import android.content.Context | ||
| import androidx.datastore.core.DataStore | ||
| import androidx.datastore.core.MultiProcessDataStoreFactory | ||
| import de.cyface.persistence.SetupException | ||
| import de.cyface.synchronization.Settings | ||
| import kotlinx.coroutines.flow.Flow | ||
| import kotlinx.coroutines.flow.map | ||
| import org.json.JSONObject | ||
| import java.io.File | ||
|
|
||
| /** | ||
| * Settings used by this library. | ||
| * | ||
| * @author Armin Schnabel | ||
| * @version 2.0.0 | ||
| * @since 7.8.1 | ||
| */ | ||
| class DefaultSynchronizationSettings(context: Context, collectorUrl: String, oAuthConfig: JSONObject) : SynchronizationSettings { | ||
|
|
||
| /** | ||
| * This avoids leaking the context when this object outlives the Activity of Fragment. | ||
| */ | ||
| private val appContext = context.applicationContext | ||
|
|
||
| /** | ||
| * The data store with multi-process support. | ||
| * | ||
| * The reason for multi-process support is that some settings are accessed by a background | ||
| * service which runs in another process. | ||
| * | ||
| * Attention: | ||
| * - Never mix SingleProcessDataStore with MultiProcessDataStore for the same file. | ||
| * - We use MultiProcessDataStore, i.e. the preferences can be accessed from multiple processes. | ||
| * - Only create one instance of `DataStore` per file in the same process. | ||
| * - We use ProtoBuf to ensure type safety. Rebuild after changing the .proto file. | ||
| */ | ||
| private val dataStore: DataStore<Settings> = MultiProcessDataStoreFactory.create( | ||
| serializer = SettingsSerializer, | ||
| produceFile = { | ||
| // With cacheDir the settings are lost on app restart [RFR-799] | ||
| File("${appContext.filesDir.path}/synchronization.pb") | ||
| }, | ||
| migrations = listOf( | ||
| PreferencesMigrationFactory.create(appContext, collectorUrl, oAuthConfig), | ||
| StoreMigration(collectorUrl, oAuthConfig) | ||
| ) | ||
| ) | ||
|
|
||
| init { | ||
| if (!collectorUrl.startsWith("https://") && !collectorUrl.startsWith("http://")) { | ||
| throw SetupException("Invalid URL protocol") | ||
| } | ||
| if (!oAuthConfig.getString("discovery_uri") | ||
| .startsWith("https://") && !oAuthConfig.getString("discovery_uri") | ||
| .startsWith("http://") | ||
| ) { | ||
| throw SetupException("Invalid URL protocol") | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Sets the URL of the server to upload data to. | ||
| * | ||
| * @param value The URL to save. | ||
| */ | ||
| override suspend fun setCollectorUrl(value: String) { | ||
| dataStore.updateData { currentSettings -> | ||
| currentSettings.toBuilder() | ||
| .setCollectorUrl(value) | ||
| .build() | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @return The URL of the server to upload data to. | ||
| */ | ||
| override val collectorUrlFlow: Flow<String> = dataStore.data | ||
| .map { settings -> | ||
| settings.collectorUrl | ||
| } | ||
|
|
||
| /** | ||
| * Sets the OAuth configuration JsonObject as String. | ||
| * | ||
| * @param value The configuration to save. | ||
| */ | ||
| override suspend fun setOAuthConfiguration(value: String) { | ||
| dataStore.updateData { currentSettings -> | ||
| currentSettings.toBuilder() | ||
| .setOAuthConfiguration(value) | ||
| .build() | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @return The OAuth configuration JsonObject as String. | ||
| */ | ||
| override val oAuthConfigurationFlow: Flow<String> = dataStore.data | ||
| .map { settings -> | ||
| settings.oAuthConfiguration | ||
| } | ||
| } |
106 changes: 7 additions & 99 deletions
106
...hronization/src/main/kotlin/de/cyface/synchronization/settings/SynchronizationSettings.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,122 +1,30 @@ | ||
| /* | ||
| * Copyright 2023 Cyface GmbH | ||
| * | ||
| * This file is part of the Cyface SDK for Android. | ||
| * | ||
| * The Cyface SDK for Android is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * The Cyface SDK for Android is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with the Cyface SDK for Android. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
| package de.cyface.synchronization.settings | ||
|
|
||
| import android.content.Context | ||
| import androidx.datastore.core.DataStore | ||
| import androidx.datastore.core.MultiProcessDataStoreFactory | ||
| import de.cyface.persistence.SetupException | ||
| import de.cyface.synchronization.Settings | ||
| import kotlinx.coroutines.flow.Flow | ||
| import kotlinx.coroutines.flow.map | ||
| import org.json.JSONObject | ||
| import java.io.File | ||
|
|
||
| /** | ||
| * Settings used by this library. | ||
| * | ||
| * @author Armin Schnabel | ||
| * @version 2.0.0 | ||
| * @since 7.8.1 | ||
| */ | ||
| class SynchronizationSettings(context: Context, collectorUrl: String, oAuthConfig: JSONObject) { | ||
|
|
||
| /** | ||
| * This avoids leaking the context when this object outlives the Activity of Fragment. | ||
| */ | ||
| private val appContext = context.applicationContext | ||
|
|
||
| /** | ||
| * The data store with multi-process support. | ||
| * | ||
| * The reason for multi-process support is that some settings are accessed by a background | ||
| * service which runs in another process. | ||
| * | ||
| * Attention: | ||
| * - Never mix SingleProcessDataStore with MultiProcessDataStore for the same file. | ||
| * - We use MultiProcessDataStore, i.e. the preferences can be accessed from multiple processes. | ||
| * - Only create one instance of `DataStore` per file in the same process. | ||
| * - We use ProtoBuf to ensure type safety. Rebuild after changing the .proto file. | ||
| */ | ||
| private val dataStore: DataStore<Settings> = MultiProcessDataStoreFactory.create( | ||
| serializer = SettingsSerializer, | ||
| produceFile = { | ||
| // With cacheDir the settings are lost on app restart [RFR-799] | ||
| File("${appContext.filesDir.path}/synchronization.pb") | ||
| }, | ||
| migrations = listOf( | ||
| PreferencesMigrationFactory.create(appContext, collectorUrl, oAuthConfig), | ||
| StoreMigration(collectorUrl, oAuthConfig) | ||
| ) | ||
| ) | ||
|
|
||
| init { | ||
| if (!collectorUrl.startsWith("https://") && !collectorUrl.startsWith("http://")) { | ||
| throw SetupException("Invalid URL protocol") | ||
| } | ||
| if (!oAuthConfig.getString("discovery_uri") | ||
| .startsWith("https://") && !oAuthConfig.getString("discovery_uri") | ||
| .startsWith("http://") | ||
| ) { | ||
| throw SetupException("Invalid URL protocol") | ||
| } | ||
| } | ||
| interface SynchronizationSettings { | ||
|
|
||
| /** | ||
| * Sets the URL of the server to upload data to. | ||
| * | ||
| * @param value The URL to save. | ||
| */ | ||
| suspend fun setCollectorUrl(value: String) { | ||
| dataStore.updateData { currentSettings -> | ||
| currentSettings.toBuilder() | ||
| .setCollectorUrl(value) | ||
| .build() | ||
| } | ||
| } | ||
| suspend fun setCollectorUrl(value: String) | ||
|
|
||
| /** | ||
| * @return The URL of the server to upload data to. | ||
| * @return The URL of the server to upload data to as a Kotlin Flow. | ||
| */ | ||
| val collectorUrlFlow: Flow<String> = dataStore.data | ||
| .map { settings -> | ||
| settings.collectorUrl | ||
| } | ||
| val collectorUrlFlow: Flow<String> | ||
|
|
||
| /** | ||
| * Sets the OAuth configuration JsonObject as String. | ||
| * | ||
| * @param value The configuration to save. | ||
| */ | ||
| suspend fun setOAuthConfiguration(value: String) { | ||
| dataStore.updateData { currentSettings -> | ||
| currentSettings.toBuilder() | ||
| .setOAuthConfiguration(value) | ||
| .build() | ||
| } | ||
| } | ||
| suspend fun setOAuthConfiguration(value: String) | ||
|
|
||
| /** | ||
| * @return The OAuth configuration JsonObject as String. | ||
| * @return The OAuth configuration JsonObject as String as a Kotlin Flow. | ||
| */ | ||
| val oAuthConfigurationFlow: Flow<String> = dataStore.data | ||
| .map { settings -> | ||
| settings.oAuthConfiguration | ||
| } | ||
| val oAuthConfigurationFlow: Flow<String> | ||
| } |