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

Feature/3338/improve parser suggestion 3 #3414

Merged
merged 20 commits into from Nov 24, 2023
Merged

Feature/3338/improve parser suggestion 3 #3414

merged 20 commits into from Nov 24, 2023

Conversation

fritschldwg
Copy link
Collaborator

@fritschldwg fritschldwg commented Nov 20, 2023 •
edited by Nereboss

Feature/3338/improve parser suggestion 3

Closes: #3338

Description

  • Enhanced logging: Now logs the absolute file paths of the output files.
  • Bug fix: Resolved an issue in the CSVExporter that previously prevented the exporting of multiple projects.
  • Test coverage: Added tests for the CSVExporter.

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/visualisation READMEs, parser READMEs, --help, etc.) has been updated (almost always necessary except for bug fixes)
  • CHANGELOG.md has been updated

@fritschldwg
Copy link
Collaborator Author

fritschldwg commented Nov 20, 2023 •
edited

I'm uncertain about whether to include unit tests to validate the logging behavior.

Pros of adding unit tests:

  • Offers explicit verification that logging functions correctly for each parser.

Cons of adding unit tests:

  • Does not assess business logic; issues related to incorrect file creation should be caught by other tests.
  • Introduces potential brittleness to the tests.

@fritschldwg fritschldwg reopened this Nov 20, 2023
@fritschldwg fritschldwg force-pushed the feature/3338/improve-parser-suggestion-3 branch from 06d08ce to 4c17a9f Compare November 21, 2023 11:04
ce-bo
ce-bo approved these changes Nov 22, 2023
View reviewed changes
Copy link
Collaborator

@ce-bo ce-bo left a comment

Choose a reason for hiding this comment

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

LGTM in general. I added some suggestions on how to improve a little bit.

@fritschldwg fritschldwg force-pushed the feature/3338/improve-parser-suggestion-3 branch 3 times, most recently from ebf0aa2 to d99aa61 Compare November 23, 2023 19:38
fritschldwg and others added 13 commits November 24, 2023 09:26
@fritschldwg
Log output-file-paths #3338
ece02a3
@fritschldwg
Add test without implementation for csvexporter #3338
97a3ed8
@fritschldwg
Implement tests for max-depth-hierarchy #3338
0d4f18e
@Nereboss @fritschldwg
Implement remaining tests for CSVexporter #3338
324fcbe
@fritschldwg
Add changes to changelog #3338
9fbb090
@Nereboss @fritschldwg
Add test for logging absolute path #3338
8d8c151
@fritschldwg
Implement remaining logging tests #3338
2ba2b77
@Nereboss @fritschldwg
Adjust valid flag input for sourcecodeparser #3338
3a044e0 
Previously if you wanted a csv output you would have to input 'table'; was changed to 'csv'
@Nereboss @fritschldwg
Clean call method of sourcecodeparser #3338
3ef7734 
Logging has been refactored into its own function
@Nereboss @fritschldwg
Small refactor to fix failing tests #3338
d3ba9c3 
Due to the change from 'table' to 'csv' some tests had to be updated
@Nereboss @fritschldwg
Update docs #3338
d54a4cd
@fritschldwg
Unmock mocks after each test #3338
a2286aa
@fritschldwg
Add format options to gh-pages #3338
851bd40
@fritschldwg fritschldwg force-pushed the feature/3338/improve-parser-suggestion-3 branch from d99aa61 to 28624ea Compare November 24, 2023 08:28
@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Nov 24, 2023

[CodeCharta Visualization] 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

No Coverage information No Coverage information
No Duplication information No Duplication information

@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Nov 24, 2023

[CodeCharta Analysis] 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

93.2% 93.2% Coverage
0.0% 0.0% Duplication

@fritschldwg fritschldwg merged commit 48e47f7 into main Nov 24, 2023
7 checks passed
@fritschldwg fritschldwg deleted the feature/3338/improve-parser-suggestion-3 branch November 24, 2023 08:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ce-bo ce-bo ce-bo 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.

Parser suggestions - Improvements
3 participants
@fritschldwg @ce-bo @Nereboss