Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WOR-1373 Billing Project user feedback: Update cost groupings in ToA Billing Project spend report. #2708

Merged
merged 6 commits into from
Jan 31, 2024
Merged

WOR-1373 Billing Project user feedback: Update cost groupings in ToA Billing Project spend report. #2708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3b5d64c
WOR-1373 Billing Project user feedback: Update cost groupings in ToA …
sergiygetlin Jan 20, 2024
eadd7da
Update bpm client version for testing.
sergiygetlin Jan 22, 2024
6255722
Update tests.
sergiygetlin Jan 23, 2024
c99df49
Fix formatting.
sergiygetlin Jan 23, 2024
5f43b31
Add tests for TerraSpendCategories.
sergiygetlin Jan 24, 2024
4f5dcba
Set correct version of BPM client.
sergiygetlin Jan 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions core/src/main/scala/org/broadinstitute/dsde/rawls/model/SpendReportingModel.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,10 +153,11 @@ object TerraSpendCategories {
}

def withName(name: String): TerraSpendCategory = name.toLowerCase match {
case "storage" => Storage
case "compute" => Compute
case "other" => Other
case _ => throw new RawlsException(s"invalid TerraSpendCategory [${name}]")
case "storage" => Storage
case "compute" => Compute
case "other" => Other
case "workspaceinfrastructure" => WorkspaceInfrastructure
case _ => throw new RawlsException(s"invalid TerraSpendCategory [${name}]")
}

