diff mbox series

[v2] cmd: setexpr: fix no matching string in gsub return empty value

Message ID 20240208145827.3547501-1-massimiliano.minella@gmail.com
State Accepted
Commit 4c7363068651f222be6150050bb3aa9823ca6f78
Delegated to: Tom Rini
Headers show
Series [v2] cmd: setexpr: fix no matching string in gsub return empty value | expand

Commit Message

Massimiliano Minella Feb. 8, 2024, 2:58 p.m. UTC 
From: Massimiliano Minella <massimiliano.minella@se.com>

In gsub, when the destination string is empty, the string 't' is
provided and the regular expression doesn't match, then the final result
is an empty string.

Example:

=> echo ${foo}

=> setenv foo
=> setexpr foo gsub e a bar
=> echo ${foo}

=>

The variable ${foo} should contain "bar" and the lack of match shouldn't
be considered an error.

This patch fixes the erroneous behavior by removing the return
statement and breaking out of the loop in case of lack of match.

Also add a test for the no match case.

Signed-off-by: Massimiliano Minella <massimiliano.minella@se.com>
---
Changes in V2:
 - update documentation to describe the behavior

 cmd/setexpr.c             |  9 ++++-----
 doc/usage/cmd/setexpr.rst |  1 +
 test/cmd/setexpr.c        | 10 ++++++++++
 3 files changed, 15 insertions(+), 5 deletions(-)

Comments

Tom Rini March 4, 2024, 3:28 p.m. UTC | #1 
On Thu, Feb 08, 2024 at 03:58:27PM +0100, Massimiliano Minella wrote:

> From: Massimiliano Minella <massimiliano.minella@se.com>
> 
> In gsub, when the destination string is empty, the string 't' is
> provided and the regular expression doesn't match, then the final result
> is an empty string.
> 
> Example:
> 
> => echo ${foo}
> 
> => setenv foo
> => setexpr foo gsub e a bar
> => echo ${foo}
> 
> =>
> 
> The variable ${foo} should contain "bar" and the lack of match shouldn't
> be considered an error.
> 
> This patch fixes the erroneous behavior by removing the return
> statement and breaking out of the loop in case of lack of match.
> 
> Also add a test for the no match case.
> 
> Signed-off-by: Massimiliano Minella <massimiliano.minella@se.com>

Applied to u-boot/next, thanks!
diff mbox series

Patch

diff --git a/cmd/setexpr.c b/cmd/setexpr.c
index 233471f6cb..ab76824a32 100644
--- a/cmd/setexpr.c
+++ b/cmd/setexpr.c
@@ -216,14 +216,12 @@  int setexpr_regex_sub(char *data, uint data_size, char *nbuf, uint nbuf_size,
 		if (res == 0) {
 			if (loop == 0) {
 				debug("%s: No match\n", data);
-				return 1;
 			} else {
-				break;
+				debug("## MATCH ## %s\n", data);
 			}
+			break;
 		}
 
-		debug("## MATCH ## %s\n", data);
-
 		if (!s)
 			return 1;
 
@@ -540,7 +538,8 @@  U_BOOT_CMD(
 	"    - For each substring matching the regular expression <r> in the\n"
 	"      string <t>, substitute the string <s>.  The result is\n"
 	"      assigned to <name>.  If <t> is not supplied, use the old\n"
-	"      value of <name>\n"
+	"      value of <name>. If no substring matching <r> is found in <t>,\n"
+	"      assign <t> to <name>.\n"
 	"setexpr name sub r s [t]\n"
 	"    - Just like gsub(), but replace only the first matching substring"
 #endif
diff --git a/doc/usage/cmd/setexpr.rst b/doc/usage/cmd/setexpr.rst
index d245a13ca8..593a0ea91e 100644
--- a/doc/usage/cmd/setexpr.rst
+++ b/doc/usage/cmd/setexpr.rst
@@ -39,6 +39,7 @@  setexpr name gsub <r> <s> [<t>]
      string <t>, substitute the string <s>.
      The result is assigned to <name>.
      If <t> is not supplied, use the old value of <name>.
+     If no substring matching <r> is found in <t>, assign <t> to <name>.
 
 setexpr name sub <r> <s> [<t>]
      Just like gsub(), but replace only the first matching substring
diff --git a/test/cmd/setexpr.c b/test/cmd/setexpr.c
index 312593e1e3..ee329e94b8 100644
--- a/test/cmd/setexpr.c
+++ b/test/cmd/setexpr.c
@@ -179,6 +179,16 @@  static int setexpr_test_regex(struct unit_test_state *uts)
 	val = env_get("mary");
 	ut_asserteq_str("this is a test", val);
 
+	/* No match */
+	ut_assertok(run_command("setenv fred 'this is a test'", 0));
+	ut_assertok(run_command("setenv mary ''", 0));
+	ut_assertok(run_command("setexpr fred gsub us is \"${fred}\"", 0));
+	ut_assertok(run_command("setexpr mary gsub us is \"${fred}\"", 0));
+	val = env_get("fred");
+	ut_asserteq_str("this is a test", val);
+	val = env_get("mary");
+	ut_asserteq_str("this is a test", val);
+
 	unmap_sysmem(buf);
 
 	return 0;