[BUG] Editing a ConfigMap with `\n` or `\t` in the data field via `edit Config` results in `a line break is expected` error in the UI

[altulek]

Rancher Server Setup

• Rancher version: 2.7.6
• Installation option (Docker install/Helm Chart):
  • If Helm Chart, Kubernetes Cluster and version (RKE1, RKE2, k3s, EKS, etc):
• Proxy/Cert Details: n/a

Information about the Cluster

• Kubernetes version: 1.25.10
• Cluster Type (Local/Downstream): local

User Information

• What is the role of the user logged in? Admin/Cluster Owner/Cluster Member/Project Owner/Project Member/Custom

Describe the bug ConfigMap edit doesn't work properly when you are using "\t" (tabulator) character.

To Reproduce

1. Create new config map
2. key: a, value: a a b c <- with tab instead of space
3. key: b, value:a a b c <- with tab instead of space
4. save

Result Error: "a line break is expected" Expected Result Saved properly

Screenshots

Additional context The issue happens when values are saved as string. Rancher adds additional key into first data section.

[altulek]

It happened always when YAML data elements becomes a string. I Can see the same when I use "\r" char.

[slickwarren]

I can't reproduce this on rancher version v2.7.6. Here's what I've tried:

• import a yaml file with the following:

  apiVersion: v1
  data:
  a: a
  b:  b
  kind: ConfigMap
  metadata:
  name: ctw-testyml
  namespace: default
  annotations: {}
  labels: {}

• entering this manually in the configMap -> create -> edit as yaml option this was using tab instead of spaces. Can you perhaps add an example configMap.yaml that is causing the problem (before it is created on the rancher side)?

[altulek]

You can try this one:

apiVersion: v1
data:
  a: "a\nb\tc"
  b: "a\nb\tc"
kind: ConfigMap
metadata:
  name: yaml-tab-test

After saving this yaml I can't save it again through "Edit Config". After I chose "Edit Config" -> "Edit as YAML" data section looks like this:

data:
  b: |+a: |+a: "a\nb\tc"
  b: "a\nb\tc"

I think that new line also is necessary to trigger this error.

[slickwarren]

repro steps:

• deploy the following yaml on any cluster using the import yaml function

  apiVersion: v1
  data:
  a: "a\nb\tc"
  b: "a\nb\tc"
  kind: ConfigMap
  metadata:
  name: yaml-tab-test

• edit the configMap via configMaps -> use the ... dropdown on the configmap -> edit Config
  • intermediate step to view problem - once edit as form is loaded, switch to edit as yaml, this will show that the UI added |+a: |+a: to the yaml, however if you do not do view as yaml first, the resource creation is not caught before erroring out the whole page with the screenshot mentioned by the user
• save the changes user is hit with the error screen shown in the original comment

tested on v2.7.6 and v2.8.0-alpha2

[altulek]

Caused by rancher/rancher#7670. Same as in [BUG] configmap formatting breaking on creation/edit rancher/dashboard#10066 It seems that https://github.com/nodeca/js-yaml doesen't work properly.

[gaktive]

Internal reference: SURE-7246

[hhstu]

内部参考：SURE-7246

can we get any help? @gaktive

[mohag]

Also see rancher/dashboard#10067

[richard-cox]

~https://github.com/rancher/dashboard/issues/10067 should be tackled at the same time as this. If it's the same issue can be closed as a duplicate~ Closed instead after reviewing description

[richard-cox]

/backport v2.7.next1

[nwmac]

@rak-phillip Is it possible to write automated tests for this?

[rak-phillip]

@nwmac Of course we can! We wrote tests in both #10179 & #10178 that address this area of dashboard. Are there any specific cases that we would like to see represented here?

[nwmac]

@rak-phillip I'm just looking for tests that test the changes in the PR for this issue - it looks like https://github.com/rancher/dashboard/pull/10168/files# has a unit test - if that is sufficient, then we should move this to QA Review, rather than To Test.

Have we got enough that we don't need any manual test for the fix for this bug?

[rak-phillip]

@nwmac I've moved to QA Review. I think that the test covers in such a way we'll prevent regressions of this type in the future. Behavior should remain unchanged otherwise.

[rak-phillip]

/backport v2.8.next1

[izaac]

Manual validation would complement any automation coverage before closing, let's move to To Test @yonasberhe23

[gaktive]

Since this was tested in 2.7.next1 & 2.8.next1 and marked done, I'll defer to QA whether this needs to be retested or if automation was in fact built up in the other tix.

[aalves08]

@gaktive @nwmac can SURE-7246 be closed in light of this issue status?

[LaoZhang-best]

this issue closed in 2.7.11, 2.7.12, but this version is non public

[richard-cox]

@LaoZhang-best This specific issue is for 2.9.0 which is the next minor release. It looks like it was also shipped in 2.8.3 which is the current minor release and is available to the community. Patch versions of a previous minor release (2.7) are for rancher prime customers and we would recommend community uses upgrade to the current minor release (2.8)