added conditional includes

Author: mhawryluk

commons-spring/src/main/scala/com/avsystem/commons/spring/HoconBeanDefinitionReader.scala

@@ -1,10 +1,7 @@
 package com.avsystem.commons
 package spring
 
-import java.{util => ju}
-
 import com.avsystem.commons.spring.AttrNames._
-import scala.annotation.nowarn
 import com.typesafe.config._
 import org.springframework.beans.factory.annotation.Qualifier
 import org.springframework.beans.factory.config.ConstructorArgumentValues.ValueHolder
@@ -13,6 +10,9 @@ import org.springframework.beans.factory.support._
 import org.springframework.beans.{MutablePropertyValues, PropertyValue}
 import org.springframework.core.io.Resource
 
+import java.{util => ju}
+import scala.annotation.nowarn
+
 class HoconBeanDefinitionReader(registry: BeanDefinitionRegistry)
   extends AbstractBeanDefinitionReader(registry) {
 
@@ -344,8 +344,28 @@ class HoconBeanDefinitionReader(registry: BeanDefinitionRegistry)
     }
   }
 
+  private def readConditionals(list: ConfigList, config: ConfigObject): ConfigObject = {
+    list.asScala.foldLeft(config)((conf, conditionalConf) => {
+      val props = getProps(conditionalConf.asInstanceOf[ConfigObject])
+      val condition = props.get("condition")
+      val newConfig = props("beans").asInstanceOf[ConfigObject].get("beans")
+
+      if (condition.map(_.unwrapped().asInstanceOf[Boolean]).exists(identity)) {
+        newConfig.withFallback(conf).asInstanceOf[ConfigObject]
+      } else {
+        conf
+      }
+    })
+  }
+
   def loadBeanDefinitions(config: Config): Int = {
-    val beans = if (config.hasPath("beans")) config.getObject("beans") else ConfigFactory.empty.root
+    var beans = if (config.hasPath("beans")) config.getObject("beans") else ConfigFactory.empty.root
+
+    if (config.hasPath("conditionals")) {
+      val conditionals: ConfigList = config.getList("conditionals")
+      beans = readConditionals(conditionals, beans)
+    }
+
     val aliases = if (config.hasPath("aliases")) config.getObject("aliases") else ConfigFactory.empty.root
     val result = readBeans(beans)
     readAliases(aliases)

commons-spring/src/test/resources/conditionalInclude.conf

@@ -0,0 +1,6 @@
+beans {
+  beanFromConditional = {
+    %class = com.avsystem.commons.spring.ConditionalTestBean, %construct = true
+    int = 100
+  }
+}

commons-spring/src/test/resources/conditionalsDisabled.conf

@@ -0,0 +1,7 @@
+featureFlag.enabled = false
+
+beans.beanFromConditional = null
+
+conditionals = [
+  {condition: ${featureFlag.enabled}, beans: {include "conditionalInclude.conf"}},
+]

commons-spring/src/test/resources/conditionalsEnabled.conf

@@ -0,0 +1,7 @@
+featureFlag.enabled = true
+
+beans.beanFromConditional = null
+
+conditionals = [
+  {condition: ${featureFlag.enabled}, beans: {include "conditionalInclude.conf"}},
+]

commons-spring/src/test/scala/com/avsystem/commons/spring/HoconBeanDefinitionReaderTest.scala

@@ -1,14 +1,13 @@
 package com.avsystem.commons
 package spring
 
-import java.{util => ju}
-
 import com.typesafe.config.{Config, ConfigFactory}
 import org.scalatest.funsuite.AnyFunSuite
 import org.springframework.beans.factory.support.DefaultListableBeanFactory
 import org.springframework.context.support.GenericApplicationContext
 import org.springframework.core.StandardReflectionParameterNameDiscoverer
 
+import java.{util => ju}
 import scala.beans.BeanProperty
 
 class TestBean(val constrInt: Int = 1, val constrString: String = "constrDefault") {
@@ -25,6 +24,16 @@ object TestBean {
     new TestBean(theInt, theString)
 }
 
+class ConditionalTestBean(int: Int) {
+
+  import ConditionalTestBean.initializedCount
+
+  initializedCount += 1
+}
+object ConditionalTestBean {
+  var initializedCount = 0
+}
+
 class HoconBeanDefinitionReaderTest extends AnyFunSuite {
   def createContext(resource: String): GenericApplicationContext = {
     val beanFactory = new DefaultListableBeanFactory
@@ -40,6 +49,21 @@ class HoconBeanDefinitionReaderTest extends AnyFunSuite {
     ctx
   }
 
+  test("file should be included with true condition") {
+    ConditionalTestBean.initializedCount = 0
+    val ctx = createContext("conditionalsEnabled.conf")
+    val testBean = ctx.getBean("beanFromConditional", classOf[ConditionalTestBean])
+    assert(testBean != null)
+    assertResult(1)(ConditionalTestBean.initializedCount)
+  }
+
+  test("file should not be included with false condition") {
+    ConditionalTestBean.initializedCount = 0
+    val ctx = createContext("conditionalsDisabled.conf")
+    assert(!ctx.containsBean("beanFromConditional"))
+    assertResult(0)(ConditionalTestBean.initializedCount)
+  }
+
   test("hocon bean definition reader should work") {
     val ctx = createContext("testBean.conf")