nedga055 / flask-rest-boilerplate Goto Github PK

Simple CI pipeline using GitHub Actions to run code linter/tests.

The version file is used to help track the latest release of the application and the git commit that was used to created it. It could be used in a couple of different contexts:

1. Identifies the version info for a release package in case we need to provide the code for an individual release.
2. Add application version information to log file.

• Add a script that will auto-generate a version.json file.
• Use git describe to get the current release tag.
• Use git rev-parse HEAD to get the latest commit tag for the current branch.
• Output the results to a version.json file which should look like:

{
"version": "1.1.3",
"git_commit": "90jdf09u029jdjsf093j209jdksljfs"
}

Example bash script can be found in the ROEC API repo. However, it may be beneficial to flask_script Command and make it available via manage.py.

• Verify that all included packages are included in the list of approved packages and versions.
• Update any dependencies accordingly.
• Update environment.yml to only allow packages from the approved package repositories.

Tests may be dependent on the server running.

Because of this, we should:

• run the server in another window.
• make sure a server is run.

We need to provide reports on the result of running tests, particularly on deployment, so that each "build" can show what tests were run and their status.

This can be achieved by creating a custom Python Unittest Test Runner.

• Copy 'object_test_runner.py' from the ROEC API into app/test
• Get License from the original repo and add it to the header under the attribution. Also specify that alterations from the original have been made.
• Use ObjectTestRunner to run tests from the manage.py:test command instead of the base TextTestRunner.
• Create report.py in app/test with a Report class that is initialized the resulting object from ObjectTestRunner.
• Add generate_json_report in report.py as part of the Report class that converts the object from ObjectTestRunner as necessary and saves to a JSON file in the reports directory.
• Add generate_markdown_report in report.py as part of the Report class that converts the object from ObjectTestRunner as necessary and saves to a markdown file in the reports directory.

For the last two, see generate_json_report in helpers.run.tests.py from the ROEC API.

• Install waitress
• Update run command in manage.py to run via serve(app) instead of app.run() (serve is imported from waitress)
• Add run_dev command to manage.py and change the main to call run_dev
• Verify app is run on host and port specified in the config

• Add an option to run the server to the app.sh script. -r or --run
• Include sub-option for the environment dev/prod, should default to dev
• Before running the server, it should build/update conda environment then activate it

• Itemize different licenses used by the project dependencies.
• List dependencies under each license.

See the https://github.com/DSD-ESDC-EDSC/dynamic-org-chart/blob/master/ATTRIBUTION.md as an example. (Note as of publishing this issue, there are changes coming to that file)

• ECS logger needs to first become a GitHub repository. Once created, we will install it from GitHub as a package via pip so that it can be used in this project.
• Initialize a logger instance each controller.
• Provide examples of creating a log entry (some info and some error). Should have one for each endpoint.