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.

Sign up for GitHub

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

Jump to bottom

Fix/3456/update mcc naming #3606

Merged
merged 30 commits into from
Jun 17, 2024
Merged

Fix/3456/update mcc naming #3606

merged 30 commits into from
Jun 17, 2024

Conversation

Nereboss
Copy link
Contributor

@Nereboss Nereboss commented Apr 30, 2024 •
edited
Loading

Update MCC naming

Closes: #3456

Description

Temporarily adds 'formerly mcc' to the no longer renamed sonar complexity

Definition of Done

A PR is only ready for merge once all the following acceptance criteria are fulfilled:

  • Changes have been manually tested
  • All TODOs related to this PR have been closed
  • There are automated tests for newly written code and bug fixes
  • All bugs discovered while working on this PR have been submitted as issues (if not already an open issue)
  • Documentation (GH-pages, analysis/visualization READMEs, parser READMEs, --help, etc.) has been updated (almost always necessary except for bug fixes)
  • CHANGELOG.md has been updated

Screenshots or gifs

@phanlezz
Copy link
Collaborator

phanlezz commented May 2, 2024

We need to investigate how this change will impact our online demo.

@phanlezz phanlezz force-pushed the fix/3456/update-mcc-naming branch from a292da5 to bf35d19 Compare May 6, 2024 08:28
@phanlezz
Copy link
Collaborator

phanlezz commented May 6, 2024

I rebased the branch to include the main changes

@phanlezz
Copy link
Collaborator

phanlezz commented May 6, 2024

I did some testing and here are some points that I found. We should evaluate if those changes are acceptable:

  • the current metric of the web demo can't be found, uses sonar_cognitive_complexity in local testing -> adjust link
  • "Metric Templates" are not applicable anymore (contain mcc)
  • "Suspicious Metrics" - MCC does not get detected as a preset
  • Attribute Descriptor Title for the sonar import still state "Maximum ...". We should change that.

@Nereboss
Copy link
Contributor Author

Nereboss commented May 7, 2024

I think all these points should be addressed before merging this issue.

i further found that we include other metrics that talk about mcc (the sourceMonitor has max_function_mcc and average_function_mcc) that should be changed as well here.

@Nereboss Nereboss force-pushed the fix/3456/update-mcc-naming branch from bf35d19 to a5a90c4 Compare May 28, 2024 13:09
Nereboss added a commit that referenced this pull request May 28, 2024
@Nereboss
Update both changelogs #3606
211a901
Nereboss added a commit that referenced this pull request May 28, 2024
@Nereboss
No longer renaming complexity to complexity (formerly mcc) in analysi…
eb45885 
…s part #3606
Nereboss added a commit that referenced this pull request May 29, 2024
@Nereboss
Update metric templares to include complexity and change attributeDes…
681e4ab 
…criptors for sourceCodeParser #3606
@Nereboss Nereboss force-pushed the fix/3456/update-mcc-naming branch from a3411d2 to 5ec6f26 Compare June 4, 2024 10:08
@Nereboss
change PNG to png in some docs where it broke the images #3456
e231da2
@Nereboss
update mcc in json schema changelog #3456
31aab2a
@Nereboss
Update text in risk profile to make users aware of mcc name change #3456
4b878c5
@Nereboss
Update mcc naming in sourcecodeparser docs #3456
869e558
@Nereboss
Fix typo in "susOiciousMetricsList" #3456
1eb567d
@Nereboss
change mcc to complexity in SourceCodeParser changelog #3456
dbe679a
@Nereboss
Change all sample files to complexity instead of mcc #3456
d75e397
@Nereboss
Update attributeDescriptors with improved descriptions and complexity…
93c222d 
… instead of mcc #3456
@Nereboss
Fix failing test for SourceMonitor #3456
ceb7e4b
@Nereboss
Add comment where sonar metric descriptions can be found #3456
b4f26b6
@Nereboss
Fix failing test for sourceCodeParser #3456
8af9476
@Nereboss
Fix failing test in artificialIntelligence.selector #3456
b2b1b05
@Nereboss
Fix failing test in riskProfileHelper #3456
1c62abf
@Nereboss
Fix failing test in suspiciousMetricsHelper #3456
fada57a
@Nereboss
Copy link
Contributor Author

All the previously found issues should be resolved. Additionally, the metrics "complexity" and "sonar_complexity" will include (formerly mcc) in their display name in the search (and are also findable my searching for mcc).

@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Jun 14, 2024

Quality Gate Passed Quality Gate passed for 'CodeCharta Visualization'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
98.6% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Jun 14, 2024

Quality Gate Passed Quality Gate passed for 'CodeCharta Analysis'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

phanlezz
phanlezz approved these changes Jun 17, 2024
View reviewed changes
Copy link
Collaborator

@phanlezz phanlezz left a comment

Choose a reason for hiding this comment

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

LGTM

@phanlezz phanlezz merged commit 40c1ce3 into main Jun 17, 2024
7 checks passed
@phanlezz phanlezz deleted the fix/3456/update-mcc-naming branch June 17, 2024 07:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@phanlezz phanlezz phanlezz approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

MCC name is incorrect
2 participants
@Nereboss @phanlezz