Merge pull request #52 from 05nelsonm/mn/testing/tor-service-integration

Add unit test for stopping Tor

Author: 05nelsonm

topl-service/src/main/java/io/matthewnelson/topl_service/TorServiceController.kt

@@ -75,7 +75,6 @@ import io.matthewnelson.topl_core_base.TorConfigFiles
 import io.matthewnelson.topl_core_base.TorSettings
 import io.matthewnelson.topl_service.service.BaseService
 import io.matthewnelson.topl_service.lifecycle.BackgroundManager
-import io.matthewnelson.topl_service.service.components.binding.BaseServiceConnection
 import io.matthewnelson.topl_service.service.components.actions.ServiceActionProcessor
 import io.matthewnelson.topl_service.service.components.actions.ServiceActions
 import io.matthewnelson.topl_service.service.components.binding.TorServiceConnection
@@ -296,10 +295,7 @@ class TorServiceController private constructor(): ServiceConsts() {
 
             torServiceNotificationBuilder.build(application.applicationContext)
 
-            backgroundManagerPolicy.build(
-                TorService::class.java,
-                TorServiceConnection.torServiceConnection
-            )
+            backgroundManagerPolicy.build()
         }
     }
 
@@ -343,28 +339,24 @@ class TorServiceController private constructor(): ServiceConsts() {
          * */
         @Throws(RuntimeException::class)
         fun startTor() =
-            BaseService.startService(
-                BaseService.getAppContext(),
-                TorService::class.java,
-                TorServiceConnection.torServiceConnection
-            )
+            BaseService.startService(BaseService.getAppContext(), TorService::class.java)
 
         /**
          * Stops [TorService].
          * */
         fun stopTor() =
-            BaseServiceConnection.serviceBinder?.submitServiceAction(ServiceActions.Stop())
+            TorServiceConnection.serviceBinder?.submitServiceAction(ServiceActions.Stop())
 
         /**
          * Restarts Tor.
          * */
         fun restartTor() =
-            BaseServiceConnection.serviceBinder?.submitServiceAction(ServiceActions.RestartTor())
+            TorServiceConnection.serviceBinder?.submitServiceAction(ServiceActions.RestartTor())
 
         /**
          * Changes identities.
          * */
         fun newIdentity() =
-            BaseServiceConnection.serviceBinder?.submitServiceAction(ServiceActions.NewId())
+            TorServiceConnection.serviceBinder?.submitServiceAction(ServiceActions.NewId())
     }
 }

topl-service/src/main/java/io/matthewnelson/topl_service/lifecycle/BackgroundManager.kt

@@ -66,14 +66,15 @@
 * */
 package io.matthewnelson.topl_service.lifecycle
 
+import android.content.Context
 import androidx.lifecycle.Lifecycle
 import androidx.lifecycle.LifecycleObserver
 import androidx.lifecycle.OnLifecycleEvent
 import androidx.lifecycle.ProcessLifecycleOwner
 import io.matthewnelson.topl_service.service.BaseService
 import io.matthewnelson.topl_service.service.TorService
 import io.matthewnelson.topl_service.service.components.actions.ServiceActionProcessor
