Merge pull request #6 from pacslab/pull_request

ghaemisr · web-flow · commit 62aae5fde522 · 2020-07-19T18:45:17.000-04:00
Pull request - Added initial doc files and async functionality for jobs
diff --git a/BlockchainNetwork/setup.sh b/BlockchainNetwork/setup.sh
@@ -20,7 +20,7 @@ sudo systemctl enable docker
 
 # install docker compose
 echo "Installing docker compose"
-sudo curl -L "https://github.com/docker/compose/releases/download/1.25.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
+sudo curl -L "https://github.com/docker/compose/releases/download/1.26.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
 sudo chmod +x /usr/local/bin/docker-compose
 
 echo "You need to log out and log back in after these installations. If you are running on a VM you may need to restart your VM"
diff --git a/ComputeProvider/HFRequests.py b/ComputeProvider/HFRequests.py
@@ -206,7 +206,7 @@ def initialize_network():
     monitoringChaincode = 'monitoring'
     monitoringPath= "./artifacts/src/monitoring"
     chaincodeLang = "node"
-    user_list = ['sghaemi', 'admin', 'controller', 'provider_test', 'provider_test2', 'provider_test3']
+    user_list = ['sghaemi', 'admin', 'controller', 'cc_provider1', 'cc_provider2', 'cc_provider3', 'cc_provider4']
 
     token1 = register_user('temp', 'Org1')
     token2 = register_user('temp', 'Org2')
@@ -223,7 +223,7 @@ def initialize_network():
     instantiate_chaincode(token2, 'org2', channelName, monitoringChaincode, chaincodeLang)
 
     for user in user_list:
-        invoke_balance_transfer_new_user(token1, channelName, monetaryChaincode, 'org1', user, "600")
+        invoke_balance_transfer_new_user(token1, channelName, monetaryChaincode, 'org1', user, "700")
     
     return token1, token2
 
@@ -245,13 +245,13 @@ def initialize_network():
     
 
 
-    token_org1, token_org2 = initialize_network()
+    # token_org1, token_org2 = initialize_network()
     if org == "Org1":
         token = token_org1
     elif org == "Org2":
         token = token_org2
 
-    # token = register_user(username, org)
+    token = register_user(username, org)
     # print(get_logs(token))
     # invoke_balance_transfer_new_user(token, channelName, "monetary", 'org1', 'controller', "600")
     # create_channel(token, channelName)
@@ -267,11 +267,14 @@ def initialize_network():
     # query_job(token, channelName, chaincodeName, orgLower, "100")
     # invoke_balance_transfer_from_fabcar(token, channelName, chaincodeName, orgLower)
     # invoke_balance_transfer(token, channelName, chaincodeName, orgLower)
-    # query_account(token, channelName, 'monetary', orgLower, 'controller')
-    # query_account(token, channelName, "monetary", orgLower, 'admin')
+    # query_account(token, channelName, 'monetary', orgLower, 'developer_test')
+    # query_account(token, channelName, "monetary", orgLower, 'cc_provider1')
+    # query_account(token, channelName, "monetary", orgLower, 'cc_provider2')
+    # query_account(token, channelName, "monetary", orgLower, 'cc_provider3')
+    # query_account(token, channelName, "monetary", orgLower, 'cc_provider4')
     # invoke_balance_transfer_new_user(token, channelName, "monetary", orgLower, "controller", "600")
     # invoke_balance_transfer_new_user(token, channelName, "monetary", orgLower, "admin", "600")
-    # invoke_balance_transfer_new_user(token, channelName, "monetary", orgLower, "sghaemi", "600")
+    # invoke_balance_transfer_new_user(token, channelName, "monetary", orgLower, "sara_test", "600")
 
 
     # get_installed_chaincodes(token, orgLower)
diff --git a/ComputeProvider/provider.py b/ComputeProvider/provider.py
@@ -13,7 +13,10 @@
 
 ready_response_text = 'Done!'
 controller = 'chainfaas.com'
-# controller = 'http://localhost'
+# controller = 'chainfaas.sara-dev.com'
+# controller_temp = 'chainfaas.sara-dev.com'
+# controller = 'localhost'
+# controller_temp = 'localhost:8080'
 # controller_short = '127.0.0.1'
 
 username = sys.argv[1]
