facebook/TestSlide

Improve StrictMock & mock_callable exception messages

Open

#234 opened on Sep 1, 2020

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Python (58 forks)auto 404
Better Error MessagesHacktoberfestenhancement

Repository metrics

Stars
 (147 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently we raise things like UnexpectedCallArguments telling about "behavior". This confuses a lot of users constantly.

@karlodwyer suggested doing things like:

  • UnexpectedCallArguments > UnmatchedCallReceived
  • explain there's no configured mocks to answer this call
  • explain which calls the mock is configured to accept.

Le's apply this "make it clearer mindset" to all existing StrictMock & mock_callable exceptions.

Contributor guide

Research direction
Examine all exception classes in StrictMock and mock callable, rename them for clarity, and update messages to explain what happened and how to fix it.
Tech stack
python
Domain
testing qa
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65