Add Rust runtime code (4874168a) · Commits · Public Repositories / Smithy Rust

codegen-test/README.md

0 → 100644

+11 −0

Original line number	Diff line number	Diff line
		# Codegen Integration Test
		This module defines an integration test of the code generation machinery. Models defined in `model` are built and generated into a Rust package. A `cargoCheck` Gradle task ensures that the generated Rust code compiles. This is added as a finalizer of the `test` task.

		## Usage
		```
		# Compile codegen, Regenerate Rust, compile:
		# REPO_ROOT allows the runtime deps to be specified properly:
		REPO_ROOT=../ ../gradlew test
		```

		The `smithy-build.json` configures the runtime dependencies to point directly to `../rust-runtime/*` via relative paths.
		No newline at end of file

codegen-test/build.gradle.kts

0 → 100644

+38 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
		* SPDX-License-Identifier: Apache-2.0.
		*/

		extra["displayName"] = "Smithy :: Rust :: Codegen :: Test"
		extra["moduleName"] = "software.amazon.smithy.kotlin.codegen.test"

		tasks["jar"].enabled = false

		plugins {
		id("software.amazon.smithy").version("0.5.2")
		}

		val smithyVersion: String by project

		dependencies {
		implementation(project(":codegen"))
		implementation("software.amazon.smithy:smithy-protocol-test-traits:$smithyVersion")
		implementation("software.amazon.smithy:smithy-aws-traits:$smithyVersion")
		}

		tasks.register<Exec>("cargoCheck") {
		workingDir("build/smithyprojections/codegen-test/source/rust-codegen/")
		// disallow warnings
		environment("RUSTFLAGS", "-D warnings")
		commandLine("cargo", "check")
		dependsOn("build")
		}

		tasks.register<Exec>("cargoClippy") {
		workingDir("build/smithyprojections/codegen-test/source/rust-codegen/")
		// disallow warnings
		commandLine("cargo", "clippy")
		dependsOn("build")
		}

		tasks["test"].finalizedBy("cargoCheck", "cargoClippy")

codegen-test/model/main.smithy

0 → 100644

+292 −0

