fix: remove header output from mutations and insertion endpoints

GenSpectrum · Dec 14, 2023 · ffd6b55 · ffd6b55
1 parent 05c198e
commit ffd6b55
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 0 deletions.
diff --git a/lapis2/src/main/kotlin/org/genspectrum/lapis/response/LapisResponse.kt b/lapis2/src/main/kotlin/org/genspectrum/lapis/response/LapisResponse.kt
@@ -1,5 +1,6 @@
 package org.genspectrum.lapis.response
 
+import com.fasterxml.jackson.annotation.JsonIgnore
 import io.swagger.v3.oas.annotations.media.Schema
 import org.genspectrum.lapis.controller.CsvRecord
 
@@ -24,6 +25,7 @@ data class NucleotideMutationResponse(
 ) : CsvRecord {
     override fun asArray() = arrayOf(mutation, count.toString(), proportion.toString())
 
+    @JsonIgnore
     override fun getHeader() = arrayOf("mutation", "count", "proportion")
 }
 
@@ -45,6 +47,7 @@ data class AminoAcidMutationResponse(
 ) : CsvRecord {
     override fun asArray() = arrayOf(mutation, count.toString(), proportion.toString())
 
+    @JsonIgnore
     override fun getHeader() = arrayOf("mutation", "count", "proportion")
 }
 
@@ -64,6 +67,7 @@ data class NucleotideInsertionResponse(
 ) : CsvRecord {
     override fun asArray() = arrayOf(insertion, count.toString())
 
+    @JsonIgnore
     override fun getHeader() = arrayOf("insertion", "count")
 }
 
@@ -82,5 +86,6 @@ data class AminoAcidInsertionResponse(
 ) : CsvRecord {
     override fun asArray() = arrayOf(insertion, count.toString())
 
+    @JsonIgnore
     override fun getHeader() = arrayOf("insertion", "count")
 }
diff --git a/lapis2/src/test/kotlin/org/genspectrum/lapis/controller/LapisControllerTest.kt b/lapis2/src/test/kotlin/org/genspectrum/lapis/controller/LapisControllerTest.kt
@@ -1,5 +1,6 @@
 package org.genspectrum.lapis.controller
 
+import com.fasterxml.jackson.databind.ObjectMapper
 import com.fasterxml.jackson.databind.node.IntNode
 import com.fasterxml.jackson.databind.node.TextNode
 import com.ninjasquad.springmockk.MockkBean
@@ -16,6 +17,9 @@ import org.genspectrum.lapis.response.DetailsData
 import org.genspectrum.lapis.response.NucleotideInsertionResponse
 import org.genspectrum.lapis.response.NucleotideMutationResponse
 import org.genspectrum.lapis.silo.DataVersion
+import org.hamcrest.MatcherAssert.assertThat
+import org.hamcrest.Matchers.containsInAnyOrder
+import org.hamcrest.Matchers.hasSize
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.params.ParameterizedTest
@@ -236,6 +240,23 @@ class LapisControllerTest(
             )
     }
 
+    @ParameterizedTest(name = "GET {0} only returns mutation, proportion and count")
+    @MethodSource("getMutationEndpoints")
+    fun `GET mutations only returns mutation, proportion and count`(endpoint: String) {
+        setupMutationMock(endpoint, null)
+
+        val mvcResult = mockMvc.perform(get("$endpoint?country=Switzerland"))
+            .andExpect(status().isOk)
+            .andReturn()
+
+        val response = ObjectMapper().readValue(mvcResult.response.contentAsString, Map::class.java)
+        val data = response["data"] as List<*>
+        val firstDataObject = data[0] as Map<*, *>
+
+        assertThat(firstDataObject.keys, hasSize(3))
+        assertThat(firstDataObject.keys, containsInAnyOrder("mutation", "proportion", "count"))
+    }
+
     private fun setupMutationMock(
         endpoint: String,
         minProportion: Double?,
@@ -294,6 +315,23 @@ class LapisControllerTest(
             .andExpect(jsonPath("\$.info.dataVersion").value(1234))
     }
 
+    @ParameterizedTest(name = "GET {0} only returns mutation, proportion and count")
+    @MethodSource("getInsertionEndpoints")
+    fun `GET insertions only returns insertion and count`(endpoint: String) {
+        setupInsertionMock(endpoint)
+
+        val mvcResult = mockMvc.perform(get("$endpoint?country=Switzerland"))
+            .andExpect(status().isOk)
+            .andReturn()
+
+        val response = ObjectMapper().readValue(mvcResult.response.contentAsString, Map::class.java)
+        val data = response["data"] as List<*>
+        val firstDataObject = data[0] as Map<*, *>
+
+        assertThat(firstDataObject.keys, hasSize(2))
+        assertThat(firstDataObject.keys, containsInAnyOrder("insertion", "count"))
+    }
+
     private fun setupInsertionMock(endpoint: String) {
         when (endpoint) {
             NUCLEOTIDE_INSERTIONS_ROUTE -> {