[Python Client] Use openapi generator instead of swagger (#3872)

* Generate python client package into repo using kfp_api_single_file.swagger.json

* Commit python client generated by swagger

* Use openapi-generator instead

* Regenerate using openapi-generator

* Add extra info into swagger single file

* Update more info

* update

* Move python http client to upper folder

* Clean up build script

* Update kfp_server_api from new swagger.json

backend/api/build_kfp_server_api_python_package.sh

@@ -34,30 +34,24 @@ if [ -z "$VERSION" ]; then
     exit 1
 fi
 
-codegen_file=/tmp/swagger-codegen-cli.jar
-# Browse all versions in: https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.7/
-codegen_uri=https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.7/swagger-codegen-cli-2.4.7.jar
+codegen_file=/tmp/openapi-generator-cli.jar
+# Browse all versions in: https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/
+codegen_uri="https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar"
 if ! [ -f "$codegen_file" ]; then
-    wget --no-verbose "$codegen_uri" -O "$codegen_file"
+    curl -L "$codegen_uri" -o "$codegen_file"
 fi
 
 pushd "$(dirname "$0")"
 
-DIR=$(mktemp -d)
+DIR="$(pwd)/python_http_client"
+swagger_file="$(pwd)/swagger/kfp_api_single_file.swagger.json"
 
-swagger_file=$(mktemp)
-
-echo "Merging all Swagger API definitions to $swagger_file."
-jq -s '
-    reduce .[] as $item ({}; . * $item) |
-    .info.title = "KF Pipelines API" |
-    .info.description = "Generated python client for the KF Pipelines server API"
-' ./swagger/{run,job,pipeline,experiment,pipeline.upload}.swagger.json > "$swagger_file"
+echo "Removing old content in DIR first."
+rm -rf "$DIR"
 
 echo "Generating python code from swagger json in $DIR."
-java -jar "$codegen_file" generate -l python -i "$swagger_file" -o "$DIR" -c <(echo '{
+java -jar "$codegen_file" generate -g python -i "$swagger_file" -o "$DIR" -c <(echo '{
     "packageName": "kfp_server_api",
-    "projectName": "kfp-server-api",
     "packageVersion": "'"$VERSION"'",
     "packageUrl": "https://github.com/kubeflow/pipelines"
 }')
@@ -71,4 +65,6 @@ echo "Run the following commands to update the package on PyPI"
 echo "python3 -m pip install twine"
 echo "python3 -m twine upload --username kubeflow-pipelines $DIR/dist/*"
 
+echo "Please also push local changes to github.com/kubeflow/pipelines"
+
 popd

backend/api/generate_api.sh

@@ -21,6 +21,7 @@
 
 set -ex
 
+VERSION="1.0.0-dev.1"
 BAZEL_BINDIR=$(bazel info bazel-bin)
 DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" > /dev/null && pwd)"
 SWAGGER_CMD=${DIR}/../../bazel-bin/external/com_github_go_swagger/cmd/swagger/*stripped/swagger
@@ -57,7 +58,9 @@ jq -s '
     reduce .[] as $item ({}; . * $item) |
     .info.title = "Kubeflow Pipelines API" |
     .info.description = "This file contains REST API specification for Kubeflow Pipelines. The file is autogenerated from the swagger definition." |
-    .info.version = "0.5.1"
+    .info.version = "'$VERSION'" |
+    .info.contact = { "name": "google", "email": "kubeflow-pipelines@google.com", "url": "https://www.google.com" } |
+    .info.license = { "name": "Apache 2.0", "url": "https://raw.githubusercontent.com/kubeflow/pipelines/master/LICENSE" }
 ' ${DIR}/swagger/{run,job,pipeline,experiment,pipeline.upload}.swagger.json > "${DIR}/swagger/kfp_api_single_file.swagger.json"
 
 # Generate Go HTTP client from the swagger files.

backend/api/python_http_client/.gitignore

@@ -0,0 +1,66 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+venv/
+.venv/
+.python-version
+.pytest_cache
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+#Ipython Notebook
+.ipynb_checkpoints

backend/api/python_http_client/.gitlab-ci.yml

@@ -0,0 +1,33 @@
+# ref: https://docs.gitlab.com/ee/ci/README.html
+
+stages:
+  - test
+
+.nosetest:
+  stage: test
+  script:
+   - pip install -r requirements.txt
+   - pip install -r test-requirements.txt
+   - pytest --cov=kfp_server_api
+
+nosetest-2.7:
+  extends: .nosetest
+  image: python:2.7-alpine
+nosetest-3.3:
+  extends: .nosetest
+  image: python:3.3-alpine
+nosetest-3.4:
+  extends: .nosetest
+  image: python:3.4-alpine
+nosetest-3.5:
+  extends: .nosetest
+  image: python:3.5-alpine
+nosetest-3.6:
+  extends: .nosetest
+  image: python:3.6-alpine
+nosetest-3.7:
+  extends: .nosetest
+  image: python:3.7-alpine
+nosetest-3.8:
+  extends: .nosetest
+  image: python:3.8-alpine

backend/api/python_http_client/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

backend/api/python_http_client/.openapi-generator/VERSION

@@ -0,0 +1 @@
+4.3.1

backend/api/python_http_client/.travis.yml

@@ -0,0 +1,17 @@
+# ref: https://docs.travis-ci.com/user/languages/python
+language: python
+python:
+  - "2.7"
+  - "3.2"
+  - "3.3"
+  - "3.4"
+  - "3.5"
+  - "3.6"
+  - "3.7"
+  - "3.8"
+# command to install dependencies
+install:
+  - "pip install -r requirements.txt"
+  - "pip install -r test-requirements.txt"
+# command to run tests
+script: pytest --cov=kfp_server_api