Skip to content

std.Build.Step.ConfigHeader: handle undefined keys and values correctly #24014

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
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

std.Build.Step.ConfigHeader: handle undefined keys and values correctly #24014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d7fc36
std.Build.Step.ConfigHeader: handle undefined keys and values correctly
Jan200101 May 29, 2025
0a162a6
test: add undefined values to cmakedefine tests
Jan200101 May 29, 2025
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
27 changes: 12 additions & 15 deletions lib/std/Build/Step/ConfigHeader.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -693,7 +693,7 @@ fn expand_variables_cmake(
}

const key = contents[curr + 1 .. close_pos];
const value = values.get(key) orelse return error.MissingValue;
const value = values.get(key) orelse .undef;
const missing = contents[source_offset..curr];
try result.appendSlice(missing);
switch (value) {
Expand Down Expand Up @@ -748,10 +748,7 @@ fn expand_variables_cmake(

const key_start = open_pos.target + open_var.len;
const key = result.items[key_start..];
if (key.len == 0) {
return error.MissingKey;
}
const value = values.get(key) orelse return error.MissingValue;
const value = values.get(key) orelse .undef;
result.shrinkRetainingCapacity(result.items.len - key.len - open_var.len);
switch (value) {
.undef, .defined => {},
Expand Down Expand Up @@ -952,8 +949,8 @@ test "expand_variables_cmake simple cases" {
// line with misc content is preserved
try testReplaceVariablesCMake(allocator, "no substitution", "no substitution", values);

// empty ${} wrapper leads to an error
try std.testing.expectError(error.MissingKey, testReplaceVariablesCMake(allocator, "${}", "", values));
// empty ${} wrapper is removed
try testReplaceVariablesCMake(allocator, "${}", "", values);

// empty @ sigils are preserved
try testReplaceVariablesCMake(allocator, "@", "@", values);
Expand Down Expand Up @@ -1016,9 +1013,9 @@ test "expand_variables_cmake simple cases" {
try testReplaceVariablesCMake(allocator, "undef@", "undef@", values);
try testReplaceVariablesCMake(allocator, "undef}", "undef}", values);

// unknown key leads to an error
try std.testing.expectError(error.MissingValue, testReplaceVariablesCMake(allocator, "@bad@", "", values));
try std.testing.expectError(error.MissingValue, testReplaceVariablesCMake(allocator, "${bad}", "", values));
// unknown key is removed
try testReplaceVariablesCMake(allocator, "@bad@", "", values);
try testReplaceVariablesCMake(allocator, "${bad}", "", values);
}

test "expand_variables_cmake edge cases" {
Expand Down Expand Up @@ -1063,17 +1060,17 @@ test "expand_variables_cmake edge cases" {
try testReplaceVariablesCMake(allocator, "@dollar@{@string@}", "${text}", values);

// when expanded variables contain invalid characters, they prevent further expansion
try std.testing.expectError(error.MissingValue, testReplaceVariablesCMake(allocator, "${${string_var}}", "", values));
try std.testing.expectError(error.MissingValue, testReplaceVariablesCMake(allocator, "${@string_var@}", "", values));
try testReplaceVariablesCMake(allocator, "${${string_var}}", "", values);
try testReplaceVariablesCMake(allocator, "${@string_var@}", "", values);

// nested expanded variables are expanded from the inside out
try testReplaceVariablesCMake(allocator, "${string${underscore}proxy}", "string", values);
try testReplaceVariablesCMake(allocator, "${string@underscore@proxy}", "string", values);

// nested vars are only expanded when ${} is closed
try std.testing.expectError(error.MissingValue, testReplaceVariablesCMake(allocator, "@nest@underscore@proxy@", "", values));
try testReplaceVariablesCMake(allocator, "@nest@underscore@proxy@", "underscore", values);
try testReplaceVariablesCMake(allocator, "${nest${underscore}proxy}", "nest_underscore_proxy", values);
try std.testing.expectError(error.MissingValue, testReplaceVariablesCMake(allocator, "@nest@@nest_underscore@underscore@proxy@@proxy@", "", values));
try testReplaceVariablesCMake(allocator, "@nest@@nest_underscore@underscore@proxy@@proxy@", "underscore", values);
try testReplaceVariablesCMake(allocator, "${nest${${nest_underscore${underscore}proxy}}proxy}", "nest_underscore_proxy", values);

// invalid characters lead to an error
Expand All @@ -1099,5 +1096,5 @@ test "expand_variables_cmake escaped characters" {
try testReplaceVariablesCMake(allocator, "$\\{string}", "$\\{string}", values);

// backslash is skipped when checking for invalid characters, yet it mangles the key
try std.testing.expectError(error.MissingValue, testReplaceVariablesCMake(allocator, "${string\\}", "", values));
try testReplaceVariablesCMake(allocator, "${string\\}", "", values);
}
18 changes: 12 additions & 6 deletions test/standalone/cmakedefine/config.h.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,16 @@

// @ substition

// no substition
// // undefined key, removed
// @undefvalue@

// no value, removed
// @noval@

// no substition
// no value, removed
// @noval@@noval@

// no substition
// no value, removed
// @noval@.@noval@

// 1
Expand Down Expand Up @@ -94,13 +97,16 @@
// test10
// @noval@@stringval@@trueval@@zeroval@

// no substition
// undefined key, removed
// ${undefvalue}

// no value, removed
// ${noval}

// no substition
// no value, removed
// ${noval}${noval}

// no substition
// no value, removed
// ${noval}.${noval}

// 1
Expand Down
18 changes: 12 additions & 6 deletions test/standalone/cmakedefine/expected_config.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,16 @@

// @ substition

// no substition
// // undefined key, removed
//

// no substition
// no value, removed
//

// no substition
// no value, removed
//

// no value, removed
// .

// 1
Expand Down Expand Up @@ -94,13 +97,16 @@
// test10
// test10

// no substition
// undefined key, removed
//

// no value, removed
//

// no substition
// no value, removed
//

// no substition
// no value, removed
// .

// 1
Expand Down
Loading