diff --git a/Docs/.gitignore b/Docs/.gitignore
@@ -0,0 +1,2 @@
+# Sphinx documentation
+_build/
diff --git a/Docs/Makefile b/Docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/Docs/conf.py b/Docs/conf.py
@@ -0,0 +1,79 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('.'))
+
+# add markdown support
+import recommonmark
+from recommonmark.transform import AutoStructify
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'ChainFaaS: An Open Blockchain-based Serverless Platform'
+copyright = '2020, PACS Lab'
+author = 'Sara Ghaemi'
+
+# The short X.Y version.
+version = "1.0"
+# The full version, including alpha/beta/rc tags
+release = "1.0.0-alpha"
+
+github_doc_root = 'https://github.com/pacslab/ChainFaaS/tree/master/docs/'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'recommonmark',
+    'sphinx_rtd_theme',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+# html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# app setup hook
+def setup(app):
+    app.add_config_value('recommonmark_config', {
+        #'url_resolver': lambda url: github_doc_root + url,
+        'auto_toc_tree_section': 'Contents',
+        'enable_math': False,
+        'enable_inline_math': False,
+        'enable_eval_rst': True,
+        'enable_auto_doc_ref': True,
+    }, True)
+    app.add_transform(AutoStructify)
diff --git a/Docs/index.md b/Docs/index.md
@@ -0,0 +1 @@
+# Welcome to ChainFaaS Docs!
diff --git a/Docs/make.bat b/Docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/Docs/requirements.txt b/Docs/requirements.txt
@@ -0,0 +1,4 @@
+  
+sphinx==3.1.1
+recommonmark==0.6.0
+sphinx-rtd-theme==0.5.0
diff --git a/ServerlessController/controller_app/views.py b/ServerlessController/controller_app/views.py
@@ -11,7 +11,7 @@
 from MSc_Research_Django.settings import TIME_ZONE, USE_FABRIC
 
 
