Core version dependence

Add the infrastructure so we can select the generator image based on the combination of the target language and the pulpcore version. The template replacements are versioned accordingly. [noissue]
pulp · Dec 3, 2024 · 4b98ddc · 4b98ddc
1 parent 6001f26
commit 4b98ddc
Show file tree

Hide file tree

Showing 9 changed files with 48 additions and 14 deletions.
diff --git a/gen-client.sh b/gen-client.sh
@@ -9,27 +9,61 @@ then
   exit 1
 fi
 
+normalize_version ()
+{
+  python3 -c '
+import sys
+from packaging.version import Version
+
+print(Version(sys.stdin.read()))
+'
+}
+
+generator_version ()
+{
+  python3 -c '
+import sys
+from packaging.version import Version
+
+language = sys.argv[1]
+core_version = Version(sys.stdin.read())
+
+if language.lower() == "python":
+    if core_version >= Version("3.70.dev"):
+        print("v4.3.1")
+    else:
+        print("v4.3.1")
+elif language.lower() == "ruby":
+    print("v4.3.1")
+elif language.lower() == "typescript":
+    print("v5.2.1")
+else:
+    exit(1)
+' "$@"
+}
+
 API_SPEC="$1"
 COMPONENT="$2"
 LANGUAGE="${3:-python}"
 PACKAGE="${4:-pulp_${COMPONENT//-/_}}"
 
 DOMAIN_ENABLED="$(jq -r '.info."x-pulp-domain-enabled" // false' < "${API_SPEC}")"
-VERSION="$(jq -r --arg component "$COMPONENT" '.info."x-pulp-app-versions"[$component] // error("No version found.")' < "${API_SPEC}")"
-echo "Unnormalized Version: ${VERSION}"
-VERSION="$(python3 -c "from packaging.version import Version; print(Version('${VERSION}'))")"
-echo "Version: ${VERSION}"
+VERSION="$(jq -r --arg component "${COMPONENT}" '.info."x-pulp-app-versions"[$component] // error("No version found.")' < "${API_SPEC}" | normalize_version)"
+CORE_VERSION="$(jq -r '.info."x-pulp-app-versions".core // "0.0.0"' < "${API_SPEC}" | normalize_version)"
+GENERATOR_VERSION="$(generator_version "${LANGUAGE}" <<<"${CORE_VERSION}")"
+IMAGE_OVERRIDE_VAR="OPENAPI_${LANGUAGE^^}_IMAGE"
+OPENAPI_IMAGE="${!IMAGE_OVERRIDE_VAR:-docker.io/openapitools/openapi-generator-cli:${GENERATOR_VERSION}}"
+IMAGE_TAG="${OPENAPI_IMAGE#*:}"
 
-OPENAPI_PYTHON_IMAGE="${OPENAPI_PYTHON_IMAGE:-docker.io/openapitools/openapi-generator-cli:v4.3.1}"
-OPENAPI_RUBY_IMAGE="${OPENAPI_RUBY_IMAGE:-docker.io/openapitools/openapi-generator-cli:v4.3.1}"
-OPENAPI_TYPESCRIPT_IMAGE="${OPENAPI_TYPESCRIPT_IMAGE:-docker.io/openapitools/openapi-generator-cli:v5.2.1}"
+echo "${COMPONENT}: ${VERSION}  core: ${CORE_VERSION}  domains: ${DOMAIN_ENABLED}  generator: ${GENERATOR_VERSION}"
+echo "Using: ${OPENAPI_IMAGE}"
 
 if command -v podman > /dev/null
 then
   CONTAINER_EXEC=podman
   if [[ -n "${PULP_MCS_LABEL:-}" ]]
   then
-    USER_COMMAND=("--userns=keep-id" "--security-opt" "label=level:$PULP_MCS_LABEL")
+    USER_COMMAND=("--userns=keep-id" "--security-opt" "label=level:${PULP_MCS_LABEL}")
   else
     USER_COMMAND=("--userns=keep-id")
   fi
@@ -38,7 +72,7 @@ else
   CONTAINER_EXEC=docker
   if [[ -n "${PULP_MCS_LABEL:-}" ]]
   then
