Skip to content

Commit 3d0cec6

Browse files
adietishadietish
committed
fix: dont trash the document when removing clutter (redhat-developer#818)
Signed-off-by: Andre Dietisheim <[email protected]>
1 parent c089bae commit 3d0cec6

File tree

7 files changed

+294
-27
lines changed

7 files changed

+294
-27
lines changed

‎src/main/kotlin/com/redhat/devtools/intellij/kubernetes/editor/EditorResourceSerialization.kt

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
package com.redhat.devtools.intellij.kubernetes.editor
1212

1313
import com.intellij.json.JsonFileType
14-
import com.intellij.openapi.editor.Document
1514
import com.intellij.openapi.fileTypes.FileType
1615
import com.redhat.devtools.intellij.kubernetes.model.util.ResourceException
1716
import com.redhat.devtools.intellij.kubernetes.model.util.createResource
@@ -26,10 +25,20 @@ object EditorResourceSerialization {
2625
private const val RESOURCE_SEPARATOR_JSON = ",\n"
2726

2827
/**
29-
* Returns a [HasMetadata] for a given [Document] instance.
28+
* Returns a list of [HasMetadata] for a given yaml or json string.
29+
* Several resources are only supported for yaml file type. Trying to deserialize ex. json that would result
30+
* in several resources throws a [ResourceException].
3031
*
31-
* @param jsonYaml serialized resources
32-
* @return [HasMetadata] for the given editor and clients
32+
* @param jsonYaml string representing kubernetes resources
33+
* @param fileType yaml- or json file type (no other types are supported)
34+
* @param currentNamespace the namespace to set to the resulting resources if they have none
35+
* @return list of [HasMetadata] for the given yaml or json string
36+
* @throws ResourceException if several resources are to be deserialized to a non-yaml filetype
37+
*
38+
* @see isSupported
39+
* @see RESOURCE_SEPARATOR_YAML
40+
* @see YAMLFileType.YML
41+
* @see JsonFileType.INSTANCE
3342
*/
3443
fun deserialize(jsonYaml: String?, fileType: FileType?, currentNamespace: String?): List<HasMetadata> {
3544
return if (jsonYaml == null
@@ -64,25 +73,27 @@ object EditorResourceSerialization {
6473
return resource
6574
}
6675

67-
fun serialize(resources: Collection<HasMetadata>, fileType: FileType?): String? {
76+
fun serialize(resources: List<HasMetadata>, fileType: FileType?): String? {
6877
if (fileType == null) {
6978
return null
7079
}
71-
if (resources.size >=2 && fileType != YAMLFileType.YML) {
80+
if (resources.size >= 2
81+
&& fileType != YAMLFileType.YML) {
7282
throw UnsupportedOperationException(
7383
"${fileType.name} is not supported for multi-resource documents. Only ${YAMLFileType.YML.name} is.")
7484
}
7585
return resources
7686
.mapNotNull { resource -> serialize(resource, fileType) }
77-
.joinToString(RESOURCE_SEPARATOR_YAML)
87+
.joinToString("\n")
88+
7889
}
7990

8091
private fun serialize(resource: HasMetadata, fileType: FileType): String? {
8192
return when(fileType) {
8293
YAMLFileType.YML ->
8394
Serialization.asYaml(resource).trim()
8495
JsonFileType.INSTANCE ->
85-
Serialization.asYaml(resource).trim()
96+
Serialization.asJson(resource).trim()
8697
else -> null
8798
}
8899
}

‎src/main/kotlin/com/redhat/devtools/intellij/kubernetes/editor/ResourceEditor.kt

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ open class ResourceEditor(
5151
// for mocking purposes
5252
private val createResources: (string: String?, fileType: FileType?, currentNamespace: String?) -> List<HasMetadata> =
5353
EditorResourceSerialization::deserialize,
54-
private val serialize: (resources: Collection<HasMetadata>, fileType: FileType?) -> String? =
54+
private val serialize: (resources: List<HasMetadata>, fileType: FileType?) -> String? =
5555
EditorResourceSerialization::serialize,
5656
// for mocking purposes
5757
private val createResourceFileForVirtual: (file: VirtualFile?) -> ResourceFile? =
@@ -165,7 +165,7 @@ open class ResourceEditor(
165165
}
166166
}
167167

168-
private fun replaceDocument(resources: Collection<HasMetadata>): Boolean {
168+
private fun replaceDocument(resources: List<HasMetadata>): Boolean {
169169
val manager = getPsiDocumentManager.invoke(project)
170170
val document = getDocument.invoke(editor) ?: return false
171171
val jsonYaml = serialize.invoke(resources, getFileType(document, manager)) ?: return false
@@ -269,17 +269,20 @@ open class ResourceEditor(
269269
}
270270

271271
fun removeClutter() {
272-
val resources = editorResources.getAllResources().map { resource ->
272+
val resources = createResources(
273+
getDocument(editor),
274+
editor.file.fileType) // don't insert namespace if not present (no namespace param)
275+
val cleaned = resources.map { resource ->
273276
MetadataClutter.remove(resource.metadata)
274277
resource
275278
}
276279
runInUI {
277-
replaceDocument(resources)
280+
replaceDocument(cleaned)
278281
notifications.hideAll()
279282
}
280283
}
281284

282-
private fun createResources(document: Document?, fileType: FileType?, namespace: String?): List<HasMetadata> {
285+
private fun createResources(document: Document?, fileType: FileType?, namespace: String? = null): List<HasMetadata> {
283286
return createResources.invoke(
284287
document?.text,
285288
fileType,

‎src/test/kotlin/com/redhat/devtools/intellij/kubernetes/editor/EditorResourceSerializationTest.kt

Lines changed: 252 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,252 @@
1+
/*******************************************************************************
2+
* Copyright (c) 2025 Red Hat, Inc.
3+
* Distributed under license by Red Hat, Inc. All rights reserved.
4+
* This program is made available under the terms of the
5+
* Eclipse Public License v2.0 which accompanies this distribution,
6+
* and is available at http://www.eclipse.org/legal/epl-v20.html
7+
*
8+
* Contributors:
9+
* Red Hat, Inc. - initial API and implementation
10+
******************************************************************************/
11+
package com.redhat.devtools.intellij.kubernetes.editor
12+
13+
import com.intellij.json.JsonFileType
14+
import com.intellij.openapi.fileTypes.PlainTextFileType
15+
import com.redhat.devtools.intellij.kubernetes.model.mocks.ClientMocks.resource
16+
import com.redhat.devtools.intellij.kubernetes.model.util.ResourceException
17+
import io.fabric8.kubernetes.api.model.Pod
18+
import io.fabric8.kubernetes.client.utils.Serialization
19+
import org.assertj.core.api.Assertions.assertThat
20+
import org.assertj.core.api.Assertions.assertThatThrownBy
21+
import org.jetbrains.yaml.YAMLFileType
22+
import org.junit.Test
23+
24+
class EditorResourceSerializationTest {
25+
26+
@Test
27+
fun `#deserialize return empty list if it is given null yaml`() {
28+
// given
29+
// when
30+
val result = EditorResourceSerialization.deserialize(null, YAMLFileType.YML, "dagobah")
31+
// then
32+
assertThat(result).isEmpty()
33+
}
34+
35+
@Test
36+
fun `#deserialize returns a list of resources if given multi-resource YAML`() {
37+
// given
38+
val yaml = """
39+
apiVersion: v1
40+
kind: Pod
41+
metadata:
42+
name: yoda
43+
---
44+
apiVersion: v1
45+
kind: Service
46+
metadata:
47+
name: luke
48+
""".trimIndent()
49+
// when
50+
val result = EditorResourceSerialization.deserialize(yaml, YAMLFileType.YML, "dagobah")
51+
// then
52+
assertThat(result)
53+
.hasSize(2)
54+
.extracting("kind")
55+
.containsExactly("Pod", "Service")
56+
}
57+
58+
@Test
59+
fun `#deserialize throws if given multiple json resources`() {
60+
// given
61+
val json = """
62+
{"apiVersion": "v1", "kind": "Pod"}
63+
---
64+
{"apiVersion": "v1", "kind": "Service"}
65+
""".trimIndent()
66+
67+
assertThatThrownBy {
68+
// when
69+
EditorResourceSerialization.deserialize(json, JsonFileType.INSTANCE, "test")
70+
// then
71+
}.isInstanceOf(ResourceException::class.java)
72+
}
73+
74+
@Test
75+
fun `#deserialize returns a list with a single resource if given valid JSON with a single resource`() {
76+
// given
77+
val json = """
78+
{
79+
"apiVersion": "v1",
80+
"kind": "Pod",
81+
"metadata": {
82+
"name": "obiwan"
83+
}
84+
}
85+
""".trimIndent()
86+
// when
87+
val result = EditorResourceSerialization.deserialize(json, JsonFileType.INSTANCE, "test")
88+
// then
89+
assertThat(result)
90+
.singleElement()
91+
.extracting("kind")
92+
.isEqualTo("Pod")
93+
}
94+
95+
@Test
96+
fun `#deserialize sets the current namespace to the resulting resource if it has no namespace`() {
97+
// given
98+
val yaml = """
99+
apiVersion: v1
100+
kind: Pod
101+
metadata:
102+
name: has-no-namespace
103+
""".trimIndent()
104+
// when
105+
val result = EditorResourceSerialization.deserialize(yaml, YAMLFileType.YML, "namespace-that-should-be-set")
106+
// then
107+
assertThat(result)
108+
.first()
109+
.extracting { it.metadata.namespace }
110+
.isEqualTo("namespace-that-should-be-set")
111+
}
112+
113+
@Test
114+
fun `#deserialize only sets the current namespace to the resources that have no namespace`() {
115+
// given
116+
val yaml = """
117+
apiVersion: v1
118+
kind: Pod
119+
metadata:
120+
name: has-no-namespace
121+
---
122+
apiVersion: v1
123+
kind: Pod
124+
metadata:
125+
name: has-a-namespace
126+
namespace: alderaan
127+
""".trimIndent()
128+
// when
129+
val result = EditorResourceSerialization.deserialize(
130+
yaml, YAMLFileType.YML, "namespace-that-should-be-set"
131+
)
132+
// then
133+
assertThat(result)
134+
.satisfiesExactly(
135+
{ assertThat(it.metadata.namespace).isEqualTo("namespace-that-should-be-set") }, // namespace set
136+
{ assertThat(it.metadata.namespace).isEqualTo("alderaan") } // no namespace set
137+
)
138+
}
139+
140+
@Test
141+
fun `#deserialize does not change namespace in the resulting resource if it has a namespace`() {
142+
// given
143+
val yaml = """
144+
apiVersion: v1
145+
kind: Pod
146+
metadata:
147+
name: yoda
148+
namespace: has-a-namespace
149+
""".trimIndent()
150+
// when
151+
val result = EditorResourceSerialization.deserialize(yaml, YAMLFileType.YML, null) // no namespace provided
152+
// then
153+
assertThat(result)
154+
.first()
155+
.extracting { it.metadata.namespace }
156+
.isEqualTo("has-a-namespace")
157+
}
158+
159+
@Test
160+
fun `#deserialize throws if given invalid yaml`() {
161+
// given
162+
val invalidYaml = """
163+
apiVersion: v1
164+
kind: Pod
165+
metadata: invalid
166+
""".trimIndent()
167+
assertThatThrownBy {
168+
// when
169+
EditorResourceSerialization.deserialize(invalidYaml, YAMLFileType.YML, "dagobah")
170+
// then
171+
}.isInstanceOf(ResourceException::class.java)
172+
}
173+
174+
@Test
175+
fun `#serialize returns null if given null file type`() {
176+
// given
177+
val resource = resource<Pod>("darth vader")
178+
// when
179+
val result = EditorResourceSerialization.serialize(listOf(resource), null)
180+
// then
181+
assertThat(result)
182+
.isNull()
183+
}
184+
185+
@Test
186+
fun `#serialize throws if given multiple resources and non-YAML file type`() {
187+
// given
188+
val resources = listOf(
189+
resource<Pod>("darth vader"),
190+
resource<Pod>("emperor")
191+
)
192+
assertThatThrownBy {
193+
// when
194+
EditorResourceSerialization.serialize(resources, JsonFileType.INSTANCE)
195+
// then
196+
}.isInstanceOf(UnsupportedOperationException::class.java)
197+
}
198+
199+
@Test
200+
fun `#serialize returns correct YAML if given single resource and YAML file type`() {
201+
// given
202+
val resource = resource<Pod>("obiwan")
203+
val expected = Serialization.asYaml(resource).trim()
204+
// when
205+
val result = EditorResourceSerialization.serialize(listOf(resource), YAMLFileType.YML)
206+
//then
207+
assertThat(result)
208+
.isEqualTo(expected)
209+
}
210+
211+
@Test
212+
fun `#serialize returns multiple YAML resources joined with newline if given 2 resources and YAML file type`() {
213+
// given
214+
val resources = listOf(
215+
resource<Pod>("leia"),
216+
resource<Pod>("luke")
217+
)
218+
val expected = resources
219+
.joinToString("\n") {
220+
Serialization.asYaml(it).trim()
221+
}
222+
// when
223+
val result = EditorResourceSerialization.serialize(resources, YAMLFileType.YML)
224+
// then
225+
assertThat(result)
226+
.isEqualTo(expected)
227+
}
228+
229+
@Test
230+
fun `#serialize returns JSON if given JSON file type`() {
231+
// given
232+
val resource = resource<Pod>("obiwan")
233+
val expected = Serialization.asJson(resource).trim()
234+
// when
235+
val result = EditorResourceSerialization.serialize(listOf(resource), JsonFileType.INSTANCE)
236+
// then
237+
assertThat(result)
238+
.isEqualTo(expected)
239+
}
240+
241+
@Test
242+
fun `#serialize returns null if given unsupported file type`() {
243+
// given
244+
val resource = resource<Pod>("leia")
245+
// when
246+
val result = EditorResourceSerialization.serialize(listOf(resource), PlainTextFileType.INSTANCE)
247+
// then
248+
assertThat(result)
249+
.isEqualTo("")
250+
}
251+
252+
}

‎src/test/kotlin/com/redhat/devtools/intellij/kubernetes/editor/ResourceEditorTest.kt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,10 @@ class ResourceEditorTest {
116116
private val createResources: (string: String?, fileType: FileType?, currentNamespace: String?) -> List<HasMetadata> =
117117
mock<(string: String?, fileType: FileType?, currentNamespace: String?) -> List<HasMetadata>>()
118118
private val editorResources: EditorResources = mock()
119-
private val serialize: (resources: Collection<HasMetadata>, fileType: FileType?) -> String? =
120-
mock<(resources: Collection<HasMetadata>, fileType: FileType?) -> String?>().apply {
119+
private val serialize: (resources: List<HasMetadata>, fileType: FileType?) -> String? =
120+
mock<(resources: List<HasMetadata>, fileType: FileType?) -> String?>().apply {
121121
doAnswer { invocation ->
122-
val resources = invocation.getArgument<Collection<HasMetadata>>(0)
122+
val resources = invocation.getArgument<List<HasMetadata>>(0)
123123
EditorResourceSerialization.serialize(resources, YAMLFileType.YML)
124124
}.whenever(this).invoke(any(), any())
125125
}
@@ -546,6 +546,7 @@ class ResourceEditorTest {
546546
// then
547547
verify(notifications).hideAll()
548548
}
549+
549550
@Test
550551
fun `#isEditing should return true if there is an EditorResource with the given resource`() {
551552
// given
@@ -629,7 +630,7 @@ class ResourceEditorTest {
629630
resourceModel: IResourceModel,
630631
project: Project,
631632
createResources: (string: String?, fileType: FileType?, currentNamespace: String?) -> List<HasMetadata>,
632-
serialize: (resources: Collection<HasMetadata>, fileType: FileType?) -> String?,
633+
serialize: (resources: List<HasMetadata>, fileType: FileType?) -> String?,
633634
resourceFileForVirtual: (file: VirtualFile?) -> ResourceFile?,
634635
notifications: Notifications,
635636
documentProvider: (FileEditor) -> Document?,

0 commit comments

Comments
 (0)