Adds waiter support to smithy-go

codegen/smithy-go-codegen-test/model/main.smithy

@@ -3,6 +3,7 @@ namespace example.weather
 
 use smithy.test#httpRequestTests
 use smithy.test#httpResponseTests
+use smithy.waiters#waitable
 
 /// Provides weather forecasts.
 @fakeProtocol
@@ -36,6 +37,49 @@ resource CityImage {
 string CityId
 
 @readonly
+@waitable(
+ CityExists: {
+ description: "Waits until a city has been created",
+ acceptors: [
+ // Fail-fast if the thing transitions to a "failed" state.
+ {
+ state: "failure",
+ matcher: {
+ errorType: "NoSuchResource"
+ }
+ },
+ // Succeed when the city image value is not empty i.e. enters into a "success" state.
+ {
+ state: "success",
+ matcher: {
+ success: true
+ }
+ },
+ // Retry if city id input is of same length as city name in output
+ {
+ state: "retry",
+ matcher: {
+ inputOutput: {
+ path: "length(input.cityId) == length(output.name)",
+ comparator: "booleanEquals",
+ expected: "true",
+ }
+ }
+ },
+ // Success if city name in output is seattle
+ {
+ state: "success",
+ matcher: {
+ output: {
+ path: "name",
+ comparator: "stringEquals",
+ expected: "seattle",
+ }
+ }
+ }
+ ]
+ }
+)
 @http(method: "GET", uri: "/cities/{cityId}")
 operation GetCity {
  input: GetCityInput,
@@ -178,6 +222,35 @@ apply NoSuchResource @httpResponseTests([
 // return truncated results.
 @readonly
 @paginated(items: "items")
+@waitable(
+ "ListContainsCity": {
+ description: "Wait until ListCities operation response matches a given state",
+ acceptors: [
+ // failure in case all items returned match to seattle
+ {
+ state: "failure",
+ matcher: {
+ output: {
+ path: "items",
+ comparator: "allStringEquals",
+ expected: "seattle",
+ }
+ }
+ },
+ // success in case any items returned match to NewYork
+ {
+ state: "success",
+ matcher: {
+ output: {
+ path: "items",
+ comparator: "anyStringEquals",
+ expected: "NewYork",
+ }
+ }
+ }
+ ]
+ }
+)
 @http(method: "GET", uri: "/cities")
 operation ListCities {
  input: ListCitiesInput,

codegen/smithy-go-codegen/build.gradle.kts

@@ -19,6 +19,7 @@ extra["moduleName"] = "software.amazon.smithy.go.codegen"
 
 dependencies {
  api("software.amazon.smithy:smithy-codegen-core:[1.3.0,2.0.0[")
+ implementation("software.amazon.smithy:smithy-waiters:[1.4.0,2.0.0[")
  compile("com.atlassian.commonmark:commonmark:0.15.2")
  api("org.jsoup:jsoup:1.13.1")
  implementation("software.amazon.smithy:smithy-protocol-test-traits:[1.3.0,2.0.0[")

codegen/smithy-go-codegen/src/main/java/software/amazon/smithy/go/codegen/GoStackStepMiddlewareGenerator.java

@@ -114,6 +114,23 @@ public static GoStackStepMiddlewareGenerator createDeserializeStepMiddleware(Str
  .build());
  }
 
+ /**
+ * Create a new Finalize step middleware generator with the provided type name.
+ *
+ * @param name is the type name to identify the middleware.
+ * @param id the unique ID for the middleware.
+ * @return the middleware generator.
+ */
+ public static GoStackStepMiddlewareGenerator createFinalizeStepMiddleware(String name, MiddlewareIdentifier id) {
+ return createMiddleware(name,
+ id,
+ "HandleFinalize",
+ SymbolUtils.createValueSymbolBuilder("FinalizeInput", SmithyGoDependency.SMITHY_MIDDLEWARE).build(),
+ SymbolUtils.createValueSymbolBuilder("FinalizeOutput", SmithyGoDependency.SMITHY_MIDDLEWARE).build(),
+ SymbolUtils.createValueSymbolBuilder("FinalizeHandler", SmithyGoDependency.SMITHY_MIDDLEWARE)
+ .build());
+ }
+
  /**
  * Generates a new step middleware generator.
  *

codegen/smithy-go-codegen/src/main/java/software/amazon/smithy/go/codegen/SmithyGoDependency.java

@@ -53,12 +53,16 @@ public final class SmithyGoDependency {
  public static final GoDependency SMITHY_RAND = smithy("rand", "smithyrand");
  public static final GoDependency SMITHY_TESTING = smithy("testing", "smithytesting");
  public static final GoDependency SMITHY_XML = smithy("xml", "smithyxml");
+ public static final GoDependency SMITHY_WAITERS = smithy("waiters", "smithywaiters");
 
  public static final GoDependency GO_CMP = goCmp("cmp");
  public static final GoDependency GO_CMP_OPTIONS = goCmp("cmp/cmpopts");
 
+ public static final GoDependency GO_JMESPATH = goJmespath(null);
+
  private static final String SMITHY_SOURCE_PATH = "github.com/awslabs/smithy-go";
  private static final String GO_CMP_SOURCE_PATH = "github.com/google/go-cmp";
+ private static final String GO_JMESPATH_SOURCE_PATH = "github.com/jmespath/go-jmespath";
 
  private SmithyGoDependency() {
  }
@@ -94,6 +98,10 @@ private static GoDependency goCmp(String relativePath) {
  return relativePackage(GO_CMP_SOURCE_PATH, relativePath, Versions.GO_CMP, null);
  }
 
+ private static GoDependency goJmespath(String relativePath) {
+ return relativePackage(GO_JMESPATH_SOURCE_PATH, relativePath, Versions.GO_JMESPATH, null);
+ }
+
  private static GoDependency relativePackage(
  String moduleImportPath,
  String relativePath,
@@ -110,6 +118,7 @@ private static GoDependency relativePackage(
  private static final class Versions {
  private static final String GO_STDLIB = "1.15";
  private static final String GO_CMP = "v0.5.4";
- private static final String SMITHY_GO = "v0.4.0";
+ private static final String SMITHY_GO = "v0.4.1-0.20201202055352-1ba08af0096d";
+ private static final String GO_JMESPATH = "v0.4.0";
  }
 }