initial commit

.coveragerc

@@ -0,0 +1,2 @@
+[run]
+omit = webwrapper/tests/*

.gitignore

@@ -0,0 +1,2 @@
+
+.coverage

Dockerfile

@@ -0,0 +1,9 @@
+from python:3.8-alpine
+
+ADD . /tmp/py-service-wrapper
+
+RUN apk add docker
+
+WORKDIR /tmp/py-service-wrapper
+
+CMD ["/bin/sh", "scripts/build-docker.sh"]

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

README.md

@@ -0,0 +1,74 @@
+# py-service-wrapper
+
+This project allows the user to build a docker container for a python library that exposes that library as a service. It uses [FastAPI](https://fastapi.tiangolo.com/) and [uvicorn](https://www.uvicorn.org/) to wrap the project as a web service in the container.
+
+There are only two requirements for the project that is being wrapped:
+1. It is packaged in a pip installable format such as sdist or a python wheel
+2. It provides a YAML file that lists the entrypoints into the library that need to be exposed as a service. The format of the YAML file is discussed in more details below
+
+The py-service-wrapper project consists of two parts:
+
+1. The python code that parses the YAML file and creates the appropriate endpoints. This code can be found under the webwrapper package in this repository.
+2. The script that set up the project and create the final docker container. This script can be found under the scripts folder in the repository.
+
+Both the python code and the script are packaged as a builder style docker image, that can be invoked directly from the library project, or integrated into the CICD pipeline for automation.
+
+## py-service-wrapper Builder Docker Image
+To build the builder docker image simple execute the following command from the root of this repository
+`docker build -t py-service-wrapper-build-utils .`
+
+## Format of the entrypoints YAML file
+The YAML file has a simple format that lists the module and entrypoints that need to be exposed. A sample YAML file might look like:
+```
+version: 1
+project:
+  name: testProject
+  version: 1
+  module: testproject.test_module
+  entrypoints:
+    - name: hello_world_endpoint
+      entrypoint: hello_world
+      path: 'hello'
+    - name: hello_name_endpoint
+      entrypoint: hello_name
+      path: 'hello/{name}'
+```
+- The `version` on line 1 defines the version of the YAML file format being used. Currently the version is ignored since this project only supports 1 version.
+- The `project` section provides the actual details about the entrypoints into the project such as `name` and `version`.
+- the `project.module` defines the module under which the functions that need to be exposed as the services reside
+- entrypoints is a list where each entry is a separate endpoint for the service and each entry contains:
+  - A unique `name`.
+  - The `entrypoint` which is the name of the function in the `project.module` which needs to be exposed.
+  - A `path` which is the url at which the endpoint will be exposed. This path can also contain any path parameters that will be passed to the exposed function.
+
+## Build a wrapper container for a project
+To use the builder docker image to create a wrapper image for a python project the following command can be executed from that projects root:
+`docker run -v $(pwd):/tmp/project -v /var/run/docker.sock:/var/run/docker.sock -e PROJECT_ROOT=/tmp/project -e PROJECT_DIST=<dist package> -e PROJECT_YAML=<YAML file> -e IMAGE_NAME=<final image tag> py-service-wrapper-build-utils:latest`
+where:
+- `<dist package>` is the path of the pip installable package of the project relative to the `PROJECT_ROOT`
+- `<YAML file>` is the path of the YAML file relative to the `PROJECT_ROOT`
+- `<final image tag>` is what that the wrapper docker image will be tagged as
+
+## Run the wrapper docker image
+The wrapper image exposes the service on port `5000` so the following docker run command can be used to run the container in a local environment:
+`docker run -p 5000:5000 <final image tag>`
+
+## TODO:
+- The wrapper only supports GET endpoints. the YAML parser and wrapper code needs to be modified so that the HTTP verb (POST, PATCH, DELETE etc.) can be defined in the YAML file.
+- Currently the `name`, `entrypoint`, and `path` for each entrypoint need to be explicitly defined in the YAML file. These should be made dynamic so that only `entrypoint` is the required.
+  - `name` if not defined can be same as the entrypoint
+  - `path` can be computed using the python `inspect` module (for GET endpoints)
+- Currently we can only define a single module in the YAML file and all entrypoints must be in that module. We should support multiple modules, each with its own list of entrypoints.
+- The endpoints are currently serviced of insecure http. HTTPs should be supported and should be the default
+
+# Sample Project
+The repository also contains a sample project under the `sample_project` directory. To wrap this project as a service run the following command from the `sample_project` directory:
+`docker run -v $(pwd):/tmp/project -v /var/run/docker.sock:/var/run/docker.sock -e PROJECT_ROOT=/tmp/project -e PROJECT_DIST=dist/test_project-0.0.1-py3-none-any.whl -e PROJECT_YAML=project.yaml -e IMAGE_NAME=sampleproject:1.0 py-service-wrapper-build-utils:latest`
+
+To the wrapped sample project run the following command:
+`docker run -p 5000:5000 sampleproject:1.0`
+
+You can then access the exposed endpoints at:
+- http://localhost:5000/hello
+- http://localhost:5000/hello/myname
+- http://localhost:5000/hello/myname/50

sample_project/project.yaml

@@ -0,0 +1,15 @@
+version: 1
+project:
+  name: testProject
+  version: 1
+  module: testproject.test_module
+  entrypoints:
+    - name: ep1
+      entrypoint: hello_name_and_age
+      path: 'hello/{name}/{age}'
+    - name: ep2
+      entrypoint: hello_name
+      path: 'hello/{name}'
+    - name: ep3
+      entrypoint: hello_world
+      path: 'hello'

sample_project/setup.py

@@ -0,0 +1,13 @@
+from setuptools import setup, find_packages
+
+setup(
+    description="test project",
+    license="BSD license",
+    include_package_data=True,
+    keywords="fhir, resources, python, hl7, health IT, healthcare",
+    name="test-project",
+    packages=find_packages('.', exclude=["*tests*"]),
+    url="https://github.ibm.com/ebaron/dicom-fhir-converter",
+    version="0.0.1",
+    python_requires=">=3.6"
+)

sample_project/testproject/test_module.py

@@ -0,0 +1,10 @@
+def hello_name(name):
+    return {'Hello': f'{name}!'}
+
+
+def hello_name_and_age(name, age:int):
+    return f'Hello, {name}! You are {age} years old'
+
+
+def hello_world():
+    return f'Hello, World!'

scripts/build-docker.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+cd /tmp/py-service-wrapper
+cp -r ${PROJECT_ROOT} ./project/
+
+docker build --file scripts/resources/Dockerfile \
+             --build-arg PYWEBWRAPPER_FRAMEWORK=${PYWEBWRAPPER_FRAMEWORK} \
+             --build-arg PROJECT_ROOT=/tmp/py-service-wrapper/project \
+             --build-arg PROJECT_DIST=${PROJECT_DIST} \
+             --build-arg PROJECT_YAML=${PROJECT_YAML} \
+             -t ${IMAGE_NAME} .

scripts/resources/Dockerfile

@@ -0,0 +1,22 @@
+FROM python:3.8-alpine
+
+ARG PYWEBWRAPPER_FRAMEWORK
+ARG PROJECT_DIST
+ARG PROJECT_YAML
+ARG PROJECT_ROOT
+
+ADD . /tmp/py-service-wrapper
+
+ENV PYWEBWRAPPER_FRAMEWORK ${PYWEBWRAPPER_FRAMEWORK}
+ENV PYWEBWRAPPER_PROJECT_ROOT .
+ENV PYWEBWRAPPER_PROJECT_FILE ${PROJECT_YAML}
+
+RUN cd /tmp/py-service-wrapper && pip install .
+RUN cd ${PROJECT_ROOT} && pip install ${PROJECT_DIST}
+RUN mkdir /opt/app
+
+WORKDIR /opt/app
+
+RUN cp /tmp/py-service-wrapper/project/${PROJECT_YAML} /opt/app/${PROJECT_YAML}
+
+CMD ["python", "-m", "webwrapper.server"]