Skip to content

Commit

Permalink
Naming improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
grzesiek2010 committed Feb 11, 2025
1 parent fb1e555 commit 334017f
Show file tree
Hide file tree
Showing 7 changed files with 44 additions and 44 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,8 @@
import org.odk.collect.metadata.InstallIDProvider;
import org.odk.collect.metadata.PropertyManager;
import org.odk.collect.metadata.SettingsInstallIDProvider;
import org.odk.collect.mobiledevicemanagement.ManagedConfigManager;
import org.odk.collect.mobiledevicemanagement.ManagedConfigSaver;
import org.odk.collect.mobiledevicemanagement.MDMConfigObserver;
import org.odk.collect.mobiledevicemanagement.MDMConfigHandler;
import org.odk.collect.permissions.ContextCompatPermissionChecker;
import org.odk.collect.permissions.PermissionsChecker;
import org.odk.collect.permissions.PermissionsProvider;
Expand Down Expand Up @@ -626,7 +626,7 @@ public FormLoaderTask.FormEntryControllerFactory formEntryControllerFactory(Proj
}

@Provides
public ManagedConfigManager providesManagedConfigManager(
public MDMConfigObserver providesManagedConfigManager(
SettingsProvider settingsProvider,
ProjectsRepository projectsRepository,
ProjectCreator projectCreator,
Expand All @@ -638,16 +638,16 @@ public ManagedConfigManager providesManagedConfigManager(
settingsProvider
);

ManagedConfigSaver managedConfigSaver = new ManagedConfigSaver(
MDMConfigHandler mdmConfigHandler = new MDMConfigHandler(
settingsProvider,
projectsRepository,
projectCreator,
settingsImporter,
settingsConnectionMatcher
);

return new ManagedConfigManager(
managedConfigSaver,
return new MDMConfigObserver(
mdmConfigHandler,
(RestrictionsManager) context.getSystemService(Context.RESTRICTIONS_SERVICE),
context
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import org.odk.collect.android.projects.ProjectSettingsDialog
import org.odk.collect.android.utilities.ThemeUtils
import org.odk.collect.androidshared.ui.FragmentFactoryBuilder
import org.odk.collect.crashhandler.CrashHandler
import org.odk.collect.mobiledevicemanagement.ManagedConfigManager
import org.odk.collect.mobiledevicemanagement.MDMConfigObserver
import org.odk.collect.permissions.PermissionsProvider
import org.odk.collect.settings.SettingsProvider
import org.odk.collect.strings.localization.LocalizedActivity
Expand All @@ -31,7 +31,7 @@ class MainMenuActivity : LocalizedActivity() {
lateinit var permissionsProvider: PermissionsProvider

@Inject
lateinit var managedConfigManager: ManagedConfigManager
lateinit var mdmConfigObserver: MDMConfigObserver

private lateinit var currentProjectViewModel: CurrentProjectViewModel

Expand Down Expand Up @@ -85,7 +85,7 @@ class MainMenuActivity : LocalizedActivity() {

super.onCreate(savedInstanceState)
setContentView(R.layout.main_menu_activity)
lifecycle.addObserver(managedConfigManager)
lifecycle.addObserver(mdmConfigObserver)
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ import org.odk.collect.android.version.VersionInformation
import org.odk.collect.androidtest.ActivityScenarioLauncherRule
import org.odk.collect.async.Scheduler
import org.odk.collect.crashhandler.CrashHandler
import org.odk.collect.mobiledevicemanagement.ManagedConfigManager
import org.odk.collect.mobiledevicemanagement.MDMConfigObserver
import org.odk.collect.permissions.PermissionsChecker
import org.odk.collect.permissions.PermissionsProvider
import org.odk.collect.projects.Project
Expand Down Expand Up @@ -133,8 +133,8 @@ class MainMenuActivityTest {
projectCreator: ProjectCreator,
settingsImporter: ODKAppSettingsImporter,
context: Context
): ManagedConfigManager {
return mock<ManagedConfigManager>()
): MDMConfigObserver {
return mock<MDMConfigObserver>()
}
})

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import org.odk.collect.settings.ODKAppSettingsImporter
import org.odk.collect.settings.SettingsProvider
import org.odk.collect.settings.keys.MetaKeys.KEY_INSTALL_ID

class ManagedConfigSaver(
class MDMConfigHandler(
private val settingsProvider: SettingsProvider,
private val projectsRepository: ProjectsRepository,
private val projectCreator: ProjectCreator,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,21 @@ import androidx.lifecycle.LifecycleOwner
*
* See android.content.APP_RESTRICTIONS in AndroidManifest for supported configuration keys.
*/
class ManagedConfigManager(
private val managedConfigSaver: ManagedConfigSaver,
class MDMConfigObserver(
private val mdmConfigHandler: MDMConfigHandler,
private val restrictionsManager: RestrictionsManager,
private val context: Context
) : DefaultLifecycleObserver {

private val restrictionsReceiver = object : BroadcastReceiver() {
override fun onReceive(context: Context, intent: Intent) {
managedConfigSaver.applyConfig(restrictionsManager.applicationRestrictions)
mdmConfigHandler.applyConfig(restrictionsManager.applicationRestrictions)
}
}

override fun onResume(owner: LifecycleOwner) {
super.onResume(owner)
managedConfigSaver.applyConfig(restrictionsManager.applicationRestrictions)
mdmConfigHandler.applyConfig(restrictionsManager.applicationRestrictions)

val restrictionsFilter = IntentFilter(Intent.ACTION_APPLICATION_RESTRICTIONS_CHANGED)
context.registerReceiver(restrictionsReceiver, restrictionsFilter)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ import org.mockito.kotlin.mock
import org.mockito.kotlin.verify
import org.mockito.kotlin.verifyNoInteractions
import org.mockito.kotlin.whenever
import org.odk.collect.mobiledevicemanagement.ManagedConfigSaver.Companion.DEVICE_ID_KEY
import org.odk.collect.mobiledevicemanagement.ManagedConfigSaver.Companion.SETTINGS_JSON_KEY
import org.odk.collect.mobiledevicemanagement.MDMConfigHandler.Companion.DEVICE_ID_KEY
import org.odk.collect.mobiledevicemanagement.MDMConfigHandler.Companion.SETTINGS_JSON_KEY
import org.odk.collect.projects.InMemProjectsRepository
import org.odk.collect.projects.Project
import org.odk.collect.projects.ProjectCreator
Expand All @@ -24,13 +24,13 @@ import org.odk.collect.settings.SettingsProvider
import org.odk.collect.settings.keys.MetaKeys.KEY_INSTALL_ID

@RunWith(AndroidJUnit4::class)
class ManagedConfigSaverTest {
class MDMConfigHandlerTest {
private lateinit var settingsProvider: SettingsProvider
private lateinit var projectsRepository: ProjectsRepository
private lateinit var projectCreator: ProjectCreator
private lateinit var settingsImporter: ODKAppSettingsImporter
private lateinit var settingsConnectionMatcher: SettingsConnectionMatcher
private lateinit var managedConfigSaver: ManagedConfigSaver
private lateinit var mdmConfigHandler: MDMConfigHandler

@Before
fun setup() {
Expand All @@ -40,7 +40,7 @@ class ManagedConfigSaverTest {
settingsImporter = mock<ODKAppSettingsImporter>()
settingsConnectionMatcher = mock<SettingsConnectionMatcher>()

managedConfigSaver = ManagedConfigSaver(
mdmConfigHandler = MDMConfigHandler(
settingsProvider,
projectsRepository,
projectCreator,
Expand All @@ -56,7 +56,7 @@ class ManagedConfigSaverTest {
val managedConfig = Bundle().apply {
putString(DEVICE_ID_KEY, null)
}
managedConfigSaver.applyConfig(managedConfig)
mdmConfigHandler.applyConfig(managedConfig)

assertThat(settingsProvider.getMetaSettings().getString(KEY_INSTALL_ID), equalTo("foo"))
}
Expand All @@ -68,7 +68,7 @@ class ManagedConfigSaverTest {
val managedConfig = Bundle().apply {
putString(DEVICE_ID_KEY, "")
}
managedConfigSaver.applyConfig(managedConfig)
mdmConfigHandler.applyConfig(managedConfig)

assertThat(settingsProvider.getMetaSettings().getString(KEY_INSTALL_ID), equalTo("foo"))
}
Expand All @@ -80,7 +80,7 @@ class ManagedConfigSaverTest {
val managedConfig = Bundle().apply {
putString(DEVICE_ID_KEY, " ")
}
managedConfigSaver.applyConfig(managedConfig)
mdmConfigHandler.applyConfig(managedConfig)

assertThat(settingsProvider.getMetaSettings().getString(KEY_INSTALL_ID), equalTo("foo"))
}
Expand All @@ -92,7 +92,7 @@ class ManagedConfigSaverTest {
val managedConfig = Bundle().apply {
putString(DEVICE_ID_KEY, "bar")
}
managedConfigSaver.applyConfig(managedConfig)
mdmConfigHandler.applyConfig(managedConfig)

assertThat(settingsProvider.getMetaSettings().getString(KEY_INSTALL_ID), equalTo("bar"))
}
Expand All @@ -102,7 +102,7 @@ class ManagedConfigSaverTest {
val managedConfig = Bundle().apply {
putString(SETTINGS_JSON_KEY, null)
}
managedConfigSaver.applyConfig(managedConfig)
mdmConfigHandler.applyConfig(managedConfig)

verifyNoInteractions(projectCreator)
verifyNoInteractions(settingsImporter)
Expand All @@ -113,7 +113,7 @@ class ManagedConfigSaverTest {
val managedConfig = Bundle().apply {
putString(SETTINGS_JSON_KEY, "")
}
managedConfigSaver.applyConfig(managedConfig)
mdmConfigHandler.applyConfig(managedConfig)

verifyNoInteractions(projectCreator)
verifyNoInteractions(settingsImporter)
Expand All @@ -124,7 +124,7 @@ class ManagedConfigSaverTest {
val managedConfig = Bundle().apply {
putString(SETTINGS_JSON_KEY, " ")
}
managedConfigSaver.applyConfig(managedConfig)
mdmConfigHandler.applyConfig(managedConfig)

verifyNoInteractions(projectCreator)
verifyNoInteractions(settingsImporter)
Expand All @@ -138,7 +138,7 @@ class ManagedConfigSaverTest {
}
whenever(settingsConnectionMatcher.getProjectWithMatchingConnection(settingsJson)).thenReturn(null)

managedConfigSaver.applyConfig(managedConfig)
mdmConfigHandler.applyConfig(managedConfig)

verify(projectCreator).createNewProject(settingsJson)
}
Expand All @@ -154,7 +154,7 @@ class ManagedConfigSaverTest {
}
whenever(settingsConnectionMatcher.getProjectWithMatchingConnection(settingsJson)).thenReturn("1")

managedConfigSaver.applyConfig(managedConfig)
mdmConfigHandler.applyConfig(managedConfig)

verifyNoInteractions(projectCreator)
verify(settingsImporter).fromJSON(settingsJson, project)
Expand All @@ -165,7 +165,7 @@ class ManagedConfigSaverTest {
val managedConfig = Bundle().apply {
putString("foo", "bar")
}
managedConfigSaver.applyConfig(managedConfig)
mdmConfigHandler.applyConfig(managedConfig)

assertThat(settingsProvider.getMetaSettings().contains("foo"), equalTo(false))
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,23 @@ import org.mockito.kotlin.whenever
import org.robolectric.Shadows.shadowOf

@RunWith(AndroidJUnit4::class)
class ManagedConfigManagerTest {
private lateinit var managedConfigSaver: ManagedConfigSaver
class MDMConfigObserverTest {
private lateinit var mdmConfigHandler: MDMConfigHandler
private lateinit var restrictionsManager: RestrictionsManager
private lateinit var context: Context
private lateinit var lifecycleOwner: LifecycleOwner
private lateinit var managedConfigManager: ManagedConfigManager
private lateinit var mdmConfigObserver: MDMConfigObserver
private lateinit var managedConfig: Bundle

@Before
fun setup() {
managedConfigSaver = mock<ManagedConfigSaver>()
mdmConfigHandler = mock<MDMConfigHandler>()
restrictionsManager = mock<RestrictionsManager>()
context = ApplicationProvider.getApplicationContext()
lifecycleOwner = mock<LifecycleOwner>()
managedConfig = Bundle()

managedConfigManager = ManagedConfigManager(managedConfigSaver, restrictionsManager, context)
mdmConfigObserver = MDMConfigObserver(mdmConfigHandler, restrictionsManager, context)

whenever(restrictionsManager.applicationRestrictions).thenReturn(managedConfig)
}
Expand All @@ -47,7 +47,7 @@ class ManagedConfigManagerTest {
it.intentFilter.hasAction(Intent.ACTION_APPLICATION_RESTRICTIONS_CHANGED)
})

managedConfigManager.onResume(lifecycleOwner)
mdmConfigObserver.onResume(lifecycleOwner)

assert(shadowApp.registeredReceivers.any {
it.intentFilter.hasAction(Intent.ACTION_APPLICATION_RESTRICTIONS_CHANGED)
Expand All @@ -56,8 +56,8 @@ class ManagedConfigManagerTest {

@Test
fun `broadcast receiver is unregistered in #onPause`() {
managedConfigManager.onResume(lifecycleOwner)
managedConfigManager.onPause(lifecycleOwner)
mdmConfigObserver.onResume(lifecycleOwner)
mdmConfigObserver.onPause(lifecycleOwner)

val shadowApp = shadowOf(context as Application)

Expand All @@ -68,20 +68,20 @@ class ManagedConfigManagerTest {

@Test
fun `#onResume triggers ManagedConfigSaver#applyConfig`() {
managedConfigManager.onResume(lifecycleOwner)
mdmConfigObserver.onResume(lifecycleOwner)

verify(managedConfigSaver, times(1)).applyConfig(managedConfig)
verify(mdmConfigHandler, times(1)).applyConfig(managedConfig)
}

@Test
fun `broadcast receiver triggers ManagedConfigSaver#applyConfig`() {
managedConfigManager.onResume(lifecycleOwner)
mdmConfigObserver.onResume(lifecycleOwner)

val intent = Intent(Intent.ACTION_APPLICATION_RESTRICTIONS_CHANGED)
context.sendBroadcast(intent)

shadowOf(context.mainLooper).idle()

verify(managedConfigSaver, times(2)).applyConfig(managedConfig)
verify(mdmConfigHandler, times(2)).applyConfig(managedConfig)
}
}

0 comments on commit 334017f

Please sign in to comment.