+/*
+ * 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 java.util.Date
-import simulation.{ConcurrentVMLocalUIDGenerator, ClientServiceSim, UserSim}
import gr.grnet.aquarium.logic.accounting.{Policy, Accounting}
import gr.grnet.aquarium.util.{Loggable, ContextualLogger}
-import com.ckkloverdos.maybe.{Just, NoVal}
+import gr.grnet.aquarium.simulation._
+import gr.grnet.aquarium.uid.{UIDGenerator, ConcurrentVMLocalUIDGenerator}
+import com.ckkloverdos.maybe.{Maybe, Just}
+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.{UserState, BillingMonthInfo, UserStateComputations}
+import gr.grnet.aquarium.computation.reason.MonthlyBillingCalculation
+import org.apache.ivy.util.Configurator
/**
* @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:
name: bandwidth
- unit: MB/hr
+ unit: MB/Hr
complex: false
costpolicy: discrete
- resource:
name: vmtime
- unit: Hour
+ unit: Hr
complex: true
costpolicy: onoff
descriminatorfield: vmid
algorithms:
- algorithm:
name: default
- bandwidth: $price times $volume
- vmtime: $price times $volume
- diskspace: $price times $volume
+ bandwidth: function bandwidth() {return 1;}
+ vmtime: function vmtime() {return 1;}
+ diskspace: function diskspace() {return 1;}
effective:
from: 0
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 Computations = new UserStateComputations
+
+ val DefaultPolicy = new DSL{} parse PolicyYAML
+ val DefaultAccounting = new Accounting{}
+
+ 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]
+
+ Assert.assertEquals(OnOffPriceUnit, unitPrice, DoubleDelta)
+
+ creditsForOnOff(timeDelta)
+
+ case DSLCostPolicyNames.once ⇒
+ val currentValue = vars(DSLCurrentValueVar).asInstanceOf[Double]
+ currentValue
- val DefaultPolicy = new DSL{}.parse(PolicyYAML)
+ 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
- // TODO: integrate this with the rest of the simulation stuff
- // TODO: since, right now, the resource strings have to be given twice
- val VMTimeResource = DSLComplexResource("vmtime", "Hr", OnOffCostPolicy, "")
- val DiskspaceResource = DSLComplexResource("diskspace", "MB/Hr", ContinuousCostPolicy, "")
- val BandwidthResource = DSLComplexResource("bandwidth", "MB/Hr", DiscreteCostPolicy, "")
- val DefaultResourcesMap = new DSLResourcesMap(VMTimeResource :: DiskspaceResource :: BandwidthResource :: Nil)
+ // 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 VMTimeResourceSim = StdVMTimeResourceSim.fromPolicy(DefaultPolicy)
+ val DiskspaceResourceSim = StdDiskspaceResourceSim.fromPolicy(DefaultPolicy)
+ val BandwidthResourceSim = StdBandwidthResourceSim.fromPolicy(DefaultPolicy)
// There are two client services, synnefo and pithos.
- val TheUIDGenerator = new ConcurrentVMLocalUIDGenerator
- val Synnefo = ClientServiceSim("synnefo")(TheUIDGenerator)
- val Pithos = ClientServiceSim("pithos")(TheUIDGenerator)
+ val TheUIDGenerator: UIDGenerator[_] = new ConcurrentVMLocalUIDGenerator
+ val Synnefo = ClientSim("synnefo")(TheUIDGenerator)
+ val Pithos = ClientSim("pithos" )(TheUIDGenerator)
+
+ val aquarium = AquariumInstance.withStoreProviderClass(classOf[MemStore])
+ Policy.withConfigurator(aquarium)
+ val StoreProvider = aquarium.storeProvider
+ val ResourceEventStore = StoreProvider.resourceEventStore
+
+ 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,
+ isActive = true,
+ credits = 0.0,
+ roleNames = List("user"),
+ agreementName = DSLAgreement.DefaultAgreementName
+ )
+
+ // 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.parentUserStateId
+ val credits = userState.creditsSnapshot.creditAmount
+ 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) = {
+ Computations.doFullMonthlyBilling(
+ UserCKKL.userId,
+ billingMonthInfo,
+ StoreProvider,
+ InitialUserState,
+ DefaultResourcesMap,
+ DefaultAccounting,
+ DefaultCompiler,
+ MonthlyBillingCalculation(billingMonthInfo),
+ Some(clog)
+ )
+ }
+
+ private[this]
+ def justUserState(userStateM: Maybe[UserState]): UserState = {
+ userStateM match {
+ case Just(userState) ⇒ userState
+ case _ ⇒ throw new AquariumException("Unexpected %s".format(userStateM))
+ }
+ }
+
+ private[this]
+ def expectCredits(clog: ContextualLogger,
+ creditsConsumed: Double,
+ userState: UserState,
+ accuracy: Double = 0.001): Unit = {
+ val computed = userState.creditsSnapshot.creditAmount
+ 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)
-// println("StartOfBillingYearDateCalc = %s".format(StartOfBillingYearDateCalc))
- val UserCreationDateCalc = StartOfBillingYearDateCalc.copy.goMinusMonths(2)
-// println("UserCreationDateCalc = %s".format(UserCreationDateCalc))
+ def testFullOnOff: Unit = {
+ val clog = ContextualLogger.fromOther(None, logger, "testFullOnOff()")
+ clog.begin()
- val computer = new UserStateComputations
+ ResourceEventStore.clearResourceEvents()
+ val OnOffDurationHrs = 10
+ val OnOffDurationMillis = hrs2millis(OnOffDurationHrs.toDouble)
- val mc = Configurator.MasterConfigurator.withStoreProviderClass(classOf[MemStore])
- Policy.withConfigurator(mc)
+ VMTimeInstanceSim.newONOFF(
+ new MutableDateCalc(2012, 01, 10).goPlusHours(13).goPlusMinutes(30).toDate, // 2012-01-10 13:30:00.000
+ OnOffDurationHrs
+ )
- val storeProvider = mc.storeProvider
- val userStateStore = storeProvider.userStateStore
- val resourceEventStore = storeProvider.resourceEventStore
- val policyStore = storeProvider.policyStore
+ val credits = DefaultAlgorithm.creditsForVMTime(OnOffDurationMillis)
- policyStore.storePolicyEntry(DefaultPolicy.toPolicyEntry)
+ showResourceEvents(clog)
- // A new user is created on 2012-01-15 00:00:00.000
- val UserCKKL = UserSim("CKKL", UserCreationDateCalc.toDate, storeProvider.resourceEventStore)
+ val userState = doFullMonthlyBilling(clog, BillingMonthInfoJan)
- // By convention
- // - synnefo is for VMTime and Bandwidth
- // - pithos is for Diskspace
- val VMTimeInstance = Synnefo.newVMTime (UserCKKL, "VM.1")
- val BandwidthInstance = Synnefo.newBandwidth(UserCKKL, "3G.1")
- val DiskInstance = Pithos .newDiskspace(UserCKKL, "DISK.1")
+ 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)
+
+ showUserState(clog, userState)
+
+ expectCredits(clog, credits, userState)
+
+ clog.end()
+ }
+
+// @Ignore
+ @Test
+ def testOrphanOFF: Unit = {
+ val clog = ContextualLogger.fromOther(None, logger, "testOrphanOFF()")
+ 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.newOFF(JanStartDate)
+
+ // This is an orphan event, so no credits will be charged
+ val credits = 0
+
+ showResourceEvents(clog)
+
+ val userState = doFullMonthlyBilling(clog, BillingMonthInfoJan)
+
+ 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)
-// println("vmStartDateCalc = %s".format(vmStartDateCalc))
- // 2012-01-16 01:00:00.000
- val vmStartDate = vmStartDateCalc.toDate
+ val VMStartDateCalc = StartOfBillingYearDateCalc.copy.goPlusDays(1).goPlusHours(1)
+ val VMStartDate = VMStartDateCalc.toDate
// Within January, create one VM ON-OFF ...
- val onOff1_M = VMTimeInstance.newONOFF(vmStartDate, 9)
+ VMTimeInstanceSim.newONOFF(VMStartDate, 9)
val diskConsumptionDateCalc = StartOfBillingYearDateCalc.copy.goPlusHours(3)
- // 2012-01-16 04:00:00.000
val diskConsumptionDate1 = diskConsumptionDateCalc.toDate
- // 2012-01-17 05:00:00.000
val diskConsumptionDateCalc2 = diskConsumptionDateCalc.copy.goPlusDays(1).goPlusHours(1)
val diskConsumptionDate2 = diskConsumptionDateCalc2.toDate
// ... and two diskspace changes
- val consume1_M = DiskInstance.consumeMB(diskConsumptionDate1, 99)
- val consume2_M = 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
- // 2012-02-07 07:07:07.007
- DiskInstance.consumeMB(
+ DiskInstanceSim.consumeMB(
StartOfBillingYearDateCalc.copy.
goNextMonth.goPlusDays(6).
goPlusHours(7).
goPlusMillis(7).toDate,
777)
- clog.debug("")
- clog.debug("=== Events by OccurredMillis ===")
- clog.withIndent {
- for(event <- UserCKKL.myResourceEventsByOccurredDate) {
- clog.debug(event.toDebugString(DefaultResourcesMap))
- }
- }
- clog.debug("=== Events by OccurredMillis ===")
- clog.debug("")
+ showResourceEvents(clog)
- val billingMonthInfo = BillingMonthInfo.fromDateCalc(StartOfBillingYearDateCalc)
+ // Policy: from 2012-01-01 to Infinity
- val userStateM = computer.doFullMonthlyBilling(
- UserCKKL.userId,
- billingMonthInfo,
- userStateStore,
- resourceEventStore,
- policyStore,
- UserCKKL.userCreationDate.getTime,
- computer.createFirstUserState(UserCKKL.userId),
- computer.createFirstUserState(UserCKKL.userId),
- DefaultPolicy,
- DefaultResourcesMap,
- new Accounting{},
- Just(clog)
- )
-
- clog.debug("userStateM = %s".format(userStateM))
- userStateM.forFailed { failed ⇒
- clog.error(failed)
- failed.exception.printStackTrace()
- NoVal
- }
+ clog.debugMap("DefaultResourcesMap", DefaultResourcesMap.map, 1)
+
+ val userState = doFullMonthlyBilling(clog, BillingMonthInfoJan)
+
+ showUserState(clog, userState)
+
+ clog.end()
}
}
\ No newline at end of file
projects / aquarium / blobdiff