Unverified Commit 0b4c5ab3 authored by John DiSanti's avatar John DiSanti Committed by GitHub
Browse files

Break `codegen-server`'s dependency on `codegen-client` (#2105) 

* Move the allow lints customization into `codegen-core`
* Move the crate version customization into `codegen-core`
* Move "pub use" extra into `codegen-core`
* Move `EventStreamSymbolProvider` into `codegen-core`
* Move the streaming shape providers into `codegen-core`
* Refactor event stream marshall/unmarshall tests
* Break `codegen-server` dependency on `codegen-client`
* Split up `EventStreamTestTools`
* Move codegen context creation in event stream tests
* Restructure tests so that #1442 is easier to resolve in the future
* Add client/server prefixes to test classes
* Improve TODO comments in server event stream tests
* Use correct builders for `ServerEventStreamMarshallerGeneratorTest`
* Remove test cases for protocols that don't support event streams
parent 3a3d1210

codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/RustClientCodegenPlugin.kt

+3 −0
Original line number Diff line number Diff line
@@ -21,6 +21,9 @@ import software.amazon.smithy.rust.codegen.core.rustlang.Attribute.Companion.Non 
import software.amazon.smithy.rust.codegen.core.rustlang.RustReservedWordSymbolProvider

import software.amazon.smithy.rust.codegen.core.smithy.BaseSymbolMetadataProvider

import software.amazon.smithy.rust.codegen.core.smithy.CodegenTarget

import software.amazon.smithy.rust.codegen.core.smithy.EventStreamSymbolProvider

import software.amazon.smithy.rust.codegen.core.smithy.StreamingShapeMetadataProvider

import software.amazon.smithy.rust.codegen.core.smithy.StreamingShapeSymbolProvider

import software.amazon.smithy.rust.codegen.core.smithy.SymbolVisitor

import software.amazon.smithy.rust.codegen.core.smithy.SymbolVisitorConfig

import java.util.logging.Level

codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/customize/RequiredCustomizations.kt

+4 −5
Original line number Diff line number Diff line
@@ -7,18 +7,18 @@ package software.amazon.smithy.rust.codegen.client.smithy.customize 


import software.amazon.smithy.model.shapes.OperationShape

import software.amazon.smithy.rust.codegen.client.smithy.ClientCodegenContext

import software.amazon.smithy.rust.codegen.client.smithy.customizations.AllowLintsGenerator

import software.amazon.smithy.rust.codegen.client.smithy.customizations.CrateVersionGenerator

import software.amazon.smithy.rust.codegen.client.smithy.customizations.EndpointPrefixGenerator

import software.amazon.smithy.rust.codegen.client.smithy.customizations.HttpChecksumRequiredGenerator

import software.amazon.smithy.rust.codegen.client.smithy.customizations.HttpVersionListCustomization

import software.amazon.smithy.rust.codegen.client.smithy.customizations.IdempotencyTokenGenerator

import software.amazon.smithy.rust.codegen.client.smithy.customizations.ResiliencyConfigCustomization

import software.amazon.smithy.rust.codegen.client.smithy.customizations.ResiliencyReExportCustomization

import software.amazon.smithy.rust.codegen.client.smithy.customizations.pubUseSmithyTypes

import software.amazon.smithy.rust.codegen.client.smithy.generators.config.ConfigCustomization

import software.amazon.smithy.rust.codegen.core.rustlang.Feature

import software.amazon.smithy.rust.codegen.core.smithy.RustCrate

import software.amazon.smithy.rust.codegen.core.smithy.customizations.AllowLintsCustomization

import software.amazon.smithy.rust.codegen.core.smithy.customizations.CrateVersionCustomization

import software.amazon.smithy.rust.codegen.core.smithy.customizations.pubUseSmithyTypes

import software.amazon.smithy.rust.codegen.core.smithy.customize.OperationCustomization

