Slather selects doccarchive when looking for binary
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 38/100
Research direction
Start in lib/slather/project.rb at find_binary_files, where the issue points to existing filters for .dsym and swiftmodule files. Reproduce with a target that generates a doccarchive and uses binary_basename; done means the archive directory is not selected as the binary and coverage can load the target binary.
Written by the indexing model from the issue text.
Description
A minor one:
If we have RUN_DOCUMENTATION_COMPILER = YES within our target, the target's doccarchive gets generated alongside the built target.
But it's possible for find_binary_file to confuse the output within the doccarchive for the target module, because they share the same name. eg. this error:
bundler: failed to load command: fastlane (/Users/vagrant/.rbenv/versions/2.6.5/bin/fastlane)
/Users/vagrant/.rbenv/versions/2.6.5/lib/ruby/gems/2.6.0/gems/fastlane-2.204.3/fastlane_core/lib/fastlane_core/ui/interface.rb:153:in `shell_error!': [!] Exit status of command 'slather coverage --sonarqube-xml --build-directory /Users/vagrant/git/derivedData --output-directory ./sonar-reports --input-format profdata --scheme AProduct --workspace AProduct.xcworkspace AProduct.xcodeproj' was 1 instead of 0. (FastlaneCore::Interface::FastlaneShellError)
Slathering...
error: /Users/vagrant/git/derivedData/Build/Products/Debug-iphonesimulator/AFramework.doccarchive/data/documentation/AFramework: Failed to load coverage: Is a directory
error: Could not load coverage information
We're able to work around this by specifying binary_file instead of binary_basename directly in our configuration, but obviously it would be preferable, and more portable, if binary_basename continued to work.
There's already explicit filtering of .dsym and swiftmodule files within find_binary_files, so one solution might also be to skip the doccarchive here as well.
Happy to suggest a PR, just wanted to try and raise an issue first!
- Dominant language
- Ruby
- Stars
- 1.6k
- Forks
- 239
- Avg merge
- 10h 19m
- Merged PRs (30d)
- 1
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from SlatherOrg/slather
-
2.8.6: NoMethodError "undefined method 'first'" in profdata_coverage_dir whenever --scheme is usedOpen
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
SlatherOrg/slather#586 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
SlatherOrg/slather#582 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
SlatherOrg/slather#580 · 9 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 56/100
SlatherOrg/slather#578 · 3 comments · 1 reaction ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
SlatherOrg/slather#577 ·
All issues in SlatherOrg/slather
Similar issues
-
bug: "Conversation information" accordion renders blank with 0px height when conversation has no attributesPossibly taken @gihovani claimed this today. Open
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 2 days
-
`hanami generate repository` would be a nice alias for `hanami generate repo`Possibly taken @sandbergja claimed this today. Openbug help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
hanami/hanami-cli#455 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 69/100
asciidoctor/asciidoctor#4882 · 4 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
sclorg/s2i-ruby-container#660 · 1 comment ·