Original line number	Diff line number	Diff line
		$version: "1.0"
		namespace example.weather

		use smithy.test#httpRequestTests
		use smithy.test#httpResponseTests
		use aws.protocols#awsJson1_1


		/// Provides weather forecasts.
		@paginated(inputToken: "nextToken", outputToken: "nextToken", pageSize: "pageSize")
		@awsJson1_1
		service Weather {
		version: "2006-03-01",
		resources: [City],
		operations: [GetCurrentTime]
		}

		resource City {
		identifiers: { cityId: CityId },
		read: GetCity,
		list: ListCities,
		resources: [Forecast, CityImage],
		}

		resource Forecast {
		identifiers: { cityId: CityId },
		read: GetForecast,
		}

		resource CityImage {
		identifiers: { cityId: CityId },
		read: GetCityImage,
		}

		// "pattern" is a trait.
		@pattern("^[A-Za-z0-9 ]+$")
		string CityId

		@readonly
		@http(method: "GET", uri: "/cities/{cityId}")
		operation GetCity {
		input: GetCityInput,
		output: GetCityOutput,
		errors: [NoSuchResource]
		}

		// Tests that HTTP protocol tests are generated.
		apply GetCity @httpRequestTests([
		{
		id: "WriteGetCityAssertions",
		documentation: "Does something",
		protocol: "aws.protocols#awsJson1_1",
		method: "GET",
		uri: "/cities/123",
		body: "",
		params: {
		cityId: "123"
		}
		}
		])

		apply GetCity @httpResponseTests([
		{
		id: "WriteGetCityResponseAssertions",
		documentation: "Does something",
		protocol: "aws.protocols#awsJson1_1",
		code: 200,
		body: """
		{
		"name": "Seattle",
		"coordinates": {
		"latitude": 12.34,
		"longitude": -56.78
		},
		"city": {
		"cityId": "123",
		"name": "Seattle",
		"number": "One",
		"case": "Upper"
		}
		}""",
		bodyMediaType: "application/json",
		params: {
		name: "Seattle",
		coordinates: {
		latitude: 12.34,
		longitude: -56.78
		},
		city: {
		cityId: "123",
		name: "Seattle",
		number: "One",
		case: "Upper"
		}
		}
		}
		])

		/// The input used to get a city.
		structure GetCityInput {
		// "cityId" provides the identifier for the resource and
		// has to be marked as required.
		@required
		@httpLabel
		cityId: CityId
		}

		structure GetCityOutput {
		// "required" is used on output to indicate if the service
		// will always provide a value for the member.
		@required
		name: String,

		@required
		coordinates: CityCoordinates,

		city: CitySummary,
		}

		// This structure is nested within GetCityOutput.
		structure CityCoordinates {
		@required
		latitude: PrimitiveFloat,

		@required
		longitude: Float,
		}

		/// Error encountered when no resource could be found.
		@error("client")
		@httpError(404)
		structure NoSuchResource {
		/// The type of resource that was not found.
		@required
		resourceType: String,

		message: String,
		}

		apply NoSuchResource @httpResponseTests([
		{
		id: "WriteNoSuchResourceAssertions",
		documentation: "Does something",
		protocol: "aws.protocols#awsJson1_1",
		code: 404,
		body: """
		{
		"resourceType": "City",
		"message": "Your custom message"
		}""",
		bodyMediaType: "application/json",
		params: {
		resourceType: "City",
		message: "Your custom message"
		}
		}
		])

		// The paginated trait indicates that the operation may
		// return truncated results.
		@readonly
		@paginated(items: "items")
		@http(method: "GET", uri: "/cities")
		operation ListCities {
		input: ListCitiesInput,
		output: ListCitiesOutput
		}

		apply ListCities @httpRequestTests([
		{
		id: "WriteListCitiesAssertions",
		documentation: "Does something",
		protocol: "aws.protocols#awsJson1_1",
		method: "GET",
		uri: "/cities",
		body: "",
		queryParams: ["pageSize=50"],
		forbidQueryParams: ["nextToken"],
		params: {
		pageSize: 50
		}
		}
		])

		structure ListCitiesInput {
		@httpQuery("nextToken")
		nextToken: String,

		@httpQuery("pageSize")
		pageSize: Integer
		}

		structure ListCitiesOutput {
		nextToken: String,

		@required
		items: CitySummaries,
		}

		// CitySummaries is a list of CitySummary structures.
		list CitySummaries {
		member: CitySummary
		}

		// CitySummary contains a reference to a City.
		@references([{resource: City}])
		structure CitySummary {
		@required
		cityId: CityId,

		@required
		name: String,

		number: String,
		case: String,
		}

		@readonly
		@http(method: "GET", uri: "/current-time")
		operation GetCurrentTime {
		output: GetCurrentTimeOutput
		}

		structure GetCurrentTimeOutput {
		@required
		time: Timestamp
		}

		@readonly
		@http(method: "GET", uri: "/cities/{cityId}/forecast")
		operation GetForecast {
		input: GetForecastInput,
		output: GetForecastOutput
		}

		// "cityId" provides the only identifier for the resource since
		// a Forecast doesn't have its own.
		structure GetForecastInput {
		@required
		@httpLabel
		cityId: CityId,
		}

		structure GetForecastOutput {
		chanceOfRain: Float,
		snow: SimpleYesNo,
		}

		union Precipitation {
		rain: PrimitiveBoolean,
		sleet: PrimitiveBoolean,
		hail: StringMap,
		snow: SimpleYesNo,
		mixed: TypedYesNo,
		other: OtherStructure,
		blob: Blob,
		baz: example.weather.nested.more#Baz,
		}

		structure OtherStructure {}

		@enum([{value: "YES"}, {value: "NO"}])
		string SimpleYesNo

		@enum([{value: "Yes", name: "YES"}, {value: "No", name: "NO"}])
		string TypedYesNo

		map StringMap {
		key: String,
		value: String,
		}

		@readonly
		@http(method: "GET", uri: "/cities/{cityId}/image")
		operation GetCityImage {
		input: GetCityImageInput,
		output: GetCityImageOutput,
		errors: [NoSuchResource]
		}

		structure GetCityImageInput {
		@required @httpLabel
		cityId: CityId,
		}

		structure GetCityImageOutput {
		@httpPayload
		image: CityImageData,
		}

		@streaming
		blob CityImageData

codegen-test/model/more-nesting.smithy

0 → 100644

+7 −0

Original line number	Diff line number	Diff line
		$version: "1.0"
		namespace example.weather.nested.more

		structure Baz {
		baz: String,
		bar: String,
		}

codegen-test/model/nested.smithy

0 → 100644

+7 −0

Original line number	Diff line number	Diff line
		$version: "1.0"
		namespace example.weather.nested

		structure Foo {
		baz: String,
		bar: String,
		}