Unverified Commit 1992bf3f authored by Jacco Kulman's avatar Jacco Kulman Committed by GitHub
Browse files

Examples for Config builder region function (#1008) 



* region function documented

* Example changelogs back

* Solve doc error

* text fixes (still fails)

* added back changelog items accidently removed

* refactor and fix test

* fix test

Co-authored-by: default avatarRussell Cohen <rcoh@amazon.com>
parent 11de3f66

CHANGELOG.next.toml

+6 −0
Original line number Diff line number Diff line
@@ -74,3 +74,9 @@ message = "aws_types::Config is now `Clone`" 
meta = { "breaking" = false, "tada" = false, "bug" = false }

references = ["smithy-rs#1002", "aws-sdk-rust#352"]

author = "rcoh"



[[aws-sdk-rust]]

message = "Example for Config builder region function added"

references = ["smithy-rs#670"]

meta = { "breaking" = false, "tada" = false, "bug" = false }

author = "Jacco"

aws/sdk-codegen/src/main/kotlin/software/amazon/smithy/rustsdk/RegionDecorator.kt

+14 −3
Original line number Diff line number Diff line
@@ -77,7 +77,7 @@ class RegionDecorator : RustCodegenDecorator { 
        codegenContext: CodegenContext,

        baseCustomizations: List<ConfigCustomization>

    ): List<ConfigCustomization> {

        return baseCustomizations + RegionProviderConfig(codegenContext.runtimeConfig)

        return baseCustomizations + RegionProviderConfig(codegenContext)

    }



    override fun operationCustomizations(
@@ -96,8 +96,9 @@ class RegionDecorator : RustCodegenDecorator { 
    }

}



class RegionProviderConfig(runtimeConfig: RuntimeConfig) : ConfigCustomization() {

    private val region = region(runtimeConfig)

class RegionProviderConfig(codegenContext: CodegenContext) : ConfigCustomization() {

    private val region = region(codegenContext.runtimeConfig)

    private val moduleUseName = codegenContext.moduleUseName()

    private val codegenScope = arrayOf("Region" to region.member("Region"))

    override fun section(section: ServiceConfig) = writable {

        when (section) {
@@ -109,6 +110,16 @@ class RegionProviderConfig(runtimeConfig: RuntimeConfig) : ConfigCustomization() 
                rustTemplate(

                    """

                    /// Sets the AWS region to use when making requests.

                    ///

                    /// ## Examples

                    /// ```no_run

                    /// use aws_types::region::Region;

                    /// use $moduleUseName::config::{Builder, Config};

                    ///

                    /// let config = $moduleUseName::Config::builder()

                    ///     .region(Region::new("us-east-1"))

                    ///     .build();

                    /// ```

                    pub fn region(mut self, region: impl Into<Option<#{Region}>>) -> Self {

                        self.region = region.into();

                        self

aws/sdk-codegen/src/test/kotlin/software/amazon/smithy/rustsdk/RegionProviderConfigTest.kt

+5 −1
Original line number Diff line number Diff line
@@ -6,11 +6,15 @@ 
package software.amazon.smithy.rustsdk



import org.junit.jupiter.api.Test

import software.amazon.smithy.rust.codegen.testutil.TestWorkspace

import software.amazon.smithy.rust.codegen.testutil.rustSettings

import software.amazon.smithy.rust.codegen.testutil.validateConfigCustomizations



internal class RegionProviderConfigTest {

    @Test

    fun `generates a valid config`() {

        validateConfigCustomizations(RegionProviderConfig(AwsTestRuntimeConfig))

        val project = TestWorkspace.testProject()

        val codegenContext = awsTestCodegenContext().copy(settings = project.rustSettings())

        validateConfigCustomizations(RegionProviderConfig(codegenContext), project)

    }

}

aws/sdk-codegen/src/test/kotlin/software/amazon/smithy/rustsdk/TestUtil.kt

+6 −0
Original line number Diff line number Diff line
@@ -5,8 +5,11 @@ 


package software.amazon.smithy.rustsdk



import software.amazon.smithy.model.Model

import software.amazon.smithy.rust.codegen.smithy.RuntimeCrateLocation

import software.amazon.smithy.rust.codegen.testutil.TestRuntimeConfig

import software.amazon.smithy.rust.codegen.testutil.asSmithyModel

import software.amazon.smithy.rust.codegen.testutil.testCodegenContext

import java.io.File



// In aws-sdk-codegen, the working dir when gradle runs tests is actually `./aws`. So, to find the smithy runtime, we need
@@ -18,3 +21,6 @@ val AwsTestRuntimeConfig = TestRuntimeConfig.copy( 
        RuntimeCrateLocation.Path(path.absolutePath)

    }

)



fun awsTestCodegenContext(model: Model? = null) =

    testCodegenContext(model ?: "namespace test".asSmithyModel()).copy(runtimeConfig = AwsTestRuntimeConfig)

codegen/src/main/kotlin/software/amazon/smithy/rust/codegen/smithy/CodegenContext.kt

+7 −6
Original line number Diff line number Diff line
@@ -40,11 +40,6 @@ data class CodegenContext( 
     * Smithy Protocol to generate, e.g. RestJson1

     */

    val protocol: ShapeId,

    /**

     * The name of the cargo crate to generate e.g. `aws-sdk-s3`

     * This is loaded from the smithy-build.json during codegen.

     */

    val moduleName: String,

    /**

     * Settings loaded from smithy-build.json

     */
@@ -63,7 +58,13 @@ data class CodegenContext( 
        protocol: ShapeId,

        settings: RustSettings,

        mode: CodegenMode,

    ) : this(model, symbolProvider, settings.runtimeConfig, serviceShape, protocol, settings.moduleName, settings, mode)

    ) : this(model, symbolProvider, settings.runtimeConfig, serviceShape, protocol, settings, mode)



    /**

     * The name of the cargo crate to generate e.g. `aws-sdk-s3`

     * This is loaded from the smithy-build.json during codegen.

     */

    val moduleName: String by lazy { settings.moduleName }



    /**

     * A moduleName for a crate uses kebab-case. When you want to `use` a crate in Rust code,