Skip to content

Commit 64578b9

Browse files
rubenhoenlerubenhoenle
committed
feat(generator): add individual blacklist for each language
1 parent 9499f03 commit 64578b9

File tree

8 files changed

+61
-47
lines changed

8 files changed

+61
-47
lines changed

‎blacklist.txt‎ renamed to ‎config/golang/blacklist.txt‎

File renamed without changes.

‎openapi-generator-config-go.yml‎ renamed to ‎config/golang/openapi-generator-config.yml‎

File renamed without changes.

‎config/java/blacklist.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Transitional file to disable generation for selected services

‎openapi-generator-config-java.yml‎ renamed to ‎config/java/openapi-generator-config.yml‎

File renamed without changes.

‎config/python/blacklist.txt‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Transitional file to disable generation for selected services
2+
customer
3+
featuretoggle
4+
workflows
5+
openstack
6+
notebooks
7+
cost
8+
functionsregistry
9+
functions
10+
pim
11+
smokeapi
12+
stackitmarketplace
13+
support

‎scripts/generate-sdk/languages/go.sh‎

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -68,15 +68,15 @@ generate_go_sdk() {
6868
fi
6969

7070
# Clone SDK repo
71-
if [ -d ${SDK_REPO_LOCAL_PATH} ]; then
71+
if [ -d "${SDK_REPO_LOCAL_PATH}" ]; then
7272
echo "Old SDK repo clone was found, it will be removed."
73-
rm -rf ${SDK_REPO_LOCAL_PATH}
73+
rm -rf "${SDK_REPO_LOCAL_PATH}"
7474
fi
75-
git clone --quiet ${SDK_REPO_URL} ${SDK_REPO_LOCAL_PATH}
75+
git clone --quiet "${SDK_REPO_URL}" "${SDK_REPO_LOCAL_PATH}"
7676

7777
# Install SDK project tools
78-
cd ${SDK_REPO_LOCAL_PATH}
79-
git checkout ${SDK_BRANCH}
78+
cd "${SDK_REPO_LOCAL_PATH}"
79+
git checkout "${SDK_BRANCH}"
8080
make project-tools
8181

8282
# Backup of the current state of the SDK services dir (services/)
@@ -86,23 +86,23 @@ generate_go_sdk() {
8686
exit 1
8787
fi
8888
cleanup() {
89-
rm -rf ${sdk_services_backup_dir}
89+
rm -rf "${sdk_services_backup_dir}"
9090
}
91-
cp -a "${SERVICES_FOLDER}/." ${sdk_services_backup_dir}
91+
cp -a "${SERVICES_FOLDER}/." "${sdk_services_backup_dir}"
9292

9393
# Cleanup after we are done
9494
trap cleanup EXIT
9595

9696
# Remove old contents of services dir (services/)
97-
rm -rf ${SERVICES_FOLDER}
98-
rm ${SDK_REPO_LOCAL_PATH}/go.work
97+
rm -rf "${SERVICES_FOLDER}"
98+
rm "${SDK_REPO_LOCAL_PATH}/go.work"
9999
if [ -f "${SDK_REPO_LOCAL_PATH}/go.work.sum" ]; then
100-
rm ${SDK_REPO_LOCAL_PATH}/go.work.sum
100+
rm "${SDK_REPO_LOCAL_PATH}/go.work.sum"
101101
fi
102102

103103
echo "go ${SDK_GO_VERSION}" >${SDK_REPO_LOCAL_PATH}/go.work
104104
if [ -d ${SDK_REPO_LOCAL_PATH}/core ]; then
105-
cd ${SDK_REPO_LOCAL_PATH}/core
105+
cd "${SDK_REPO_LOCAL_PATH}/core"
106106
go work use .
107107
fi
108108

@@ -132,18 +132,18 @@ generate_go_sdk() {
132132
exit 1
133133
fi
134134

135-
if grep -E "^$service$" ${ROOT_DIR}/blacklist.txt; then
135+
if grep -E "^$service$" "${ROOT_DIR}/config/golang/blacklist.txt"; then
136136
echo "Skipping blacklisted service ${service}"
137137
warning+="Skipping blacklisted service ${service}\n"
138138
continue
139139
fi
140140

141141
echo -e "\n>> Generating \"${service}\" service..."
142-
cd ${ROOT_DIR}
142+
cd "${ROOT_DIR}"
143143

144144
GO_POST_PROCESS_FILE="gofmt -w" \
145145
mkdir -p ${SERVICES_FOLDER}/${service}/
146-
cp ${ROOT_DIR}/scripts/generate-sdk/.openapi-generator-ignore-go ${SERVICES_FOLDER}/${service}/.openapi-generator-ignore
146+
cp "${ROOT_DIR}/scripts/generate-sdk/.openapi-generator-ignore-go" "${SERVICES_FOLDER}/${service}/.openapi-generator-ignore"
147147
regional_api=
148148
if grep -E "^$service$" ${ROOT_DIR}/regional-whitelist.txt; then
149149
echo "Generating new regional api"
@@ -153,22 +153,22 @@ generate_go_sdk() {
153153
# Run the generator for Go
154154
java -Dlog.level=${GENERATOR_LOG_LEVEL} -jar ${jar_path} generate \
155155
--generator-name go \
156-
--input-spec ${service_json} \
157-
--output ${SERVICES_FOLDER}/${service} \
158-
--package-name ${service} \
156+
--input-spec "${service_json}" \
157+
--output "${SERVICES_FOLDER}/${service}" \
158+
--package-name "${service}" \
159159
--enable-post-process-file \
160-
--git-host ${GIT_HOST} \
161-
--git-user-id ${GIT_USER_ID} \
162-
--git-repo-id ${GIT_REPO_ID} \
160+
--git-host "${GIT_HOST}" \
161+
--git-user-id "${GIT_USER_ID}" \
162+
--git-repo-id "${GIT_REPO_ID}" \
163163
--global-property apis,models,modelTests=true,modelDocs=false,apiDocs=false,supportingFiles \
164164
--additional-properties=isGoSubmodule=true,enumClassPrefix=true,generateInterfaces=true,$regional_api \
165-
--http-user-agent stackit-sdk-go/${service} \
165+
--http-user-agent "stackit-sdk-go/${service}" \
166166
--reserved-words-mappings type=types \
167-
--config openapi-generator-config-go.yml
167+
--config "${ROOT_DIR}/config/golang/openapi-generator-config.yml"
168168

169169
# Remove unnecessary files
170-
rm ${SERVICES_FOLDER}/${service}/.openapi-generator-ignore
171-
rm ${SERVICES_FOLDER}/${service}/.openapi-generator/FILES
170+
rm "${SERVICES_FOLDER}/${service}/.openapi-generator-ignore"
171+
rm "${SERVICES_FOLDER}/${service}/.openapi-generator/FILES"
172172

173173
# If there's a comment at the start of go.mod, copy it
174174
go_mod_backup_path="${sdk_services_backup_dir}/${service}/go.mod"
@@ -183,63 +183,63 @@ generate_go_sdk() {
183183
fi
184184

185185
# Move tests to the service folder
186-
cp ${SERVICES_FOLDER}/${service}/test/* ${SERVICES_FOLDER}/${service}
187-
rm -r ${SERVICES_FOLDER}/${service}/test/
186+
cp "${SERVICES_FOLDER}/${service}/test/*" "${SERVICES_FOLDER}/${service}"
187+
rm -r "${SERVICES_FOLDER}/${service}/test/"
188188

189189
# If the service has a wait package files, move them inside the service folder
190-
if [ -d ${sdk_services_backup_dir}/${service}/wait ]; then
190+
if [ -d "${sdk_services_backup_dir}/${service}/wait" ]; then
191191
echo "Found ${service} \"wait\" package"
192-
cp -r ${sdk_services_backup_dir}/${service}/wait ${SERVICES_FOLDER}/${service}/wait
192+
cp -r "${sdk_services_backup_dir}/${service}/wait" "${SERVICES_FOLDER}/${service}/wait"
193193
fi
194194

195195
# If the service has a CHANGELOG file, move it inside the service folder
196-
if [ -f ${sdk_services_backup_dir}/${service}/CHANGELOG.md ]; then
196+
if [ -f "${sdk_services_backup_dir}/${service}/CHANGELOG.md" ]; then
197197
echo "Found ${service} \"CHANGELOG\" file"
198-
cp -r ${sdk_services_backup_dir}/${service}/CHANGELOG.md ${SERVICES_FOLDER}/${service}/CHANGELOG.md
198+
cp -r "${sdk_services_backup_dir}/${service}/CHANGELOG.md" "${SERVICES_FOLDER}/${service}/CHANGELOG.md"
199199
fi
200200

201201
# If the service has a LICENSE file, move it inside the service folder
202-
if [ -f ${sdk_services_backup_dir}/${service}/LICENSE.md ]; then
202+
if [ -f "${sdk_services_backup_dir}/${service}/LICENSE.md" ]; then
203203
echo "Found ${service} \"LICENSE\" file"
204-
cp -r ${sdk_services_backup_dir}/${service}/LICENSE.md ${SERVICES_FOLDER}/${service}/LICENSE.md
204+
cp -r "${sdk_services_backup_dir}/${service}/LICENSE.md" "${SERVICES_FOLDER}/${service}/LICENSE.md"
205205
fi
206206

207207
# If the service has a NOTICE file, move it inside the service folder
208-
if [ -f ${sdk_services_backup_dir}/${service}/NOTICE.txt ]; then
208+
if [ -f "${sdk_services_backup_dir}/${service}/NOTICE.txt" ]; then
209209
echo "Found ${service} \"NOTICE\" file"
210-
cp -r ${sdk_services_backup_dir}/${service}/NOTICE.txt ${SERVICES_FOLDER}/${service}/NOTICE.txt
210+
cp -r "${sdk_services_backup_dir}/${service}/NOTICE.txt" "${SERVICES_FOLDER}/${service}/NOTICE.txt"
211211
fi
212212

213213
# If the service has a VERSION file, move it inside the service folder
214-
if [ -f ${sdk_services_backup_dir}/${service}/VERSION ]; then
214+
if [ -f "${sdk_services_backup_dir}/${service}/VERSION" ]; then
215215
echo "Found ${service} \"VERSION\" file"
216-
cp -r ${sdk_services_backup_dir}/${service}/VERSION ${SERVICES_FOLDER}/${service}/VERSION
216+
cp -r "${sdk_services_backup_dir}/${service}/VERSION" "${SERVICES_FOLDER}/${service}/VERSION"
217217
fi
218218

219-
cd ${SERVICES_FOLDER}/${service}
219+
cd "${SERVICES_FOLDER}/${service}"
220220
go work use .
221221
# Make sure that dependencies are uptodate
222222
go get -u ./...
223223
go mod tidy
224224
done
225225

226226
# Add examples to workspace
227-
if [ -d ${EXAMPLES_FOLDER} ]; then
227+
if [ -d "${EXAMPLES_FOLDER}" ]; then
228228
for example_dir in ${EXAMPLES_FOLDER}/*; do
229-
cd ${example_dir}
229+
cd "${example_dir}"
230230
go work use .
231231
done
232232
fi
233233

234234
# Add scripts to workspace
235-
if [ -d ${SCRIPTS_FOLDER} ]; then
236-
cd ${SCRIPTS_FOLDER}
235+
if [ -d "${SCRIPTS_FOLDER}" ]; then
236+
cd "${SCRIPTS_FOLDER}"
237237
go work use .
238238
fi
239239

240240
# Cleanup after SDK generation
241-
cd ${SDK_REPO_LOCAL_PATH}
242-
goimports -w ${SERVICES_FOLDER}/
241+
cd "${SDK_REPO_LOCAL_PATH}"
242+
goimports -w "${SERVICES_FOLDER}/"
243243
make sync-tidy
244244

245245
if [[ -n "$warning" ]]; then

‎scripts/generate-sdk/languages/java.sh‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ generate_java_sdk() {
100100
continue
101101
fi
102102

103-
if grep -E "^$service$" "${ROOT_DIR}/blacklist.txt"; then
103+
if grep -E "^$service$" "${ROOT_DIR}/config/java/blacklist.txt"; then
104104
echo "Skipping blacklisted service ${service}"
105105
warning+="Skipping blacklisted service ${service}\n"
106106
continue
@@ -124,8 +124,8 @@ generate_java_sdk() {
124124
--git-repo-id "${GIT_REPO_ID}" \
125125
--global-property apis,models,modelTests=false,modelDocs=false,apiDocs=false,apiTests=true,supportingFiles \
126126
--additional-properties="artifactId=${service},artifactDescription=${SERVICE_DESCRIPTION},invokerPackage=cloud.stackit.sdk.${service},modelPackage=cloud.stackit.sdk.${service}.model,apiPackage=cloud.stackit.sdk.${service}.api,serviceName=${service_pascal_case}" >/dev/null \
127-
--http-user-agent stackit-sdk-java/"${service}" \
128-
--config openapi-generator-config-java.yml
127+
--http-user-agent stackit-sdk-java/"${service}" \
128+
--config "${ROOT_DIR}/config/java/openapi-generator-config.yml"
129129

130130
# Rename DefaultApiServiceApi.java to {serviceName}Api.java
131131
# This approach is a workaround because the file name cannot be set dynamically via --additional-properties or the config file in OpenAPI Generator.

‎scripts/generate-sdk/languages/python.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ generate_python_sdk() {
9292
service=$(echo "${service}" | tr '[:upper:]' '[:lower:]') # convert upper case letters to lower case
9393
service=$(echo "${service}" | tr -d -c '[:alnum:]') # remove non-alphanumeric characters
9494

95-
if grep -E "^$service$" ${ROOT_DIR}/blacklist.txt; then
95+
if grep -E "^$service$" "${ROOT_DIR}/config/python/blacklist.txt"; then
9696
echo "Skipping blacklisted service ${service}"
9797
warning+="Skipping blacklisted service ${service}\n"
9898
continue

0 commit comments

Comments
 (0)