#DEOPSCSW-510: Pritam: Create and move network related utilities to n…

…ew `csw-network-utils` module.

build.sbt

@@ -26,6 +26,7 @@ lazy val aggregatedProjects: Seq[ProjectReference] = Seq(
   `csw-alarm-api`,
   `csw-alarm-client`,
   `csw-alarm-cli`,
+  `csw-network-utils`,
   `csw-commons`,
   `csw-benchmark`,
   `romaine`,
@@ -43,6 +44,7 @@ lazy val unidocExclusions: Seq[ProjectReference] = Seq(
   `csw-alarm-cli`,
   `csw-logging-macros`,
   `csw-params-js`,
+  `csw-network-utils`,
   `csw-commons`,
   `csw-benchmark`,
   `romaine`,
@@ -99,6 +101,7 @@ lazy val `csw-location-server` = project
   .dependsOn(
     `csw-location-api`,
     `csw-logging`,
+    `csw-network-utils`,
     `csw-location-client` % "test->compile;multi-jvm->compile",
     `csw-commons`         % "compile->compile;test->test"
   )
@@ -108,7 +111,10 @@ lazy val `csw-location-server` = project
   )
 
 lazy val `csw-location-client` = project
-  .dependsOn(`csw-location-api`)
+  .dependsOn(
+    `csw-location-api`,
+    `csw-network-utils`
+  )
   .enablePlugins(PublishBintray, GenJavadocPlugin, MaybeCoverage)
   .settings(
     libraryDependencies ++= Dependencies.LocationClient.value
@@ -308,7 +314,15 @@ lazy val `csw-alarm-cli` = project
   .settings(libraryDependencies ++= Dependencies.AlarmCli.value)
 
 /* =============== Common Utilities ============ */
+lazy val `csw-network-utils` = project
+  .dependsOn(`csw-logging`)
+  .enablePlugins(PublishBintray)
+  .settings(
+    libraryDependencies ++= Dependencies.NetworkUtils.value
+  )
+
 lazy val `csw-commons` = project
+  .dependsOn(`csw-network-utils`)
   .enablePlugins(PublishBintray)
   .settings(
     libraryDependencies ++= Dependencies.Commons.value
@@ -359,7 +373,8 @@ lazy val integration = project
   .dependsOn(
     `csw-location-server`,
     `csw-command-client`,
-    `csw-location-agent`
+    `csw-location-agent`,
+    `csw-network-utils`
   )
   .enablePlugins(DeployApp)
   .settings(

csw-admin-server/src/main/scala/csw/admin/server/log/http/AdminHttpService.scala

@@ -5,8 +5,8 @@ import akka.http.scaladsl.Http.ServerBinding
 import csw.admin.server.commons.AdminLogger
 import csw.admin.server.commons.CoordinatedShutdownReasons.FailureReason
 import csw.admin.server.wiring.{ActorRuntime, Settings}
-import csw.location.api.commons.ClusterAwareSettings
 import csw.logging.scaladsl.Logger
+import csw.network.utils.Networks
 
 import scala.async.Async._
 import scala.concurrent.Future
@@ -32,7 +32,7 @@ class AdminHttpService(adminRoutes: AdminRoutes, actorRuntime: ActorRuntime, set
 
   private def bind() = Http().bindAndHandle(
     handler = adminRoutes.route,
-    interface = ClusterAwareSettings.hostname,
+    interface = Networks().hostname,
     port = settings.adminPort
   )
 }

csw-admin-server/src/main/scala/csw/admin/server/wiring/ActorRuntime.scala

@@ -4,9 +4,9 @@ import akka.Done
 import akka.actor.CoordinatedShutdown.Reason
 import akka.actor.{ActorSystem, CoordinatedShutdown, Scheduler}
 import akka.stream.{ActorMaterializer, Materializer}
-import csw.location.api.commons.ClusterAwareSettings
 import csw.logging.internal.LoggingSystem
 import csw.logging.scaladsl.LoggingSystemFactory
+import csw.network.utils.Networks
 import csw.services.BuildInfo
 
 import scala.concurrent.{ExecutionContextExecutor, Future}
@@ -20,7 +20,7 @@ private[admin] class ActorRuntime(_actorSystem: ActorSystem) {
   private[admin] val coordinatedShutdown = CoordinatedShutdown(actorSystem)
 
   def startLogging(name: String): LoggingSystem =
-    LoggingSystemFactory.start(name, BuildInfo.version, ClusterAwareSettings.hostname, actorSystem)
+    LoggingSystemFactory.start(name, BuildInfo.version, Networks().hostname, actorSystem)
 
   def shutdown(reason: Reason): Future[Done] = coordinatedShutdown.run(reason)
 }

csw-admin-server/src/test/scala/csw/admin/server/log/AkkaLogAdminTest.scala

@@ -19,7 +19,6 @@ import csw.command.client.models.framework.{Component, Components, ContainerLife
 import csw.common.FrameworkAssertions.assertThatContainerIsRunning
 import csw.commons.tags.LoggingSystemSensitive
 import csw.framework.internal.wiring.{Container, FrameworkWiring}
-import csw.location.api.commons.ClusterAwareSettings
 import csw.location.api.models.ComponentId
 import csw.location.api.models.ComponentType.{Assembly, HCD}
 import csw.location.api.models.Connection.AkkaConnection
@@ -29,6 +28,7 @@ import csw.logging.internal.LoggingLevels.{ERROR, Level, WARN}
 import csw.logging.internal._
 import csw.logging.models.LogMetadata
 import csw.logging.scaladsl.LoggingSystemFactory
+import csw.network.utils.Networks
 import csw.params.commands.CommandResponse.OnewayResponse
 import csw.params.commands.{CommandName, Setup}
 import csw.params.core.models.Prefix
@@ -112,7 +112,7 @@ class AkkaLogAdminTest extends AdminLogTestSuite with HTTPLocationService with H
     // send http get metadata request and verify the response has correct log levels
     val getLogMetadataUri = Uri.from(
       scheme = "http",
-      host = ClusterAwareSettings.hostname,
+      host = Networks().hostname,
       port = 7879,
       path = s"/admin/logging/${motionControllerConnection.name}/level"
     )
@@ -169,7 +169,7 @@ class AkkaLogAdminTest extends AdminLogTestSuite with HTTPLocationService with H
     // set log level of laser component to error through http endpoint
     val uri = Uri.from(
       scheme = "http",
-      host = ClusterAwareSettings.hostname,
+      host = Networks().hostname,
       port = 7879,
       path = s"/admin/logging/${laserConnection.name}/level",
       queryString = Some("value=error")
@@ -214,7 +214,7 @@ class AkkaLogAdminTest extends AdminLogTestSuite with HTTPLocationService with H
     // send http get metadata request for invalid component
     val getLogMetadataUri = Uri.from(
       scheme = "http",
-      host = ClusterAwareSettings.hostname,
+      host = Networks().hostname,
       port = 7879,
       path = s"/admin/logging/abcd-hcd-akka/level"
     )
@@ -229,7 +229,7 @@ class AkkaLogAdminTest extends AdminLogTestSuite with HTTPLocationService with H
     // send http set request for invalid log level
     val uri = Uri.from(
       scheme = "http",
-      host = ClusterAwareSettings.hostname,
+      host = Networks().hostname,
       port = 7879,
       path = s"/admin/logging/${laserConnection.name}/level",
       queryString = Some("value=error1")

csw-admin-server/src/test/scala/csw/admin/server/log/HttpAndTcpLogAdminTest.scala

@@ -13,12 +13,12 @@ import csw.admin.server.log.http.HttpSupport
 import csw.commons.http.{ErrorMessage, ErrorResponse}
 import csw.config.server.commons.{ConfigServiceConnection, TestFileUtils}
 import csw.config.server.{ServerWiring, Settings}
-import csw.location.api.commons.ClusterAwareSettings
 import csw.location.api.models.Connection.TcpConnection
 import csw.location.api.models.{ComponentId, ComponentType}
 import csw.location.server.http.HTTPLocationService
 import csw.logging.internal._
 import csw.logging.scaladsl.LoggingSystemFactory
+import csw.network.utils.Networks
 
 import scala.concurrent.Await
 import scala.concurrent.duration.DurationDouble
@@ -64,7 +64,7 @@ class HttpAndTcpLogAdminTest extends AdminLogTestSuite with HttpSupport with HTT
     // send http get metadata request and verify the response has correct log levels
     val getLogMetadataUri = Uri.from(
       scheme = "http",
-      host = ClusterAwareSettings.hostname,
+      host = Networks().hostname,
       port = 7888,
       path = s"/admin/logging/${ConfigServiceConnection.value.name}/level"
     )
@@ -83,7 +83,7 @@ class HttpAndTcpLogAdminTest extends AdminLogTestSuite with HttpSupport with HTT
     // send http get metadata request and verify the response has correct log levels
     val getLogMetadataUri = Uri.from(
       scheme = "http",
-      host = ClusterAwareSettings.hostname,
+      host = Networks().hostname,
       port = 7888,
       path = s"/admin/logging/${ConfigServiceConnection.value.name}/level",
       queryString = Some("value=debug")
@@ -105,7 +105,7 @@ class HttpAndTcpLogAdminTest extends AdminLogTestSuite with HttpSupport with HTT
     // send http get metadata request and verify the response has correct log levels
     val getLogMetadataUri = Uri.from(
       scheme = "http",
-      host = ClusterAwareSettings.hostname,
+      host = Networks().hostname,
       port = 7888,
       path = s"/admin/logging/${tcpConnection.name}/level"
     )
@@ -126,7 +126,7 @@ class HttpAndTcpLogAdminTest extends AdminLogTestSuite with HttpSupport with HTT
     // send http get metadata request and verify the response has correct log levels
     val getLogMetadataUri = Uri.from(
       scheme = "http",
-      host = ClusterAwareSettings.hostname,
+      host = Networks().hostname,
       port = 7888,
       path = s"/admin/logging/${tcpConnection.name}/level",
       queryString = Some("value=debug")

csw-admin-server/src/test/scala/csw/admin/server/log/app/DemoApp.scala

@@ -12,11 +12,11 @@ import csw.command.client.messages.ContainerMessage
 import csw.command.client.models.framework.{Component, Components, ContainerLifecycleState}
 import csw.common.FrameworkAssertions.assertThatContainerIsRunning
 import csw.framework.internal.wiring.{Container, FrameworkWiring}
-import csw.location.api.commons.ClusterAwareSettings
 import csw.location.client.ActorSystemFactory
 import csw.location.server.internal.ServerWiring
 import csw.logging.appenders.StdOutAppender
 import csw.logging.scaladsl.{LoggerFactory, LoggingSystemFactory}
+import csw.network.utils.Networks
 import csw.params.commands.CommandResponse.OnewayResponse
 import csw.params.commands.{CommandName, Setup}
 import csw.params.core.models.Prefix
@@ -62,7 +62,7 @@ object DemoApp extends App {
 
   private def startSeed() = {
     import adminWiring.actorRuntime._
-    val loggingSystem = LoggingSystemFactory.start("logging", "version", ClusterAwareSettings.hostname, actorSystem)
+    val loggingSystem = LoggingSystemFactory.start("logging", "version", Networks().hostname, actorSystem)
     loggingSystem.setAppenders(List(StdOutAppender))
     Await.result(ServerWiring.make(Some(3552)).locationHttpService.start(), 5.seconds)
     Await.result(adminWiring.adminHttpService.registeredLazyBinding, 5.seconds)

csw-alarm-cli/src/main/scala/csw/alarm/cli/wiring/ActorRuntime.scala

@@ -4,9 +4,9 @@ import akka.Done
 import akka.actor.CoordinatedShutdown.Reason
 import akka.actor.{ActorSystem, CoordinatedShutdown}
 import akka.stream.{ActorMaterializer, Materializer}
-import csw.location.api.commons.ClusterAwareSettings
 import csw.logging.internal.LoggingSystem
 import csw.logging.scaladsl.LoggingSystemFactory
+import csw.network.utils.Networks
 import csw.services.BuildInfo
 
 import scala.concurrent.{ExecutionContextExecutor, Future}
@@ -19,7 +19,7 @@ class ActorRuntime(_actorSystem: ActorSystem) {
   lazy val coordinatedShutdown = CoordinatedShutdown(system)
 
   def startLogging(name: String): LoggingSystem =
-    LoggingSystemFactory.start(name, BuildInfo.version, ClusterAwareSettings.hostname, system)
+    LoggingSystemFactory.start(name, BuildInfo.version, Networks().hostname, system)
 
   /**
    * Gracefully shutdown [[_actorSystem]]

csw-alarm-client/src/test/scala/csw/alarm/client/internal/helpers/AlarmServiceTestSetup.scala

@@ -14,7 +14,7 @@ import csw.alarm.client.internal.commons.serviceresolver.AlarmServiceHostPortRes
 import csw.alarm.client.internal.helpers.TestFutureExt.RichFuture
 import csw.alarm.client.internal.redis.RedisConnectionsFactory
 import csw.commons.redis.EmbeddedRedis
-import csw.commons.utils.SocketUtils.getFreePort
+import csw.network.utils.SocketUtils.getFreePort
 import io.lettuce.core.RedisClient
 import org.scalatest.mockito.MockitoSugar
 import org.scalatest.{BeforeAndAfterAll, BeforeAndAfterEach, FunSuite, Matchers}

csw-commons/src/test/scala/csw/commons/redis/EmbeddedRedis.scala

@@ -1,5 +1,6 @@
 package csw.commons.redis
-import csw.commons.utils.SocketUtils.getFreePort
+
+import csw.network.utils.SocketUtils.getFreePort
 import redis.embedded.{RedisSentinel, RedisServer}
 
 trait EmbeddedRedis {

csw-config-cli/src/main/scala/csw/config/cli/Main.scala

@@ -4,9 +4,9 @@ import akka.http.scaladsl.Http
 import csw.config.cli.args.{ArgsParser, Options}
 import csw.config.cli.commons.CoordinatedShutdownReasons.ApplicationFinishedReason
 import csw.config.cli.wiring.Wiring
-import csw.location.api.commons.ClusterAwareSettings
 import csw.location.client.utils.LocationServerStatus
 import csw.logging.scaladsl.LoggingSystemFactory
+import csw.network.utils.Networks
 import csw.services.BuildInfo
 
 // $COVERAGE-OFF$
@@ -20,7 +20,7 @@ object Main extends App {
 
     val wiring = Wiring.make(options.locationHost)
     import wiring._
-    LoggingSystemFactory.start(name, BuildInfo.version, ClusterAwareSettings.hostname, actorSystem)
+    LoggingSystemFactory.start(name, BuildInfo.version, Networks().hostname, actorSystem)
 
     try {
       cliApp.start(options)

csw-config-server/src/main/scala/csw/config/server/ActorRuntime.scala

@@ -8,9 +8,9 @@ import akka.actor.{ActorSystem, CoordinatedShutdown}
 import akka.dispatch.MessageDispatcher
 import akka.stream.{ActorMaterializer, Materializer}
 import csw.services.BuildInfo
-import csw.location.api.commons.ClusterAwareSettings
 import csw.logging.internal.LoggingSystem
 import csw.logging.scaladsl.LoggingSystemFactory
+import csw.network.utils.Networks
 
 import scala.compat.java8.FutureConverters.FutureOps
 import scala.concurrent.{ExecutionContextExecutor, Future}
@@ -28,7 +28,7 @@ private[config] class ActorRuntime(_actorSystem: ActorSystem, settings: Settings
   val blockingIoDispatcher: MessageDispatcher = actorSystem.dispatchers.lookup(settings.`blocking-io-dispatcher`)
 
   def startLogging(name: String): LoggingSystem =
-    LoggingSystemFactory.start(name, BuildInfo.version, ClusterAwareSettings.hostname, actorSystem)
+    LoggingSystemFactory.start(name, BuildInfo.version, Networks().hostname, actorSystem)
 
   def shutdown(reason: Reason): Future[Done] = coordinatedShutdown.run(reason)
 

csw-config-server/src/main/scala/csw/config/server/http/HttpService.scala

@@ -10,8 +10,8 @@ import csw.config.server.commons.{ConfigServerLogger, ConfigServiceConnection}
 import csw.config.server.{ActorRuntime, Settings}
 import csw.location.api.models.{HttpRegistration, RegistrationResult}
 import csw.location.api.scaladsl.LocationService
-import csw.location.api.commons.ClusterAwareSettings
 import csw.logging.scaladsl.Logger
+import csw.network.utils.Networks
 
 import scala.async.Async._
 import scala.concurrent.Future
@@ -62,7 +62,7 @@ class HttpService(
 
   private def bind() = Http().bindAndHandle(
     handler = configServiceRoute.route,
-    interface = ClusterAwareSettings.hostname,
+    interface = Networks().hostname,
     port = settings.`service-port`
   )
 

csw-config-server/src/test/scala/csw/config/server/http/HttpServiceTest.scala

@@ -6,11 +6,11 @@ import akka.stream.{ActorMaterializer, BindFailedException}
 import csw.config.server.ServerWiring
 import csw.config.server.commons.ConfigServiceConnection
 import csw.config.server.commons.TestFutureExtension.RichFuture
-import csw.location.api.commons.ClusterAwareSettings
 import csw.location.api.exceptions.OtherLocationIsRegistered
 import csw.location.api.models.HttpRegistration
 import csw.location.client.scaladsl.HttpLocationServiceFactory
 import csw.location.server.http.HTTPLocationService
+import csw.network.utils.Networks
 
 import scala.util.control.NonFatal
 
@@ -32,7 +32,7 @@ class HttpServiceTest extends HTTPLocationService {
     val (binding, registrationResult) = httpService.registeredLazyBinding.await
     locationService.find(ConfigServiceConnection.value).await.get.connection shouldBe ConfigServiceConnection.value
 
-    binding.localAddress.getAddress.getHostAddress shouldBe ClusterAwareSettings.hostname
+    binding.localAddress.getAddress.getHostAddress shouldBe Networks().hostname
     registrationResult.location.connection shouldBe ConfigServiceConnection.value
     actorRuntime.shutdown(UnknownReason).await
   }

csw-event-cli/src/main/scala/csw/event/cli/wiring/ActorRuntime.scala

@@ -4,9 +4,9 @@ import akka.Done
 import akka.actor.CoordinatedShutdown.Reason
 import akka.actor.{ActorSystem, CoordinatedShutdown}
 import akka.stream.{ActorMaterializer, Materializer}
-import csw.location.api.commons.ClusterAwareSettings
 import csw.logging.internal.LoggingSystem
 import csw.logging.scaladsl.LoggingSystemFactory
+import csw.network.utils.Networks
 import csw.services.BuildInfo
 
 import scala.concurrent.{ExecutionContextExecutor, Future}
@@ -19,7 +19,7 @@ class ActorRuntime(_actorSystem: ActorSystem) {
   val coordinatedShutdown = CoordinatedShutdown(system)
 
   def startLogging(name: String): LoggingSystem =
-    LoggingSystemFactory.start(name, BuildInfo.version, ClusterAwareSettings.hostname, system)
+    LoggingSystemFactory.start(name, BuildInfo.version, Networks().hostname, system)
 
   /**
    * Gracefully shutdown [[_actorSystem]]