Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Defaults Facts and Fact Help! UI Element #2791

Closed
wants to merge 30 commits into from

Conversation

matthewRekos
Copy link

@matthewRekos matthewRekos commented Jul 21, 2023

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

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
Copy link

sonarcloud bot commented Jul 26, 2023

SonarCloud Quality Gate failed.    Quality Gate failed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

73.7% 73.7% Coverage
0.0% 0.0% Duplication

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

1 similar comment
@sonarcloud
Copy link

sonarcloud bot commented Jul 26, 2023

SonarCloud Quality Gate failed.    Quality Gate failed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

73.7% 73.7% Coverage
0.0% 0.0% Duplication

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

@sonarcloud
Copy link

sonarcloud bot commented Jul 27, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

81.8% 81.8% Coverage
0.0% 0.0% Duplication

updated for tests

fixed tests to include fact_descriptions in ability object

switching to snake case

added data_svc tests

style fixes

tests for loading files

flake8

added tests for reading files

removed toggle functionality

removed alt_command executor

actually removing toggle
@sonarcloud
Copy link

sonarcloud bot commented Jul 27, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

81.2% 81.2% Coverage
0.0% 0.0% Duplication

Copy link
Contributor

@clenk clenk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Author

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
Copy link
Author

matthewRekos commented Jul 28, 2023

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

@sonarcloud
Copy link

sonarcloud bot commented Jul 28, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

81.2% 81.2% Coverage
0.0% 0.0% Duplication

@github-actions
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants