Allow model assembling from symlink model files / directory

smithy-lang · Sep 15, 2019 · a2481a3 · a2481a3
1 parent 4079d43
commit a2481a3
Show file tree

Hide file tree

Showing 3 changed files with 100 additions and 3 deletions.
diff --git a/smithy-model/src/main/java/software/amazon/smithy/model/loader/ModelAssembler.java b/smithy-model/src/main/java/software/amazon/smithy/model/loader/ModelAssembler.java
@@ -19,6 +19,7 @@
 import java.io.InputStream;
 import java.io.UncheckedIOException;
 import java.net.URL;
+import java.nio.file.FileVisitOption;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
@@ -246,15 +247,15 @@ public ModelAssembler addImport(Path importPath) {
 
         if (Files.isDirectory(importPath)) {
             try {
-                Files.walk(importPath)
+                Files.walk(importPath, FileVisitOption.FOLLOW_LINKS)
                         .filter(p -> !p.equals(importPath))
                         .filter(p -> Files.isDirectory(p) || Files.isRegularFile(p))
                         .forEach(this::addImport);
             } catch (IOException e) {
                 throw new ModelImportException("Error loading the contents of " + importPath, e);
             }
         } else if (Files.isRegularFile(importPath)) {
-            stringModels.put(importPath.toString(), () -> IoUtils.readUtf8File(importPath.toString()));
+            stringModels.put(importPath.toString(), () -> IoUtils.readUtf8File(importPath));
         } else {
             throw new ModelImportException("Cannot find import file: " + importPath);
         }

diff --git a/smithy-model/src/test/java/software/amazon/smithy/model/loader/ModelAssemblerTest.java b/smithy-model/src/test/java/software/amazon/smithy/model/loader/ModelAssemblerTest.java
@@ -30,6 +30,9 @@
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.Collections;
 import java.util.HashMap;
@@ -149,6 +152,99 @@ public void detectsUnresolvedImports() {
         Assertions.assertThrows(RuntimeException.class, () -> new ModelAssembler().addImport("/bad/path"));
     }
 
+    @Test
+    public void importsSymlinksDirectoryWithAllShapes() throws Exception {
+        ValidatedResult<Model> result = new ModelAssembler()
+            .addImport(getClass().getResource("main.json"))
+            .addImport(createSymbolicLink(Paths.get(getClass().getResource("nested").toURI()), "symlink-nested"))
+            .assemble();
+        assertThat(result.getValidationEvents(), empty());
+        Model model = result.unwrap();
+        assertTrue(model.getShapeIndex().getShape(ShapeId.from("example.namespace#String")).isPresent());
+        assertThat(model.getShapeIndex().getShape(ShapeId.from("example.namespace#String")).get().getType(),
+            is(ShapeType.STRING));
+        assertThat(model.getShapeIndex().getShape(ShapeId.from("example.namespace#String2")).get().getType(),
+            is(ShapeType.STRING));
+        assertThat(model.getShapeIndex().getShape(ShapeId.from("example.namespace#String3")).get().getType(),
+            is(ShapeType.STRING));
+        assertThat(model.getShapeIndex().getShape(ShapeId.from("example.namespace#String")).get().getType(),
+            is(ShapeType.STRING));
+        assertThat(model.getShapeIndex().getShape(ShapeId.from("example.namespace#Integer")).get().getType(),
+            is(ShapeType.INTEGER));
+        assertThat(model.getShapeIndex().getShape(ShapeId.from("example.namespace#Long")).get().getType(),
+            is(ShapeType.LONG));
+        assertThat(model.getShapeIndex().getShape(ShapeId.from("example.namespace#Float")).get().getType(),
+            is(ShapeType.FLOAT));
+        assertThat(model.getShapeIndex().getShape(ShapeId.from("example.namespace#BigDecimal")).get().getType(),
+            is(ShapeType.BIG_DECIMAL));
+        assertThat(model.getShapeIndex().getShape(ShapeId.from("example.namespace#BigInteger")).get().getType(),
+            is(ShapeType.BIG_INTEGER));
+        assertThat(model.getShapeIndex().getShape(ShapeId.from("example.namespace#Blob")).get().getType(),
+            is(ShapeType.BLOB));
+        assertThat(model.getShapeIndex().getShape(ShapeId.from("example.namespace#Boolean")).get().getType(),
+            is(ShapeType.BOOLEAN));
+        assertThat(model.getShapeIndex().getShape(ShapeId.from("example.namespace#Timestamp")).get().getType(),
+            is(ShapeType.TIMESTAMP));
+        assertThat(model.getShapeIndex().getShape(ShapeId.from("example.namespace#List")).get().getType(),
+            is(ShapeType.LIST));
+        assertThat(model.getShapeIndex().getShape(ShapeId.from("example.namespace#Map")).get().getType(),
+            is(ShapeType.MAP));
+        assertThat(model.getShapeIndex().getShape(ShapeId.from("example.namespace#Structure")).get().getType(),
+            is(ShapeType.STRUCTURE));
+        assertThat(model.getShapeIndex().getShape(ShapeId.from("example.namespace#TaggedUnion")).get().getType(),
+            is(ShapeType.UNION));
+        assertThat(model.getShapeIndex().getShape(ShapeId.from("example.namespace#Resource")).get().getType(),
+            is(ShapeType.RESOURCE));
+        assertThat(model.getShapeIndex().getShape(ShapeId.from("example.namespace#Operation")).get().getType(),
+            is(ShapeType.OPERATION));
+        assertThat(model.getShapeIndex().getShape(ShapeId.from("example.namespace#Service")).get().getType(),
+            is(ShapeType.SERVICE));
+
+        ShapeId stringId = ShapeId.from("example.namespace#String");
+        Optional<SensitiveTrait> sensitiveTrait = model.getShapeIndex()
+            .getShape(stringId).get()
+            .getTrait(SensitiveTrait.class);
+        assertTrue(sensitiveTrait.isPresent());
+
+        assertThat(model.getMetadata(), hasKey("foo"));
+        assertThat(model.getMetadata().get("foo"), equalTo(Node.from("baz")));
+        assertThat(model.getMetadata(), hasKey("bar"));
+        assertThat(model.getMetadata().get("bar"), equalTo(Node.from("qux")));
+        assertThat(model.getMetadata(), hasKey("lorem"));
+        assertThat(model.getMetadata().get("lorem"), equalTo(Node.from("ipsum")));
+        assertThat(model.getMetadata(), hasKey("list"));
+        assertThat(model.getMetadata().get("list").expectArrayNode().getElementsAs(StringNode::getValue),
+            containsInAnyOrder("a", "b", "c"));
+
+        // The String shape should have a documentation trait applied.
+        assertTrue(model.getShapeIndex().getShape(ShapeId.from("example.namespace#String"))
+            .flatMap(shape -> shape.getTrait(DocumentationTrait.class))
+            .isPresent());
+    }
+
+    @Test
+    public void importsSymlinkFileWithAllShapes() throws Exception {
+        ValidatedResult<Model> result = new ModelAssembler()
+            .addImport(getClass().getResource("main.json"))
+            .addImport(createSymbolicLink(
+                Paths.get(getClass().getResource("nested/merges-2.json").toURI()), "symlink-merges-2.json"))
+            .assemble();
+        assertThat(result.getValidationEvents(), empty());
+        Model model = result.unwrap();
+        // The String shape should have a documentation trait applied.
+        assertTrue(model.getShapeIndex().getShape(ShapeId.from("example.namespace#String"))
+            .flatMap(shape -> shape.getTrait(DocumentationTrait.class))
+            .isPresent());
+    }
+
+    public Path createSymbolicLink(Path target, String linkName) throws IOException {
+        Path link = Paths.get("./src/test/resources", linkName);
+        if (Files.exists(link)) {
+            Files.delete(link);
+        }
+        return Files.createSymbolicLink(link, target);
+    }
+
     @Test
     public void importsFilesWithAllShapes() throws Exception {
         ValidatedResult<Model> result = new ModelAssembler()

diff --git a/smithy-utils/src/main/java/software/amazon/smithy/utils/IoUtils.java b/smithy-utils/src/main/java/software/amazon/smithy/utils/IoUtils.java
@@ -83,7 +83,7 @@ public static String readUtf8File(String path) {
      */
     public static String readUtf8File(Path path) {
         try {
-            return new String(Files.readAllBytes(path), StandardCharsets.UTF_8);
+            return new String(Files.readAllBytes(path.toRealPath()), StandardCharsets.UTF_8);
         } catch (IOException e) {
             throw new UncheckedIOException(e);
         }