-import io.matthewnelson.topl_service.service.components.binding.BaseServiceConnection
+import io.matthewnelson.topl_service.service.components.binding.TorServiceConnection
 import io.matthewnelson.topl_service.util.ServiceConsts
 
 /**
@@ -117,15 +118,15 @@ import io.matthewnelson.topl_service.util.ServiceConsts
  * @param [executionDelay] Length of time before the policy gets executed *after* the application
  *   is sent to the background.
  * @param [serviceClass] The Service class being managed
- * @param [serviceConnection] The ServiceConnection being used to bind with
- * @see [io.matthewnelson.topl_service.service.components.binding.TorServiceBinder.executeBackgroundPolicyJob]
- * @see [io.matthewnelson.topl_service.service.components.binding.TorServiceBinder.cancelExecuteBackgroundPolicyJob]
+ * @param [bindServiceFlag] The flag to be used when binding to the service
+ * @see [io.matthewnelson.topl_service.service.components.binding.BaseServiceBinder.executeBackgroundPolicyJob]
+ * @see [io.matthewnelson.topl_service.service.components.binding.BaseServiceBinder.cancelExecuteBackgroundPolicyJob]
  * */
 class BackgroundManager internal constructor(
     @BackgroundPolicy private val policy: String,
     private val executionDelay: Long,
     private val serviceClass: Class<*>,
-    private val serviceConnection: BaseServiceConnection
+    private val bindServiceFlag: Int
 ): ServiceConsts(), LifecycleObserver {
 
 
@@ -213,8 +214,8 @@ class BackgroundManager internal constructor(
              * test classes get initialized so they aren't overwritten by production classes.
              * */
             internal fun build(
-                serviceClass: Class<*>,
-                serviceConnection: BaseServiceConnection
+                serviceClass: Class<*> = TorService::class.java,
+                bindServiceFlag: Int = Context.BIND_AUTO_CREATE
             ) {
 
                 // Only initialize it once. Reflection has issues here
@@ -227,7 +228,7 @@ class BackgroundManager internal constructor(
                             policyBuilder.chosenPolicy,
                             policyBuilder.executionDelay,
                             serviceClass,
-                            serviceConnection
+                            bindServiceFlag
                         )
                 }
             }
@@ -257,19 +258,19 @@ class BackgroundManager internal constructor(
         // if the last _accepted_ ServiceAction to be issued by the Application was not to STOP
         // the service, then we want to put it back in the state it was in
         if (!ServiceActionProcessor.wasLastAcceptedServiceActionStop()) {
-            BaseServiceConnection.serviceBinder?.cancelExecuteBackgroundPolicyJob()
+            TorServiceConnection.serviceBinder?.cancelExecuteBackgroundPolicyJob()
             BaseService.startService(
                 BaseService.getAppContext(),
                 serviceClass,
-                serviceConnection,
-                includeIntentActionStart = false
+                includeIntentActionStart = false,
+                bindServiceFlag = bindServiceFlag
             )
         }
     }
 
     @OnLifecycleEvent(Lifecycle.Event.ON_STOP)
     private fun applicationMovedToBackground() {
         if (!ServiceActionProcessor.wasLastAcceptedServiceActionStop())
-            BaseServiceConnection.serviceBinder?.executeBackgroundPolicyJob(policy, executionDelay)
+            TorServiceConnection.serviceBinder?.executeBackgroundPolicyJob(policy, executionDelay)
     }
 }

topl-service/src/main/java/io/matthewnelson/topl_service/service/BaseService.kt

@@ -71,7 +71,6 @@ import android.app.Service
 import android.content.Context
 import android.content.Intent
 import android.content.SharedPreferences
-import android.os.IBinder
 import androidx.annotation.WorkerThread
 import io.matthewnelson.topl_core.broadcaster.BroadcastLogger
 import io.matthewnelson.topl_core_base.TorConfigFiles
@@ -82,8 +81,6 @@ import io.matthewnelson.topl_service.prefs.TorServicePrefsListener
 import io.matthewnelson.topl_service.service.components.actions.ServiceActionProcessor
 import io.matthewnelson.topl_service.service.components.actions.ServiceActions
 import io.matthewnelson.topl_service.service.components.actions.ServiceActions.ServiceAction
-import io.matthewnelson.topl_service.service.components.binding.BaseServiceConnection
-import io.matthewnelson.topl_service.service.components.binding.TorServiceBinder
 import io.matthewnelson.topl_service.service.components.binding.TorServiceConnection
 import io.matthewnelson.topl_service.util.ServiceConsts.ServiceActionName
 import io.matthewnelson.topl_service.util.ServiceConsts.NotificationImage
