Defaults Facts and Fact Help! UI Element

[matthewRekos]

Description

Reads a new fact_description.yml file for each plugin that provides default facts and fact descriptions

Default Facts are loaded as a new source, which is now the default source for a new operation

Fact Descriptions are loaded as a part of a sidebar whenever a new "Fact Help" button is pressed on the "add potential link" panel.

Type of change

• New feature (non-breaking change which adds functionality)
• This change requires a documentation update
  • Documentation for PR 2791 in Caldera - Default Facts fieldmanual#114 <---- Field Manual Update

How Has This Been Tested?

I added tests to dava_svc to verify that it can loads fact_description yamls, tested that it works if these yamls do not exist, and added tests to check that the default source is being created

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have made corresponding changes to the documentation
• I have added tests that prove my fix is effective or that my feature works

[sonarcloud]

SonarCloud Quality Gate failed.   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

73.7% Coverage
0.0% Duplication

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

[sonarcloud]

SonarCloud Quality Gate failed.   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

73.7% Coverage
0.0% Duplication

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

81.8% Coverage
0.0% Duplication

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

81.2% Coverage
0.0% Duplication

[clenk]

I need to look at this closer, but some initial thoughts:

• Nice usability feature.
• Might be better to put the fact description right on the ability modal instead of way off to the side in a sidebar. We may want to bring in the UI team for their ideas.
• create_facts is too generic a name; maybe create_default_facts?
• load_fact_description_file needs a better, more descriptive error message

[matthewRekos]

I definitely also want the fact descriptions on the right side of the ability modal - I just couldn't figure it out quickly. Hopefully an easy change for front end folks

[matthewRekos]

• create_facts is too generic a name; maybe create_default_facts?
• load_fact_description_file needs a better, more descriptive error message

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

81.2% Coverage
0.0% Duplication

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days