update_generated.sh

#!/bin/bash

set -euo pipefail

SED=sed
if [[ "$OSTYPE" =~ "darwin" ]]; then
	SED=gsed # Use GNU sed on macOS.
fi

USAGE='
Usage:

    update_generated.sh /path/to/TileDB-Cloud-API-Spec

This creates generated API documents in [repo root]/src/tiledb/cloud/rest_api.
'

if [[ "$#" -ne 1 ]]; then
  echo "$USAGE"
  exit 1
fi

ROOT="$(git rev-parse --show-toplevel)"
GENERATOR="$ROOT/.cache/openapi-generator-cli-4.3.1.jar"
TEMP_PACKAGE_NAME="zzz_replace_me_zzz"

OPENAPI_GENERATOR_IGNORE='
docs/*
test/
test/*
git_push.sh
tox.ini
test-requirements.txt
setup.py
.gitignore
.travis.yml
'

OPENAPI_GENERATOR_CONFIG='
{
  "projectName": "tiledb-cloud",
  "packageName": "'"${TEMP_PACKAGE_NAME}"'",
  "documentationPage": false,
  "generateSourceCodeOnly": true
}
'

download_generator() {
  if [[ ! -f "$GENERATOR" ]]; then
    mkdir -p "$ROOT/.cache"
    wget -O "$GENERATOR" "https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar"
  fi
}

generate_api() {
  RAW_SPEC="$1"
  PACKAGE_NAME="$2"
  PACKAGE_NAME_SLASHY="${PACKAGE_NAME//.//}"

  TARGET_PATH="$ROOT/src/tiledb/cloud"

  TEMP_PATH="$(mktemp -d /tmp/api_gen.XXXXXX)"

  SPEC="$("$ROOT/generator/rewrite_urls.py" "$RAW_SPEC")"

  ################################################################################
  # minimize output to what we want
  echo "$OPENAPI_GENERATOR_IGNORE" > ${TEMP_PATH}/.openapi-generator-ignore

  ################################################################################
  # openapi-generator config
  echo "$OPENAPI_GENERATOR_CONFIG" > ${TEMP_PATH}/openapi_config-api

  ################################################################################
  java -jar "$GENERATOR" \
    generate \
    -c "$TEMP_PATH/openapi_config-api" \
    -o "$TEMP_PATH" \
    -i "$SPEC" \
    -g python \
    --skip-validate-spec  # The generator doesn't like the v2 spec.

  # Remove useless generated "test" files.
  rm -r -- "${TEMP_PATH}/${TEMP_PACKAGE_NAME}/test"

  # Rewrite imports and links in docs,
  # and work around https://github.com/OpenAPITools/openapi-generator/issues/10236
  find "${TEMP_PATH}" \
    -type f \
    -execdir \
      "$SED" --in-place \
        -e "s/${TEMP_PACKAGE_NAME}\./tiledb.cloud.${PACKAGE_NAME}./g" \
        -e "s/\\(from\\|import\\) ${TEMP_PACKAGE_NAME}/\\1 tiledb.cloud.${PACKAGE_NAME}/g" \
        -e "s/${TEMP_PACKAGE_NAME}/${PACKAGE_NAME}/g" \
        -e "s/ del =/ _del =/g" \
        '{}' \
    '+'

  # Fix up links in README.
  "$SED" --in-place -e "s/](${PACKAGE_NAME}\\//](/g" "${TEMP_PATH}/${TEMP_PACKAGE_NAME}_README.md"

  # Get TARGET_PATH out of the way (if present).
  if [ -e "$TARGET_PATH/$PACKAGE_NAME_SLASHY" ]; then
    rm -r -- "$TARGET_PATH/$PACKAGE_NAME_SLASHY"
  fi

  # move generated files to TARGET_PATH
  cp -r "${TEMP_PATH}/${TEMP_PACKAGE_NAME}" "${TARGET_PATH}/${PACKAGE_NAME_SLASHY}"

  cp ${TEMP_PATH}/${TEMP_PACKAGE_NAME}_README.md ${TARGET_PATH}/${PACKAGE_NAME_SLASHY}/README.md
  cp ${TEMP_PATH}/.openapi-generator-ignore ${TARGET_PATH}/${PACKAGE_NAME_SLASHY}/
  cp ${TEMP_PATH}/openapi_config-api ${TARGET_PATH}/${PACKAGE_NAME_SLASHY}/
  cp -r ${TEMP_PATH}/.openapi-generator/ ${TARGET_PATH}/${PACKAGE_NAME_SLASHY}/

  echo
  echo "Output copied from '${TEMP_PATH}' to '${TARGET_PATH}/${PACKAGE_NAME_SLASHY}'"
}

run_format() {
  cd "$ROOT"
  # Both of these return 0 even when they do reformatting.
  for command in 'ruff --fix -e .' 'pre-commit run --all'; do
    # Intentionally not in quotes, to run each string as a command line.
    if $command; then continue; fi
    # This part only runs if $command failed.
    progname="${command%% *}"
    echo "${progname} is not installed." >&2
    echo 'Before sending a review request, run:' >&2
    echo "  $ pip install ${progname}" >&2
    echo "  $ cd ${ROOT}" >&2
    echo "  $ ${command}" >&2
    echo 'to ensure your files are correctly formatted.' >&2
  done
}

# Apply an api_client patch to avoid descending into known–JSON-safe values.
apply_json_safe_patch() {
  git apply - <<EOF
diff --git a/src/tiledb/cloud/rest_api/api_client.py b/src/tiledb/cloud/rest_api/api_client.py
index 97319c27..f2307414 100644
--- a/src/tiledb/cloud/rest_api/api_client.py
+++ b/src/tiledb/cloud/rest_api/api_client.py
@@ -24,7 +24,8 @@ import six
 from dateutil.parser import parse
 from six.moves.urllib.parse import quote

-import tiledb.cloud.rest_api.models
+from tiledb.cloud._common import json_safe
+from tiledb.cloud.rest_api import models
 from tiledb.cloud.rest_api import rest
 from tiledb.cloud.rest_api.configuration import Configuration
 from tiledb.cloud.rest_api.exceptions import ApiException
@@ -73,6 +74,7 @@ class ApiClient(object):
         header_value=None,
         cookie=None,
         pool_threads=1,
+        _tdb_models_module=None,
     ):
         if configuration is None:
             configuration = Configuration.get_default_copy()
@@ -87,6 +89,12 @@ class ApiClient(object):
         # Set default User-Agent.
         self.user_agent = "OpenAPI-Generator/1.0.0/python"
         self.client_side_validation = configuration.client_side_validation
+        self._tdb_models_module = _tdb_models_module or models
+        """The module to look up model names on when parsing messages.
+
+        This is needed to share the same API class between both this API version
+        and API version 2.  See __deserialize for use.
+        """

     def __enter__(self):
         return self
@@ -250,6 +258,8 @@ class ApiClient(object):
         """
         if obj is None:
             return None
+        elif isinstance(obj, json_safe.Value):
+            return obj.value
         elif isinstance(obj, self.PRIMITIVE_TYPES):
             return obj
         elif isinstance(obj, list):
@@ -326,7 +336,7 @@ class ApiClient(object):
             if klass in self.NATIVE_TYPES_MAPPING:
                 klass = self.NATIVE_TYPES_MAPPING[klass]
             else:
-                klass = getattr(tiledb.cloud.rest_api.models, klass)
+                klass = getattr(self._tdb_models_module, klass)

         if klass in self.PRIMITIVE_TYPES:
             return self.__deserialize_primitive(data, klass)
EOF
}

ABSPATH="$(realpath "$1")"

download_generator
generate_api "${ABSPATH%/}/openapi-v1.yaml" rest_api
generate_api "${ABSPATH%/}/openapi-v2.yaml" _common.api_v2
run_format
apply_json_safe_patch
cp "$ROOT/generator/openapi_overrides"/* "$TARGET_PATH/_common/api_v2"