feat: Smoke Tests V2 #1791
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| // | ||
|
There was a problem hiding this comment. Separate subcommand for generating package manifest for SmokeTests module. |
||
| // Copyright Amazon.com Inc. or its affiliates. | ||
| // All Rights Reserved. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
|
|
||
| import ArgumentParser | ||
| import Foundation | ||
| import AWSCLIUtils | ||
|
|
||
| struct GenerateSmokeTestsPackageManifestCommand: ParsableCommand { | ||
| static var configuration = CommandConfiguration( | ||
| commandName: "generate-smoke-tests-package-manifest", | ||
| abstract: "Generates the Package.swift manifest for the aws-sdk-swift/SmokeTests package." | ||
| ) | ||
|
|
||
| @Argument(help: "The path to the aws-sdk-swift repository") | ||
| var repoPath: String | ||
|
|
||
| func run() throws { | ||
| let generateSmokeTestsPackageManifest = GenerateSmokeTestsPackageManifest( | ||
| repoPath: repoPath | ||
| ) | ||
| try generateSmokeTestsPackageManifest.run() | ||
| } | ||
| } | ||
|
|
||
| struct GenerateSmokeTestsPackageManifest { | ||
| /// The path to the package repository | ||
| let repoPath: String | ||
|
|
||
| func run() throws { | ||
| try FileManager.default.changeWorkingDirectory(repoPath) | ||
| // Generate package manifest for smoke tests and save it as aws-sdk-swift/SmokeTests/Package.swift | ||
| let smokeTestsContents = try generateSmokeTestsPackageManifestContents() | ||
| try savePackageManifest(smokeTestsContents) | ||
| } | ||
|
|
||
| // MARK: - Helpers | ||
|
|
||
| func generateSmokeTestsPackageManifestContents() throws -> String { | ||
| return [ | ||
| // SmokeTests package manifest uses same prefix as one for aws-sdk-swift. | ||
| try PackageManifestBuilder.contentReader(filename: "Package.Prefix")(), | ||
| try generateServiceNamesArray(), | ||
| try PackageManifestBuilder.contentReader(filename: "SmokeTestsPackage.Base")() | ||
| ].joined(separator: .newline) | ||
| } | ||
|
|
||
| func generateServiceNamesArray() throws -> String { | ||
| let servicesWithSmokeTests = try FileManager.default.servicesWithSmokeTests() | ||
| let formatedServiceList = servicesWithSmokeTests.map { "\t\"\($0)\"," }.joined(separator: .newline) | ||
| return [ | ||
| "// All services that have smoke tests generated for them.", | ||
| "let serviceNames: [String] = [", | ||
| formatedServiceList, | ||
| "]" | ||
| ].joined(separator: .newline) | ||
| } | ||
|
|
||
| func savePackageManifest(_ contents: String) throws { | ||
| let packageFilePath = "SmokeTests/Package.swift" | ||
| log("Saving package manifest to \(packageFilePath)...") | ||
| try contents.write( | ||
| toFile: packageFilePath, | ||
| atomically: true, | ||
| encoding: .utf8 | ||
| ) | ||
| log("Successfully saved package manifest to \(packageFilePath)") | ||
| } | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| // MARK: - Static Content | ||
|
There was a problem hiding this comment. The static content of package manifest. The only generated content, which comes right before this, is |
||
|
|
||
| extension Target.Dependency { | ||
| // AWS runtime module | ||
| static var awsClientRuntime: Self { .product(name: "AWSClientRuntime", package: "aws-sdk-swift") } | ||
| // Smithy runtime module | ||
| static var clientRuntime: Self { .product(name: "ClientRuntime", package: "smithy-swift") } | ||
| } | ||
|
|
||
| let package = Package( | ||
| name: "SmokeTests", | ||
| platforms: [ | ||
| .macOS(.v10_15) | ||
| ], | ||
| products: serviceNames.map(productForRunner(_:)), | ||
| dependencies: [ | ||
| .package(path: "../../smithy-swift"), | ||
| .package(path: "../../aws-sdk-swift") | ||
| ], | ||
| targets: serviceNames.map(targetForRunner(_:)) | ||
| ) | ||
|
|
||
| // MARK: - Helper functions | ||
|
|
||
| private func productForRunner(_ serviceName: String) -> Product { | ||
| .executable(name: "\(serviceName)SmokeTestRunner", targets: ["\(serviceName)SmokeTestRunner"]) | ||
| } | ||
|
|
||
| private func targetForRunner(_ serviceName: String) -> Target { | ||
| .executableTarget( | ||
| name: "\(serviceName)SmokeTestRunner", | ||
| dependencies: [ | ||
| .clientRuntime, | ||
| .awsClientRuntime, | ||
| .product(name: "\(serviceName)", package: "aws-sdk-swift") | ||
| ], | ||
| path: "\(serviceName)SmokeTestRunner" | ||
| ) | ||
| } | ||
Empty file.
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| package software.amazon.smithy.aws.swift.codegen | ||
|
There was a problem hiding this comment. Extends generic smoke test generator in smithy-swift. Overrides methods to provide AWS specific logic. |
||
|
|
||
| import software.amazon.smithy.aws.traits.ServiceTrait | ||
| import software.amazon.smithy.model.node.ObjectNode | ||
| import software.amazon.smithy.swift.codegen.SwiftWriter | ||
| import software.amazon.smithy.swift.codegen.integration.ProtocolGenerator | ||
| import software.amazon.smithy.swift.codegen.integration.SmokeTestGenerator | ||
| import software.amazon.smithy.swift.codegen.utils.toUpperCamelCase | ||
|
|
||
| class AWSSmokeTestGenerator( | ||
| private val ctx: ProtocolGenerator.GenerationContext | ||
| ) : SmokeTestGenerator(ctx) { | ||
| // Filter out tests by name or tag at codegen time. | ||
| // Each element must have the prefix "<service-name>:" before the test name or tag name. | ||
| // E.g., "AWSS3:GetObjectTest" or "AWSS3:BucketTests" | ||
| override val smokeTestIdsToIgnore = setOf<String>( | ||
| // Add smoke test name to ignore here: | ||
| // E.g., "AWSACM:GetCertificateFailure", | ||
| ) | ||
| override val smokeTestTagsToIgnore = setOf<String>( | ||
| // Add smoke test tag to ignore here: | ||
| // E.g., "AWSACM:TagToIgnore", | ||
| ) | ||
|
|
||
| override fun getServiceName(): String { | ||
| return "AWS" + ctx.service.getTrait(ServiceTrait::class.java).get().sdkId.toUpperCamelCase() | ||
| } | ||
|
|
||
| override fun getClientName(): String { | ||
| return ctx.service.getTrait(ServiceTrait::class.java).get().sdkId.toUpperCamelCase().removeSuffix("Service") + "Client" | ||
| } | ||
|
|
||
| override fun renderCustomFilePrivateVariables(writer: SwiftWriter) { | ||
| writer.write("fileprivate let regionFromEnv = ProcessInfo.processInfo.environment[\"AWS_SMOKE_TEST_REGION\"]") | ||
| writer.write("fileprivate let tagsToSkip = (ProcessInfo.processInfo.environment[\"AWS_SMOKE_TEST_SKIP_TAGS\"] ?? \"\").components(separatedBy: \",\")") | ||
| } | ||
|
|
||
| override fun handleVendorParams(vendorParams: ObjectNode, writer: SwiftWriter) { | ||
| val nameToValueMappings = getFormattedVendorParams(vendorParams) | ||
| nameToValueMappings.forEach { mapping -> | ||
| writer.write("config.${mapping.key} = ${mapping.value}") | ||
| } | ||
| } | ||
|
|
||
| // Converts trait definition vendor param key:value pairs to Swift SDK config field:value pairs. | ||
| private fun getFormattedVendorParams(vendorParams: ObjectNode): Map<String, String> { | ||
| val formattedMapping = mutableMapOf<String, String>() | ||
| vendorParams.members.forEach { originalMapping -> | ||
| when (originalMapping.key.value) { | ||
| /* BaseAwsVendorParams members */ | ||
| "region" -> { | ||
| // Take region value retrieved from environment variable if present; otherwise, take from trait definition. | ||
| val regionValue = "regionFromEnv ?? \"${originalMapping.value.expectStringNode().value}\"" | ||
| formattedMapping.put("region", regionValue) | ||
| formattedMapping.put("signingRegion", regionValue) | ||
| } | ||
| "sigv4aRegionSet" -> { /* no-op; setting multiple signing regions in config is unsupported atm. */ } | ||
| "uri" -> { formattedMapping.put("endpoint", "\"${originalMapping.value.expectStringNode().value}\"") } | ||
| "useFips" -> { formattedMapping.put("useFIPS", originalMapping.value.expectBooleanNode().value.toString()) } | ||
| "useDualstack" -> { formattedMapping.put("useDualStack", originalMapping.value.expectBooleanNode().value.toString()) } | ||
| "useAccountIdRouting" -> { /* no-op; setting account ID routing in config is unsupported atm. */ } | ||
|
|
||
| /* S3VendorParams members */ | ||
| "useAccelerate" -> { formattedMapping.put("accelerate", originalMapping.value.expectBooleanNode().value.toString()) } | ||
| "useMultiRegionAccessPoints" -> { | ||
| // Name for corresponding config in Swift SDK is: `disableMultiRegionAccessPoints`; value needs to be flipped. | ||
| formattedMapping.put("disableMultiRegionAccessPoints", (!(originalMapping.value.expectBooleanNode().value)).toString()) | ||
| } | ||
| "useGlobalEndpoint", "forcePathStyle", "useArnRegion" -> { | ||
| // No change needed for these | ||
| formattedMapping.put(originalMapping.key.value, originalMapping.value.expectBooleanNode().value.toString()) | ||
| } | ||
| } | ||
| } | ||
| return formattedMapping | ||
| } | ||
|
Comment on lines
+45
to
+76
There was a problem hiding this comment. This "translates" vendor params officially defined in Smithy vendor param shapes that service teams can use to specify client config values in their smoke tests. There're a couple that we don't have config bindings for yet. There was a problem hiding this comment. What is the behavior if they use a param we haven't supported yet? Fail codegen or generate without it & presumably fail the test later? There was a problem hiding this comment. If they use a param we haven't supported yet, the test will be generated without it and test will most likely fail later. If that happens we'll need to disable smoke test temporarily. |
||
| } | ||
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
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
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
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
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
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
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
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.
The package manifest for
SmokeTestsmodule will also be generated along with thePackage.swiftforaws-sdk-swiftproject. The static fileSmokeTestsPackage.Base.txtis appended after generated content during manifest generation, similar to how it's done for root project. Both manifests will use same file for prefix (Package.Prefix.txt).