Skip to content

Commit 5accc5e

Browse files
authored
Add additional included files in smithy-templates for smithy init (#1832)
* Add additional file inclusion in smithy init template * Add support for additional directories * update list template integ tests to account for newly added templates * correct line continuation spacing
1 parent 98dce46 commit 5accc5e

File tree

13 files changed

+695
-28
lines changed

13 files changed

+695
-28
lines changed

config/spotbugs/filter.xml

+6
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,12 @@
9393
<Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
9494
</Match>
9595

96+
<!-- This is a false positive. The value is guarded behind an Objects.requireNonNull -->
97+
<Match>
98+
<Class name="software.amazon.smithy.cli.commands.InitCommand"/>
99+
<Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
100+
</Match>
101+
96102
<!-- Using a buffer here would actually allocate more, not less -->
97103
<Match>
98104
<Class name="software.amazon.smithy.jsonschema.SchemaDocument"/>

smithy-cli/src/it/java/software/amazon/smithy/cli/InitCommandTest.java

+60-6
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
import org.junit.jupiter.api.Test;
77
import software.amazon.smithy.utils.IoUtils;
88
import software.amazon.smithy.utils.ListUtils;
9+
10+
import java.io.IOException;
911
import java.nio.file.Files;
1012
import java.nio.file.Path;
1113
import java.nio.file.Paths;
@@ -54,6 +56,50 @@ public void missingTemplate() {
5456
});
5557
}
5658

