+/*
+ * Copyright 2011-2012 GRNET S.A. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or
+ * without modification, are permitted provided that the following
+ * conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above
+ * copyright notice, this list of conditions and the following
+ * disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following
+ * disclaimer in the documentation and/or other materials
+ * provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
+ * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ * The views and conclusions contained in the software and
+ * documentation are those of the authors and should not be
+ * interpreted as representing official policies, either expressed
+ * or implied, of GRNET S.A.
+ */
+
package gr.grnet.aquarium.user
-import org.junit.Test
-import gr.grnet.aquarium.Configurator
import gr.grnet.aquarium.store.memory.MemStore
-import gr.grnet.aquarium.util.date.MutableDateCalc
import gr.grnet.aquarium.logic.accounting.dsl._
-import gr.grnet.aquarium.logic.accounting.{Policy, Accounting}
+import gr.grnet.aquarium.logic.accounting.Policy
import gr.grnet.aquarium.util.{Loggable, ContextualLogger}
-import com.ckkloverdos.maybe.{Just, NoVal}
import gr.grnet.aquarium.simulation._
-import gr.grnet.aquarium.simulation.uid.{UIDGenerator, ConcurrentVMLocalUIDGenerator}
+import gr.grnet.aquarium.uid.{UIDGenerator, ConcurrentVMLocalUIDGenerator}
+import org.junit.{Assert, Ignore, Test}
+import gr.grnet.aquarium.logic.accounting.algorithm.{ExecutableCostPolicyAlgorithm, CostPolicyAlgorithmCompiler}
+import gr.grnet.aquarium.AquariumException
+import gr.grnet.aquarium.Aquarium.{Instance ⇒ AquariumInstance}
+import gr.grnet.aquarium.computation.reason.{NoSpecificChangeReason, MonthlyBillingCalculation}
+import gr.grnet.aquarium.util.date.MutableDateCalc
+import gr.grnet.aquarium.computation.BillingMonthInfo
+import gr.grnet.aquarium.computation.state.{UserStateBootstrap, UserState}
/**
* @author Christos KK Loverdos <loverdos@gmail.com>
*/
class UserStateComputationsTest extends Loggable {
- val PolicyYAML = """
+ final val DoubleDelta = 0.001
+
+ final val BandwidthPriceUnit = 3.3 //
+ final val VMTimePriceUnit = 1.5 //
+ final val DiskspacePriceUnit = 2.7 //
+
+ final val OnOffPriceUnit = VMTimePriceUnit
+ final val ContinuousPriceUnit = DiskspacePriceUnit
+ final val DiscretePriceUnit = BandwidthPriceUnit
+
+ final val PolicyYAML = """
aquariumpolicy:
resources:
- resource:
pricelists:
- pricelist:
name: default
- bandwidth: 1.0
- vmtime: 1.0
- diskspace: 1.0
+ bandwidth: %s
+ vmtime: %s
+ diskspace: %s
effective:
from: 0
algorithm: default
pricelist: default
creditplan: default
- """
+ """.format(
+ BandwidthPriceUnit,
+ VMTimePriceUnit,
+ DiskspacePriceUnit
+ )
+
+ val aquarium = AquariumInstance.withStoreProviderClass(classOf[MemStore])
+ Policy.withConfigurator(aquarium)
+ val StoreProvider = aquarium.storeProvider
+ val ResourceEventStore = StoreProvider.resourceEventStore
+
+ val Computations = aquarium.userStateComputations
+
+ val DSL = new DSL {}
+ val DefaultPolicy = DSL parse PolicyYAML
+
+ val DefaultAlgorithm = new ExecutableCostPolicyAlgorithm {
+ def creditsForContinuous(timeDelta: Double, oldTotalAmount: Double) =
+ hrs(timeDelta) * oldTotalAmount * ContinuousPriceUnit
+
+ final val creditsForDiskspace = creditsForContinuous(_, _)
+
+ def creditsForDiscrete(currentValue: Double) =
+ currentValue * DiscretePriceUnit
+
+ final val creditsForBandwidth = creditsForDiscrete(_)
+
+ def creditsForOnOff(timeDelta: Double) =
+ hrs(timeDelta) * OnOffPriceUnit
+
+ final val creditsForVMTime = creditsForOnOff(_)
+
+ @inline private[this]
+ def hrs(millis: Double) = millis / 1000 / 60 / 60
+
+ def apply(vars: Map[DSLCostPolicyVar, Any]): Double = {
+ vars.apply(DSLCostPolicyNameVar) match {
+ case DSLCostPolicyNames.continuous ⇒
+ val unitPrice = vars(DSLUnitPriceVar).asInstanceOf[Double]
+ val oldTotalAmount = vars(DSLOldTotalAmountVar).asInstanceOf[Double]
+ val timeDelta = vars(DSLTimeDeltaVar).asInstanceOf[Double]
+
+ Assert.assertEquals(ContinuousPriceUnit, unitPrice, DoubleDelta)
+
+ creditsForContinuous(timeDelta, oldTotalAmount)
+
+ case DSLCostPolicyNames.discrete ⇒
+ val unitPrice = vars(DSLUnitPriceVar).asInstanceOf[Double]
+ val currentValue = vars(DSLCurrentValueVar).asInstanceOf[Double]
+
+ Assert.assertEquals(DiscretePriceUnit, unitPrice, DoubleDelta)
+
+ creditsForDiscrete(currentValue)
+
+ case DSLCostPolicyNames.onoff ⇒
+ val unitPrice = vars(DSLUnitPriceVar).asInstanceOf[Double]
+ val timeDelta = vars(DSLTimeDeltaVar).asInstanceOf[Double]
- val DefaultPolicy = new DSL{} parse PolicyYAML
+ Assert.assertEquals(OnOffPriceUnit, unitPrice, DoubleDelta)
+
+ creditsForOnOff(timeDelta)
+
+ case DSLCostPolicyNames.once ⇒
+ val currentValue = vars(DSLCurrentValueVar).asInstanceOf[Double]
+ currentValue
+
+ case name ⇒
+ throw new AquariumException("Unknown cost policy %s".format(name))
+ }
+ }
+
+ override def toString = "DefaultAlgorithm(%s)".format(
+ Map(
+ DSLCostPolicyNames.continuous -> "hrs(timeDelta) * oldTotalAmount * %s".format(ContinuousPriceUnit),
+ DSLCostPolicyNames.discrete -> "currentValue * %s".format(DiscretePriceUnit),
+ DSLCostPolicyNames.onoff -> "hrs(timeDelta) * %s".format(OnOffPriceUnit),
+ DSLCostPolicyNames.once -> "currentValue"))
+ }
+
+ val DefaultCompiler = new CostPolicyAlgorithmCompiler {
+ def compile(definition: String): ExecutableCostPolicyAlgorithm = {
+ DefaultAlgorithm
+ }
+ }
+ //val DefaultAlgorithm = justForSure(DefaultCompiler.compile("")).get // hardcoded since we know exactly what this is
+
+ val VMTimeDSLResource = DefaultPolicy.findResource("vmtime").get
// For this to work, the definitions must match those in the YAML above.
// Those StdXXXResourceSim are just for debugging convenience anyway, so they must match by design.
- val VMTimeResource = StdVMTimeResourceSim.fromPolicy(DefaultPolicy)
- val DiskspaceResource = StdDiskspaceResourceSim.fromPolicy(DefaultPolicy)
- val BandwidthResource = StdBandwidthResourceSim.fromPolicy(DefaultPolicy)
+ val VMTimeResourceSim = StdVMTimeResourceSim.fromPolicy(DefaultPolicy)
+ val DiskspaceResourceSim = StdDiskspaceResourceSim.fromPolicy(DefaultPolicy)
+ val BandwidthResourceSim = StdBandwidthResourceSim.fromPolicy(DefaultPolicy)
// There are two client services, synnefo and pithos.
- val TheUIDGenerator: UIDGenerator = new ConcurrentVMLocalUIDGenerator
+ val TheUIDGenerator: UIDGenerator[_] = new ConcurrentVMLocalUIDGenerator
val Synnefo = ClientSim("synnefo")(TheUIDGenerator)
val Pithos = ClientSim("pithos" )(TheUIDGenerator)
+ val StartOfBillingYearDateCalc = new MutableDateCalc(2012, 1, 1)
+ val UserCreationDate = new MutableDateCalc(2011, 11, 1).toDate
+
+ val BillingMonthInfoJan = {
+ val MutableDateCalcJan = new MutableDateCalc(2012, 1, 1)
+ BillingMonthInfo.fromDateCalc(MutableDateCalcJan)
+ }
+ val BillingMonthInfoFeb = BillingMonthInfo.fromDateCalc(new MutableDateCalc(2012, 2, 1))
+ val BillingMonthInfoMar = BillingMonthInfo.fromDateCalc(new MutableDateCalc(2012, 3, 1))
+
+ // Store the default policy
+ val policyDateCalc = StartOfBillingYearDateCalc.copy
+ val policyOccurredMillis = policyDateCalc.toMillis
+ val policyValidFromMillis = policyDateCalc.copy.goPreviousYear.toMillis
+ val policyValidToMillis = policyDateCalc.copy.goNextYear.toMillis
+ StoreProvider.policyStore.storePolicyEntry(DefaultPolicy.toPolicyEntry(policyOccurredMillis, policyValidFromMillis, policyValidToMillis))
+
+ val Aquarium = AquariumSim(List(VMTimeResourceSim, DiskspaceResourceSim, BandwidthResourceSim), StoreProvider.resourceEventStore)
+ val DefaultResourcesMap = Aquarium.resourcesMap
+
+ val UserCKKL = Aquarium.newUser("CKKL", UserCreationDate)
+
+// val InitialUserState = UserState.createInitialUserState(
+// userID = UserCKKL.userID,
+// userCreationMillis = UserCreationDate.getTime,
+// totalCredits = 0.0,
+// initialRole = "default",
+// initialAgreement = DSLAgreement.DefaultAgreementName
+// )
+
+ val UserStateBootstrapper = UserStateBootstrap(
+ userID = UserCKKL.userID,
+ userCreationMillis = UserCreationDate.getTime(),
+ initialRole = "default",
+ initialAgreement = DSLAgreement.DefaultAgreementName,
+ initialCredits = 0.0
+ )
+
+ // By convention
+ // - synnefo is for VMTime and Bandwidth
+ // - pithos is for Diskspace
+ val VMTimeInstanceSim = VMTimeResourceSim.newInstance ("VM.1", UserCKKL, Synnefo)
+ val BandwidthInstanceSim = BandwidthResourceSim.newInstance("3G.1", UserCKKL, Synnefo)
+ val DiskInstanceSim = DiskspaceResourceSim.newInstance("DISK.1", UserCKKL, Pithos)
+
+ private[this]
+ def showUserState(clog: ContextualLogger, userState: UserState) {
+ val id = userState._id
+ val parentId = userState.parentUserStateIDInStore
+ val credits = userState.totalCredits
+ val newWalletEntries = userState.newWalletEntries.map(_.toDebugString)
+ val changeReason = userState.lastChangeReason
+ val implicitlyIssued = userState.implicitlyIssuedSnapshot.implicitlyIssuedEvents.map(_.toDebugString)
+ val latestResourceEvents = userState.latestResourceEventsSnapshot.resourceEvents.map(_.toDebugString)
+
+ clog.debug("_id = %s", id)
+ clog.debug("parentId = %s", parentId)
+ clog.debug("credits = %s", credits)
+ clog.debug("changeReason = %s", changeReason)
+ clog.debugSeq("implicitlyIssued", implicitlyIssued, 0)
+ clog.debugSeq("latestResourceEvents", latestResourceEvents, 0)
+ clog.debugSeq("newWalletEntries", newWalletEntries, 0)
+ }
+
+ private[this]
+ def showResourceEvents(clog: ContextualLogger): Unit = {
+ clog.debug("")
+ clog.begin("Events by OccurredMillis")
+ clog.withIndent {
+ for(event <- UserCKKL.myResourceEventsByOccurredDate) {
+ clog.debug(event.toDebugString)
+ }
+ }
+ clog.end("Events by OccurredMillis")
+ clog.debug("")
+ }
+
+ private[this]
+ def doFullMonthlyBilling(
+ clog: ContextualLogger,
+ billingMonthInfo: BillingMonthInfo,
+ billingTimeMillis: Long) = {
+
+ Computations.doMonthBillingUpTo(
+ billingMonthInfo,
+ billingTimeMillis,
+ UserStateBootstrapper,
+ DefaultResourcesMap,
+ MonthlyBillingCalculation(NoSpecificChangeReason(), billingMonthInfo),
+ aquarium.userStateStore.insertUserState,
+ Some(clog)
+ )
+ }
+
+ private[this]
+ def expectCredits(
+ clog: ContextualLogger,
+ creditsConsumed: Double,
+ userState: UserState,
+ accuracy: Double = 0.001
+ ): Unit = {
+
+ val computed = userState.totalCredits
+ Assert.assertEquals(-creditsConsumed, computed, accuracy)
+
+ clog.info("Consumed %.3f credits [accuracy = %f]", creditsConsumed, accuracy)
+ }
+
+ private[this]
+ def millis2hrs(millis: Long) = millis.toDouble / 1000 / 60 / 60
+
+ private[this]
+ def hrs2millis(hrs: Double) = (hrs * 60 * 60 * 1000).toLong
+
+ /**
+ * Test a sequence of ON, OFF vmtime events.
+ */
+ @Ignore
@Test
- def testOne: Unit = {
- val clog = ContextualLogger.fromOther(NoVal, logger, "testOne()")
- val StartOfBillingYearDateCalc = new MutableDateCalc(2012, 1, 1)
- val UserCreationDate = new MutableDateCalc(2011, 11, 1).toDate
+ def testFullOnOff: Unit = {
+ val clog = ContextualLogger.fromOther(None, logger, "testFullOnOff()")
+ clog.begin()
+
+ ResourceEventStore.clearResourceEvents()
+ val OnOffDurationHrs = 10
+ val OnOffDurationMillis = hrs2millis(OnOffDurationHrs.toDouble)
+
+ VMTimeInstanceSim.newONOFF(
+ new MutableDateCalc(2012, 01, 10).goPlusHours(13).goPlusMinutes(30).toDate, // 2012-01-10 13:30:00.000
+ OnOffDurationHrs
+ )
+
+ val credits = DefaultAlgorithm.creditsForVMTime(OnOffDurationMillis)
+
+ showResourceEvents(clog)
+
+ val userState = doFullMonthlyBilling(clog, BillingMonthInfoJan, BillingMonthInfoJan.monthStopMillis)
+
+ showUserState(clog, userState)
+
+ expectCredits(clog, credits, userState)
+
+ clog.end()
+ }
+
+ @Ignore
+ @Test
+ def testLonelyON: Unit = {
+ val clog = ContextualLogger.fromOther(None, logger, "testLonelyON()")
+ clog.begin()
+
+ ResourceEventStore.clearResourceEvents()
+
+ val JanStart = new MutableDateCalc(2012, 01, 01)
+ val JanEnd = JanStart.copy.goEndOfThisMonth
+ val JanStartDate = JanStart.toDate
+ val OnOffImplicitDurationMillis = JanEnd.toMillis - JanStart.toMillis
+ val OnOffImplicitDurationHrs = millis2hrs(OnOffImplicitDurationMillis)
+
+ VMTimeInstanceSim.newON(JanStartDate)
+
+ val credits = DefaultAlgorithm.creditsForVMTime(OnOffImplicitDurationMillis)
+
+ showResourceEvents(clog)
+
+ val userState = doFullMonthlyBilling(clog, BillingMonthInfoJan, BillingMonthInfoJan.monthStopMillis)
+
+ showUserState(clog, userState)
+
+ expectCredits(clog, credits, userState)
- val computations = new UserStateComputations
+ clog.end()
+ }
+
+// @Ignore
+ @Test
+ def testOrphanOFF: Unit = {
+ val clog = ContextualLogger.fromOther(None, logger, "testOrphanOFF()")
+ clog.begin()
+
+ ResourceEventStore.clearResourceEvents()
- val mc = Configurator.MasterConfigurator.withStoreProviderClass(classOf[MemStore])
- Policy.withConfigurator(mc)
+ val JanStart = new MutableDateCalc(2012, 01, 01)
+ val JanEnd = JanStart.copy.goEndOfThisMonth
+ val JanStartDate = JanStart.toDate
+ val OnOffImplicitDurationMillis = JanEnd.toMillis - JanStart.toMillis
+ val OnOffImplicitDurationHrs = millis2hrs(OnOffImplicitDurationMillis)
- val storeProvider = mc.storeProvider
- val userStateStore = storeProvider.userStateStore
- val resourceEventStore = storeProvider.resourceEventStore
- val policyStore = storeProvider.policyStore
+ VMTimeInstanceSim.newOFF(JanStartDate)
- // Store the default policy
- val policyDateCalc = StartOfBillingYearDateCalc.copy
- val policyOccurredMillis = policyDateCalc.toMillis
- val policyValidFromMillis = policyDateCalc.copy.goPreviousYear.toMillis
- val policyValidToMillis = policyDateCalc.copy.goNextYear.toMillis
- policyStore.storePolicyEntry(DefaultPolicy.toPolicyEntry(policyOccurredMillis, policyValidFromMillis, policyValidToMillis))
+ // This is an orphan event, so no credits will be charged
+ val credits = 0
- val Aquarium = AquariumSim(List(VMTimeResource, DiskspaceResource, BandwidthResource), storeProvider.resourceEventStore)
- val DefaultResourcesMap = Aquarium.resourcesMap
+ showResourceEvents(clog)
- // A new user is created on 2012-01-15 00:00:00.000
- val UserCKKL = Aquarium.newUser("CKKL", UserCreationDate)
+ val userState = doFullMonthlyBilling(clog, BillingMonthInfoJan, BillingMonthInfoJan.monthStopMillis)
- // By convention
- // - synnefo is for VMTime and Bandwidth
- // - pithos is for Diskspace
- val VMTimeInstance = VMTimeResource.newInstance ("VM.1", UserCKKL, Synnefo)
- val BandwidthInstance = BandwidthResource.newInstance("3G.1", UserCKKL, Synnefo)
- val DiskInstance = DiskspaceResource.newInstance("DISK.1", UserCKKL, Pithos)
+ showUserState(clog, userState)
+
+ expectCredits(clog, credits, userState)
+
+ clog.end()
+ }
+
+ @Ignore
+ @Test
+ def testOne: Unit = {
+ val clog = ContextualLogger.fromOther(None, logger, "testOne()")
+ clog.begin()
// Let's create our dates of interest
- val vmStartDateCalc = StartOfBillingYearDateCalc.copy.goPlusDays(1).goPlusHours(1)
- val vmStartDate = vmStartDateCalc.toDate
+ val VMStartDateCalc = StartOfBillingYearDateCalc.copy.goPlusDays(1).goPlusHours(1)
+ val VMStartDate = VMStartDateCalc.toDate
// Within January, create one VM ON-OFF ...
- VMTimeInstance.newONOFF(vmStartDate, 9)
+ VMTimeInstanceSim.newONOFF(VMStartDate, 9)
val diskConsumptionDateCalc = StartOfBillingYearDateCalc.copy.goPlusHours(3)
val diskConsumptionDate1 = diskConsumptionDateCalc.toDate
val diskConsumptionDate2 = diskConsumptionDateCalc2.toDate
// ... and two diskspace changes
- DiskInstance.consumeMB(diskConsumptionDate1, 99)
- DiskInstance.consumeMB(diskConsumptionDate2, 23)
+ DiskInstanceSim.consumeMB(diskConsumptionDate1, 99)
+ DiskInstanceSim.consumeMB(diskConsumptionDate2, 23)
// 100MB 3G bandwidth
val bwDateCalc = diskConsumptionDateCalc2.copy.goPlusDays(1)
- BandwidthInstance.useBandwidth(bwDateCalc.toDate, 100.0)
+ BandwidthInstanceSim.useBandwidth(bwDateCalc.toDate, 100.0)
// ... and one "future" event
- DiskInstance.consumeMB(
+ DiskInstanceSim.consumeMB(
StartOfBillingYearDateCalc.copy.
goNextMonth.goPlusDays(6).
goPlusHours(7).
goPlusMillis(7).toDate,
777)
- clog.debug("")
- clog.begin("Events by OccurredMillis")
- clog.withIndent {
- for(event <- UserCKKL.myResourceEventsByOccurredDate) {
- clog.debug(event.toDebugString(DefaultResourcesMap))
- }
- }
- clog.end("Events by OccurredMillis")
- clog.debug("")
-
- val billingMonthInfo = BillingMonthInfo.fromDateCalc(StartOfBillingYearDateCalc)
-
- val initialUserState = computations.createFirstUserState(
- userId = UserCKKL.userId,
- userCreationMillis = UserCreationDate.getTime,
- isActive = true,
- credits = 0.0,
- roleNames = List("user"),
- agreementName = DSLAgreement.DefaultAgreementName
- )
-
- val currentUserState = initialUserState
+ showResourceEvents(clog)
// Policy: from 2012-01-01 to Infinity
clog.debugMap("DefaultResourcesMap", DefaultResourcesMap.map, 1)
- val userStateM = computations.doFullMonthlyBilling(
- UserCKKL.userId,
- billingMonthInfo,
- storeProvider,
- currentUserState,
- initialUserState,
- DefaultResourcesMap,
- new Accounting{},
- MonthlyBillingCalculation(billingMonthInfo),
- Just(clog)
- )
-
- clog.debug("userStateM = %s".format(userStateM))
- userStateM.forFailed { failed ⇒
- clog.error(failed)
- failed.exception.printStackTrace()
- NoVal
- }
+ val userState = doFullMonthlyBilling(clog, BillingMonthInfoJan, BillingMonthInfoJan.monthStopMillis)
+
+ showUserState(clog, userState)
+
+ clog.end()
}
}
\ No newline at end of file