import software.amazon.smithy.rust.codegen.core.smithy.generators.LibRsCustomization
@@ -52,8 +52,7 @@ class RequiredCustomizations : ClientCodegenDecorator { 
        codegenContext: ClientCodegenContext,

        baseCustomizations: List<LibRsCustomization>,

    ): List<LibRsCustomization> =

        baseCustomizations + CrateVersionGenerator() +

            AllowLintsGenerator()

        baseCustomizations + CrateVersionCustomization() + AllowLintsCustomization()



    override fun extras(codegenContext: ClientCodegenContext, rustCrate: RustCrate) {

        // Add rt-tokio feature for `ByteStream::from_path`

codegen-client/src/test/kotlin/software/amazon/smithy/rust/codegen/client/smithy/EventStreamSymbolProviderTest.kt

+1 −0
Original line number Diff line number Diff line
@@ -12,6 +12,7 @@ import software.amazon.smithy.model.shapes.ServiceShape 
import software.amazon.smithy.model.shapes.ShapeId

import software.amazon.smithy.rust.codegen.core.rustlang.RustType

import software.amazon.smithy.rust.codegen.core.smithy.CodegenTarget

import software.amazon.smithy.rust.codegen.core.smithy.EventStreamSymbolProvider

import software.amazon.smithy.rust.codegen.core.smithy.SymbolVisitor

import software.amazon.smithy.rust.codegen.core.smithy.rustType

import software.amazon.smithy.rust.codegen.core.smithy.transformers.OperationNormalizer

codegen-client/src/test/kotlin/software/amazon/smithy/rust/codegen/client/smithy/protocols/eventstream/ClientEventStreamBaseRequirements.kt

0 → 100644
+59 −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

 */



package software.amazon.smithy.rust.codegen.client.smithy.protocols.eventstream



import org.junit.jupiter.api.extension.ExtensionContext

import org.junit.jupiter.params.provider.Arguments

import org.junit.jupiter.params.provider.ArgumentsProvider

import software.amazon.smithy.model.Model

import software.amazon.smithy.model.shapes.ServiceShape

import software.amazon.smithy.model.shapes.ShapeId

import software.amazon.smithy.model.shapes.StructureShape

import software.amazon.smithy.rust.codegen.client.smithy.ClientCodegenContext

import software.amazon.smithy.rust.codegen.client.smithy.customize.CombinedClientCodegenDecorator

import software.amazon.smithy.rust.codegen.client.testutil.clientTestRustSettings

import software.amazon.smithy.rust.codegen.client.testutil.testSymbolProvider

import software.amazon.smithy.rust.codegen.core.rustlang.RustWriter

import software.amazon.smithy.rust.codegen.core.smithy.CodegenTarget

import software.amazon.smithy.rust.codegen.core.smithy.generators.BuilderGenerator

import software.amazon.smithy.rust.codegen.core.smithy.generators.implBlock

import software.amazon.smithy.rust.codegen.core.testutil.EventStreamTestModels

import software.amazon.smithy.rust.codegen.core.testutil.EventStreamTestRequirements

import java.util.stream.Stream



class TestCasesProvider : ArgumentsProvider {

    override fun provideArguments(context: ExtensionContext?): Stream<out Arguments> =

        EventStreamTestModels.TEST_CASES.map { Arguments.of(it) }.stream()

}



abstract class ClientEventStreamBaseRequirements : EventStreamTestRequirements<ClientCodegenContext> {

    override fun createCodegenContext(

        model: Model,

        serviceShape: ServiceShape,

        protocolShapeId: ShapeId,

        codegenTarget: CodegenTarget,

    ): ClientCodegenContext = ClientCodegenContext(

        model,

        testSymbolProvider(model),

        serviceShape,

        protocolShapeId,

        clientTestRustSettings(),

        CombinedClientCodegenDecorator(emptyList()),

    )



    override fun renderBuilderForShape(

        writer: RustWriter,

        codegenContext: ClientCodegenContext,

        shape: StructureShape,

    ) {

        BuilderGenerator(codegenContext.model, codegenContext.symbolProvider, shape).apply {

            render(writer)

            writer.implBlock(shape, codegenContext.symbolProvider) {

                renderConvenienceMethod(writer)

            }

        }

    }

}

codegen-client/src/test/kotlin/software/amazon/smithy/rust/codegen/client/smithy/protocols/eventstream/ClientEventStreamMarshallerGeneratorTest.kt

0 → 100644
+46 −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

 */



package software.amazon.smithy.rust.codegen.client.smithy.protocols.eventstream



import org.junit.jupiter.params.ParameterizedTest

import org.junit.jupiter.params.provider.ArgumentsSource

import software.amazon.smithy.rust.codegen.client.smithy.ClientCodegenContext

import software.amazon.smithy.rust.codegen.core.smithy.CodegenTarget

import software.amazon.smithy.rust.codegen.core.smithy.RuntimeType

import software.amazon.smithy.rust.codegen.core.smithy.protocols.Protocol

import software.amazon.smithy.rust.codegen.core.smithy.protocols.serialize.EventStreamMarshallerGenerator

import software.amazon.smithy.rust.codegen.core.testutil.EventStreamTestModels

import software.amazon.smithy.rust.codegen.core.testutil.EventStreamTestTools

import software.amazon.smithy.rust.codegen.core.testutil.EventStreamTestVariety

import software.amazon.smithy.rust.codegen.core.testutil.TestEventStreamProject

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



class ClientEventStreamMarshallerGeneratorTest {

    @ParameterizedTest

    @ArgumentsSource(TestCasesProvider::class)

    fun test(testCase: EventStreamTestModels.TestCase) {

        EventStreamTestTools.runTestCase(

            testCase,

            object : ClientEventStreamBaseRequirements() {

                override fun renderGenerator(

                    codegenContext: ClientCodegenContext,

                    project: TestEventStreamProject,

                    protocol: Protocol,

                ): RuntimeType = EventStreamMarshallerGenerator(

                    project.model,

                    CodegenTarget.CLIENT,

                    TestRuntimeConfig,

                    project.symbolProvider,

                    project.streamShape,

                    protocol.structuredDataSerializer(project.operationShape),

                    testCase.requestContentType,

                ).render()

            },

            CodegenTarget.CLIENT,

            EventStreamTestVariety.Marshall,

        )

    }

}