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

refactor: Remove circular dependencies from fileIO/common/codingutilities #3247

Merged

Conversation

MelReyCG
Copy link
Contributor

@MelReyCG MelReyCG commented Jul 26, 2024

The point of this PR is to solve the circular dependencies of fileIO, common and codingutilities by:

  • adding two basicIO and format in common.
    • format will contain Format.*pp, fileIO/Table/*, fileIO/Section/*
      • => no more fileIO <-> common
    • logger: will contain utilities logging (only one file for now but is going to grow)
      • => prevent further circular dependencies
  • lighten the DataType.*pp by making it only related to static types:
    • rtTypes & Regex will be in codingUtilities, aside of StringEnums.hpp
      • => no more codingUtilities <-> common
    • no more MPI constants nor formatting nor logger inclusion in this header
    • no more need for a DataType.cpp
      • => this header can now be included anywhere without needed any linking

@MelReyCG MelReyCG added type: cleanup / refactor Non-functional change (NFC) ci: run CUDA builds Allows to triggers (costly) CUDA jobs ci: run integrated tests Allows to run the integrated tests in GEOS CI labels Jul 26, 2024
@MelReyCG MelReyCG self-assigned this Jul 26, 2024
Copy link

codecov bot commented Jul 26, 2024

Codecov Report

Attention: Patch coverage is 58.62069% with 12 lines in your changes missing coverage. Please review.

Project coverage is 55.91%. Comparing base (23acc39) to head (2d8b341).
Report is 76 commits behind head on develop.

Files with missing lines Patch % Lines
src/coreComponents/codingUtilities/RTTypes.hpp 68.00% 8 Missing ⚠️
src/coreComponents/common/format/Format.hpp 0.00% 4 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #3247      +/-   ##
===========================================
- Coverage    55.92%   55.91%   -0.02%     
===========================================
  Files         1042     1043       +1     
  Lines        88923    88934      +11     
===========================================
- Hits         49733    49729       -4     
- Misses       39190    39205      +15     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@MelReyCG MelReyCG changed the title refactor: Remove circular dependency fileIO/common/codingutilities refactor: Remove circular dependencies from fileIO/common/codingutilities Jul 26, 2024
@MelReyCG MelReyCG requested a review from paveltomin as a code owner July 29, 2024 06:46
src/coreComponents/common/MpiWrapper.cpp Outdated Show resolved Hide resolved
@MelReyCG MelReyCG force-pushed the feature/rey/remove-circular-fileIO&common-dependancies branch from 3ed38d8 to 6981b3b Compare August 1, 2024 09:14
@MelReyCG
Copy link
Contributor Author

MelReyCG commented Aug 1, 2024

@rrsettgast @CusiniM I reverted the branch to the commit before the "MPI_COMM_GEOSX to MPI_COMM_GEOS" because this renaming now has its own PR.

@rrsettgast rrsettgast merged commit 0cbc589 into develop Aug 5, 2024
21 of 22 checks passed
@rrsettgast rrsettgast deleted the feature/rey/remove-circular-fileIO&common-dependancies branch August 5, 2024 16:24
rrsettgast pushed a commit that referenced this pull request Sep 17, 2024
…ties (#3247)

* DataTypes.hpp now only manage static types
- no runtime types nor Mpi constants
- DataTypes.cpp is not useful anymore.

* removing common -> fileIO

* removing common->codingUtilities

* logger has now a dedicated folder for upcoming files (future PRs)
---------
rrsettgast pushed a commit that referenced this pull request Sep 17, 2024
…ties (#3247)

* DataTypes.hpp now only manage static types
- no runtime types nor Mpi constants
- DataTypes.cpp is not useful anymore.

* removing common -> fileIO

* removing common->codingUtilities

* logger has now a dedicated folder for upcoming files (future PRs)
---------
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci: run CUDA builds Allows to triggers (costly) CUDA jobs ci: run integrated tests Allows to run the integrated tests in GEOS CI type: cleanup / refactor Non-functional change (NFC)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants