Merge pull request Azure#15 from kairu-ms/web

React frontend and Flask backend to list all specs

Author: kairu-ms

.gitignore

@@ -120,3 +120,5 @@ __pycache__/
 # C extensions
 *.so
 
+/src/backend/flask_my_extension.egg-info/
+/aazdev

install.ps1

@@ -0,0 +1,10 @@
+py -3.9 -m venv aazdev
+./aazdev/Scripts/Activate
+
+cd ./src/web
+npm install
+npm run build
+
+cd ../backend
+pip install -r ./requirements.txt
+pip install -e .

src/backend/app.py

@@ -0,0 +1,36 @@
+from flask import Flask, request
+from swagger.view.specs import load_specs, get_specs_for_module
+import webbrowser
+from threading import Timer
+import click
+from flask.cli import FlaskGroup
+
+def open_browser():
+    webbrowser.open_new('http://127.0.0.1:5000/')
+
+def create_app():
+    app = Flask(__name__, static_folder='../web/build', static_url_path='/')
+    # other setup
+
+    @app.route('/', defaults={'path': ''})
+    @app.route('/<string:path>')
+    @app.route('/<path:path>')
+    def index(path):
+        if '.' in path:
+            return app.send_static_file(path)
+        return app.send_static_file('index.html')
+
+    @app.route("/specifications")
+    def get_specs():
+        return load_specs('specs.json')
+
+    @app.route("/specification")
+    def get_specs_for():
+        return get_specs_for_module(request.args.get('name'))
+
+    Timer(1, open_browser).start()
+    return app
+
+@click.group(cls=FlaskGroup, create_app=create_app)
+def cli():
+    """Management script for the aazdev application."""

src/backend/requirements.txt

@@ -7,3 +7,4 @@ inflect~=5.3.0
 msrestazure~=0.6.4
 knack~=0.9.0
 lxml~=4.6.4
+flask~=2.0.2

src/backend/setup.py

@@ -0,0 +1,10 @@
+from setuptools import setup
+
+setup(
+    name='flask-my-extension',
+    entry_points={
+        'console_scripts': [
+            'aazdev=app:cli'
+        ],
+    },
+)

src/backend/swagger/view/specs.py

@@ -0,0 +1,47 @@
+from ..model.specs import SwaggerSpecs
+import os
+import json
+
+from utils.config import SWAGGER_PATH
+
+def get_module_map(modules, module_name=None):
+    module_map = {}
+    for module in modules:
+        if module_name and module.name != module_name:
+            continue
+        module_map[module.name] = []
+        for resource_provider in module.get_resource_providers():
+            for resource_id, version_map in resource_provider.get_resource_map().items():
+                module_map[module.name].append({resource_id: [k.version for k in version_map.keys()]})
+    return module_map
+
+
+def generate_specs():
+    specs = SwaggerSpecs(folder_path=SWAGGER_PATH)
+    mgmt_plane_modules = specs.get_mgmt_plane_modules()
+    data_plane_modules = specs.get_data_plane_modules()
+
+    mgmt_plane_map = get_module_map(mgmt_plane_modules)
+    data_plane_map = get_module_map(data_plane_modules)
+    return {"mgmt":mgmt_plane_map, "data": data_plane_map}
+
+def save_specs(filename):
+    data = generate_specs()
+    with open(filename, 'w') as outfile:
+        json.dump(data, outfile)
+    return data
+
+def load_specs(filename):
+    if not os.path.isfile(filename):
+        return save_specs(filename)
+    with open(filename, 'r') as infile:
+        return json.load(infile)
+
+def get_specs_for_module(module_name):
+    specs = SwaggerSpecs(folder_path=SWAGGER_PATH)
+    mgmt_plane_modules = specs.get_mgmt_plane_modules()
+    data_plane_modules = specs.get_data_plane_modules()
+
+    mgmt_plane_map = get_module_map(mgmt_plane_modules, module_name)
+    data_plane_map = get_module_map(data_plane_modules, module_name)
+    return {"mgmt":mgmt_plane_map, "data": data_plane_map}

src/web/.gitignore

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

src/web/README.md

@@ -0,0 +1,70 @@
+# Getting Started with Create React App
+
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm start`
+
+Runs the app in the development mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.\
+You will also see any lint errors in the console.
+
+### `npm test`
+
+Launches the test runner in the interactive watch mode.\
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.\
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.\
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `npm run eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).
+
+### Code Splitting
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
+
+### Analyzing the Bundle Size
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
+
+### Making a Progressive Web App
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
+
+### Advanced Configuration
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
+
+### Deployment
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
+
+### `npm run build` fails to minify
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)