feat(interactive): Init interactive python admin service (#4592)

Initialize Python-based interactive admin service.

Author: zhanglei1949

.github/workflows/interactive.yml

@@ -186,6 +186,11 @@ jobs:
         cd ${GITHUB_WORKSPACE}/flex/tests/hqps
         bash hqps_admin_test.sh ${TMP_INTERACTIVE_WORKSPACE} ./interactive_config_test.yaml ${GS_TEST_DIR}
 
+    - name: Test Interactive Python Admin Service
+      run:
+        cd ${GITHUB_WORKSPACE}/flex/interactive/sdk
+        bash generate_sdk.sh -g python -t server
+
     - name: Build and test Interactive Java/Python SDK
       env: 
         FLEX_DATA_DIR: ${{ github.workspace }}/flex/interactive/examples/modern_graph

.gitignore

@@ -158,16 +158,24 @@ flex/interactive/sdk/python/pyproject.toml
 flex/interactive/sdk/python/gs_interactive/models/
 flex/interactive/sdk/python/gs_interactive/api/
 flex/interactive/sdk/python/gs_interactive/__init__.py
-flex/interactive/sdk/python/gs_interactive/api_client.py
 flex/interactive/sdk/python/gs_interactive/api_response.py
-flex/interactive/sdk/python/gs_interactive/configuration.py
 flex/interactive/sdk/python/gs_interactive/exceptions.py
 flex/interactive/sdk/python/gs_interactive/rest.py
 !flex/interactive/sdk/python/gs_interactive/client/generated/__init__.py
 !flex/interactive/sdk/python/gs_interactive/models/long_text.py
 !flex/interactive/sdk/python/gs_interactive/models/time_stamp_type.py
 !flex/interactive/sdk/python/gs_interactive/models/date_type.py
 
+flex/interactive/sdk/master/.github/
+flex/interactive/sdk/master/Dockerfile
+flex/interactive/sdk/master/git_push.sh
+flex/interactive/sdk/master/tox.ini
+flex/interactive/sdk/master/.travis.yml
+flex/interactive/sdk/master/.dockerignore
+flex/interactive/sdk/master/.gitignore
+flex/interactive/sdk/master/gs_interactive_admin/models/
+flex/interactive/sdk/master/gs_interactive_admin/typing_utils.py
+
 interactive_engine/groot-http/src/main/java/com/alibaba/graphscope/groot/service/models/
 interactive_engine/groot-http/.openapi-generator/
 interactive_engine/groot-http/src/main/java/org/

flex/interactive/sdk/generate_sdk.sh

@@ -18,6 +18,7 @@
 
 PACKAGE_NAME="com.alibaba.graphscope.interactive"
 PYTHON_PACKAGE_NAME="gs_interactive"
+PYTHON_ADMIN_PACKAGE_NAME="gs_interactive_admin"
 GROUP_ID="com.alibaba.graphscope"
 ARTIFACT_ID="interactive"
 ARTIFACT_URL="https://github.com/alibaba/GraphScope/tree/main/flex/interactive"
@@ -29,7 +30,7 @@ developerOrganizationUrl="https://graphscope.io"
 DEVELOPER_NAME="GraphScope Team"
 LICENSE_NAME="Apache-2.0"
 LICENSE_URL="https://www.apache.org/licenses/LICENSE-2.0.html"
-LOG_LEVEL="error"
+LOG_LEVEL="INFO"
 export OPENAPI_GENERATOR_VERSION=7.2.0
 
 #get current bash scrip's directory
@@ -46,6 +47,18 @@ function usage() {
 }
 
 function do_gen_java() {
+    if [ $# -ne 1 ]; then
+        err "Invalid number of arguments:$#"
+        usage
+        exit 1
+    fi
+    type=$(echo $1 | tr '[:upper:]' '[:lower:]')
+    if [ "$type" != "client" ]; then
+        err "Currently only support client type when generating Java Code"
+        usage
+        exit 1
+    fi
+
     echo "Generating Java SDK"
     OUTPUT_PATH="${CUR_DIR}/java/"
 
@@ -71,14 +84,35 @@ function do_gen_java() {
 }
 
 function do_gen_python() {
-    echo "Generating Python SDK"
-    OUTPUT_PATH="${CUR_DIR}/python"
-    export JAVA_OPTS="-Dlog.level=${LOG_LEVEL}"
-    cmd="openapi-generator-cli generate -i ${OPENAPI_SPEC_PATH} -g python -o ${OUTPUT_PATH}"
-    cmd=" ${cmd} --package-name ${PYTHON_PACKAGE_NAME}"
-    cmd=" ${cmd} --additional-properties=packageVersion=${VERSION},pythonVersion=3"
-    echo "Running command: ${cmd}"
-    eval $cmd
+    if [ $# -ne 1 ]; then
+        err "Invalid number of arguments:$#"
+        usage
+        exit 1
+    fi
+    type=$(echo $1 | tr '[:upper:]' '[:lower:]')
+    if [ "$type" == "client" ]; then
+        echo "Generating Python SDK"
+        OUTPUT_PATH="${CUR_DIR}/python"
+        export JAVA_OPTS="-Dlog.level=${LOG_LEVEL}"
+        cmd="openapi-generator-cli generate -i ${OPENAPI_SPEC_PATH} -g python -o ${OUTPUT_PATH}"
+        cmd=" ${cmd} --package-name ${PYTHON_PACKAGE_NAME}"
+        cmd=" ${cmd} --additional-properties=packageVersion=${VERSION},pythonVersion=3"
+        echo "Running command: ${cmd}"
+        eval $cmd
+    elif [ "$type" == "server" ]; then
+        echo "Generating Python Server"
+        OUTPUT_PATH="${CUR_DIR}/master"
+        export JAVA_OPTS="-Dlog.level=${LOG_LEVEL}"
+        cmd="openapi-generator-cli generate -i ${OPENAPI_SPEC_PATH} -g python-flask -o ${OUTPUT_PATH}"
+        cmd=" ${cmd} --package-name ${PYTHON_ADMIN_PACKAGE_NAME}"
+        cmd=" ${cmd} --additional-properties=packageVersion=${VERSION},pythonVersion=3"
+        echo "Running command: ${cmd}"
+        eval $cmd
+    else
+        err "Unsupported type: $type"
+        usage
+        exit 1
+    fi
 }
 
 function do_gen_spring() {
@@ -96,20 +130,20 @@ function do_gen_spring() {
 }
 
 function do_gen() {
-    # expect only one argument
-    if [ $# -ne 1 ]; then
+    if [ $# -ne 2 ]; then
         err "Invalid number of arguments:$#"
         usage
         exit 1
     fi
     # to lower case
     lang=$(echo $1 | tr '[:upper:]' '[:lower:]')
+    type=$(echo $2 | tr '[:upper:]' '[:lower:]')
     case $lang in
     java)
-        do_gen_java
+        do_gen_java $type
         ;;
     python)
-        do_gen_python
+        do_gen_python $type
         ;;
     spring)
         do_gen_spring
@@ -178,6 +212,8 @@ function install_generator() {
 }
 
 install_generator
+type="client" # client or server
+language=""
 
 while [[ $# -gt 0 ]]; do
   key="$1"
@@ -189,13 +225,20 @@ while [[ $# -gt 0 ]]; do
     ;;
   -g | --lang)
     shift
-    do_gen "$@"
-    exit 0
+    language="$1"
+    shift
+    ;;
+  -t | --type)
+    shift
+    type="$1"
+    shift
     ;;
   *) # unknown option
     err "unknown option $1"
     usage
     exit 1
     ;;
   esac
-done
+done
+
+do_gen $language $type

flex/interactive/sdk/master/.openapi-generator-ignore

@@ -0,0 +1,44 @@
+# 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
+
+README.md
+setup.py
+gs_interactive_admin/controllers/admin_service_graph_management_controller.py
+gs_interactive_admin/controllers/admin_service_procedure_management_controller.py
+gs_interactive_admin/controllers/graph_service_edge_management_controller.py
+gs_interactive_admin/controllers/query_service_controller.py
+gs_interactive_admin/controllers/admin_service_job_management_controller.py
+gs_interactive_admin/controllers/admin_service_service_management_controller.py
+gs_interactive_admin/controllers/graph_service_vertex_management_controller.py
+gs_interactive_admin/controllers/utils_controller.py
+gs_interactive_admin/controllers/security_controller.py
+gs_interactive_admin/controllers/admin_service_service_registry_controller.py
+gs_interactive_admin/test/
+gs_interactive_admin/encoder.py
+requirements.txt
+test-requirements.txt
+setup.cfg
+gs_interactive_admin/__init__.py
+gs_interactive_admin/__main__.py
+gs_interactive_admin/util.py

flex/interactive/sdk/master/README.md

@@ -0,0 +1,49 @@
+# OpenAPI generated server
+
+## Overview
+This server was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the
+[OpenAPI-Spec](https://openapis.org) from a remote server, you can easily generate a server stub.  This
+is an example of building a OpenAPI-enabled Flask server.
+
+This example uses the [Connexion](https://github.com/zalando/connexion) library on top of Flask.
+
+## Requirements
+Python 3.5.2+
+
+## Usage
+To run the server, please execute the following from the root directory:
+
+```
+pip3 install -r requirements.txt
+python3 -m gs_interactive_admin
+```
+
+and open your browser to here:
+
+```
+http://localhost:8080/ui/
+```
+
+Your OpenAPI definition lives here:
+
+```
+http://localhost:8080/openapi.json
+```
+
+To launch the integration tests, use tox:
+```
+sudo pip install tox
+tox
+```
+
+## Running with Docker
+
+To run the server on a Docker container, please execute the following from the root directory:
+
+```bash
+# building the image
+docker build -t gs_interactive_admin .
+
+# starting up a container
+docker run -p 8080:8080 gs_interactive_admin
+```

flex/interactive/sdk/master/gs_interactive_admin/__init__.py

@@ -0,0 +1,17 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Copyright 2020 Alibaba Group Holding Limited. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#

flex/interactive/sdk/master/gs_interactive_admin/__main__.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Copyright 2020 Alibaba Group Holding Limited. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+import connexion
+
+from gs_interactive_admin import encoder
+
+
+def main():
+    app = connexion.App(__name__, specification_dir="./openapi/")
+    app.app.json_encoder = encoder.JSONEncoder
+    app.add_api(
+        "openapi.yaml",
+        arguments={"title": "GraphScope Interactive API v0.3"},
+        pythonic_params=True,
+    )
+
+    app.run(port=8080)
+
+
+if __name__ == "__main__":
+    main()

flex/interactive/sdk/master/gs_interactive_admin/controllers/__init__.py

@@ -0,0 +1,17 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Copyright 2020 Alibaba Group Holding Limited. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#