reworking the general flow of the README

.github/workflows/main.yml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v2
       - name: Check all entangled files are in sync with Markdown
         run: make check
-  cpp:
+  cli:
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
 
@@ -23,11 +23,62 @@ jobs:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v2
 
-      - name: Run C++ examples
-        run: make test-cli test-cgi
-  python:
+      - name: Run C++ test for CLI
+        run: make test-cli
+  cgi:
     # The type of runner that the job will run on
-    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+
+      - name: Run C++ test for CGI
+        run: make test-cgi
+  openapi:
+    # The type of runner that the job will run on
+    name: openapi / python-${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8]
+      fail-fast: true
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: "x64"
+
+      - name: Which Python
+        run: which python
+
+      - name: Install Python dependencies
+        run: make pip-pybind11 && make pip-connexion
+
+      - name: Run Python example
+        run: make test-py
+
+      - name: Start web service in background
+        run: |
+          make run-webservice 2>&1 | tee ./run-webservice.log &
+          sleep 2
+      - name: Test web service
+        run: make test-webservice
+
+      - name: Upload log of services
+        if: ${{ always() }}
+        uses: actions/upload-artifact@v2
+        with:
+          name: service-logs
+          path: ./run-*.log
+  flask:
+    # The type of runner that the job will run on
+    name: flask / python-${{ matrix.python-version }}
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -53,29 +104,27 @@ jobs:
         run: which python
 
       - name: Install Python dependencies
-        run: make py-deps && pip install httpie
+        run: make pip-pybind11 && make pip-flask && make pip-celery && pip install httpie
 
-      - name: Run Python example
-        run: make test-py
+      - name: Build shared library and link to it
+        run: |
+          make flask-link-newtonraphsonpy
 
       - name: Start web application in background
-        run: make run-webapp 2>&1 | tee ./run-webapp.log &
+        run: |
+          make run-webapp 2>&1 | tee ./run-webapp.log &
+          sleep 2
 
       - name: Test web application
         run: http --ignore-stdin -f localhost:5001 epsilon=0.001 guess=-20
 
-      - name: Start web service in background
-        run: make run-webservice 2>&1 | tee ./run-webservice.log &
-
-      - name: Test web service
-        run: make test-webservice
-
       - name: Start Celery web app in background
-        run: make run-celery-webapp 2>&1 | tee ./run-celery-webapp.log  &
+        run: |
+          make run-celery-webapp 2>&1 | tee ./run-celery-webapp.log  &
 
       - name: Start Celery worker in background
         run: |
-          cd src/py
+          cd flask
           PYTHONPATH=$PWD/../.. celery -A tasks worker 2>&1 | tee ./run-celery-worker.log &
           cd ../..
 
@@ -93,7 +142,30 @@ jobs:
         with:
           name: service-logs
           path: ./run-*.log
-  wasm:
+  webassembly:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install emscripten
+        uses: mymindstorm/setup-emsdk@v4
+
+      - name: Build WebAssembly module
+        run: make build-wasm
+
+      - name: Start web server for hosting files in background
+        run: make host-files 2>&1 | tee ./web-server.log &
+
+      - name: Run tests
+        run: make test-wasm
+
+      - name: Upload log of web server
+        if: ${{ always() }}
+        uses: actions/upload-artifact@v2
+        with:
+          name: web-server-log
+          path: ./web-server.log
+  react:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2

.gitignore

@@ -4,14 +4,19 @@ __pycache__/
 cypress/plugins
 cypress/support
 cypress/videos
+/cypress/screenshots
 
 # Ignore compiled files
-bin/newtonraphson.exe
-src/py/newtonraphsonpy.*.so
-apache2/cgi-bin/newtonraphson
+/cli/newtonraphson.exe
+/cgi/apache2/cgi-bin/newtonraphson
+/openapi/newtonraphsonpy.*.so
+/flask/newtonraphsonpy.*.so
+/webassembly/newtonraphsonwasm.js
+/webassembly/newtonraphsonwasm.wasm
 
 # Ignore entangled db
 .entangled/db.sqlite
 
 # other ignores
 node_modules
+

INSTALL.md