-    USER_COMMAND=("-u" "$(id -u)" "--security-opt" "label=level:$PULP_MCS_LABEL")
+    USER_COMMAND=("-u" "$(id -u)" "--security-opt" "label=level:${PULP_MCS_LABEL}")
   else
     USER_COMMAND=("-u" "$(id -u)")
   fi
@@ -76,12 +110,12 @@ then
     "${USER_COMMAND[@]}" \
     --rm \
     "${VOLUME_OPTION[@]}" \
-    "$OPENAPI_PYTHON_IMAGE" generate \
+    "${OPENAPI_IMAGE}" generate \
     -i "${VOLUME_DIR}/patched-api.json" \
     -g python \
     -o "${VOLUME_DIR}/${PACKAGE}-client" \
     "--additional-properties=packageName=pulpcore.client.${PACKAGE},projectName=${PACKAGE}-client,packageVersion=${VERSION},domainEnabled=${DOMAIN_ENABLED}" \
-    -t "${VOLUME_DIR}/templates/python" \
+    -t "${VOLUME_DIR}/templates/python/${IMAGE_TAG}" \
     --skip-validate-spec \
     --strict-spec=false
   cp python/__init__.py "${PACKAGE}-client/pulpcore/"
@@ -101,13 +135,13 @@ then
     "${USER_COMMAND[@]}" \
     --rm \
     "${VOLUME_OPTION[@]}" \
-    "$OPENAPI_RUBY_IMAGE" generate \
+    "${OPENAPI_IMAGE}" generate \
     -i "${VOLUME_DIR}/patched-api.json" \
     -g ruby \
     -o "${VOLUME_DIR}/${PACKAGE}-client" \
     "--additional-properties=gemName=${PACKAGE}_client,gemLicense="GPLv2+",gemVersion=${VERSION},gemHomepage=https://github.com/pulp/${PACKAGE}" \
     --library=faraday \
-    -t "${VOLUME_DIR}/templates/ruby" \
+    -t "${VOLUME_DIR}/templates/ruby/${IMAGE_TAG}" \
     --skip-validate-spec \
     --strict-spec=false
 fi
@@ -121,7 +155,7 @@ then
     "${USER_COMMAND[@]}" \
     --rm \
     "${VOLUME_OPTION[@]}" \
-    "$OPENAPI_TYPESCRIPT_IMAGE" generate \
+    "${OPENAPI_TYPESCRIPT_IMAGE}" generate \
     -i "${VOLUME_DIR}/patched-api.json" \
     -g typescript-axios \
     -o "${VOLUME_DIR}/${PACKAGE}-client" \

diff --git a/templates/python/api.mustache → templates/python/v4.3.1/api.mustache b/templates/python/api.mustache → templates/python/v4.3.1/api.mustache
diff --git a/templates/python/configuration.mustache → ...ates/python/v4.3.1/configuration.mustache b/templates/python/configuration.mustache → ...ates/python/v4.3.1/configuration.mustache
diff --git a/templates/python/setup.mustache → templates/python/v4.3.1/setup.mustache b/templates/python/setup.mustache → templates/python/v4.3.1/setup.mustache
diff --git a/.../ruby/api_client_faraday_partial.mustache → ...4.3.1/api_client_faraday_partial.mustache b/.../ruby/api_client_faraday_partial.mustache → ...4.3.1/api_client_faraday_partial.mustache
diff --git a/templates/ruby/configuration.mustache → templates/ruby/v4.3.1/configuration.mustache b/templates/ruby/configuration.mustache → templates/ruby/v4.3.1/configuration.mustache
diff --git a/...onfiguration_tls_faraday_partial.mustache → ...onfiguration_tls_faraday_partial.mustache b/...onfiguration_tls_faraday_partial.mustache → ...onfiguration_tls_faraday_partial.mustache
diff --git a/templates/ruby/gemspec.mustache → templates/ruby/v4.3.1/gemspec.mustache b/templates/ruby/gemspec.mustache → templates/ruby/v4.3.1/gemspec.mustache
diff --git a/templates/typescript-axios/apiInner.mustache → ...typescript-axios/v5.2.1/apiInner.mustache b/templates/typescript-axios/apiInner.mustache → ...typescript-axios/v5.2.1/apiInner.mustache