Add gen-client.sh

This script focusses on generating the client from an api spec file. It does not require access to a running pulp instance. [noissue]
pulp · Jun 18, 2024 · 58a94cf · 58a94cf
1 parent 6bc3825
commit 58a94cf
Show file tree

Hide file tree

Showing 3 changed files with 125 additions and 110 deletions.
diff --git a/.gitignore b/.gitignore
@@ -65,3 +65,6 @@ target/
 
 # written in generate.sh
 .openapi-generator-ignore
+
+# generated client packages
+/*-client/
diff --git a/gen-client.sh b/gen-client.sh
@@ -0,0 +1,117 @@
+#!/bin/bash
+
+set -eu
+
+if [ $# -eq 0 ]
+then
+  echo "No arguments provided"
+  echo "Usage: $0 <api_spec> <component> [<language> [<package>]]"
+  exit 1
+fi
+
+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"' < "${API_SPEC}")"
+
+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}"
+
+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")
+  else
+    USER_COMMAND=("--userns=keep-id")
+  fi
+  ULIMIT_COMMAND=()
+else
+  CONTAINER_EXEC=docker
+  if [[ -n "${PULP_MCS_LABEL:-}" ]]
+  then
+    USER_COMMAND=("-u" "$(id -u)" "--security-opt" "label=level:$PULP_MCS_LABEL")
+  else
+    USER_COMMAND=("-u" "$(id -u)")
+  fi
+  ULIMIT_COMMAND=("--ulimit" "nofile=122880:122880")
+fi
+
+# Mount volumes from parent container with `--volumes-from` option if `PARENT_CONTAINER_ID` is set.
+if [ -z "${PARENT_CONTAINER_ID:-}" ]
+then
+  if command -v getenforce > /dev/null && [ "$(getenforce)" == "Enforcing" ]
+  then
+    VOLUME_NAME="/local:Z"
+  else
+    VOLUME_NAME="/local"
+  fi
+  VOLUME_OPTION=("--volume" "${PWD}:${VOLUME_NAME}")
+  VOLUME_DIR="/local"
+else
+  VOLUME_OPTION=("--volumes-from" "${PARENT_CONTAINER_ID}:rw")
+  VOLUME_DIR="${PWD}"
+fi
+
+if [ "$LANGUAGE" = "python" ]
+then
+  $CONTAINER_EXEC run \
+    "${ULIMIT_COMMAND[@]}" \
+    "${USER_COMMAND[@]}" \
+    --rm \
+    "${VOLUME_OPTION[@]}" \
+    "$OPENAPI_PYTHON_IMAGE" generate \
+    -i "${VOLUME_DIR}/${API_SPEC}" \
+    -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" \
+    --skip-validate-spec \
+    --strict-spec=false
+  cp python/__init__.py "${PACKAGE}-client/pulpcore/"
+  cp python/__init__.py "${PACKAGE}-client/pulpcore/client/"
+fi
+
+if [ "$LANGUAGE" = "ruby" ]
+then
+  # https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-to-skip-certain-files-during-code-generation
+  mkdir -p "$1-client"
+  echo git_push.sh > "${PACKAGE}-client/.openapi-generator-ignore"
+
+  python3 remove-cookie-auth.py
+  $CONTAINER_EXEC run \
+    "${ULIMIT_COMMAND[@]}" \
+    "${USER_COMMAND[@]}" \
+    --rm \
+    "${VOLUME_OPTION[@]}" \
+    "$OPENAPI_RUBY_IMAGE" generate \
+    -i "${VOLUME_DIR}/${API_SPEC}" \
+    -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" \
+    --skip-validate-spec \
+    --strict-spec=false
+fi
+
+if [ "$LANGUAGE" = "typescript" ]
+then
+  $CONTAINER_EXEC run \
+    "${ULIMIT_COMMAND[@]}" \
+    "${USER_COMMAND[@]}" \
+    --rm \
+    "${VOLUME_OPTION[@]}" \
+    "$OPENAPI_TYPESCRIPT_IMAGE" generate \
+    -i "${VOLUME_DIR}/${API_SPEC}" \
+    -g typescript-axios \
+    -o "${VOLUME_DIR}/${PACKAGE}-client" \
+    -t "${VOLUME_DIR}/templates/typescript-axios" \
+    --skip-validate-spec \
+    --strict-spec=false
+fi
diff --git a/generate.sh b/generate.sh
@@ -8,34 +8,6 @@ then
   exit 1
 fi
 
-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")
-  else
-    USER_COMMAND=("--userns=keep-id")
-  fi
-  ULIMIT_COMMAND=()
-else
-  CONTAINER_EXEC=docker
-  if [[ -n "${PULP_MCS_LABEL:-}" ]]
-  then
-    USER_COMMAND=("-u" "$(id -u)" "--security-opt" "label=level:$PULP_MCS_LABEL")
-  else
-    USER_COMMAND=("-u" "$(id -u)")
-  fi
-  ULIMIT_COMMAND=("--ulimit" "nofile=122880:122880")
-fi
-
-if command -v getenforce > /dev/null && [ "$(getenforce)" == "Enforcing" ]
-then
-  VOLUME_NAME="/local:Z"
-else
-  VOLUME_NAME="/local"
-fi
-
 # Skip downloading the api.json if `USE_LOCAL_API_JSON` is set.
 if [[ -z "${USE_LOCAL_API_JSON:-}" ]]
 then
@@ -57,94 +29,17 @@ then
   # Get the version of the pulpcore or plugin as reported by status API
 fi
 
-DOMAIN_ENABLED="$(jq -r '.info | ."x-pulp-domain-enabled" // false' < api.json)"
-
-if [ $# -gt 2 ]
+# match the component name by removing the "pulp/pulp_" prefix
+if [ "$1" = "pulpcore" ]
 then
-  export VERSION=$3
+    COMPONENT="core"
 else
-  # match the component name by removing the "pulp/pulp_" prefix
-  if [ "$1" = "pulpcore" ]
-  then
-      COMPONENT="core"
-  else
-      COMPONENT=${1#"pulp_"}
-  fi
-
-  VERSION="$(curl -k "${PULP_URL}status/" | jq --arg component "$COMPONENT" -r '.versions[] | select(.component == $component) | .version')"
+    COMPONENT=${1#"pulp_"}
 fi
 
-# Mount volumes from parent container with `--volumes-from` option if the
-# `PARENT_CONTAINER_ID` is set.
-if [ -z "${PARENT_CONTAINER_ID:-}" ]
-then
-  VOLUME_OPTION=("--volume" "${PWD}:${VOLUME_NAME}")
-  VOLUME_DIR="/local"
-else
-  VOLUME_OPTION=("--volumes-from" "${PARENT_CONTAINER_ID}:rw")
-  VOLUME_DIR="${PWD}"
-fi
-
-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 ::group::BINDINGS
-if [ "$2" = "python" ]
-then
-  $CONTAINER_EXEC run \
-    "${ULIMIT_COMMAND[@]}" \
-    "${USER_COMMAND[@]}" \
-    --rm \
-    "${VOLUME_OPTION[@]}" \
-    "$OPENAPI_PYTHON_IMAGE" generate \
-    -i "${VOLUME_DIR}/api.json" \
-    -g python \
-    -o "${VOLUME_DIR}/$1-client" \
-    "--additional-properties=packageName=pulpcore.client.$1,projectName=$1-client,packageVersion=${VERSION},domainEnabled=${DOMAIN_ENABLED}" \
-    -t "${VOLUME_DIR}/templates/python" \
-    --skip-validate-spec \
-    --strict-spec=false
-  cp python/__init__.py "$1-client/pulpcore/"
-  cp python/__init__.py "$1-client/pulpcore/client/"
-fi
-if [ "$2" = 'ruby' ]
-then
-  # https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-to-skip-certain-files-during-code-generation
-  mkdir -p "$1-client"
-  echo git_push.sh > "$1-client/.openapi-generator-ignore"
 
-  python3 remove-cookie-auth.py
-  $CONTAINER_EXEC run \
-    "${ULIMIT_COMMAND[@]}" \
-    "${USER_COMMAND[@]}" \
-    --rm \
-    "${VOLUME_OPTION[@]}" \
-    "$OPENAPI_RUBY_IMAGE" generate \
-    -i "${VOLUME_DIR}/api.json" \
-    -g ruby \
-    -o "${VOLUME_DIR}/$1-client" \
-    "--additional-properties=gemName=$1_client,gemLicense="GPLv2+",gemVersion=${VERSION},gemHomepage=https://github.com/pulp/$1" \
-    --library=faraday \
-    -t "${VOLUME_DIR}/templates/ruby" \
-    --skip-validate-spec \
-    --strict-spec=false
-fi
-if [ "$2" = 'typescript' ]
-then
-  $CONTAINER_EXEC run \
-    "${ULIMIT_COMMAND[@]}" \
-    "${USER_COMMAND[@]}" \
-    --rm \
-    "${VOLUME_OPTION[@]}" \
-    "$OPENAPI_TYPESCRIPT_IMAGE" generate \
-    -i "${VOLUME_DIR}/api.json" \
-    -g typescript-axios \
-    -o "${VOLUME_DIR}/$1-client" \
-    -t "${VOLUME_DIR}/templates/typescript-axios" \
-    --skip-validate-spec \
-    --strict-spec=false
-fi
+./gen-client.sh api.json "${COMPONENT}" "${2:-python}" "${1}"
 
 echo ::endgroup::
 if [[ -z "${USE_LOCAL_API_JSON:-}" ]]