Merge pull request #50 from datakind/uitest

Add testing and ui element to download solutions

Author: Zebreu

.github/workflows/docker-actions.yml

@@ -1,9 +1,9 @@
 name: Create and publish a Docker image
 
-# Configures this workflow to run every time a change is pushed to the branch called `main`.
 on:
   push:
     branches: ['main']
+  workflow_dispatch:
 
 # Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds.
 env:
@@ -49,3 +49,7 @@ jobs:
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+      - name: Run tests
+        run: |
+          echo Running tests
+          docker run --name tester --rm ${{ env.IMAGE_NAME }}:${{ steps.meta.outputs.tags }} /opt/conda/bin/python /src/tests/end_to_end/test_runner.py	

dkroutingtool/Dockerfile.dev

@@ -90,6 +90,8 @@ COPY manual.ipynb .
 
 COPY manual.sh .
 
+COPY Makefile .
+
 RUN mkdir -p py-lib
 
 RUN mv osrm-backend/example/build/osrmbindings.cpython-37m-x86_64-linux-gnu.so py-lib/

dkroutingtool/Makefile

@@ -0,0 +1,24 @@
+build:
+	sh s_build_docker_dev.sh
+
+interact:
+	docker run --name server --rm --network host -it dkroutingtool:dev bash
+
+run_and_serve:
+	docker run --name server --network host -d --rm dkroutingtool:dev /opt/conda/bin/python src/py/server.py
+
+serve:
+	/opt/conda/bin/python /src/py/server.py &
+
+test: 
+	/opt/conda/bin/python /src/tests/end_to_end/test_runner.py
+
+dockergui:
+	cd src/py/ui && docker build -t dashboard -f dashboard.dockerfile . 
+	docker run --name dashboard --network host -d --rm dashboard:latest
+
+gui:
+	cd src/py/ui && streamlit run dashboard.py
+
+#go to http://localhost:8501/ in your browser and it should work
+demo: run_and_serve dockergui

dkroutingtool/README.md

@@ -1,16 +1,22 @@
 
 # CART General Instructions
 
-You'll need to install docker and yq.
+You'll need to install docker (e.g. Rancher Desktop) and yq.
 
 The only vehicle profiles available are the ones defined in the directory `veh_profiles`, so make sure to have at least one profile there before building the solution. Feel free to add your own profiles as needed.
 
+Refer to the Makefile for common use cases, e.g.
+`make demo`
+then go to http://localhost:8501/ to use the web-based interface
+
 ## User Manual
 This is the draft for a user manual, it has information about configuration options and a few things that are more related to setting up your workflow with the tool.
 https://docs.google.com/document/d/1iOlXQk6_ElM_LdawJPREHNjVkv_2Qajam3is2hm5zyM
 
 ### Server API example
 docker run --network host dkroutingtool:latest /opt/conda/bin/python src/py/server.py
+or if you want to map ports instead: 
+docker run -p 5001:5001 dkroutingtool:latest /opt/conda/bin/python src/py/server.py
 
 curl -X "POST" "localhost:5001/provide_files" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "files=@local_data/config.json" -F "files=@local_data/customer_data.xlsx"
 
@@ -20,6 +26,10 @@ curl -o download.zip http://localhost:5001/download
 
 curl -X "POST" "localhost:5001/adjust_solution" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "files=@download/manual_edits/manual_routes_edits.xlsx"
 
+### GUI
+
+Refer to the src/py/ui directory to try out the web-based interface.
+
 ## Dev
 
 ### Build

dkroutingtool/local_data/config.json

@@ -31,6 +31,6 @@
   "node_loader_options": {"num_containers_default": 2, "elevation_factor": 300},
   "global_solver_options": {
     "max_solver_time_min": 1,
-    "fast_run": false
+    "fast_run": true
   }
 }

…tingtool/scripts/run_end_to_end_tests.sh …tingtool/scripts/obsolete_run_end2end.shdkroutingtool/scripts/run_end_to_end_tests.sh renamed to dkroutingtool/scripts/obsolete_run_end2end.sh dkroutingtool/scripts/run_end_to_end_tests.sh renamed to dkroutingtool/scripts/obsolete_run_end2end.sh

@@ -1,3 +1,4 @@
+import base64
 import requests
 import datetime
 import streamlit as st
@@ -12,8 +13,10 @@ def download_solution(solution_path, map_path):
     timestamp = datetime.datetime.now().strftime(format='%Y%m%d-%H-%M-%S')
     response = requests.get(f'{host_url}/download')
 
+    solution_zip = response.content
+
     with open(f'solution_files_{timestamp}.zip', 'wb') as f:
-        f.write(response.content)
+        f.write(solution_zip)
 
     with zipfile.ZipFile(f'solution_files_{timestamp}.zip', 'r') as zipped:
         zipped.extractall(f'solution_files_{timestamp}/')
@@ -24,13 +27,13 @@ def download_solution(solution_path, map_path):
     with open(f'solution_files_{timestamp}/{map_path}', 'r') as map_html:
         map = map_html.read()
 
-    return solution, map
+    return solution, map, solution_zip
 
 def request_solution():
     response = requests.get(f'{host_url}/get_solution')
-    solution, map = download_solution(solution_path='solution.txt', map_path='/maps/route_map.html')
+    solution, map, solution_zip = download_solution(solution_path='solution.txt', map_path='/maps/route_map.html')
 
-    return solution, map
+    return solution, map, solution_zip
 
 def adjust(adjusted_file):
     headers = {
@@ -82,7 +85,12 @@ def main():
 
     if solution_requested:
         with st.spinner('Computing routes, please wait...'):
-            solution, map = request_solution()
+            solution, map, solution_zip = request_solution()
+        #this button reloads the page, let's avoid it
+        #st.download_button('Download solution files', solution_zip, file_name='solution.zip', 
+        #                   mime='application/octet-stream', help='Downloads all the files generated by the tool')
+        b64 = base64.b64encode(solution_zip).decode()
+        st.markdown(f'<a href="data:application/octet-stream;base64,{b64}" download="solution.zip">Download solution files</a>', unsafe_allow_html=True)
         components.html(map, height = 800)
         st.write(solution)
 

dkroutingtool/scripts/run_tests.sh …routingtool/scripts/obsolete_runtests.shdkroutingtool/scripts/run_tests.sh renamed to dkroutingtool/scripts/obsolete_runtests.sh dkroutingtool/scripts/run_tests.sh renamed to dkroutingtool/scripts/obsolete_runtests.sh

@@ -0,0 +1,37 @@
+import zipfile
+import requests
+import time
+import subprocess
+
+host_url = 'http://localhost:5001'
+
+def download_solution(solution_path):
+    response = requests.get(f'{host_url}/download')
+    solution_zip = response.content
+
+    with open(f'solution_files.zip', 'wb') as f:
+        f.write(solution_zip)
+    
+    with zipfile.ZipFile(f'solution_files.zip', 'r') as zipped:
+        zipped.extractall(f'solution_files/')
+    
+    with open(f'solution_files/{solution_path}', 'r') as solution_txt:
+        solution = solution_txt.read().replace('\n', '  \n')
+    
+    return solution
+
+def request_solution():
+    response = requests.get(f'{host_url}/get_solution')
+    solution = download_solution(solution_path='solution.txt')
+    return solution
+
+def does_it_work_at_all():
+    start = time.time()
+    solution = request_solution()
+    assert len(solution) > 1, "The solution file is empty"
+    print('Success:', time.time()-start, 'seconds')
+
+subprocess.Popen("/opt/conda/bin/python /src/py/server.py &", shell=True)
+time.sleep(10)
+does_it_work_at_all()
+