cisagov / cisagov/mesa-toolkit

Improve deliverables output

Open
#18 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
8
Forks
7
PR merge metrics
No merged PRs in 30d

Description

# 💡 Summary #

Update the JSON output to account for all scans. Consolidate duplicative functions to ensure tool efficiency. Ensure JSON can be generated regardless of the number of completed scans.

## Motivation and context ##

Currently the JSON file that's generated after the scans does not provide an overview of all scan results. There were also several functions that were serving the same purpose that needed to be consolidated for efficiency. Lastly, the JSON generator function would fail if not all scans were completed. This can be problematic for use cases where only a subset of scan functions are used but results are still desired.

## Implementation notes ##

- Review the code to identify any functions that can be consolidated for efficiency
- Identify why JSON files fail to generate when partial scans are performed
- Create additional functions to account for missing JSON data

## Acceptance criteria ##

How do we know when this work is done?

- [ ] Remove duplicative functions wherever possible
- [ ] Ensure JSON data is generated for all completed scans
- [ ] Ensure JSON generator function doesn't fail when only a subset of scans are performed

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by tracing the JSON generator and how completed scan results are collected, then inspect the functions that provide overlapping behavior. Reproduce generation with a partial scan set and verify that output includes every completed scan without failing; completion also requires removing unnecessary duplication.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.