Skip to content

fix(obligation): stop persisting tab chars in obligation text (#3214) #3765

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Flamki wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(obligation): stop persisting tab chars in obligation text (#3214) #3765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions libraries/datahandler/src/main/java/org/eclipse/sw360/datahandler/thrift/ThriftValidate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ public static void prepareTodo(Obligation oblig) throws SW360Exception {
assertNotNull(oblig.getTitle());
assertNotNull(oblig.getObligationLevel());

oblig.setText(normalizeObligationText(oblig.getText()));

if (oblig.whitelist == null) {
oblig.setWhitelist(Collections.emptySet());
}
Expand All @@ -64,6 +66,11 @@ public static void prepareTodo(Obligation oblig) throws SW360Exception {
oblig.setType(TYPE_OBLIGATION);
}

private static String normalizeObligationText(String text) {
// Store printable indentation only to avoid persisting tab control characters in DB text fields.
return text.replace('\t', ' ');
}

public static void prepareLicenseType(LicenseType licenseType) throws SW360Exception {
// Check required fields
assertNotNull(licenseType);
Expand Down
24 changes: 22 additions & 2 deletions ...es/datahandler/src/test/java/org/eclipse/sw360/datahandler/thrift/ThriftValidateTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,18 @@
package org.eclipse.sw360.datahandler.thrift;

import org.junit.Test;
import static org.eclipse.sw360.datahandler.common.SW360Constants.TYPE_USER;
import static org.junit.Assert.assertEquals;
import org.eclipse.sw360.datahandler.thrift.licenses.Obligation;
import org.eclipse.sw360.datahandler.thrift.licenses.ObligationLevel;
import org.eclipse.sw360.datahandler.thrift.users.User;

import static org.eclipse.sw360.datahandler.common.SW360Constants.TYPE_OBLIGATION;
import static org.eclipse.sw360.datahandler.common.SW360Constants.TYPE_USER;
import static org.eclipse.sw360.datahandler.thrift.ThriftValidate.prepareTodo;
import static org.eclipse.sw360.datahandler.thrift.ThriftValidate.prepareUser;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;

public class ThriftValidateTest {
final String DUMMY_EMAIL_ADDRESS = "dummy.name@dummy.domain.tld";
Expand All @@ -40,4 +45,19 @@ public void testPrepareUser() throws Exception {
assertEquals(TYPE_USER, user.getType());
assertFalse(user.isSetCommentMadeDuringModerationRequest());
}

@Test
public void testPrepareTodoNormalizesTabCharacters() throws Exception {
Obligation obligation = new Obligation();
obligation.setTitle("Test Obligation");
obligation.setText("Line1\n\tIndented\tsegment");
obligation.setObligationLevel(ObligationLevel.LICENSE_OBLIGATION);

prepareTodo(obligation);

assertEquals(TYPE_OBLIGATION, obligation.getType());
assertFalse(obligation.getText().contains("\t"));
assertEquals("Line1\n Indented segment", obligation.getText());
assertTrue(obligation.getWhitelist().isEmpty());
}
}