@@ -151,7 +148,7 @@ internal abstract class BaseService: Service() {
          * Updates [lastAcceptedServiceAction] in several key places so that we can keep
          * [TorService]'s state in sync with the latest calls coming from the Application using
          * the Library. It is used in [TorService.onStartCommand] and
-         * [io.matthewnelson.topl_service.service.components.binding.TorServiceBinder.submitServiceAction]
+         * [io.matthewnelson.topl_service.service.components.binding.BaseServiceBinder.submitServiceAction]
          *
          * @param [serviceAction] The [ServiceActionName] to update [lastAcceptedServiceAction] to
          * */
@@ -176,35 +173,39 @@ internal abstract class BaseService: Service() {
          *
          * @param [context]
          * @param [serviceClass] The Service's class wanting to be started
-         * @param [serviceConn] The [BaseServiceConnection] to bind to
          * @param [includeIntentActionStart] Boolean for including [ServiceActionName.START] as
          *   the Intent's Action.
+         * @param [bindServiceFlag] The flag to use when binding to [TorService]
          * */
         fun startService(
             context: Context,
             serviceClass: Class<*>,
-            serviceConn: BaseServiceConnection,
-            includeIntentActionStart: Boolean = true
+            includeIntentActionStart: Boolean = true,
+            bindServiceFlag: Int = Context.BIND_AUTO_CREATE
         ) {
             val intent = Intent(context.applicationContext, serviceClass)
             if (includeIntentActionStart)
                 intent.action = ServiceActionName.START
             context.applicationContext.startService(intent)
-            context.applicationContext.bindService(intent, serviceConn, Context.BIND_AUTO_CREATE)
+            context.applicationContext.bindService(
+                intent,
+                TorServiceConnection.torServiceConnection,
+                bindServiceFlag
+            )
         }
 
         /**
          * Unbinds [TorService] from the Application and clears the reference to
-         * [BaseServiceConnection.serviceBinder].
+         * [TorServiceConnection.serviceBinder].
          *
          * @param [context] [Context]
-         * @param [serviceConn] The [BaseServiceConnection] to unbind
+         * @param [serviceConn] The [TorServiceConnection] to unbind
          * @throws [IllegalArgumentException] If no binding exists for the provided [serviceConn]
          * */
         @Throws(IllegalArgumentException::class)
-        fun unbindService(context: Context, serviceConn: BaseServiceConnection) {
-            serviceConn.clearServiceBinderReference()
-            context.applicationContext.unbindService(serviceConn)
+        fun unbindService(context: Context) {
+            TorServiceConnection.torServiceConnection.clearServiceBinderReference()
+            context.applicationContext.unbindService(TorServiceConnection.torServiceConnection)
         }
     }
 
@@ -217,21 +218,7 @@ internal abstract class BaseService: Service() {
     ///////////////
     /// Binding ///
     ///////////////
-    private val torServiceBinder: TorServiceBinder by lazy {
-        TorServiceBinder(this)
-    }
-
-    open fun unbindTorService(): Boolean {
-        return try {
-            unbindService(context, TorServiceConnection.torServiceConnection)
-            true
-        } catch (e: IllegalArgumentException) {
-            false
-        }
-    }
-    override fun onBind(intent: Intent?): IBinder? {
-        return torServiceBinder
-    }
+    abstract fun unbindTorService()
 
 
     /////////////////////////
@@ -361,12 +348,12 @@ internal abstract class BaseService: Service() {
 
 
     override fun onTaskRemoved(rootIntent: Intent?) {
-        // Cancel the BackgroundManager's coroutine if it's active so it doesn't execute
-        torServiceBinder.cancelExecuteBackgroundPolicyJob()
-
         // Move to the foreground so we can properly shutdown w/o interrupting the
         // application's normal lifecycle (Context.startServiceForeground does... thus,
         // the complexity)
         startForegroundService()
+
+        // Shutdown Tor and stop the Service.
+        processServiceAction(ServiceActions.Stop(updateLastServiceAction = false))
     }
 }

topl-service/src/main/java/io/matthewnelson/topl_service/service/TorService.kt

@@ -73,7 +73,8 @@ import io.matthewnelson.topl_core.OnionProxyManager
 import io.matthewnelson.topl_core.broadcaster.BroadcastLogger
 import io.matthewnelson.topl_core.util.FileUtilities
 import io.matthewnelson.topl_service.TorServiceController
-import io.matthewnelson.topl_service.service.components.actions.ServiceActions
+import io.matthewnelson.topl_service.service.components.binding.TorServiceBinder
+import io.matthewnelson.topl_service.service.components.binding.TorServiceConnection
 import io.matthewnelson.topl_service.service.components.onionproxy.ServiceEventBroadcaster
 import io.matthewnelson.topl_service.service.components.onionproxy.ServiceEventListener
 import io.matthewnelson.topl_service.service.components.onionproxy.ServiceTorInstaller
@@ -98,15 +99,19 @@ internal class TorService: BaseService() {
     ///////////////
     /// Binding ///
     ///////////////
-    override fun unbindTorService(): Boolean {
-        val boolean = super.unbindTorService()
-        if (boolean)
+    private val torServiceBinder: TorServiceBinder by lazy {
+        TorServiceBinder(this)
+    }
+
+    override fun unbindTorService() {
+        try {
+            unbindService(context)
             broadcastLogger.debug("Has been unbound")
-        return boolean
+        } catch (e: IllegalArgumentException) {}
     }
     override fun onBind(intent: Intent?): IBinder? {
         broadcastLogger.debug("Has been bound")
-        return super.onBind(intent)
+        return torServiceBinder
     }
 
 
@@ -254,15 +259,10 @@ internal class TorService: BaseService() {
         supervisorJob.cancel()
     }
 
-    override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int {
-        return super.onStartCommand(intent, flags, startId)
-    }
-
     override fun onTaskRemoved(rootIntent: Intent?) {
-        super.onTaskRemoved(rootIntent)
+        // Cancel the BackgroundManager's coroutine if it's active so it doesn't execute
+        torServiceBinder.cancelExecuteBackgroundPolicyJob()
         broadcastLogger.debug("Task has been removed")
-
-        // Shutdown Tor and stop the Service.
-        processServiceAction(ServiceActions.Stop(updateLastServiceAction = false))
+        super.onTaskRemoved(rootIntent)
     }
 }