Test-More / Test-More/test-more

Discourage checking hash fields in `object`.

Open
#994 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Perl
Stars
149
Forks
98
PR merge metrics
No merged PRs in 30d

Description

It's glassbox testing to say that an object must contain certain hash fields and should not be encouraged. Unfortunately the object doc example spends half its time on this.

This is particularly egregious with end. This requires that the object contain exactly certain specific fields and no others. And end only applies to certain parts of the object description complicating how the user expects end to work.

To that end...

  • Remove field and end from the object docs.
    • Leave them working for backwards compat.
  • Allow hash, array, and bag to work inside object.

This eliminates a bunch of redundancy in object with hash and array, and it allows the object docs to focus on blackbox testing.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the object documentation, its implementation, and the tests covering field, end, hash, array, and bag. Verify the requested documentation removals, backward compatibility, and nested behavior; done means the tests pass and the object docs no longer encourage glassbox field checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
perl
Domain
testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.