@@ -22,7 +22,7 @@ All the commands in the [README.md](README.md) and [CONTRIBUTING.md](CONTRIBUTIN
 UID := $(shell id -u)
 # Prevent suicide by excluding Makefile
 ENTANGLED := $(shell perl -ne 'print $$1,"\n" if /^```\{.*file=(.*)\}/' *.md | grep -v Makefile | sort -u)
-COMPILED := bin/newtonraphson.exe src/py/newtonraphsonpy.*.so apache2/cgi-bin/newtonraphson src/js/newtonraphsonwasm.js  src/js/newtonraphsonwasm.wasm
+COMPILED := cli/newtonraphson.exe openapi/newtonraphsonpy.*.so cgi/apache2/cgi-bin/newtonraphson webassembly/newtonraphsonwasm.js  webassembly/newtonraphsonwasm.wasm
 
 entangle: *.md
 	<<pandoc-tangle>>
@@ -46,22 +46,25 @@ pip-celery:
 pip-connexion:
 	<<pip-connexion>>
 
-bin/newtonraphson.exe: src/cli-newtonraphson.cpp
+cli/newtonraphson.exe: cli/cli-newtonraphson.cpp
 	<<build-cli>>
 
-test-cli: bin/newtonraphson.exe
+test-cli: cli/newtonraphson.exe
 	<<test-cli>>
 
-apache2/cgi-bin/newtonraphson: src/cgi-newtonraphson.cpp
+cgi/apache2/cgi-bin/newtonraphson: cgi/cgi-newtonraphson.cpp
 	<<build-cgi>>
 
-test-cgi: apache2/cgi-bin/newtonraphson
+test-cgi: cgi/apache2/cgi-bin/newtonraphson
 	<<test-cgi>>
 
-src/py/newtonraphsonpy.*.so: src/py-newtonraphson.cpp
+openapi/newtonraphsonpy.*.so: openapi/py-newtonraphson.cpp
 	<<build-py>>
 
-test-py: src/py/example.py src/py/newtonraphsonpy.*.so
+flask-link-newtonraphsonpy: openapi/newtonraphsonpy.*.so
+	<<flask-link-newtonraphsonpy>>
+
+test-py: openapi/example.py openapi/newtonraphsonpy.*.so
 	<<test-py>>
 
 test: test-cli test-cgi test-py test-webservice
@@ -84,24 +87,24 @@ start-redis:
 stop-redis:
 	<<stop-redis>>
 
-run-webapp: src/py/newtonraphsonpy.*.so
+run-webapp: openapi/newtonraphsonpy.*.so
 	<<run-webapp>>
 
-run-webservice: src/py/newtonraphsonpy.*.so
+run-webservice: openapi/newtonraphsonpy.*.so
 	<<run-webservice>>
 
 test-webservice:
 	<<test-webservice>>
 
-run-celery-worker: src/py/newtonraphsonpy.*.so
+run-celery-worker: openapi/newtonraphsonpy.*.so
 	<<run-celery-worker>>
 
-run-celery-webapp: src/py/newtonraphsonpy.*.so
+run-celery-webapp: openapi/newtonraphsonpy.*.so
 	<<run-celery-webapp>>
 
-build-wasm: src/js/newtonraphsonwasm.js src/js/newtonraphsonwasm.wasm
+build-wasm: webassembly/newtonraphsonwasm.js webassembly/newtonraphsonwasm.wasm
 
-src/js/newtonraphsonwasm.js src/js/newtonraphsonwasm.wasm: src/wasm-newtonraphson.cpp
+webassembly/newtonraphsonwasm.js webassembly/newtonraphsonwasm.wasm: webassembly/wasm-newtonraphson.cpp
 	<<build-wasm>>
 
 host-files: build-wasm

Makefile

@@ -4,7 +4,7 @@
 UID := $(shell id -u)
 # Prevent suicide by excluding Makefile
 ENTANGLED := $(shell perl -ne 'print $$1,"\n" if /^```\{.*file=(.*)\}/' *.md | grep -v Makefile | sort -u)
-COMPILED := bin/newtonraphson.exe src/py/newtonraphsonpy.*.so apache2/cgi-bin/newtonraphson src/js/newtonraphsonwasm.js  src/js/newtonraphsonwasm.wasm
+COMPILED := cli/newtonraphson.exe openapi/newtonraphsonpy.*.so cgi/apache2/cgi-bin/newtonraphson webassembly/newtonraphsonwasm.js  webassembly/newtonraphsonwasm.wasm
 
 entangle: *.md
 	docker run --rm --user ${UID} -v ${PWD}:/data nlesc/pandoc-tangle:0.5.0 --preserve-tabs *.md
@@ -28,24 +28,27 @@ pip-celery:
 pip-connexion:
 	pip install connexion[swagger-ui]
 
-bin/newtonraphson.exe: src/cli-newtonraphson.cpp
-	g++ src/cli-newtonraphson.cpp -o bin/newtonraphson.exe
+cli/newtonraphson.exe: cli/cli-newtonraphson.cpp
+	g++ cli/cli-newtonraphson.cpp -o cli/newtonraphson.exe
 
-test-cli: bin/newtonraphson.exe
-	./bin/newtonraphson.exe
+test-cli: cli/newtonraphson.exe
+	./cli/newtonraphson.exe
 
-apache2/cgi-bin/newtonraphson: src/cgi-newtonraphson.cpp
-	g++ -Ideps src/cgi-newtonraphson.cpp -o apache2/cgi-bin/newtonraphson
+cgi/apache2/cgi-bin/newtonraphson: cgi/cgi-newtonraphson.cpp
+	g++ -Icgi/deps/ -Icli/ cgi/cgi-newtonraphson.cpp -o cgi/apache2/cgi-bin/newtonraphson
 
-test-cgi: apache2/cgi-bin/newtonraphson
-	echo '{"guess":-20, "epsilon":0.001}' | apache2/cgi-bin/newtonraphson
+test-cgi: cgi/apache2/cgi-bin/newtonraphson
+	echo '{"guess":-20, "epsilon":0.001}' | cgi/apache2/cgi-bin/newtonraphson
 
-src/py/newtonraphsonpy.*.so: src/py-newtonraphson.cpp
-	g++ -O3 -Wall -shared -std=c++14 -fPIC `python3 -m pybind11 --includes` \
-	src/py-newtonraphson.cpp -o src/py/newtonraphsonpy`python3-config --extension-suffix`
+openapi/newtonraphsonpy.*.so: openapi/py-newtonraphson.cpp
+	g++ -O3 -Wall -shared -std=c++14 -fPIC -Icli/ `python3 -m pybind11 --includes` \
+	openapi/py-newtonraphson.cpp -o openapi/newtonraphsonpy`python3-config --extension-suffix`
 
-test-py: src/py/example.py src/py/newtonraphsonpy.*.so
-	python src/py/example.py
+flask-link-newtonraphsonpy: openapi/newtonraphsonpy.*.so
+		cd flask && ln -s openapi/newtonraphsonpy.*.so && cd -
+
+test-py: openapi/example.py openapi/newtonraphsonpy.*.so
+	python openapi/example.py
 
 test: test-cli test-cgi test-py test-webservice
 
@@ -67,28 +70,28 @@ start-redis:
 stop-redis:
 	docker stop some-redis
 
-run-webapp: src/py/newtonraphsonpy.*.so
-	python src/py/webapp.py
+run-webapp: openapi/newtonraphsonpy.*.so
+	python flask/webapp.py
 
-run-webservice: src/py/newtonraphsonpy.*.so
-	python src/py/webservice.py
+run-webservice: openapi/newtonraphsonpy.*.so
+	python openapi/webservice.py
 
 test-webservice:
 	curl -X POST "http://localhost:8080/api/newtonraphson" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"epsilon\":0.001,\"guess\":-20}"
 
-run-celery-worker: src/py/newtonraphsonpy.*.so
-	PYTHONPATH=src/py celery worker -A tasks
+run-celery-worker: openapi/newtonraphsonpy.*.so
+	PYTHONPATH=openapi celery worker -A tasks
 
-run-celery-webapp: src/py/newtonraphsonpy.*.so
-	python src/py/webapp-celery.py
+run-celery-webapp: openapi/newtonraphsonpy.*.so
+	python flask/webapp-celery.py
 
-build-wasm: src/js/newtonraphsonwasm.js src/js/newtonraphsonwasm.wasm
+build-wasm: webassembly/newtonraphsonwasm.js webassembly/newtonraphsonwasm.wasm
 
-src/js/newtonraphsonwasm.js src/js/newtonraphsonwasm.wasm: src/wasm-newtonraphson.cpp
-	emcc --bind -o src/js/newtonraphsonwasm.js -s MODULARIZE=1 -s EXPORT_NAME=createModule src/wasm-newtonraphson.cpp
+webassembly/newtonraphsonwasm.js webassembly/newtonraphsonwasm.wasm: webassembly/wasm-newtonraphson.cpp
+	emcc -Icli/ --bind -o webassembly/newtonraphsonwasm.js -s MODULARIZE=1 -s EXPORT_NAME=createModule webassembly/wasm-newtonraphson.cpp
 
 host-files: build-wasm
-	python3 -m http.server 8000
+	cd flask && python3 -m http.server 8000 && cd -
 
 test-wasm:
 	npx cypress run --config-file false