apache / apache/pekko-connectors

what to do about file/src/test/resources/nested-sample.tar ?

Open
#320 7 comments 0 reactions 0 assignees View on GitHub
Dominant language
Scala
Stars
82
Forks
50
Avg merge
1d 2h
Merged PRs (30d)
78

Description

Used in a unit test.

* remove the file but then need to rewrite the test to create a temp tar file
* this is not as easy as it sounds - this tar contains multiple tgz files
* it's not clear if the test needs it to be this complicated
* document what is in our repo and the source release to highlight that this is a test artifact and not a jar
* ASF bans us from having binaries like jars in our repo and source releases but it doesn't ban all binary files
* unfortunately, release reviewers might still find the file and still -1 or generally the release

Contributor guide

Open the contributing guide

Research direction

Inspect file/src/test/resources/nested-sample.tar and the unit test that uses it. Compare the two options in the issue: recreating the nested tar in a temporary file or documenting the artifact for repository and source-release reviewers. Done requires a decided approach and a test or release-documentation change that addresses the concern.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation, release, testing
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.