Pivotal ID # 185786866: Simple automated performance test

.gitlab-ci.yml

@@ -79,6 +79,8 @@ fire-itest:
   needs: [ "nfs-itest" ]
   stage: fire-itest
   script: gradle clean :submission:submission-webapp:itest -PenableFire=true --rerun-tasks --stacktrace
+  variables:
+    ITEST_FIXED_DELAY: "50"
 
 fire-caos-itest:
   needs: [ "fire-itest" ]

submission/submission-webapp/src/itest/kotlin/ac/uk/ebi/biostd/itest/itest/ITestListener.kt

@@ -108,6 +108,7 @@ class ITestListener : TestExecutionListener {
         private const val ftpUser = "ftpUser"
         private const val ftpPassword = "ftpPassword"
 
+        internal const val fixedDelayEnv = "ITEST_FIXED_DELAY"
         internal val nfsSubmissionPath = testAppFolder.createDirectory("submission")
         internal val fireSubmissionPath = testAppFolder.createDirectory("submission-fire")
         internal val firePath = testAppFolder.createDirectory("fire-db")
@@ -159,11 +160,13 @@ class ITestListener : TestExecutionListener {
 
         private fun createFireApiMock(s3MockContainer: S3MockContainer): WireMockServer {
             val factor = System.getenv(failFactorEnv)?.toInt()
+            val delay = System.getenv(fixedDelayEnv)?.toLong() ?: 0L
             val transformer = newTransformer(
                 subFolder = fireSubmissionPath.toPath(),
                 ftpFolder = fireFtpPath.toPath(),
                 dbFolder = firePath.toPath(),
                 failFactor = factor,
+                fixedDelay = delay,
                 httpEndpoint = s3MockContainer.httpEndpoint,
                 defaultBucket = defaultBucket
             )

submission/submission-webapp/src/itest/kotlin/ac/uk/ebi/biostd/itest/test/submission/submit/SubmissionPerformanceTest.kt

@@ -0,0 +1,73 @@
+package ac.uk.ebi.biostd.itest.test.submission.submit
+
+import ac.uk.ebi.biostd.client.integration.commons.SubmissionFormat
+import ac.uk.ebi.biostd.client.integration.web.BioWebClient
+import ac.uk.ebi.biostd.common.config.FilePersistenceConfig
+import ac.uk.ebi.biostd.itest.common.SecurityTestService
+import ac.uk.ebi.biostd.itest.entities.SuperUser
+import ac.uk.ebi.biostd.itest.itest.ITestListener.Companion.fixedDelayEnv
+import ac.uk.ebi.biostd.itest.itest.ITestListener.Companion.tempFolder
+import ac.uk.ebi.biostd.itest.itest.getWebClient
+import ebi.ac.uk.dsl.tsv.line
+import ebi.ac.uk.dsl.tsv.tsv
+import ebi.ac.uk.io.ext.createFile
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.jupiter.api.BeforeAll
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.condition.EnabledIfEnvironmentVariable
+import org.junit.jupiter.api.condition.EnabledIfSystemProperty
+import org.junit.jupiter.api.extension.ExtendWith
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.test.context.SpringBootTest
+import org.springframework.boot.test.web.server.LocalServerPort
+import org.springframework.context.annotation.Import
+import org.springframework.test.context.junit.jupiter.SpringExtension
+import kotlin.time.ExperimentalTime
+import kotlin.time.measureTime
+
+@OptIn(ExperimentalTime::class)
+@Import(FilePersistenceConfig::class)
+@ExtendWith(SpringExtension::class)
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
+class SubmissionPerformanceTest(
+    @Autowired val securityTestService: SecurityTestService,
+    @LocalServerPort val serverPort: Int,
+) {
+    private lateinit var webClient: BioWebClient
+
+    @BeforeAll
+    fun init() {
+        securityTestService.ensureUserRegistration(SuperUser)
+        webClient = getWebClient(serverPort, SuperUser)
+    }
+
+    @Test
+    @EnabledIfEnvironmentVariable(named = fixedDelayEnv, matches = "\\d+")
+    @EnabledIfSystemProperty(named = "enableFire", matches = "true")
+    fun `test with many files`() {
+        val files = 100
+        val delay = System.getenv(fixedDelayEnv).toLong()
+
+        val subFiles = (1..files).map { tempFolder.createFile("$it.txt") }
+        webClient.uploadFiles(subFiles)
+
+        val performanceSubmission = tsv {
+            line("Submission", "SPER-1")
+            line("Title", "Performance Submission")
+            line()
+
+            line("Study")
+            line()
+
+            line("Files")
+            subFiles.forEach { line(it.name) }
+            line()
+        }.toString()
+
+        val executionTime = measureTime { webClient.submitSingle(performanceSubmission, SubmissionFormat.TSV) }
+
+        // Execution time is bounded by 9 times the delay on each Fire operation
+        val expectedTime = (9.0 * (files * delay)).toLong()
+        assertThat(executionTime.inWholeMilliseconds).isLessThan(expectedTime)
+    }
+}

submission/submission-webapp/src/itest/kotlin/ac/uk/ebi/biostd/itest/wiremock/TestWireMockTransformer.kt

@@ -27,6 +27,7 @@ import kotlin.random.Random
 
 class TestWireMockTransformer constructor(
     private val failFactor: Int?,
+    private val fixedDelay: Long,
     private val handlers: List<RequestHandler>,
 ) : ResponseDefinitionTransformer() {
     override fun getName(): String = Companion.name
@@ -37,6 +38,7 @@ class TestWireMockTransformer constructor(
         files: FileSource?,
         parameters: Parameters?,
     ): ResponseDefinition {
+        Thread.sleep(fixedDelay)
         return failIfApply()
             ?: handlers.firstOrNull { it.urlPattern.matches(rqt.url) && it.method == rqt.method }?.handleSafely(rqt)
             ?: throw WebClientException(HttpStatus.BAD_REQUEST, "http method ${rqt.method.name} is not supported")
@@ -57,6 +59,7 @@ class TestWireMockTransformer constructor(
             ftpFolder: Path,
             dbFolder: Path,
             failFactor: Int?,
+            fixedDelay: Long,
             httpEndpoint: String,
             defaultBucket: String,
         ): TestWireMockTransformer {
@@ -66,6 +69,7 @@ class TestWireMockTransformer constructor(
 
             return TestWireMockTransformer(
                 failFactor,
+                fixedDelay,
                 listOf(
                     Md5QueryHandler(fireDatabase),
                     FileSaveHandler(fireDatabase),