Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add exceptions for invalid paths in template definition #1907

Merged
merged 2 commits into from
Aug 3, 2023
Merged

Add exceptions for invalid paths in template definition #1907

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e47ffa5
Add exceptions for invalid paths in template definition
hpmellema Aug 3, 2023
ac873b3
Update based on PR comments
hpmellema Aug 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions smithy-cli/src/it/java/software/amazon/smithy/cli/InitCommandTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,10 @@ public void unexpectedTemplate() {
.append(System.lineSeparator())
.append("───────────────────── ─────────────────────────────────────────────────────────────────────────────")
.append(System.lineSeparator())
.append("bad-include-path Template with incorrect include path. Should throw error.")
.append(System.lineSeparator())
.append("bad-template-path Template with incorrect path. Should throw error.")
.append(System.lineSeparator())
.append("included-file-json Smithy Quickstart example with json file included.")
.append(System.lineSeparator())
.append("included-files-gradle Smithy Quickstart example with gradle files included.")
Expand Down Expand Up @@ -199,6 +203,10 @@ public void withListArg() {
.append(System.lineSeparator())
.append("───────────────────── ─────────────────────────────────────────────────────────────────────────────")
.append(System.lineSeparator())
.append("bad-include-path Template with incorrect include path. Should throw error.")
.append(System.lineSeparator())
.append("bad-template-path Template with incorrect path. Should throw error.")
.append(System.lineSeparator())
.append("included-file-json Smithy Quickstart example with json file included.")
.append(System.lineSeparator())
.append("included-files-gradle Smithy Quickstart example with gradle files included.")
Expand Down Expand Up @@ -253,6 +261,40 @@ public void executesInitSuccessQuiet() {
});
}

@Test
public void badTemplatePathFailureExpected() {
IntegUtils.withProject(PROJECT_NAME, templatesDir -> {
setupTemplatesDirectory(templatesDir);

IntegUtils.withTempDir("badTemplatePath", dir -> {
RunResult result = IntegUtils.run(
dir, ListUtils.of("init", "-t", "bad-template-path", "-u", templatesDir.toString()));
assertThat(Files.exists(Paths.get(dir.toString(), "bad-template-path")), is(false));
assertThat(result.getExitCode(), is(1));
assertThat(result.getOutput(),
containsString("Template path `getting-started-example/does-not-exist` for template"
+" \"bad-template-path\" is invalid."));
});
});
}

@Test
public void badIncludePathFailureExpected() {
IntegUtils.withProject(PROJECT_NAME, templatesDir -> {
setupTemplatesDirectory(templatesDir);

IntegUtils.withTempDir("badIncludePath", dir -> {
RunResult result = IntegUtils.run(
dir, ListUtils.of("init", "-t", "bad-include-path", "-u", templatesDir.toString()));
assertThat(Files.exists(Paths.get(dir.toString(), " bad-include-path")), is(false));
assertThat(result.getExitCode(), is(1));
assertThat(result.getOutput(),
containsString("File or directory `getting-started-example/does-not-exist` is marked"
+ " for inclusion in template \"bad-include-path\", but was not found"));
});
});
}

private static void run(List<String> args, Path root) {
StringBuilder output = new StringBuilder();
int result = IoUtils.runCommand(args, root, output, Collections.emptyMap());
Expand Down
11 changes: 11 additions & 0 deletions ...c/it/resources/software/amazon/smithy/cli/projects/smithy-templates/smithy-templates.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,17 @@
"getting-started-example/common-gradle-configs/gradlew",
"getting-started-example/common-gradle-configs/gradle.properties"
]
},
"bad-template-path": {
"documentation": "Template with incorrect path. Should throw error.",
"path": "getting-started-example/does-not-exist"
},
"bad-include-path": {
"documentation": "Template with incorrect include path. Should throw error.",
"path": "getting-started-example/included-files-gradle",
"include": [
"getting-started-example/does-not-exist"
]
}
}
}
19 changes: 11 additions & 8 deletions smithy-cli/src/main/java/software/amazon/smithy/cli/commands/InitCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ private void cloneTemplate(Path temp, ObjectNode smithyTemplatesNode, Options op
final String templatePath = getTemplatePath(templateNode, template);
List<String> includedFiles = getIncludedFiles(templateNode);

try (ProgressTracker t = new ProgressTracker(env,
try (ProgressTracker ignored = new ProgressTracker(env,
ProgressStyle.dots("cloning template", "template cloned"),
standardOptions.quiet()
)) {
Expand All @@ -214,8 +214,13 @@ private void cloneTemplate(Path temp, ObjectNode smithyTemplatesNode, Options op
exec(ListUtils.of("git", "checkout"), temp);
}

if (!Files.exists(temp.resolve(templatePath))) {
throw new CliError(String.format("Template path `%s` for template \"%s\" is invalid.",
templatePath, template));
}

IoUtils.copyDir(Paths.get(temp.toString(), templatePath), dest);
copyIncludedFiles(temp.toString(), dest.toString(), includedFiles, template, env);
copyIncludedFiles(temp.toString(), dest.toString(), includedFiles, template);

if (!standardOptions.quiet()) {
try (ColorBuffer buffer = ColorBuffer.of(env.colors(), env.stdout())) {
Expand Down Expand Up @@ -266,15 +271,13 @@ private static List<String> getIncludedFiles(ObjectNode templateNode) {
}

private static void copyIncludedFiles(String temp, String dest, List<String> includedFiles,
String templateName, Env env) throws IOException {
String templateName) throws IOException {
for (String included : includedFiles) {
Path includedPath = Paths.get(temp, included);
if (!Files.exists(includedPath)) {
try (ColorBuffer buffer = ColorBuffer.of(env.colors(), env.stderr())) {
buffer.println(String.format(
"File or directory %s is marked for inclusion in template %s but was not found",
included, templateName), ColorTheme.WARNING);
}
throw new CliError(String.format(
"File or directory `%s` is marked for inclusion in template \"%s\", but was not found",
included, templateName));
}

Path target = Paths.get(dest, Objects.requireNonNull(includedPath.getFileName()).toString());
Expand Down