DCPERF-747 Add Investment.Builder

atlassian-labs · Nov 25, 2024 · 2030313 · 2030313
1 parent 4caa2b2
commit 2030313
Show file tree

Hide file tree

Showing 7 changed files with 73 additions and 24 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -23,6 +23,9 @@ Dropping a requirement of a major version of a dependency is a new contract.
 ## [Unreleased]
 [Unreleased]: https://github.com/atlassian-labs/aws-resources/compare/release-1.17.0...master
 
+### Added
+- Add `Investment.Builder`
+
 ## [1.17.0] - 2024-06-14
 [1.17.0]: https://github.com/atlassian-labs/aws-resources/compare/release-1.16.0...release-1.17.0
 

diff --git a/src/main/kotlin/com/atlassian/performance/tools/aws/api/Aws.kt b/src/main/kotlin/com/atlassian/performance/tools/aws/api/Aws.kt
@@ -111,12 +111,13 @@ class Aws private constructor(
 
     private val shortTermStorage: ProvisionedStack by lazy {
         StackFormula(
-            investment = Investment(
+            investment = Investment.Builder(
                 useCase = "Transport files necessary to run the tests",
-                reuseKey = { "jpt-short-term-storage" },
-                lifespan = Duration.ofDays(30),
-                disposable = false
-            ),
+                lifespan = Duration.ofDays(30)
+            )
+            .disposable(false)
+            .reuseKey { "jpt-short-term-storage" }
+            .build(),
             cloudformationTemplate = readResourceText("aws/short-term-storage.yaml"),
             parameters = listOf(
                 Parameter().withParameterKey("PermissionBoundaryPolicyARN")
@@ -130,12 +131,13 @@ class Aws private constructor(
 
     private val customDatasetStorage: ProvisionedStack by lazy {
         StackFormula(
-            investment = Investment(
+            investment = Investment.Builder(
                 useCase = "Store custom datasets",
-                reuseKey = { "jpt-custom-datasets-storage" },
-                lifespan = Duration.ofDays(800),
-                disposable = false
-            ),
+                lifespan = Duration.ofDays(800)
+            )
+            .disposable(false)
+            .reuseKey { "jpt-custom-datasets-storage" }
+            .build(),
             cloudformationTemplate = readResourceText("aws/custom-datasets-storage.yaml"),
             aws = this
         ).provision()

diff --git a/src/main/kotlin/com/atlassian/performance/tools/aws/api/Investment.kt b/src/main/kotlin/com/atlassian/performance/tools/aws/api/Investment.kt
@@ -19,7 +19,17 @@ import com.amazonaws.services.ec2.model.Tag as Ec2Tag
  * @param reuseKey if a new investment would have the same reuse key as an existing investment, the old one can be
  *                 reused, reducing the cost
  */
-data class Investment(
+data class Investment
+@Deprecated(
+    message = "Use Builder instead. Constructor will be be made private in the next major version.",
+    replaceWith = ReplaceWith(
+        expression = "Investment.Builder(useCase = useCase, lifespan = lifespan)" +
+            ".disposable(disposable)" +
+            ".reuseKey(reuseKey)" +
+            ".build()"
+    )
+)
+constructor(
     private val useCase: String,
     val lifespan: Duration,
     private val disposable: Boolean = true,
@@ -66,6 +76,42 @@ data class Investment(
         }
     }
 
+    /**
+     * Describes an investment:
+     * - value proposition
+     * - cost factors
+     * - accountability tracking
+     *
+     * @param useCase the value proposition for the investment
+     * @param lifespan pessimistic estimate of the duration of the investment, higher values mean higher cost
+     */
+    class Builder(
+        private val useCase: String,
+        private val lifespan: Duration
+    ) {
+        private var disposable: Boolean = true
+        private var reuseKey: () -> String = { "jpt-${UUID.randomUUID()}" }
+
+        /**
+         * @param disposable if true, then the investment can be cancelled even before [lifespan] and get its cost reduced
+         */
+        fun disposable(disposable: Boolean) = apply { this.disposable = disposable }
+        /**
+         * @param reuseKey if a new investment would have the same reuse key as an existing investment, the old one can be
+         *                 reused, reducing the cost
+         */
+        fun reuseKey(reuseKey: () -> String) = apply { this.reuseKey = reuseKey }
+
+        fun build(): Investment {
+            return Investment(
+                useCase = useCase,
+                lifespan = lifespan,
+                disposable = disposable,
+                reuseKey = reuseKey
+            )
+        }
+    }
+
     companion object TagKeys {
         const val lifespanKey = "lifespan"
         private const val expiryKey = "expiry"

diff --git a/src/main/kotlin/com/atlassian/performance/tools/aws/api/ami/SshAmiMod.kt b/src/main/kotlin/com/atlassian/performance/tools/aws/api/ami/SshAmiMod.kt
@@ -32,15 +32,12 @@ class SshAmiMod private constructor(
 
     private val useCase = sshInstanceMod.useCase
 
-    private val amiInvestment = Investment(
-        useCase = useCase,
-        lifespan = amiLifespan
-    )
+    private val amiInvestment = Investment.Builder(useCase, amiLifespan).build()
     private val expectedImageSavingTime = Duration.ofMinutes(6)
-    private val instanceInvestment = Investment(
+    private val instanceInvestment = Investment.Builder(
         useCase = useCase,
         lifespan = sshInstanceMod.expectedDuration + expectedImageSavingTime
-    )
+    ).build()
 
     /**
      * If the [amiCache] finds an AMI matching [sshInstanceMod] and [amiProvider], it will be reused.

diff --git a/src/test/kotlin/com/atlassian/performance/tools/aws/AwsIT.kt b/src/test/kotlin/com/atlassian/performance/tools/aws/AwsIT.kt
@@ -20,11 +20,12 @@ import java.util.*
 
 class AwsIT {
 
-    private val investment = Investment(
+    private val investment = Investment.Builder(
         useCase = "Test aws-resources library",
-        lifespan = Duration.ofMinutes(5),
-        disposable = true
+        lifespan = Duration.ofMinutes(5)
     )
+    .disposable(true)
+    .build()
     private val workspace = Files.createTempDirectory("AwsIT-")
     private val awsPrefix = "aws-resources-test-"
 

diff --git a/src/test/kotlin/com/atlassian/performance/tools/aws/api/StackFormulaTest.kt b/src/test/kotlin/com/atlassian/performance/tools/aws/api/StackFormulaTest.kt
@@ -21,10 +21,10 @@ class StackFormulaTest {
     @Timeout(5, unit = SECONDS)
     fun shouldNotHang() {
         val formula = StackFormula(
-            investment = Investment(
+            investment = Investment.Builder(
                 useCase = "Unit test the StackFormula",
-                lifespan = Duration.ofMinutes(1)
-            ),
+                lifespan = Duration.ofMinutes(1))
+                .build(),
             aws = FakeAws.awsForUnitTests(
                 batchingCloudformationRefreshPeriod = Duration.ofMillis(100),
                 credentialsProvider = MissingCredentialsProvider()

diff --git a/src/test/kotlin/com/atlassian/performance/tools/aws/api/ami/SshAmiModIT.kt b/src/test/kotlin/com/atlassian/performance/tools/aws/api/ami/SshAmiModIT.kt
@@ -39,7 +39,7 @@ class SshAmiModIT {
         val newImageId = sshAmiMod.provideAmiId(aws)
 
         // then
-        val investment = Investment(echo.useCase, Duration.ofMinutes(10))
+        val investment = Investment.Builder(echo.useCase, Duration.ofMinutes(10)).build()
         val prefix = investment.reuseKey()
         val sshKey = SshKeyFormula(aws.ec2, createTempDirectory(prefix), prefix, investment.lifespan).provision()
         aws.awaitingEc2.allocateInstance(investment, sshKey, vpcId = null) { launch ->