-
-
Notifications
You must be signed in to change notification settings - Fork 8
Fail closed on conditional SafeDI scanning #297
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.
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
adam-zethraeus
wants to merge
1
commit into
dfed:main
Choose a base branch
from
adam-zethraeus:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -22,6 +22,16 @@ | |||||||||||||||||||||||||||
| /// All input file paths are relative to the working directory where the tool is invoked. | ||||||||||||||||||||||||||||
| /// Output file paths may be absolute or relative to the working directory. | ||||||||||||||||||||||||||||
| public struct SafeDIToolManifest: Codable, Sendable { | ||||||||||||||||||||||||||||
| private enum CodingKeys: String, CodingKey { | ||||||||||||||||||||||||||||
| case dependencyTreeGeneration | ||||||||||||||||||||||||||||
| case mockGeneration | ||||||||||||||||||||||||||||
| case configurationFilePaths | ||||||||||||||||||||||||||||
| case mockConfigurationOutputFilePath | ||||||||||||||||||||||||||||
| case additionalMocksToGenerate | ||||||||||||||||||||||||||||
| case additionalInputFiles | ||||||||||||||||||||||||||||
| case activeCompilationConditions | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| /// A mapping from an input Swift file to an output file. | ||||||||||||||||||||||||||||
| public struct InputOutputMap: Codable, Sendable { | ||||||||||||||||||||||||||||
| /// The path to the input Swift file containing one or more root `@Instantiable` declarations. | ||||||||||||||||||||||||||||
|
|
@@ -65,19 +75,37 @@ public struct SafeDIToolManifest: Codable, Sendable { | |||||||||||||||||||||||||||
| /// Only populated by the `scan` subcommand; ignored by `generate`. | ||||||||||||||||||||||||||||
| public var additionalInputFiles: [String] | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| /// Active conditional compilation flags used while scanning SafeDI declarations. | ||||||||||||||||||||||||||||
| public var activeCompilationConditions: [String] | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| public init( | ||||||||||||||||||||||||||||
| dependencyTreeGeneration: [InputOutputMap], | ||||||||||||||||||||||||||||
| mockGeneration: [InputOutputMap] = [], | ||||||||||||||||||||||||||||
| configurationFilePaths: [String] = [], | ||||||||||||||||||||||||||||
| mockConfigurationOutputFilePath: String? = nil, | ||||||||||||||||||||||||||||
| additionalMocksToGenerate: [String] = [], | ||||||||||||||||||||||||||||
| additionalInputFiles: [String] = [], | ||||||||||||||||||||||||||||
| activeCompilationConditions: [String] = [], | ||||||||||||||||||||||||||||
| ) { | ||||||||||||||||||||||||||||
| self.dependencyTreeGeneration = dependencyTreeGeneration | ||||||||||||||||||||||||||||
| self.mockGeneration = mockGeneration | ||||||||||||||||||||||||||||
| self.configurationFilePaths = configurationFilePaths | ||||||||||||||||||||||||||||
| self.mockConfigurationOutputFilePath = mockConfigurationOutputFilePath | ||||||||||||||||||||||||||||
| self.additionalMocksToGenerate = additionalMocksToGenerate | ||||||||||||||||||||||||||||
| self.additionalInputFiles = additionalInputFiles | ||||||||||||||||||||||||||||
| self.activeCompilationConditions = activeCompilationConditions | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| public init(from decoder: Decoder) throws { | ||||||||||||||||||||||||||||
| let container = try decoder.container(keyedBy: CodingKeys.self) | ||||||||||||||||||||||||||||
| self.init( | ||||||||||||||||||||||||||||
| dependencyTreeGeneration: try container.decode([InputOutputMap].self, forKey: .dependencyTreeGeneration), | ||||||||||||||||||||||||||||
| mockGeneration: try container.decodeIfPresent([InputOutputMap].self, forKey: .mockGeneration) ?? [], | ||||||||||||||||||||||||||||
| configurationFilePaths: try container.decodeIfPresent([String].self, forKey: .configurationFilePaths) ?? [], | ||||||||||||||||||||||||||||
| mockConfigurationOutputFilePath: try container.decodeIfPresent(String.self, forKey: .mockConfigurationOutputFilePath), | ||||||||||||||||||||||||||||
| additionalMocksToGenerate: try container.decodeIfPresent([String].self, forKey: .additionalMocksToGenerate) ?? [], | ||||||||||||||||||||||||||||
| additionalInputFiles: try container.decodeIfPresent([String].self, forKey: .additionalInputFiles) ?? [], | ||||||||||||||||||||||||||||
| activeCompilationConditions: try container.decodeIfPresent([String].self, forKey: .activeCompilationConditions) ?? [], | ||||||||||||||||||||||||||||
| ) | ||||||||||||||||||||||||||||
|
Comment on lines
+97
to
+109
Owner
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. same as above
Suggested change
|
||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
40 changes: 40 additions & 0 deletions
40
Sources/SafeDICore/Models/UnevaluableConditionalCompilationConditionError.swift
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| // Distributed under the MIT License | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in all | ||
| // copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| // SOFTWARE. | ||
|
|
||
| public struct UnevaluableConditionalCompilationConditionError: Error, CustomStringConvertible, Equatable, Sendable { | ||
| public let condition: String | ||
| public let suggestedActiveCondition: String? | ||
|
|
||
| public init( | ||
| condition: String, | ||
| suggestedActiveCondition: String? = nil, | ||
| ) { | ||
| self.condition = condition | ||
| self.suggestedActiveCondition = suggestedActiveCondition | ||
| } | ||
|
|
||
| public var description: String { | ||
| if let suggestedActiveCondition { | ||
| "Unable to evaluate conditional compilation condition `\(condition)` while scanning SafeDI declarations. Pass the active condition to SafeDITool with `--active-compilation-conditions \(suggestedActiveCondition)`, or remove the SafeDI declaration from the conditional branch." | ||
| } else { | ||
| "Unable to evaluate conditional compilation condition `\(condition)` while scanning SafeDI declarations. SafeDITool can only evaluate boolean literals, `!`, `&&`, `||`, parentheses, and active custom compilation conditions while scanning SafeDI declarations." | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can remove. build artifacts are hermetic per SafeDI version. no need for custom decoding. breaking changes to the format are fine.