fix: Replace SwiftPM dependency with local Version type #1684
Conversation
| @@ -18,15 +18,6 @@ | |||
| "version" : "1.3.1" | |||
| } | |||
| }, | |||
There was a problem hiding this comment.
Bye bye, useless dependencies
| try testRunner.run(process) | ||
| return nil | ||
| } | ||
| #endif |
There was a problem hiding this comment.
Adding this code fixes this process runner so that it can be mocked with a test runner. Note that when the behavior is mocked, the returned output is nil; output may be mocked as well in the future if desired.
| } | ||
| } | ||
|
|
||
| extension Version: CustomStringConvertible { |
There was a problem hiding this comment.
Like the previous Version, this struct provides the version string when printed.
|
|
||
| // MARK: - Decodable |
There was a problem hiding this comment.
The struct below replaces the one that was previously imported from the SwiftPM package.
|
|
||
| // MARK: - Codable | ||
|
|
||
| extension Version: Codable { |
There was a problem hiding this comment.
Version encodes & decodes itself by encoding/decoding its version string.
| 0, | ||
| prereleaseIdentifiers: prereleaseIdentifiers, | ||
| buildMetadataIdentifiers: buildMetadataIdentifiers | ||
| 0 |
There was a problem hiding this comment.
Prerelease & build metadata identifiers are removed, since our project does not use them.
| self.minor = minor | ||
| self.patch = patch | ||
| } | ||
|
|
There was a problem hiding this comment.
Note that creating a Version from a string is now a non-optional initializer that throws if the string is not a valid semantic version identifier.
| @@ -16,10 +16,10 @@ class GeneratePackageManifestTests: CLITestCase { | |||
| func createPackageDependencies( | |||
| crtVersion: String, | |||
| clientRuntimeVersion: String | |||
There was a problem hiding this comment.
Below, many tests have been marked with throws since creating a Version from a string is now a throwing operation.
Issue #
#1683
Description of changes
The
AWSSDKSwiftCLIproject requires theSwiftPMpackage as a dependency. One ofSwiftPM's dependencies,swift-llbuild, has been causing failures of preview builds because of issues with symlinked folders in the project.A review of the
SwiftPMdependency shows that is is used exclusively for access to theVersionstructure, which represents a semantic version specifier.To simplify the project and lighten its dependencies (including the specific dependency that is causing preview build failures), the
SwiftPMpackage is removed as a dependency and aVersionstructure is provided in its place.The
Versionstructure represents a major, minor, and patch version. It does not accept versions that do not include all three values, and it does not accept preprelease identifiers that are allowed by the semver standard. However, this is sufficient for the current manner in which the project is versioned.All
AWSSDKSwiftCLItests pass with this change. (They previously froze because of an issue with testing Process invocations. This PR fixes the_runReturningStdOut()function so that it may be mocked with a test runner.)I have also tested this change by running the
prepare-releaseCLI command on my desktop, and observing the changes made to the project and the change log that was generated.New/existing dependencies impact assessment, if applicable
No new dependencies were added to this change.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.