Skip to content

Commit 68933b7

Browse files
authored
Renaming gradle task :aws:sdk:test to sdkTest avoid task name collision (#3650)
It is now called :aws:sdk:sdkTest and the README has been updated to align with this. ## Motivation and Context <!--- Why is this change required? What problem does it solve? --> <!--- If it fixes an open issue, please link to the issue here --> The gradle task `:aws:sdk:test` mentioned in our `README` has been broken for sometime. This seems to be because one of the plugins we are using (I was unable to determine exactly which one) is registering a task named `test` and it was conflicting with ours. ## Description <!--- Describe your changes in detail --> I changed the name of the broken task to `:aws:sdk:sdkTest`, explicitly registered it, and added the appropriate dependencies and steps for the task. I also updated the `README` to reflect this new name and added a note to indicate that these tests require Go to be installed (because they tests some FIPS functionality). ## Testing <!--- Please describe in detail how you tested your changes --> <!--- Include details of your testing environment, and the tests you ran to --> <!--- see how your change affects other areas of the code, etc. --> I was able to successfully run `./gradlew :aws:sdk:sdkTest` on my local machine (after installing Go which I was initially missing). ## Checklist <!--- If a checkbox below is not applicable, then please DELETE it rather than leaving it unchecked --> No changes to any published code in this PR ---- _By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice._
1 parent 181b48b commit 68933b7

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ Project Layout
3030
* `aws`: AWS specific codegen & Rust code (signing, endpoints, customizations, etc.)
3131
Common commands:
3232
* `./gradlew :aws:sdk:assemble`: Generate (but do not test / compile etc.) a fresh SDK into `sdk/build/aws-sdk`
33-
* `./gradlew :aws:sdk:test`: Generate & run all tests for a fresh SDK
33+
* `./gradlew :aws:sdk:sdkTest`: Generate & run all tests for a fresh SDK. (Note that these tests require Go to be
34+
installed for FIP support to compile properly)
3435
* `./gradlew :aws:sdk:{cargoCheck, cargoTest, cargoDocs, cargoClippy}`: Generate & run specified cargo command.
3536
* `codegen-core`: Common code generation logic useful for clients and servers
3637
* `codegen-client`: Whitelabel Smithy client code generation
@@ -123,7 +124,7 @@ to generate more or less AWS service clients.
123124
# Generate an SDK, but do not attempt to compile / run tests. Useful for inspecting generated code
124125
./gradlew :aws:sdk:assemble
125126
# Run all the tests
126-
./gradlew :aws:sdk:test
127+
./gradlew :aws:sdk:sdkTest
127128
# Validate that the generated code compiles
128129
./gradlew :aws:sdk:cargoCheck
129130
# Validate that the generated code passes Clippy

aws/sdk/build.gradle.kts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -445,8 +445,12 @@ tasks["assemble"].apply {
445445
project.registerCargoCommandsTasks(outputDir.asFile, defaultRustDocFlags)
446446
project.registerGenerateCargoConfigTomlTask(outputDir.asFile)
447447

448-
tasks["test"].dependsOn("assemble")
449-
tasks["test"].finalizedBy(Cargo.CLIPPY.toString, Cargo.TEST.toString, Cargo.DOCS.toString)
448+
//The task name "test" is already registered by one of our plugins
449+
tasks.register("sdkTest") {
450+
description = "Run Cargo clippy/test/docs against the generated SDK."
451+
dependsOn("assemble")
452+
finalizedBy(Cargo.CLIPPY.toString, Cargo.TEST.toString, Cargo.DOCS.toString)
453+
}
450454

451455
tasks.register<Delete>("deleteSdk") {
452456
delete(

0 commit comments

Comments
 (0)