-def request_handler(request, service, start_time):
+def request_handler(request, service, start_time, run_async=False):
     """
     Gets the request and the corresponding service and returns the response and the corresponding provider
     :param request:
diff --git a/ServerlessController/developers_app/urls.py b/ServerlessController/developers_app/urls.py
@@ -8,8 +8,11 @@
     path('', views.index, name='index'),
     path('new_service/', views.new_service, name='new_service'),
     path('user_services/', views.user_services, name='user_services'),
+    path('user_jobs/', views.user_jobs, name='user_jobs'),
     path('<int:service_id>/stop_service/', views.stop_service, name='stop_service'),
     path('<int:service_id>/start_service/', views.start_service, name='start_service'),
     path('<int:service_id>/delete_service/', views.delete_service, name='delete_service'),
     path('<int:service_id>/run/', views.run_service, name='run_service'),
+    path('<int:service_id>/run_async/', views.run_service_async, name='run_service_async'),
+    path('<int:job_id>/job_info/', views.job_info, name='job_info'),
 ]
diff --git a/ServerlessController/developers_app/views.py b/ServerlessController/developers_app/views.py
@@ -4,11 +4,15 @@
 from django.contrib import messages
 from django.db import IntegrityError
 from developers_app.models import Services
+from providers_app.models import Job
 from django.core.exceptions import ObjectDoesNotExist
-from controller_app.views import request_handler
+from controller_app.views import request_handler, find_provider
 from datetime import datetime
 from pytz import timezone
 from MSc_Research_Django.settings import TIME_ZONE
+from datetime import timedelta
+import json
+import threading
 
 
 def index(request):
@@ -53,7 +57,6 @@ def user_services(request):
                   {'all_services': all_services,
                    'developer_id': request.user.developer.id})
 
-
 @login_required()
 def stop_service(request, service_id):
     all_services = Services.objects.filter(developer=request.user.developer)
@@ -113,4 +116,58 @@ def run_service(request, service_id):
                    'total_time': response['total_time'],
                    'provider': provider, 
                    'job_id': job_id})
+                   
+def run_service_async(request, service_id):
+    response = ''
+    try:
+        service = Services.objects.get(id=service_id)
+        if service.active:
+            temp_time = datetime.now(tz=timezone(TIME_ZONE))
+            # request_handler(request, service, temp_time, run_async=True)
+            x = threading.Thread(target=request_handler, args=(request, service, temp_time, True))
+            x.start()
+            if find_provider() is None:
+                messages.error(request, "There are no available providers in the network")
+                return redirect('index')
+            else:
+                messages.success(request, "Successfully sent an async request to '{}' service of '{}'".format(service.name,
+                                                                                                   service.developer))
+        else:
+            messages.error(request, "This service is disabled")
+
+    except ObjectDoesNotExist:
+        messages.error(request, "Incorrect service id")
+
+    return redirect('index')
+
+@login_required()
+def user_jobs(request):
+    """
+    Shows all jobs that belong to a user.
+    """
+    services = Services.objects.filter(developer=request.user.developer)
+    all_jobs = Job.objects.filter(service__in=services).order_by('pk').reverse()
+    return render(request, 'developers_app/user_jobs.html',
+                  {'all_jobs': all_jobs,
+                   'developer_id': request.user.developer.id})
 
+
+@login_required()
+def job_info(request, job_id):
+    """
+    Shows all jobs that belong to a user.
+    """
+    job = Job.objects.get(pk=job_id)
+    providing_time = int(((job.ack_time - job.start_time)/timedelta(microseconds=1))/1000)
+    if job.response == '':
+        result = "Result is not ready yet."
+    else:
+        result = json.loads(job.response)['Result']
+    return render(request, 'final_response.html',
+                  {'result': result,
+                   'providing_time': providing_time,
+                   'pull_time': job.pull_time,
+                   'run_time': job.run_time,
+                   'total_time': job.total_time,
+                   'provider': job.provider.user.username, 
+                   'job_id': job.pk})
diff --git a/ServerlessController/docker-compose.yml b/ServerlessController/docker-compose.yml
@@ -1,4 +1,4 @@
-version: '3.3'
+version: '3.7'
 
 services:
   caddy:
diff --git a/ServerlessController/providers_app/migrations/0002_auto_20200528_1450.py b/ServerlessController/providers_app/migrations/0002_auto_20200528_1450.py
@@ -0,0 +1,23 @@
+# Generated by Django 2.2.10 on 2020-05-28 18:50
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('providers_app', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='job',
+            name='corr_id',
+            field=models.UUIDField(db_index=True, default=0),
+        ),
+        migrations.AddField(
+            model_name='job',
+            name='response',
+            field=models.TextField(default=''),
+        ),
+    ]
diff --git a/ServerlessController/providers_app/models.py b/ServerlessController/providers_app/models.py
@@ -16,4 +16,6 @@ class Job(models.Model):
     run_time = models.IntegerField(default=0)
     total_time = models.IntegerField(default=0)
     cost = models.FloatField(default=0.0)
-    finished = models.BooleanField(default=False)
+    finished = models.BooleanField(default=False)
+    corr_id = models.UUIDField(default=0, db_index=True)
+    response = models.TextField(default='')
diff --git a/ServerlessController/providers_app/views.py b/ServerlessController/providers_app/views.py
@@ -108,6 +108,12 @@ def add_task_to_queue(request, task, username):
     task_dict = json.dumps(task)
     client.call(username, task_dict)
     response = client.response
+    job = get_object_or_404(Job, pk=task['job'])
+    # print(response)
+    job.corr_id = client.corr_id
+    job.response = response.decode("utf-8")
+    # print("job.response ", job.response)
+    job.save(update_fields=['corr_id', 'response'])
     if response is None:
         return
     return json.loads(response.decode("utf-8"))
diff --git a/ServerlessController/server_setup.sh b/ServerlessController/server_setup.sh
@@ -15,7 +15,11 @@ sudo systemctl start docker
 sudo systemctl enable docker
 
 sudo apt update
-sudo apt  install docker-compose
+
+# install docker compose
+echo "Installing docker compose"
+sudo curl -L "https://github.com/docker/compose/releases/download/1.26.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
+sudo chmod +x /usr/local/bin/docker-compose
 
 CADDY_TELEMETRY=on curl https://getcaddy.com | bash -s personal hook.service
 # pip3 install -r requirements.txt
diff --git a/ServerlessController/templates/base.html b/ServerlessController/templates/base.html
diff --git a/ServerlessController/templates/developers_app/services_table.html b/ServerlessController/templates/developers_app/services_table.html
diff --git a/ServerlessController/templates/developers_app/user_jobs.html b/ServerlessController/templates/developers_app/user_jobs.html
diff --git a/ServerlessController/templates/developers_app/user_services.html b/ServerlessController/templates/developers_app/user_services.html
