Feature: Added State Tracking Support to Findings

[alxbl]

Feature: State Tracking Support to Findings

Motivation: When multiple testers are working on the same report and adding findings, it becomes difficult to keep track of which findings are fully written out, which ones need review and which ones need to be filled out.

I'm submitting this feature because we've found it useful internally for our QA workflow and I hope other people benefit from this small quality of life improvement.

Cheers,
Alex

Usage

Add finding_states (or copy from config.json.defaults) to config.json as follows:

  "finding_states": [
    "Draft",
    "Under Review",
    "Completed"
  ],

• The first entry in the list is the default and fallback state.
• Reordering entries is not supported.
• Renaming entries is supported.

To disable the feature again, simply comment out the states array.

Backward Compatibility

• The finding_states array needs to be added to config.json otherwise this
  feature will remain hidden.
• This adds one column of type Integer called state to the findings table. Column is NULLABLE.
• Removing entries from the state list will force out of bound states back to the default state.

Screenshots

Findings List

Findings Edit

Notes

• This feature also adds a development Dockerfile to run Serpico in a docker container while keeping the sources out of the image. This allows for fast iteration without having to use RVM on the host.
• This feature builds on top of my other pull request Update docker image #513 because it leverages the Dockerfile. You should probably land Update docker image #513 before landing this to make sure there are merge issues.

[alxbl]

Quick side note: SSL with WebRack in Docker appears to be slow (or it could be my laptop, I suppose) so it's better to set "use_ssl": false in config.json if planning to develop using docker-compose up.

[BuffaloWill]

Awesome PR. See my note on #513 about changing Ruby versions. After we settle on that I am good to land this.