Skip to content

Using Development Environment

Jump to bottom
Ian Pendleton edited this page May 30, 2020 · 2 revisions

This site is a clone of 'Using-Development-Environment.md' from ESCALATE_Capture. Last updated on May 26th, 2020. Report V1.11

Capture and report have many shared dependencies, but are still independent. Capture is reponsible for aiding in data collection, while report is focused on data curation. However, both pieces are dependent on a number of implied API frameworks which are distributed throughout code. To make this a bit less cumbersome, we have assembled a set of example runs which span the variation of all existing datasets in ESCALATE. Details about these experiments can be found in the README file

When developing new ESCALATE_Capture or ESCALATE_report capabilities, be sure to test the development environment first before deploying to the main code base. To do this:

  1. Generate an example of the new ESCALATE_Capture template, execute the run and fill in any expected data.
    • One can follow the user guide to ensure that all of the steps are complete.
  2. Ensure that ESCALATE_report passes pytest (prior to moving new data into the dev 4-Data folder).
    • Note: DO NOT MODIFY THE DEV 4-DATA FOLDER UNLESS YOU ARE SURE YOU WANT TO ADD NEW RUNS
  3. Once pytest passes, verify that the run you are considering actually adds new functionality. A list of the reasoning for the current folders can be found in the associated dev README.md
  4. Add the details of the new target to the readme following the existing template
  5. Move the new folder (with completed data) to the dev 4-Data folder
  6. Run pytest again with the new folder added
    • Note: Equality test, column tests, and new shape tests will all fail. This is okay and expected.
    • Ensure that the ROW tests pass for all of the previous runs. If anything is amiss, STOP and pin point the problem before proceeding.
  7. Add parsing code as needed to accept the new run data,

We should attempt to use new feature deployment as an opportunity to develop suitable test cases. In particular, we need additional development environment tables to run 'diffs' against. I.e. we have a stable set of data, make sure that the tables we generate are not changing in unexpected ways.

This is a point of ongoing development.

ESCALATE REPORT

Try a search on this wiki!

Clone this wiki locally