regression: Fix property expansion of "recipe.preproc.macros" #2268
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously the undefined template placeholders in "recipe.preproc.macros" were silently replaced the empty string. This changed after a refactoring in 0585435. Previously it was: arduino@0585435#diff-371f93465ca5a66f01cbe876348f67990750091d27a827781c8633456b93ef3bL62 - cmd, err := builder_utils.PrepareCommandForRecipe(buildProperties, "recipe.preproc.macros", true, ctx.PackageManager.GetEnvVarsForSpawnedProcess()) The `true` parameter in the call to `builder_utils.PrepareCommandForRecipe` is the parameter `removeUnsetProperties`. This behaviour has not been ported over after the "refactoring": arduino@0585435#diff-733dda6759fe968eb8a8d7305c37c7a320a8df52764ca0cba8e88a6f1d077eb5R44-R65 + const gccPreprocRecipeProperty = "recipe.preproc.macros" + if gccBuildProperties.Get(gccPreprocRecipeProperty) == "" { + // autogenerate preprocess macros recipe from compile recipe + preprocPattern := gccBuildProperties.Get("recipe.cpp.o.pattern") + // add {preproc.macros.flags} to {compiler.cpp.flags} + preprocPattern = strings.Replace(preprocPattern, "{compiler.cpp.flags}", "{compiler.cpp.flags} {preproc.macros.flags}", 1) + // replace "{object_file}" with "{preprocessed_file_path}" + preprocPattern = strings.Replace(preprocPattern, "{object_file}", "{preprocessed_file_path}", 1) + + gccBuildProperties.Set(gccPreprocRecipeProperty, preprocPattern) + } + + pattern := gccBuildProperties.Get(gccPreprocRecipeProperty) + if pattern == "" { + return nil, nil, errors.Errorf(tr("%s pattern is missing"), gccPreprocRecipeProperty) + } + + commandLine := gccBuildProperties.ExpandPropsInString(pattern) + args, err := properties.SplitQuotedString(commandLine, `"'`, false) + if err != nil { + return nil, nil, err + } that is missing the call to `properties.DeleteUnexpandedPropsFromString`.
cmaglie
added
priority: high
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## master #2268 +/- ##
=======================================
Coverage 62.95% 62.95%
=======================================
Files 220 220
Lines 19546 19547 +1
=======================================
+ Hits 12305 12306 +1
Misses 6151 6151
Partials 1090 1090
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Sentry. |
alessio-perugini
approved these changes
Aug 18, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
See how to contribute
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)configuration.schema.jsonupdated if new parameters are added.What kind of change does this PR introduce?
Previously the undefined template placeholders in
recipe.preproc.macroswere silently replaced by the empty string. This changed after a refactoring in 0585435.Previously it was:
0585435#diff-371f93465ca5a66f01cbe876348f67990750091d27a827781c8633456b93ef3bL62
- cmd, err := builder_utils.PrepareCommandForRecipe(buildProperties, "recipe.preproc.macros", true, ctx.PackageManager.GetEnvVarsForSpawnedProcess())The
trueparameter in the call tobuilder_utils.PrepareCommandForRecipeis the parameterremoveUnsetProperties.This behavior has not been ported over after the "refactoring": 0585435#diff-733dda6759fe968eb8a8d7305c37c7a320a8df52764ca0cba8e88a6f1d077eb5R44-R65
that is completely missing the call to
properties.DeleteUnexpandedPropsFromString.What is the current behavior?
The old behavior for property expansion of "recipe.preproc.macros" is not preserved. See #2267 for details.
What is the new behavior?
The old behavior for property expansion of "recipe.preproc.macros" is restored.
Does this PR introduce a breaking change, and is titled accordingly?
No
Other information
The regression has been introduced in #2194.
Fix #2261