Go to file

Dan Funk d39ef658a2 Made some modifications to the Approval so that it knows exactly what versions of every file are being sent for approval Added the following columns: * date_created - so we know when the file was created * renamed workflow_version to just "version", because everything has a version, this is the version of the request. * workflow_hash - this is just a quick way to see what files and versions are associated with the request, it could be factored out. * study - a quick relationship link to the study, so that this model is easier to use. * workflow - ditto * approval_files - these is a list from a new link table that links an approval to specific files and versions. The RequestApproval is logically sound, but still needs some additional pieces in place to be callable from a BPMN workflow diagram. Altered the file service to pick up on changes to files vs adding new files, so that versions are picked up correctly as users modify their submission - adding new files or replacing existing ones. Deleting files worries me, and I will need to revisit this. The damn base test keeps giving me a headache, so I made changes there to see if clearing and dropping the database each time won't allow the tests to pass more consistently. Lots more tests around the file service to make sure it is versioning user uploaded files correctly. The "Test Request Approval Script" tries to find to assure the correct behavior as this is likely to be called many times repeatedly and with little knowledge of the internal system. So it should just "do the right thing".		2020-05-23 15:08:17 -04:00
config	Allow disabling the Protocol Builder	2020-05-22 14:37:49 -04:00
crc	Made some modifications to the Approval so that it knows exactly what versions of every file are being sent for approval	2020-05-23 15:08:17 -04:00
deploy	adding requirements.txt and a way to regenerate it.	2020-05-20 14:21:39 -04:00
docs	Cleanup.	2020-01-09 10:09:59 -05:00
migrations	Removing duplicate migration.	2020-05-06 13:28:41 -04:00
postgres	It became impossible to use the Swagger ui when we started adding authentication to all of the calls. I discovered Connexion and Swagger have a default way of handing JTW authentication and this cleans up our code quite a bit, moves the securing of endpoints into the API Definition, which is quite nice, and removes a whole library dependency (I never get to do that!) I added a SWAGGER_AUTH_KEY that can be used in non-production environments to allow users to quickly authenticate from the Swagger ui. I also removed all api calls to simple little happy api services, because that is just mean and pointless.	2020-03-24 14:15:21 -04:00
readme_images	Updates to the README and removing a problematic dependency	2019-11-20 17:00:02 -05:00
schema	Adds basic Flask, Connexion, and SpiffWorkflow structure	2019-11-19 15:57:46 -05:00
tests	Made some modifications to the Approval so that it knows exactly what versions of every file are being sent for approval	2020-05-23 15:08:17 -04:00
.gitignore	Removes xlsx lock file. Adds LibreOffice lock files to gitignore	2020-04-27 22:58:12 -04:00
.sonarcloud.properties	Generates coverage.xml report	2020-02-12 11:04:04 -05:00
.travis.yml	Uses Python 3.6.9	2020-05-20 16:49:55 -04:00
Dockerfile	Installs curl	2020-05-20 20:13:09 -04:00
LICENSE.md	Adds basic Flask, Connexion, and SpiffWorkflow structure	2019-11-19 15:57:46 -05:00
Pipfile	Dropping flask_sso library in favor of reading from the headers directly. Updating login to read from ldap once it has the user_id. Adding more information to the sso endpoint.	2020-05-22 07:55:58 -04:00
Pipfile.lock	Dropping flask_sso library in favor of reading from the headers directly. Updating login to read from ldap once it has the user_id. Adding more information to the sso endpoint.	2020-05-22 07:55:58 -04:00
README.md	Updates in travis to do a push to docker hub, so our code can be deployed to various environments.	2020-02-05 15:53:52 -05:00
crconnect.wsgi	o	2020-05-20 15:32:40 -04:00
deploy.sh	Only creates Docker tag for branch	2020-05-14 08:52:05 -04:00
docker_run.sh	Adds downgrade command	2020-04-21 19:37:56 -04:00
example_data.py	We now only return the ready user tasks, not all tasks, and even then the ready user tasks don't come back with the forms and details, just the bare minimum. Speeds things up considerably, and most of this information wasn't used anyway.	2020-05-14 17:13:47 -04:00
fact_runner.py	Creating a dependency on the SpiffWorkflow fork we created. and placing the command line script into this code base and demonstrating that our workflow processor works at least on that level. Removing all kinds of garbage that had piled up before to keep this thing clean.	2019-12-11 11:45:44 -05:00
run.py	Allows port to be set via environment variable	2020-05-15 21:32:33 -04:00
sonar-project.properties	Adds sonar properties	2020-02-08 14:00:37 -05:00
wait-for-it.sh	Scripts should be executable.	2020-02-06 09:02:02 -05:00

README.md

CrConnectFrontend

CR Connect Workflow Microservice

Development Setup

Tools

These instructions assume you're using these development and tools:

IDE: PyCharm Professional Edition
Operating System: Ubuntu

Environment Setup

Make sure all of the following are properly installed on your system:

python3 & pip3:
- Install python3 & pip3
- Installing Python 3 on Linux
pipenv:
- Install pipenv
- Add ${HOME}/.local/bin to your PATH

Project Initialization

Clone this repository.
In PyCharm:
- Go to File > New Project...
- Click Pure Python (NOT Flask!!)
- Click the folder icon in the Location field.
- Select the directory where you cloned this repository and click Ok.
- Expand the Project Interpreter section.
- Select the New environment using radio button and choose Pipenv in the dropdown.
- Under Base interpreter, select Python 3.6
- In the Pipenv executable field, enter /home/your_username_goes_here/.local/bin/pipenv
- Click Create
PyCharm should automatically install the necessary packages via pipenv. For me, the project interpreter did not set set up for me correctly on first attempt. I had to go to File -> Settings -> Project Interpreter and again set the project to use the correct PipEnv environment. Be sure that your settings like simliar to this, or attempt to add the interpreter again by clicking on the gear icon.
With this properly setup for the project, you can now right click on the run.py and set up a new run configuration and set up a run configuration that looks like the following (be sure to save this run configuration so it doesn't go away.) :

Running the Web API

Just click the "Play" button next to RUN in the top right corner of the screen. The Swagger based view of the API will be avialable at http://0.0.0.0:5000/v1.0/ui/

Testing from the Shell

This app includes a command line interface that will read in BPMN files and let you play with it at the command line. To run it right click on app/command_line/joke.py and click run. Type "?" to get a list of commands. So far the joke system will work a little, when you file it up try these commands in this order:

> engine  (this will run all tasks up to first user task and should print a joke)
> answer clock (this is the correct answer)
> next (this completes the user task)
> engine (this runs the rest of the tasks, and should tell you that  you got the question right)

You can try re-running this and getting the question wrong. You might open up the Joke bpmn diagram so you can see what this looks like to draw out.

Documentation

Additional Documentation is available on ReadTheDocs

Additional Reading

BPMN Is the tool we are using to create diagrams of our business processes. It's is a beautiful concise diagramming tool. We strongly recommend you read this complete tutorial, as this notation is the foundation on which this project as well as many other software systems for businesses are built. Know it well.

Notes on Creating Good BPMN Diagrams in Comunda

Be sure to give each task a thoughtful (but unique!) id. This will make the command line and debugging far far easier. I've tended to pre-fix these, so task_ask_riddle if a task is asking a riddle for instance.