def categorize(service: String): TerraSpendCategory = service.toLowerCase.replace(" ", "") match {
Expand All @@ -166,6 +167,7 @@ object TerraSpendCategories {
case _ => Other
}

case object WorkspaceInfrastructure extends TerraSpendCategory
case object Storage extends TerraSpendCategory
case object Compute extends TerraSpendCategory
case object Other extends TerraSpendCategory
Expand Down
70 changes: 58 additions & 12 deletions core/src/test/scala/org/broadinstitute/dsde/rawls/model/SpendReportingModelSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@ import bio.terra.profile.model.SpendReport
import bio.terra.profile.model.SpendReportingForDateRange.CategoryEnum
import bio.terra.profile.model.{SpendReportingForDateRange => SpendReportingForDateRangeBPM}
import bio.terra.profile.model.{SpendReportingAggregation => SpendReportingAggregationBPM}
import org.broadinstitute.dsde.rawls.RawlsException
import org.joda.time.DateTime
import org.joda.time.format.ISODateTimeFormat
import org.scalatest.flatspec.AnyFlatSpecLike
import org.scalatest.matchers.must.Matchers.have
import org.scalatest.matchers.should.Matchers.{convertToAnyShouldWrapper, equal}
import org.scalatest.matchers.must.Matchers.{be, have}
import org.scalatest.matchers.should.Matchers.{an, convertToAnyShouldWrapper, equal}

import scala.jdk.CollectionConverters._

Expand Down Expand Up @@ -106,7 +107,11 @@ class SpendReportingModelSpec extends AnyFlatSpecLike {
val to = DateTime.now().plusMonths(1)
val computeCost: BigDecimal = 100.20
val storageCost: BigDecimal = 54.32
val categoriesCosts = Map(CategoryEnum.COMPUTE -> computeCost, CategoryEnum.STORAGE -> storageCost)
val k8sInfrastructureCost: BigDecimal = 75.15
val categoriesCosts = Map(CategoryEnum.COMPUTE -> computeCost,
CategoryEnum.STORAGE -> storageCost,
CategoryEnum.WORKSPACEINFRASTRUCTURE -> k8sInfrastructureCost
)
val someReport = TestData.someBPMNonEmptyReport(from, to, categoriesCosts)

val result = SpendReportingResults(someReport)
Expand All @@ -115,26 +120,32 @@ class SpendReportingModelSpec extends AnyFlatSpecLike {
result.spendSummary shouldNot equal(null)
result.spendSummary.cost shouldBe categoriesCosts.values.sum.toString()
result.spendDetails shouldNot equal(null)
result.spendDetails(0) shouldNot equal(null)
result.spendDetails(0).spendData should have size categoriesCosts.size
result.spendDetails.head shouldNot equal(null)
result.spendDetails.head.spendData should have size categoriesCosts.size

val computeDetails = result
.spendDetails(0)
.spendData
val computeDetails = result.spendDetails.head.spendData
.find(v => v.category.nonEmpty && v.category.get.equals(TerraSpendCategories.Compute))
computeDetails.nonEmpty shouldBe true
computeDetails.get.cost shouldBe computeCost.toString()
computeDetails.get.credits shouldBe TestData.defaultAzureCredits
computeDetails.get.currency shouldBe TestData.defaultCurrency
computeDetails.get.category.get shouldBe TerraSpendCategories.Compute

val storageDetails = result
.spendDetails(0)
.spendData
val storageDetails = result.spendDetails.head.spendData
.find(v => v.category.nonEmpty && v.category.get.equals(TerraSpendCategories.Storage))
storageDetails.nonEmpty shouldBe true
storageDetails.get.cost shouldBe storageCost.toString()
storageDetails.get.credits shouldBe TestData.defaultAzureCredits
storageDetails.get.currency shouldBe TestData.defaultCurrency
storageDetails.get.category.get shouldBe TerraSpendCategories.Storage

val k8sDetails = result.spendDetails.head.spendData
.find(v => v.category.nonEmpty && v.category.get.equals(TerraSpendCategories.WorkspaceInfrastructure))
k8sDetails.nonEmpty shouldBe true
k8sDetails.get.cost shouldBe k8sInfrastructureCost.toString()
k8sDetails.get.credits shouldBe TestData.defaultAzureCredits
k8sDetails.get.currency shouldBe TestData.defaultCurrency
k8sDetails.get.category.get shouldBe TerraSpendCategories.WorkspaceInfrastructure
}

behavior of "SpendReportingForDateRange conversion"
Expand Down Expand Up @@ -172,7 +183,11 @@ class SpendReportingModelSpec extends AnyFlatSpecLike {
it should "successfully convert BPM model for SpendReportingAggregation" in {
val computeCost: BigDecimal = 1000.20
val storageCost: BigDecimal = 900.32
val categoriesCosts = Map(CategoryEnum.COMPUTE -> computeCost, CategoryEnum.STORAGE -> storageCost)
val workspaceInfrastructureCost: BigDecimal = 2500.01
val categoriesCosts = Map(CategoryEnum.COMPUTE -> computeCost,
CategoryEnum.STORAGE -> storageCost,
CategoryEnum.WORKSPACEINFRASTRUCTURE -> workspaceInfrastructureCost
)

val spendReportingAggregationBPM = TestData.buildSpendReportingAggregation(categoriesCosts)
val result = SpendReportingAggregation(spendReportingAggregationBPM)
Expand All @@ -187,13 +202,44 @@ class SpendReportingModelSpec extends AnyFlatSpecLike {
computeCategory.get.cost shouldBe computeCost.toString()
computeCategory.get.credits shouldBe TestData.defaultAzureCredits
computeCategory.get.currency shouldBe TestData.defaultCurrency
computeCategory.get.category.get shouldBe TerraSpendCategories.Compute

val storageCategory =
result.spendData.find(sd => sd.category.nonEmpty && sd.category.get.equals(TerraSpendCategories.Storage))
storageCategory.nonEmpty shouldBe true
storageCategory.get.cost shouldBe storageCost.toString()
storageCategory.get.credits shouldBe TestData.defaultAzureCredits
storageCategory.get.currency shouldBe TestData.defaultCurrency
storageCategory.get.category.get shouldBe TerraSpendCategories.Storage

val workspaceInfrastructureCategory =
result.spendData.find(sd =>
sd.category.nonEmpty && sd.category.get.equals(TerraSpendCategories.WorkspaceInfrastructure)
)
workspaceInfrastructureCategory.nonEmpty shouldBe true
workspaceInfrastructureCategory.get.cost shouldBe workspaceInfrastructureCost.toString()
workspaceInfrastructureCategory.get.credits shouldBe TestData.defaultAzureCredits
workspaceInfrastructureCategory.get.currency shouldBe TestData.defaultCurrency
workspaceInfrastructureCategory.get.category.get shouldBe TerraSpendCategories.WorkspaceInfrastructure
}

behavior of "TerraSpendCategories mapping"

it should "convert correct string into specific category" in {
TerraSpendCategories.withName("compute") shouldBe TerraSpendCategories.Compute
TerraSpendCategories.withName("Compute") shouldBe TerraSpendCategories.Compute
TerraSpendCategories.withName("storage") shouldBe TerraSpendCategories.Storage
TerraSpendCategories.withName("Storage") shouldBe TerraSpendCategories.Storage
TerraSpendCategories.withName("other") shouldBe TerraSpendCategories.Other
TerraSpendCategories.withName("Other") shouldBe TerraSpendCategories.Other
TerraSpendCategories.withName("workspaceinfrastructure") shouldBe TerraSpendCategories.WorkspaceInfrastructure
TerraSpendCategories.withName("WorkspaceInfrastructure") shouldBe TerraSpendCategories.WorkspaceInfrastructure
}

it should "throw exception in case of invalid string representation of a category" in {
an[RawlsException] should be thrownBy TerraSpendCategories.withName("test")
an[RawlsException] should be thrownBy TerraSpendCategories.withName("ai")
an[RawlsException] should be thrownBy TerraSpendCategories.withName("unexpectedCategory")
}

}
2 changes: 1 addition & 1 deletion project/Dependencies.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ object Dependencies {
val workspaceManager = clientLibExclusions("bio.terra" % "workspace-manager-client" % "0.254.998-SNAPSHOT")
val dataRepo = clientLibExclusions("bio.terra" % "datarepo-jakarta-client" % "1.568.0-SNAPSHOT")
val resourceBufferService = clientLibExclusions("bio.terra" % "terra-resource-buffer-client" % "0.198.42-SNAPSHOT")
val billingProfileManager = clientLibExclusions("bio.terra" % "billing-profile-manager-client" % "0.1.502-SNAPSHOT")
val billingProfileManager = clientLibExclusions("bio.terra" % "billing-profile-manager-client" % "0.1.506-SNAPSHOT")
val terraCommonLib = tclExclusions(clientLibExclusions("bio.terra" % "terra-common-lib" % "0.1.9-SNAPSHOT" classifier "plain"))
val sam: ModuleID = clientLibExclusions("org.broadinstitute.dsde.workbench" %% "sam-client" % "0.1-70fda75")
val leonardo: ModuleID = "org.broadinstitute.dsde.workbench" % "leonardo-client_2.13" % "1.3.6-d0bf371"
Expand Down
Loading