Fixes #16411: Change the packaging to pass via the Rudder api to install the plugin

README.adoc

@@ -73,7 +73,7 @@ It may happens that at some point in the Rudder maintenance cycle, a Rudder mino
 breaking change in a plugin API or a binary incompability in a plugin ABI. In such a case, we will
 explain which plugin versions are compatible with which Rudder versions in plugin readme file.
 
-=== Summary of binary compatibility for Rudder 5.0 branch
+=== Summary of binary compatibility for Rudder 6.0 branch
 
 Please see file: version-compat.adoc
 

api-authorizations/build.conf

@@ -22,7 +22,7 @@ for API tokens.</p>"""
 # - x.y(.z): plugin major.minor.micro. Micro should be omitted. When omitted, z is assumed to be 0. 
 # For the build, we split the information between two properties, rudder branch and plugin version, 
 # which must be concaneted with "-" to build the plugin version. 
-plugin-branch=1.5
+plugin-branch=1.6-SNAPSHOT
 
 # rudder branch comes from parent
 plugin-version=${rudder-branch}-${plugin-branch}

api-authorizations/src/main/scala-templates/default/com/normation/plugins/apiauthorizations/EnablePluginImpl.scala

@@ -38,6 +38,7 @@
 package com.normation.plugins.apiauthorizations
 
 import com.normation.plugins.PluginEnableImpl
+import com.normation.rudder.services.nodes.NodeInfoService
 
-final class CheckRudderPluginEnableImpl() extends PluginEnableImpl
+final class CheckRudderPluginEnableImpl(nodeInfoService: NodeInfoService) extends PluginEnableImpl
 

api-authorizations/src/main/scala-templates/limited/com/normation/plugins/apiauthorizations/EnablePluginImpl.scala

@@ -38,11 +38,14 @@
 package com.normation.plugins.apiauthorizations
 
 import com.normation.plugins.LicensedPluginCheck
+import com.normation.rudder.services.nodes.NodeInfoService
 
-final class CheckRudderPluginEnableImpl() extends LicensedPluginCheck {
+final class CheckRudderPluginEnableImpl(nodeInfoService: NodeInfoService) extends LicensedPluginCheck {
   // here are processed variables
   def pluginResourcePublickey = "${plugin-resource-publickey}"
   def pluginResourceLicense   = "${plugin-resource-license}"
   def pluginDeclaredVersion   = "${plugin-declared-version}"
   def pluginId                = "${plugin-fullname}"
+
+  override def getNumberOfNodes: Int = nodeInfoService.getNumberOfManagedNodes
 }

api-authorizations/src/main/scala/bootstrap/rudder/plugin/ApiAuthorizationsConf.scala

@@ -56,7 +56,7 @@ class AclLevel(status: PluginStatus) extends ApiAuthorizationLevelService {
  */
 object ApiAuthorizationsConf extends RudderPluginModule {
   // by build convention, we have only one of that on the classpath
-  lazy val pluginStatusService =  new CheckRudderPluginEnableImpl()
+  lazy val pluginStatusService =  new CheckRudderPluginEnableImpl(RudderConfig.nodeInfoService)
 
   // override default service level
   RudderConfig.apiAuthorizationLevelService.overrideLevel(new AclLevel(pluginStatusService))

api-authorizations/src/main/scala/com/normation/plugins/apiauthorizations/UserTokenApiDefinition.scala

@@ -54,7 +54,7 @@ import net.liftweb.json._
 import org.joda.time.DateTime
 import com.normation.rudder.rest.{UserApi => API}
 
-
+import com.normation.box._
 
 class UserApi(
     restExtractor : RestExtractorService
@@ -87,7 +87,7 @@ class UserApi(
     val schema = API.GetApiToken
     val restExtractor = api.restExtractor
     def process0(version: ApiVersion, path: ApiPath, req: Req, params: DefaultParams, authzToken: AuthzToken): LiftResponse = {
-      readApi.getById(ApiAccountId(authzToken.actor.name)) match {
+      readApi.getById(ApiAccountId(authzToken.actor.name)).toBox match {
         case Full(Some(token)) =>
           val accounts: JValue = ("accounts" -> JArray(List(token.toJson)))
           RestUtils.toJsonResponse(None, accounts)(schema.name, true)
@@ -119,7 +119,7 @@ class UserApi(
         , now
       )
 
-      writeApi.save(account, ModificationId(uuidGen.newUuid), authzToken.actor) match {
+      writeApi.save(account, ModificationId(uuidGen.newUuid), authzToken.actor).toBox match {
         case Full(token) =>
           val accounts: JValue = ("accounts" -> JArray(List(token.toJson)))
           RestUtils.toJsonResponse(None,accounts)(schema.name, true)
@@ -135,7 +135,7 @@ class UserApi(
     val schema = API.DeleteApiToken
     val restExtractor = api.restExtractor
     def process0(version: ApiVersion, path: ApiPath, req: Req, params: DefaultParams, authzToken: AuthzToken): LiftResponse = {
-      writeApi.delete(ApiAccountId(authzToken.actor.name), ModificationId(uuidGen.newUuid), authzToken.actor) match {
+      writeApi.delete(ApiAccountId(authzToken.actor.name), ModificationId(uuidGen.newUuid), authzToken.actor).toBox match {
         case Full(token) =>
           val accounts: JValue = ("accounts" -> ("id" -> token.value))
           RestUtils.toJsonResponse(None,accounts)(schema.name, true)
@@ -151,7 +151,7 @@ class UserApi(
     val schema = API.UpdateApiToken
     val restExtractor = api.restExtractor
     def process0(version: ApiVersion, path: ApiPath, req: Req, params: DefaultParams, authzToken: AuthzToken): LiftResponse = {
-      readApi.getById(ApiAccountId(authzToken.actor.name)) match {
+      readApi.getById(ApiAccountId(authzToken.actor.name)).toBox match {
         case Full(Some(token)) =>
           val accounts: JValue = ("accounts" -> JArray(List(token.toJson)))
           RestUtils.toJsonResponse(None, accounts)(schema.name, true)

auth-backends/src/main/scala-templates/default/com/normation/plugins/authbackends/EnablePluginImpl.scala

@@ -38,10 +38,11 @@
 package com.normation.plugins.authbackends
 
 import com.normation.plugins.PluginEnableImpl
+import com.normation.rudder.services.nodes.NodeInfoService
 
 /*
  * The class will be loaded by ServiceLoader, it needs an empty constructor.
  */
 
-final class CheckRudderPluginEnableImpl() extends PluginEnableImpl
+final class CheckRudderPluginEnableImpl(nodeInfoService: NodeInfoService) extends PluginEnableImpl
 

auth-backends/src/main/scala-templates/limited/com/normation/plugins/authbackends/EnablePluginImpl.scala

@@ -38,6 +38,7 @@
 package com.normation.plugins.authbackends
 
 import com.normation.plugins.LicensedPluginCheck
+import com.normation.rudder.services.nodes.NodeInfoService
 
 /*
  * This template file will processed at build time to choose
@@ -46,11 +47,13 @@ import com.normation.plugins.LicensedPluginCheck
  *
  * The class will be loaded by ServiceLoader, it needs an empty constructor.
  */
-final class CheckRudderPluginEnableImpl() extends LicensedPluginCheck {
+final class CheckRudderPluginEnableImpl(nodeInfoService: NodeInfoService) extends LicensedPluginCheck {
   // here are processed variables
   def pluginResourcePublickey = "${plugin-resource-publickey}"
   def pluginResourceLicense   = "${plugin-resource-license}"
   def pluginDeclaredVersion   = "${plugin-declared-version}"
   def pluginId                = "${plugin-fullname}"
-} 
+
+  override def getNumberOfNodes: Int = nodeInfoService.getNumberOfManagedNodes
+}
 

auth-backends/src/main/scala/bootstrap/rudder/plugin/AuthBackendsConf.scala

@@ -53,7 +53,7 @@ import com.normation.plugins.authbackends.api.AuthBackendsApiImpl
 object AuthBackendsConf extends RudderPluginModule {
 
   // by build convention, we have only one of that on the classpath
-  lazy val pluginStatusService =  new CheckRudderPluginEnableImpl()
+  lazy val pluginStatusService =  new CheckRudderPluginEnableImpl(RudderConfig.nodeInfoService)
 
   lazy val authBackendsProvider = new AuthBackendsProvider {
     def authenticationBackends = Set("ldap", "radius")

branding/pom-template.xml

@@ -37,6 +37,10 @@
     </plugins>
   </build>
 
+  <dependencies>
+    <!-- Add other plugin specific dependencies -->
+  </dependencies>
+
   <!-- Below is an horrible if/then/else in maven. You shouldn't have anything to change here -->
 
   <!-- Internal profile: FOR INTERNAL USE ONLY - active if -Dlimited is *not* specified. -->

branding/src/main/scala-templates/default/com/normation/plugins/branding/EnablePluginImpl.scala

@@ -38,7 +38,8 @@
 package com.normation.plugins.branding
 
 import com.normation.plugins.PluginEnableImpl
+import com.normation.rudder.services.nodes.NodeInfoService
 
-final class CheckRudderPluginEnableImpl() extends PluginEnableImpl
+final class CheckRudderPluginEnableImpl(nodeInfoService: NodeInfoService) extends PluginEnableImpl
 
 

branding/src/main/scala-templates/limited/com/normation/plugins/branding/EnablePluginImpl.scala

@@ -38,11 +38,14 @@
 package com.normation.plugins.branding
 
 import com.normation.plugins.LicensedPluginCheck
+import com.normation.rudder.services.nodes.NodeInfoService
 
-final class CheckRudderPluginEnableImpl() extends LicensedPluginCheck {
+final class CheckRudderPluginEnableImpl(nodeInfoService: NodeInfoService) extends LicensedPluginCheck {
   // here are processed variables
   def pluginResourcePublickey = "${plugin-resource-publickey}"
   def pluginResourceLicense   = "${plugin-resource-license}"
   def pluginDeclaredVersion   = "${plugin-declared-version}"
   def pluginId                = "${plugin-fullname}"
+
+  override def getNumberOfNodes: Int = nodeInfoService.getNumberOfManagedNodes
 }

branding/src/main/scala/bootstrap/rudder/plugin/BrandingConf.scala

@@ -50,7 +50,7 @@ import com.normation.rudder.rest.{BrandingApi, BrandingApiService}
 object BrandingPluginConf extends RudderPluginModule {
 
   // by build convention, we have only one of that on the classpath
-  lazy val pluginStatusService =  new CheckRudderPluginEnableImpl()
+  lazy val pluginStatusService =  new CheckRudderPluginEnableImpl(RudderConfig.nodeInfoService)
 
   import bootstrap.liftweb.{ RudderConfig => Cfg }
 

branding/src/main/scala/com/normation/plugins/branding/snippet/LoginBranding.scala

@@ -53,8 +53,8 @@ import scala.xml.NodeSeq
 class LoginBranding(val status: PluginStatus, version: PluginVersion)(implicit val ttag: ClassTag[Login]) extends PluginExtensionPoint[Login] with Loggable {
 
   def pluginCompose(snippet:Login) : Map[String, NodeSeq => NodeSeq] = Map(
-    "display" -> display _
-  ).mapValues(guard _)
+    "display" -> guard(display(_))
+  )
 
 
   private [this] val confRepo = BrandingPluginConf.brandingConfService

change-validation/build.conf

@@ -22,7 +22,7 @@ plugin-web-description=<p>Enable configuration change requests and validation wo
 # - x.y(.z): plugin major.minor.micro. Micro should be omitted. When omitted, z is assumed to be 0. 
 # For the build, we split the information between two properties, rudder branch and plugin version, 
 # which must be concaneted with "-" to build the plugin version. 
-plugin-branch=1.4
+plugin-branch=1.5-SNAPSHOT
 
 # rudder branch comes from parent
 plugin-version=${rudder-branch}-${plugin-branch}

change-validation/src/main/scala-templates/default/com/normation/plugins/changevalidation/EnablePluginImpl.scala

@@ -38,10 +38,11 @@
 package com.normation.plugins.changevalidation
 
 import com.normation.plugins.PluginEnableImpl
+import com.normation.rudder.services.nodes.NodeInfoService
 
 /*
  * The class will be loaded by ServiceLoader, it needs an empty constructor.
  */
 
-final class CheckRudderPluginEnableImpl() extends PluginEnableImpl
+final class CheckRudderPluginEnableImpl(nodeInfoService: NodeInfoService) extends PluginEnableImpl
 

change-validation/src/main/scala-templates/limited/com/normation/plugins/changevalidation/EnablePluginImpl.scala

@@ -38,6 +38,7 @@
 package com.normation.plugins.changevalidation
 
 import com.normation.plugins.LicensedPluginCheck
+import com.normation.rudder.services.nodes.NodeInfoService
 
 /*
  * This template file will processed at build time to choose
@@ -46,11 +47,13 @@ import com.normation.plugins.LicensedPluginCheck
  *
  * The class will be loaded by ServiceLoader, it needs an empty constructor.
  */
-final class CheckRudderPluginEnableImpl() extends LicensedPluginCheck {
+final class CheckRudderPluginEnableImpl(nodeInfoService: NodeInfoService) extends LicensedPluginCheck {
   // here are processed variables
   def pluginResourcePublickey = "${plugin-resource-publickey}"
   def pluginResourceLicense   = "${plugin-resource-license}"
   def pluginDeclaredVersion   = "${plugin-declared-version}"
   def pluginId                = "${plugin-fullname}"
-} 
+
+  override def getNumberOfNodes: Int = nodeInfoService.getNumberOfManagedNodes
+}
 

change-validation/src/main/scala/bootstrap/rudder/plugin/ChangeValidationConf.scala

@@ -91,7 +91,7 @@ import com.normation.rudder.services.workflows.WorkflowService
 import net.liftweb.common.Box
 import net.liftweb.common.Full
 
-
+import com.normation.box._
 
 /*
  * The validation workflow level
@@ -191,7 +191,7 @@ class ChangeValidationWorkflowLevelService(
 object ChangeValidationConf extends RudderPluginModule {
 
   // by build convention, we have only one of that on the classpath
-  lazy val pluginStatusService =  new CheckRudderPluginEnableImpl()
+  lazy val pluginStatusService =  new CheckRudderPluginEnableImpl(RudderConfig.nodeInfoService)
 
   lazy val roWorkflowRepository = new RoWorkflowJdbcRepository(RudderConfig.doobie)
   lazy val woWorkflowRepository = new WoWorkflowJdbcRepository(RudderConfig.doobie)
@@ -208,8 +208,8 @@ object ChangeValidationConf extends RudderPluginModule {
     , roChangeRequestRepository
     , woChangeRequestRepository
     , () => Full(RudderConfig.workflowLevelService.workflowEnabled)
-    , RudderConfig.configService.rudder_workflow_self_validation _
-    , RudderConfig.configService.rudder_workflow_self_deployment _
+    , () => RudderConfig.configService.rudder_workflow_self_validation.toBox
+    , () => RudderConfig.configService.rudder_workflow_self_deployment.toBox
   )
 
   lazy val supervisedTargetRepo = new SupervisedTargetsReposiory(
@@ -248,7 +248,7 @@ object ChangeValidationConf extends RudderPluginModule {
         )
         , new UserValidationNeeded(roValidatedUserRepository)
       )
-      , RudderConfig.configService.rudder_workflow_enabled _
+      , () => RudderConfig.configService.rudder_workflow_enabled.toBox
     )
   )
 

change-validation/src/main/scala/com/normation/plugins/changevalidation/ChangeRequestJdbcRepository.scala

@@ -37,7 +37,6 @@
 
 package com.normation.plugins.changevalidation
 
-import cats.implicits._
 import com.normation.eventlog.EventActor
 import com.normation.eventlog.ModificationId
 import com.normation.rudder.db.Doobie
@@ -57,6 +56,7 @@ import doobie.postgres.implicits._
 import net.liftweb.common.Loggable
 import net.liftweb.common._
 import org.joda.time.DateTime
+import zio.interop.catz._
 
 import scala.xml.Elem
 
@@ -66,7 +66,7 @@ class RoChangeRequestJdbcRepository(
 ) extends RoChangeRequestRepository with Loggable {
 
   import doobie._
-  import mapper.ChangeRequestComposite
+  import mapper.ChangeRequestRead
 
 
   val SELECT_SQL = "SELECT id, name, description, content, modificationId FROM ChangeRequest"
@@ -75,11 +75,11 @@ class RoChangeRequestJdbcRepository(
 
   //utility method which correctly transform Doobie types towards Box[Vector[ChangeRequest]]
   private[this] def execQuery(q: Query0[Box[ChangeRequest]]): Box[Vector[ChangeRequest]] = {
-    q.to[Vector].attempt.map(
+    transactRunBox(xa => q.to[Vector].map(
         // we are just ignoring change request with unserialisation
         // error. Does not seem the best.
-        _.map(_.flatten.toVector)
-    ).transact(xa).unsafeRunSync
+        _.flatten.toVector
+    ).transact(xa))
   }
 
   override def getAll() : Box[Vector[ChangeRequest]] = {
@@ -89,7 +89,7 @@ class RoChangeRequestJdbcRepository(
 
   override def get(changeRequestId:ChangeRequestId) : Box[Option[ChangeRequest]] = {
     val q = Query[ChangeRequestId, Box[ChangeRequest]](SELECT_SQL + " where id = ?", None).toQuery0(changeRequestId)
-    q.option.map(_.map(_.toOption)).transact(xa).unsafeRunSync
+    transactRunBox(xa =>q.option.map(_.flatMap(_.toOption)).transact(xa))
 
   }
 
@@ -187,7 +187,7 @@ class WoChangeRequestJdbcRepository(
        """.update.withUniqueGeneratedKeys[Int]("id")
 
     for {
-      id  <- (q.transact(xa).attempt.unsafeRunSync: Box[Int])
+      id  <- transactRunBox(xa => q.transact(xa))
       cr  <- roRepo.get(ChangeRequestId(id)).flatMap {
                case None    =>
                  val msg = s"The newly saved change request with ID ${id} was not found back in data base"
@@ -224,12 +224,12 @@ class WoChangeRequestJdbcRepository(
                      Failure(msg)
                    case Some(x) => Full("ok")
                  }
-      update  <- ({
+      update  <- {
                    val (name, desc, xml, modId) = getAtom(changeRequest)
                    val q = sql"""update ChangeRequest set name = ${name}, description = ${desc}, content = ${xml}, modificationId = ${modId}
                                  where id = ${changeRequest.id}"""
-                   q.update.run.transact(xa).attempt.unsafeRunSync
-                 }: Box[Int])
+                   transactRunBox(xa => q.update.run.transact(xa))
+                 }
       updated <- roRepo.get(changeRequest.id).flatMap {
                    case None =>
                      val msg = s"Couldn't find the updated entry when updating Change Request ${changeRequest.id.value}"
@@ -306,11 +306,7 @@ class ChangeRequestMapper(
     }
   }
 
-  implicit val ChangeRequestComposite: Composite[Box[ChangeRequest]] = {
-    Composite[CR].imap(
-        (t : CR                ) => unserialize(t._1, t._2, t._3, t._4, t._5))(
-        (cr: Box[ChangeRequest]) => serialize(cr) // not sure we really need that, but Doobie force symetry on Composite
-    )
-
+  implicit val ChangeRequestRead: Read[Box[ChangeRequest]] = {
+    Read[CR].map((t: CR) => unserialize(t._1, t._2, t._3, t._4, t._5))
   }
 }