Add a microservices based sample app to test enablement (#18)

Adding a microservices based sample app to help us test enablement for
the python integration. 

By submitting this pull request, I confirm that you can use, modify,
copy, and redistribute this contribution, under the terms of your
choice.

---------

Co-authored-by: Prashant Srivastava <[email protected]>

Author: AsakerMohd

eachdist.ini

@@ -4,7 +4,7 @@
 
 [lintroots]
 extraroots=scripts/, sample-applications/
-subglob=*.py,tests/,test/,src/*, simple-client-server
+subglob=*.py,tests/,test/,src/*, simple-client-server, vehicle-dealership-sample-app
 
 [testroots]
 extraroots=tests/

sample-applications/vehicle-dealership-sample-app/.gitignore

@@ -0,0 +1 @@
+.env

sample-applications/vehicle-dealership-sample-app/ImageServiceApp/.gitignore

@@ -0,0 +1,5 @@
+static
+.idea
+.env
+db.sqlite3
+*.iml

sample-applications/vehicle-dealership-sample-app/ImageServiceApp/Dockerfile

@@ -0,0 +1,19 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+# Use an official Python runtime as a parent image
+FROM python:3.10
+
+# Set environment variables
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+
+# Set the working directory
+WORKDIR /image-service-app
+
+# Install dependencies
+COPY ImageServiceApp/requirements.txt /image-service-app/
+RUN pip install -r requirements.txt
+
+# Copy the project code into the container
+COPY ImageServiceApp/. /image-service-app/

sample-applications/vehicle-dealership-sample-app/ImageServiceApp/ImageServiceApp/asgi.py

@@ -0,0 +1,18 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+"""
+ASGI config for ImageServiceApp project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.0/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "ImageServiceApp.settings")
+
+application = get_asgi_application()

sample-applications/vehicle-dealership-sample-app/ImageServiceApp/ImageServiceApp/settings.py

@@ -0,0 +1,127 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+"""
+Django settings for ImageServiceApp project.
+
+Generated by 'django-admin startproject' using Django 5.0.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.0/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/5.0/ref/settings/
+"""
+
+import os
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/5.0/howto/deployment/checklist/
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = False
+
+ALLOWED_HOSTS = ["*"]
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "django-insecure-kixr5rw-%ik9i@395&jyjc$p_2%r(^vu0pv=)$$0)z8sjh84=#"
+
+# Application definition
+
+INSTALLED_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "MainService.apps.MainServiceConfig",
+]
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+]
+
+ROOT_URLCONF = "ImageServiceApp.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = "ImageServiceApp.wsgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/5.0/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/5.0/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/5.0/topics/i18n/
+
+LANGUAGE_CODE = "en-us"
+
+TIME_ZONE = "UTC"
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/5.0/howto/static-files/
+
+STATIC_URL = "static/"
+STATIC_ROOT = os.path.join(BASE_DIR, "static")
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/5.0/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

sample-applications/vehicle-dealership-sample-app/ImageServiceApp/ImageServiceApp/urls.py

@@ -0,0 +1,21 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+"""
+URL configuration for ImageServiceApp project.
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/5.0/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+from django.urls import include, path
+
+urlpatterns = [path("images/", include("MainService.urls"))]

sample-applications/vehicle-dealership-sample-app/ImageServiceApp/ImageServiceApp/wsgi.py

@@ -0,0 +1,18 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+"""
+WSGI config for ImageServiceApp project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.0/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "ImageServiceApp.settings")
+
+application = get_wsgi_application()

sample-applications/vehicle-dealership-sample-app/ImageServiceApp/MainService/admin.py

@@ -0,0 +1,5 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+# from django.contrib import admin
+
+# Register your models here.

sample-applications/vehicle-dealership-sample-app/ImageServiceApp/MainService/apps.py

@@ -0,0 +1,8 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+from django.apps import AppConfig
+
+
+class MainServiceConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "MainService"

sample-applications/vehicle-dealership-sample-app/ImageServiceApp/MainService/models.py

@@ -0,0 +1,5 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+# from django.db import models
+
+# Create your models here.

sample-applications/vehicle-dealership-sample-app/ImageServiceApp/MainService/tests.py

@@ -0,0 +1,5 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+# from django.test import TestCase
+
+# Create your tests here.

sample-applications/vehicle-dealership-sample-app/ImageServiceApp/MainService/urls.py

@@ -0,0 +1,11 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+from django.urls import path
+
+from . import views
+
+urlpatterns = [
+    path("", views.index, name="index"),
+    path("name/<str:image_name>", views.handle_image, name="image"),
+    path("remote-image", views.get_remote_image, name="remote-image"),
+]

sample-applications/vehicle-dealership-sample-app/ImageServiceApp/MainService/views.py

@@ -0,0 +1,73 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+import os
+from threading import Thread
+from time import sleep
+
+import boto3
+import requests
+from django.http import HttpResponse, HttpResponseNotAllowed
+from django.views.decorators.csrf import csrf_exempt
+from dotenv import load_dotenv
+
+load_dotenv()
+
+s3_client = boto3.client("s3")
+s3_resource = boto3.resource("s3")
+sqs = boto3.resource("sqs", region_name="us-west-2")
+
+
+# create resources if they don't exist
+# TODO: auto gen bucket name
+bucket_name = os.environ.get("S3_BUCKET")
+bucket = s3_resource.create_bucket(Bucket=bucket_name)
+queue = sqs.create_queue(
+    QueueName="imageQueue.fifo", Attributes={"FifoQueue": "true", "ContentBasedDeduplication": "true"}
+)
+
+
+def read_from_queue():
+    while True:
+        for message in queue.receive_messages():
+            image_name = message.body
+            print("receiving " + image_name + " from the queue")
+            s3_client.put_object(Bucket=bucket_name, Key=image_name)
+            message.delete()
+        sleep(10)
+
+
+thread = Thread(target=read_from_queue)
+
+
+def index(request):
+    # return all images in s3?
+    return HttpResponse("Hello, world LOL!")
+
+
+@csrf_exempt
+def handle_image(request, image_name):
+    print(image_name)
+    if request.method == "POST":
+        put_image(image_name)
+        return HttpResponse("Putting to queue")
+    if request.method == "GET":
+        return HttpResponse(get_image(image_name))
+    return HttpResponseNotAllowed("Only GET requests are allowed!")
+
+
+def get_image(image_name):
+    s3_object = s3_client.get_object(Bucket=bucket_name, Key=image_name)
+    return str(s3_object)
+
+
+def get_remote_image(request):
+    api_url = "https://google.com"
+    return HttpResponse(requests.get(api_url, timeout=10))
+
+
+def put_image(image_name):
+    queue.send_message(MessageBody=image_name, MessageGroupId="1")
+    print("adding " + image_name + " to the queue")
+    if not thread.is_alive():
+        thread.start()
+    return HttpResponse("Image added to the queue")

sample-applications/vehicle-dealership-sample-app/ImageServiceApp/manage.py

@@ -0,0 +1,25 @@
+#!/usr/bin/env python
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+# pylint: skip-file
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "ImageServiceApp.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()

sample-applications/vehicle-dealership-sample-app/ImageServiceApp/requirements.txt

@@ -0,0 +1,4 @@
+Django~=5.0
+requests~=2.31.0
+boto3~=1.34.14
+python-dotenv~=1.0.0