[5.9][ScanDependencies] Fix JSON generation under certain circunstances. #67265
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
The code of `ScanDependencies.cpp` was creating invalid JSON since apple#66031 because in the case of having `extraPcmArgs` and `swiftOverlayDependencies`, but not `bridgingHeader`, a comma will not be added at the end of `extraPcmArgs`, creating an invalid JSON file. Additionally that same PR added a trailing comma at the end of the `swiftOverlayDependencies`, which valid JSON does not allow, but that bug was removed in apple#66366. Both problems are, however, present in the 5.9 branch, because apple#66936 included apple#66031, but not apple#66366. Besides fixing the problem in `ScanDependencies.cpp` I modified every test that uses `--scan-dependencies` to pass the produced JSON through Python's `json.tool` in order to validate proper JSON is produced. In most cases I was able to pipe the output of the tool into `FileCheck`, but in some cases the validation is done by itself because the checks depend on the exact format generated by `--scan-dependencies`. In a couple of tests I added a call to `FileCheck` that seemed to be missing. Without these changes, two tests seems to be generating invalid JSON in my machine: - `ScanDependencies/local_cache_consistency.swift` (which outputs `Expecting ',' delimiter: line 525 column 11 (char 22799)`) - `ScanDependencies/placholder_overlay_deps.swift` Additional changes for the cherry-pick: - Removed some changes in some CAS tests that are not present in release/5.9. - Switch `trailingComma` from `true` to `false` for `swiftOverlayDependencies` similar to what apple#66366 did in `main`. - Remove the new `RUN` line in `optional_deps_of_testable_imports.swift` because it fails in 5.9 if the `CHECK` is performed. (cherry picked from commit 7de1089)
|
@swift-ci please test |
nkcsgexi
approved these changes
Jul 12, 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.
Cherry-pick of #67246
--scan-dependencies. It happens a couple of times in the test suite, and it happens organically when trying to--scan-dependenciesof all frameworks and modules in Xcode 15 betas SDKs.--scan-dependencies.Original commit message:
The code of
ScanDependencies.cppwas creating invalid JSON since #66031 because in the case of havingextraPcmArgsandswiftOverlayDependencies, but notbridgingHeader, a comma will not be added at the end ofextraPcmArgs, creating an invalid JSON file. Additionally that same PR added a trailing comma at the end of theswiftOverlayDependencies, which valid JSON does not allow, but that bug was removed in #66366.Both problems are, however, present in the 5.9 branch, because #66936 included #66031, but not #66366.
Besides fixing the problem in
ScanDependencies.cppI modified every test that uses--scan-dependenciesto pass the produced JSON through Python'sjson.toolin order to validate proper JSON is produced. In most cases I was able to pipe the output of the tool intoFileCheck, but in some cases the validation is done by itself because the checks depend on the exact format generated by--scan-dependencies. In a couple of tests I added a call toFileCheckthat seemed to be missing.Without these changes, two tests seems to be generating invalid JSON in my machine:
ScanDependencies/local_cache_consistency.swift(which outputsExpecting ',' delimiter: line 525 column 11 (char 22799))ScanDependencies/placholder_overlay_deps.swiftAdditional changes for the cherry-pick:
trailingCommafromtruetofalseforswiftOverlayDependenciessimilar to what [CAS] swift dependency scanning using CAS for compiler caching #66366 did inmain.RUNline inoptional_deps_of_testable_imports.swiftbecause it fails in 5.9 if theCHECKis performed.