59+
@Test
60+
public void includedFileJson() {
61+
IntegUtils.withProject(PROJECT_NAME, templatesDir -> {
62+
setupTemplatesDirectory(templatesDir);
63+
64+
IntegUtils.withTempDir("includedFiles", dir -> {
65+
RunResult result = IntegUtils.run(
66+
dir, ListUtils.of("init", "-t", "included-file-json", "-u", templatesDir.toString()));
67+
assertThat(result.getOutput(),
68+
containsString("Smithy project created in directory: "));
69+
assertThat(result.getExitCode(), is(0));
70+
assertThat(Files.exists(Paths.get(dir.toString(), "included-file-json")), is(true));
71+
assertThat(Files.exists(Paths.get(dir.toString(), "included-file-json/smithy-build.json")), is(true));
72+
});
73+
});
74+
}
75+
76+
@Test
77+
public void includedFileGradle() {
78+
IntegUtils.withProject(PROJECT_NAME, templatesDir -> {
79+
setupTemplatesDirectory(templatesDir);
80+
81+
IntegUtils.withTempDir("includedFilesGradle", dir -> {
82+
RunResult result = IntegUtils.run(
83+
dir, ListUtils.of("init", "-t", "included-files-gradle", "-u", templatesDir.toString()));
84+
assertThat(result.getOutput(),
85+
containsString("Smithy project created in directory: "));
86+
assertThat(result.getExitCode(), is(0));
87+
assertThat(Files.exists(Paths.get(dir.toString(), "included-files-gradle")), is(true));
88+
try {
89+
Files.walk(Paths.get(dir.toString())).forEach(System.out::println);
90+
} catch (IOException e) {
91+
throw new RuntimeException(e);
92+
}
93+
assertThat(Files.exists(Paths.get(dir.toString(), "included-files-gradle/gradle.properties")), is(true));
94+
assertThat(Files.exists(Paths.get(dir.toString(), "included-files-gradle/gradlew")), is(true));
95+
assertThat(Files.exists(Paths.get(dir.toString(), "included-files-gradle/gradle")), is(true));
96+
assertThat(Files.exists(Paths.get(dir.toString(), "included-files-gradle/gradle/wrapper")), is(true));
97+
assertThat(Files.exists(Paths.get(dir.toString(), "included-files-gradle/gradle/wrapper/gradle-wrapper.jar")), is(true));
98+
assertThat(Files.exists(Paths.get(dir.toString(), "included-files-gradle/gradle/wrapper/gradle-wrapper.properties")), is(true));
99+
});
100+
});
101+
}
102+
57103
@Test
58104
public void unexpectedTemplate() {
59105
IntegUtils.withProject(PROJECT_NAME, templatesDir -> {
@@ -67,11 +113,15 @@ public void unexpectedTemplate() {
67113
.append("Invalid template `blabla`. `Smithy-Examples` provides the following templates:")
68114
.append(System.lineSeparator())
69115
.append(System.lineSeparator())
70-
.append("NAME DOCUMENTATION")
116+
.append("NAME DOCUMENTATION")
117+
.append(System.lineSeparator())
118+
.append("--------------------- -----------------------------------------------------")
71119
.append(System.lineSeparator())
72-
.append("-------------- ---------------------------------------------------------------")
120+
.append("included-file-json Smithy Quickstart example with json file included. ")
73121
.append(System.lineSeparator())
74-
.append("quickstart-cli Smithy Quickstart example weather service using the Smithy CLI.")
122+
.append("included-files-gradle Smithy Quickstart example with gradle files included.")
123+
.append(System.lineSeparator())
124+
.append("quickstart-cli Smithy Quickstart example weather service. ")
75125
.append(System.lineSeparator())
76126
.toString();
77127

@@ -133,11 +183,15 @@ public void withListArg() {
133183
"init", "--list", "--url", templatesDir.toString()));
134184

135185
String expectedOutput = new StringBuilder()
136-
.append("NAME DOCUMENTATION")
186+
.append("NAME DOCUMENTATION")
187+
.append(System.lineSeparator())
188+
.append("--------------------- -----------------------------------------------------")
189+
.append(System.lineSeparator())
190+
.append("included-file-json Smithy Quickstart example with json file included. ")
137191
.append(System.lineSeparator())
138-
.append("-------------- ---------------------------------------------------------------")
192+
.append("included-files-gradle Smithy Quickstart example with gradle files included.")
139193
.append(System.lineSeparator())
140-
.append("quickstart-cli Smithy Quickstart example weather service using the Smithy CLI.")
194+
.append("quickstart-cli Smithy Quickstart example weather service. ")
141195
.append(System.lineSeparator())
142196
.toString();
143197

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
org.gradle.parallel=true
2+
org.gradle.jvmargs='-Dfile.encoding=UTF-8'
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
distributionBase=GRADLE_USER_HOME
2+
distributionPath=wrapper/dists
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-bin.zip
4+
zipStoreBase=GRADLE_USER_HOME
5+
zipStorePath=wrapper/dists
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,234 @@
1+
#!/bin/sh
2+
3+
#
4+
# Copyright © 2015-2021 the original authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#
18+
19+
##############################################################################
20+
#
21+
# Gradle start up script for POSIX generated by Gradle.
22+
#
23+
# Important for running:
24+
#
25+
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
26+
# noncompliant, but you have some other compliant shell such as ksh or
27+
# bash, then to run this script, type that shell name before the whole
28+
# command line, like:
29+
#
30+
# ksh Gradle
31+
#
32+
# Busybox and similar reduced shells will NOT work, because this script
33+
# requires all of these POSIX shell features:
34+
# * functions;
35+
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
36+
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
37+
# * compound commands having a testable exit status, especially «case»;
38+
# * various built-in commands including «command», «set», and «ulimit».
39+
#
40+
# Important for patching:
41+
#
42+
# (2) This script targets any POSIX shell, so it avoids extensions provided
43+
# by Bash, Ksh, etc; in particular arrays are avoided.
44+
#
45+
# The "traditional" practice of packing multiple parameters into a
46+
# space-separated string is a well documented source of bugs and security
47+
# problems, so this is (mostly) avoided, by progressively accumulating
48+
# options in "$@", and eventually passing that to Java.
49+
#
50+
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
51+
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
52+
# see the in-line comments for details.
53+
#
54+
# There are tweaks for specific operating systems such as AIX, CygWin,
55+
# Darwin, MinGW, and NonStop.
56+
#
57+
# (3) This script is generated from the Groovy template
58+
# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
59+
# within the Gradle project.
60+
#
61+
# You can find Gradle at https://github.com/gradle/gradle/.
62+
#
63+
##############################################################################
64+
65+
# Attempt to set APP_HOME
66+
67+
# Resolve links: $0 may be a link
68+
app_path=$0
69+
70+
# Need this for daisy-chained symlinks.
71+
while
72+
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
73+
[ -h "$app_path" ]
74+
do
75+
ls=$( ls -ld "$app_path" )
76+
link=${ls#*' -> '}
77+
case $link in #(
78+
/*) app_path=$link ;; #(
79+
*) app_path=$APP_HOME$link ;;
80+
esac
81+
done
82+
83+
APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
84+
85+
APP_NAME="Gradle"
86+
APP_BASE_NAME=${0##*/}
87+
88+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
89+
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
90+
91+
# Use the maximum available, or set MAX_FD != -1 to use that value.
92+
MAX_FD=maximum
93+
94+
warn () {
95+
echo "$*"
96+
} >&2
97+
98+
die () {
99+
echo
100+
echo "$*"
101+
echo
102+
exit 1
103+
} >&2
104+
105+
# OS specific support (must be 'true' or 'false').
106+
cygwin=false
107+
msys=false
108+
darwin=false
109+
nonstop=false
110+
case "$( uname )" in #(
111+
CYGWIN* ) cygwin=true ;; #(
112+
Darwin* ) darwin=true ;; #(
113+
MSYS* | MINGW* ) msys=true ;; #(
114+
NONSTOP* ) nonstop=true ;;
115+
esac
116+
117+
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
118+
119+
120+
# Determine the Java command to use to start the JVM.
121+
if [ -n "$JAVA_HOME" ] ; then
122+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
123+
# IBM's JDK on AIX uses strange locations for the executables
124+
JAVACMD=$JAVA_HOME/jre/sh/java
125+
else
126+
JAVACMD=$JAVA_HOME/bin/java
127+
fi
128+
if [ ! -x "$JAVACMD" ] ; then
129+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
130+
131+
Please set the JAVA_HOME variable in your environment to match the
132+
location of your Java installation."
133+
fi
134+
else
135+
JAVACMD=java
136+
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
137+
138+
Please set the JAVA_HOME variable in your environment to match the
139+
location of your Java installation."
140+
fi
141+
142+
# Increase the maximum file descriptors if we can.
143+
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
144+
case $MAX_FD in #(
145+
max*)
146+
MAX_FD=$( ulimit -H -n ) ||
147+
warn "Could not query maximum file descriptor limit"
148+
esac
149+
case $MAX_FD in #(
150+
'' | soft) :;; #(
151+
*)
152+
ulimit -n "$MAX_FD" ||
153+
warn "Could not set maximum file descriptor limit to $MAX_FD"
154+
esac
155+
fi
156+
157+
# Collect all arguments for the java command, stacking in reverse order:
158+
# * args from the command line
159+
# * the main class name
160+
# * -classpath
161+
# * -D...appname settings
162+
# * --module-path (only if needed)
163+
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
164+
165+
# For Cygwin or MSYS, switch paths to Windows format before running java
166+
if "$cygwin" || "$msys" ; then
167+
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
168+
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
169+
170+
JAVACMD=$( cygpath --unix "$JAVACMD" )
171+
172+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
173+
for arg do
174+
if
175+
case $arg in #(
176+
-*) false ;; # don't mess with options #(
177+
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
178+
[ -e "$t" ] ;; #(
179+
*) false ;;
180+
esac
181+
then
182+
arg=$( cygpath --path --ignore --mixed "$arg" )
183+
fi
184+
# Roll the args list around exactly as many times as the number of
185+
# args, so each arg winds up back in the position where it started, but
186+
# possibly modified.
187+
#
188+
# NB: a `for` loop captures its iteration list before it begins, so
189+
# changing the positional parameters here affects neither the number of
190+
# iterations, nor the values presented in `arg`.
191+
shift # remove old arg
192+
set -- "$@" "$arg" # push replacement arg
193+
done
194+
fi
195+
196+
# Collect all arguments for the java command;
197+
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
198+
# shell script including quotes and variable substitutions, so put them in
199+
# double quotes to make sure that they get re-expanded; and
200+
# * put everything else in single quotes, so that it's not re-expanded.
201+
202+
set -- \
203+
"-Dorg.gradle.appname=$APP_BASE_NAME" \
204+
-classpath "$CLASSPATH" \
205+
org.gradle.wrapper.GradleWrapperMain \
206+
"$@"
207+
208+
# Use "xargs" to parse quoted args.
209+
#
210+
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
211+
#
212+
# In Bash we could simply go:
213+
#
214+
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
215+
# set -- "${ARGS[@]}" "$@"
216+
#
217+
# but POSIX shell has neither arrays nor command substitution, so instead we
218+
# post-process each arg (as a line of input to sed) to backslash-escape any
219+
# character that might be a shell metacharacter, then use eval to reverse
220+
# that process (while maintaining the separation between arguments), and wrap
221+
# the whole thing up as a single "set" statement.
222+
#
223+
# This will of course break if any of these variables contains a newline or
224+
# an unmatched quote.
225+
#
226+
227+
eval "set -- $(
228+
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
229+
xargs -n1 |
230+
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
231+
tr '\n' ' '
232+
)" '"$@"'
233+
234+
exec "$JAVACMD" "$@"
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"version": "1.0"
3+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Quickstart Example
2+
To run this example you will need the [Smithy CLI](https://smithy.io/2.0/guides/smithy-cli/index.html) installed.
3+
If you do not have the CLI installed, follow [this guide](https://smithy.io/2.0/guides/smithy-cli/index.html) to install it now.
4+
5+
Once you have the CLI installed run:
6+
```
7+
smithy build
8+
```
9+
From the root of this directory.

0 commit comments

Comments
 (0)