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

restore "CZICmd" demo application #20

Merged
merged 55 commits into from
Dec 19, 2022
Merged

restore "CZICmd" demo application #20

merged 55 commits into from
Dec 19, 2022

Conversation

ptahmose
Copy link
Contributor

@ptahmose ptahmose commented Dec 13, 2022

Description

This is adding the sample-application "CZICmd". It is functionally identical with the
version from here, with the following change: the command-line argument parsing has been refactored and is now done with the help of CLI11.

Note: this PR is just adding the code, but CZICmd is not built by default. It needs to be enabled by setting the option "LIBCZI_BUILD_CZICMD" to "ON".

Fix for #18 is included.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

  • build runs locally (Linux and Windows)
  • CZICmd tested manually

Checklist:

  • I followed the Contributing Guidelines.
  • I did a self-review.
  • I commented my code, particularly in hard-to-understand areas.
  • I updated the documentation.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.

@codecov
Copy link

codecov bot commented Dec 13, 2022

Codecov Report

❗ No coverage uploaded for pull request base (main@7b425bd). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #20   +/-   ##
=======================================
  Coverage        ?   46.20%           
=======================================
  Files           ?       77           
  Lines           ?    15659           
  Branches        ?        0           
=======================================
  Hits            ?     7235           
  Misses          ?     8424           
  Partials        ?        0           
Flag Coverage Δ
windows-latest 46.20% <0.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Src/CZICmd/BitmapGenNull.cpp Fixed Show fixed Hide fixed
Src/CZICmd/BitmapGenNull.cpp Fixed Show fixed Hide fixed
Src/CZICmd/BitmapGenNull.cpp Fixed Show fixed Hide fixed
Src/CZICmd/executeCreateCzi.cpp Fixed Show fixed Hide fixed
Src/CZICmd/executeCreateCzi.cpp Fixed Show fixed Hide fixed
@ptahmose ptahmose mentioned this pull request Dec 13, 2022
@FelixS90
Copy link
Collaborator

Reported code coverage is OK -> 46.2% is the same as currently on main. No comparison to base commit since branch seems to have been based on commit prior to introducing codecov.

@FelixS90 FelixS90 added the cla Contributor License Agreement sent to Admin label Dec 17, 2022
@FelixS90
Copy link
Collaborator

Note: Not further reviewing the logic of Src/CZICmd based on PR description stating that this is basically "copied" over from the archived repo and functionally equivalent.

@FelixS90
Copy link
Collaborator

FelixS90 commented Dec 17, 2022

Seems that Src/libCZI/Doxyfile was never used?

I'd think so, only ..Src/Doxyfile is used.

.github/workflows/cmake.yml Outdated Show resolved Hide resolved
.github/workflows/cmake.yml Outdated Show resolved Hide resolved
.github/workflows/cmake.yml Outdated Show resolved Hide resolved
.github/workflows/cmake.yml Outdated Show resolved Hide resolved
Src/CMakeLists.txt Show resolved Hide resolved
Src/CZICmd/CZIcmd.cpp Show resolved Hide resolved
Src/JxrDecode/CMakeLists.txt Show resolved Hide resolved
Src/libCZI/CMakeLists.txt Show resolved Hide resolved
Src/libCZI/Doc/CZICmd_usage.markdown Show resolved Hide resolved
Src/libCZI/Doc/CZICmd_usage.markdown Show resolved Hide resolved
@FelixS90 FelixS90 self-requested a review December 17, 2022 10:24
Copy link
Collaborator

@FelixS90 FelixS90 left a comment

Choose a reason for hiding this comment

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

Please have a look at the open conversations/threads. Looks good to me.

@FelixS90 FelixS90 self-requested a review December 17, 2022 10:28
Copy link
Collaborator

@FelixS90 FelixS90 left a comment

Choose a reason for hiding this comment

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

LGTM. Just a few open comments.

@FelixS90
Copy link
Collaborator

One thing I just noticed when running doxygen locally (version 1.9.5):

image

Maybe we want to remove the unused flags. I leave this up to you.

Info: The last successful run on main was still using 1.8. Most likely, it will then also use 1.9 next time (i.e. upon completion of this PR), but as I said, we can also tackle this later on when we get the warning on the CD build.

Copy link
Collaborator

@FelixS90 FelixS90 left a comment

Choose a reason for hiding this comment

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

What are your plans on adding tests for CZICmd?

Should we still already include it in https://github.com/ZEISS/libczi/blob/main/opencppcoverage.txt (to have visibility through codecov)?
image

Or should we add an issue (maybe tagged "good first issue") to keep track of it?

What do you think?

@ptahmose
Copy link
Contributor Author

One thing I just noticed when running doxygen locally (version 1.9.5):

image

Maybe we want to remove the unused flags. I leave this up to you.

Info: The last successful run on main was still using 1.8. Most likely, it will then also use 1.9 next time (i.e. upon completion of this PR), but as I said, we can also tackle this later on when we get the warning on the CD build.

One thing I just noticed when running doxygen locally (version 1.9.5):

image

Maybe we want to remove the unused flags. I leave this up to you.

Info: The last successful run on main was still using 1.8. Most likely, it will then also use 1.9 next time (i.e. upon completion of this PR), but as I said, we can also tackle this later on when we get the warning on the CD build.

added an issue -> #21

@ptahmose ptahmose mentioned this pull request Dec 19, 2022
@ptahmose
Copy link
Contributor Author

ptahmose commented Dec 19, 2022

What are your plans on adding tests for CZICmd?

Should we still already include it in https://github.com/ZEISS/libczi/blob/main/opencppcoverage.txt (to have visibility through codecov)? image

Or should we add an issue (maybe tagged "good first issue") to keep track of it?

What do you think?

Added #24 and discussed ideas/options.
For the time being, I'd be fine with "codecov does not include CZIcmd".

@ptahmose ptahmose merged commit 8990f99 into ZEISS:main Dec 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla Contributor License Agreement sent to Admin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants