Add unit test for default package description updated based on artifact type

Author: AndrewFossAWS

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/PackageJsonGenerator.java

@@ -30,6 +30,8 @@
 @SmithyInternalApi
 final class PackageJsonGenerator {
 
+    public static final String PACKAGE_JSON_FILENAME = "package.json";
+
     private PackageJsonGenerator() {}
 
     static void writePackageJson(
@@ -74,6 +76,6 @@ static void writePackageJson(
         template = template.replace("${packageDescription}", settings.getPackageDescription());
         template = template.replace("${packageVersion}", settings.getPackageVersion());
         template = template.replace("${packageManager}", settings.getPackageManager().getCommand());
-        manifest.writeFile("package.json", template);
+        manifest.writeFile(PACKAGE_JSON_FILENAME, template);
     }
 }

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptSettings.java

@@ -111,17 +111,17 @@ public static TypeScriptSettings from(Model model, ObjectNode config, ArtifactTy
     }
 
     private String getDefaultDescription() {
-        String defaultDescription = getPackageName();
+        String description = getPackageName();
         switch (artifactType) {
             case CLIENT:
-                defaultDescription += " client";
+                description += " client";
                 break;
             case SSDK:
-                defaultDescription += " server";
+                description += " server";
                 break;
             default:
         }
-        return defaultDescription;
+        return description;
     }
 
     // TODO: this seems reusable across generators.

smithy-typescript-codegen/src/test/java/software/amazon/smithy/typescript/codegen/PackageJsonGeneratorTest.java

@@ -0,0 +1,52 @@
+package software.amazon.smithy.typescript.codegen;
+
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+import software.amazon.smithy.build.MockManifest;
+import software.amazon.smithy.model.Model;
+import software.amazon.smithy.model.node.Node;
+import software.amazon.smithy.model.node.ObjectNode;
+
+import java.util.HashMap;
+import java.util.stream.Stream;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.containsString;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+class PackageJsonGeneratorTest {
+    @ParameterizedTest
+    @MethodSource("providePackageDescriptionTestCases")
+    void expectPackageDescriptionUpdatedByArtifactType(TypeScriptSettings.ArtifactType artifactType, String expectedDescription) {
+        Model model = Model.assembler()
+                .addImport(getClass().getResource("simple-service.smithy"))
+                .assemble()
+                .unwrap();
+
+        MockManifest manifest = new MockManifest();
+
+        ObjectNode settings = Node.objectNodeBuilder()
+                .withMember("service", Node.from("smithy.example#Example"))
+                .withMember("package", Node.from("example"))
+                .withMember("packageVersion", Node.from("1.0.0"))
+                .build();
+
+        final TypeScriptSettings typeScriptSettings = TypeScriptSettings.from(model, settings, artifactType);
+
+        PackageJsonGenerator.writePackageJson(typeScriptSettings, manifest, new HashMap<>());
+
+        assertTrue(manifest.getFileString(PackageJsonGenerator.PACKAGE_JSON_FILENAME).isPresent());
+
+        String packageJson = manifest.getFileString(PackageJsonGenerator.PACKAGE_JSON_FILENAME).get();
+
+        assertThat(packageJson, containsString(String.format("\"description\": \"%s\"", expectedDescription)));
+    }
+
+    private static Stream<Arguments> providePackageDescriptionTestCases() {
+        return Stream.of(
+            Arguments.of(TypeScriptSettings.ArtifactType.SSDK, "example server"),
+            Arguments.of(TypeScriptSettings.ArtifactType.CLIENT, "example client")
+        );
+    }
+}

smithy-typescript-codegen/src/test/java/software/amazon/smithy/typescript/codegen/TypeScriptSettingsTest.java

@@ -1,14 +1,24 @@
 package software.amazon.smithy.typescript.codegen;
 
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.containsString;
 import static org.hamcrest.Matchers.equalTo;
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+import software.amazon.smithy.build.MockManifest;
 import software.amazon.smithy.model.Model;
 import software.amazon.smithy.model.node.Node;
+import software.amazon.smithy.model.node.ObjectNode;
 import software.amazon.smithy.model.shapes.ShapeId;
 
+import java.util.HashMap;
+import java.util.stream.Stream;
+
 public class TypeScriptSettingsTest {
 
     @Test
@@ -54,6 +64,33 @@ public void canBeConfiguredToNpm() {
         assertEquals(TypeScriptSettings.PackageManager.NPM, settings.getPackageManager());
     }
 
+
+    @ParameterizedTest
+    @MethodSource("providePackageDescriptionTestCases")
+    void expectPackageDescriptionUpdatedByArtifactType(TypeScriptSettings.ArtifactType artifactType, String expectedDescription) {
+        Model model = Model.assembler()
+                .addImport(getClass().getResource("simple-service.smithy"))
+                .assemble()
+                .unwrap();
+
+        ObjectNode settings = Node.objectNodeBuilder()
+                .withMember("service", Node.from("smithy.example#Example"))
+                .withMember("package", Node.from("example"))
+                .withMember("packageVersion", Node.from("1.0.0"))
+                .build();
+
+        final TypeScriptSettings typeScriptSettings = TypeScriptSettings.from(model, settings, artifactType);
+
+        assertThat(typeScriptSettings.getPackageDescription(), containsString(expectedDescription));
+    }
+
+    private static Stream<Arguments> providePackageDescriptionTestCases() {
+        return Stream.of(
+                Arguments.of(TypeScriptSettings.ArtifactType.SSDK, "example server"),
+                Arguments.of(TypeScriptSettings.ArtifactType.CLIENT, "example client")
+        );
+    }
+
     @Test
     public void resolvesSupportProtocols() {
         // TODO