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

Removed Unnecessary .gcov files #708

Merged
merged 16 commits into from
Jun 19, 2021
Merged

Removed Unnecessary .gcov files #708

merged 16 commits into from
Jun 19, 2021

Conversation

AdvaitDhingra
Copy link
Contributor

Originating Project/Creator
Affected Component Mainly Svc
Affected Architectures(s)
Related Issue(s) #689
Has Unit Tests (y/n) Y
Builds Without Errors (y/n) Y
Unit Tests Pass (y/n) Y
Documentation Included (y/n) N

Change Description

Deleted all of the .gcov files in Svc, as the fprime-util tool renders theses useless.

Rationale

With the new fprime-util tool there is no need to keep the old executable files.

Testing/Review Recommendations

Tests all passed.

Future Work

Idk

@AdvaitDhingra
Copy link
Contributor Author

Are there any files I missed that need deleting?

@AdvaitDhingra
Copy link
Contributor Author

@saba-ja does this work?

@saba-ja
Copy link
Contributor

saba-ja commented Jun 14, 2021

@AdvaitDhingra,

Thank you for working on this task.
The following gcov files also need to be removed:

./Svc/PolyDb/test/ut/output/PolyDbImpl.hpp.gcov
./Svc/PolyDb/test/ut/output/PolyDbComponentAc.cpp.gcov
./Svc/PolyDb/test/ut/output/SvcPolyDb_gcov.txt
./Svc/PolyDb/test/ut/output/test.txt

./Svc/ActiveLogger/test/ut/output/ActiveLoggerComponentAc.cpp.gcov
./Svc/ActiveLogger/test/ut/output/ActiveLoggerImpl.cpp.gcov
./Svc/ActiveLogger/test/ut/output/SvcActiveLogger_gcov.txt
./Svc/ActiveLogger/test/ut/output/test.txt

You can double check the result by running find . -type f -name *.gcov

Note: Some of these gcov files are linked in the docs/sdd.md (see this for an example)

If you like you can update the Unit Testing section of the sdd.md files by removing links to the gcov and test output file with the following statement:

"""
To see unit test coverage run fprime-util check --coverage
"""

You can use the CmdDispatcher sdd as an example:

To be organized make a separate commit after updating sdd.md of each component.

Note: The maintainers might decide to keep some of the files depending on the group decision.

@AdvaitDhingra
Copy link
Contributor Author

@AdvaitDhingra,

Thank you for working on this task.
The following gcov files also need to be removed:

./Svc/PolyDb/test/ut/output/PolyDbImpl.hpp.gcov
./Svc/PolyDb/test/ut/output/PolyDbComponentAc.cpp.gcov
./Svc/PolyDb/test/ut/output/SvcPolyDb_gcov.txt
./Svc/PolyDb/test/ut/output/test.txt

./Svc/ActiveLogger/test/ut/output/ActiveLoggerComponentAc.cpp.gcov
./Svc/ActiveLogger/test/ut/output/ActiveLoggerImpl.cpp.gcov
./Svc/ActiveLogger/test/ut/output/SvcActiveLogger_gcov.txt
./Svc/ActiveLogger/test/ut/output/test.txt

You can double check the result by running find . -type f -name *.gcov

Note: Some of these gcov files are linked in the docs/sdd.md (see this for an example)

If you like you can update the Unit Testing section of the sdd.md files by removing links to the gcov and test output file with the following statement:

"""
To see unit test coverage run fprime-util check --coverage
"""

You can use the CmdDispatcher sdd as an example:

To be organized make a separate commit after updating sdd.md of each component.

Note: The maintainers might decide to keep some of the files depending on the group decision.

Okay. Thank you for the feedback. I will remove the remaining files in the morning. If the maintainers agree with the files I have deleted, then this PR can be merged. Else I can recover those files.

@AdvaitDhingra
Copy link
Contributor Author

@AdvaitDhingra,

Thank you for working on this task.
The following gcov files also need to be removed:

./Svc/PolyDb/test/ut/output/PolyDbImpl.hpp.gcov
./Svc/PolyDb/test/ut/output/PolyDbComponentAc.cpp.gcov
./Svc/PolyDb/test/ut/output/SvcPolyDb_gcov.txt
./Svc/PolyDb/test/ut/output/test.txt

./Svc/ActiveLogger/test/ut/output/ActiveLoggerComponentAc.cpp.gcov
./Svc/ActiveLogger/test/ut/output/ActiveLoggerImpl.cpp.gcov
./Svc/ActiveLogger/test/ut/output/SvcActiveLogger_gcov.txt
./Svc/ActiveLogger/test/ut/output/test.txt

You can double check the result by running find . -type f -name *.gcov

Note: Some of these gcov files are linked in the docs/sdd.md (see this for an example)

If you like you can update the Unit Testing section of the sdd.md files by removing links to the gcov and test output file with the following statement:

"""
To see unit test coverage run fprime-util check --coverage
"""

You can use the CmdDispatcher sdd as an example:

To be organized make a separate commit after updating sdd.md of each component.

Note: The maintainers might decide to keep some of the files depending on the group decision.

Is it okay if I just remove the entire output directory? Because thats what I've been doing until now

@saba-ja
Copy link
Contributor

saba-ja commented Jun 16, 2021

Yes, you can remove the entire output directory.
FYI, if a folder is empty git will automatically ignore the folder.

@AdvaitDhingra
Copy link
Contributor Author

Yes, you can remove the entire output directory.
FYI, if a folder is empty git will automatically ignore the folder.

Ah ok, thanks. I'll get started when I come home from school (approx. 2:15 pm CET)

@AdvaitDhingra
Copy link
Contributor Author

AdvaitDhingra commented Jun 16, 2021

@saba-ja Does that work?

@saba-ja
Copy link
Contributor

saba-ja commented Jun 16, 2021

@AdvaitDhingra, SDD updates look good except for commit de60877 (Svc/Health/docs/sdd.md).
Requirements and textual information about the UT should stay. Only the Links to the gcov an test output .txt files should be removed from the SDD.

@AdvaitDhingra
Copy link
Contributor Author

@AdvaitDhingra, SDD updates look good except for commit de60877 (Svc/Health/docs/sdd.md).
Requirements and textual information about the UT should stay. Only the Links to the gcov an test output .txt files should be removed from the SDD.

Ah okay. I'll delete that commit with rebase -i and redo it.

@LeStarch
Copy link
Collaborator

@AdvaitDhingra when you are finished with your proposed edits, let me know and I will rereview/merge this.

@LeStarch LeStarch self-requested a review June 16, 2021 18:54
@AdvaitDhingra
Copy link
Contributor Author

@AdvaitDhingra when you are finished with your proposed edits, let me know and I will rereview/merge this.

Thank you. I think that's it. I fixed the mistake in SVC/Health/sdd.md so that should be it

@LeStarch
Copy link
Collaborator

@AdvaitDhingra this is good. I will hold off merging just a bit as there are some other processes in-play.

@LeStarch LeStarch merged commit b86e9ba into nasa:devel Jun 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants