Consolidate package-level & receiver-type suite Run() function

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

Nobody has claimed this yet.

Assessment

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

Research direction

Start by locating the package-level suite.Run function and the receiver-type Run method, then compare their behavior and existing usage. Determine whether the receiver method should be consolidated or removed, including the compatibility impact, and validate the decision against the existing suite tests and callers.

Written by the indexing model from the issue text.

Description

Breaking Change

What?

The suite.Run() method exists both on the package level as well as a receiver of a suite type. The package-level function has a lot more development and features whereas the receiver is very basic and neglected.

Why?

Reduce code duplication, remove user confusion over which one to use, reduce errors, centralise code.

Risk

This is potentially a breaking change and could be incompatible with all existing code that uses the receiver-type function should we decide to remove it.

Dominant language
Go
Stars
26.2k
Forks
1.9k
Avg merge
2d 4h
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

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.

More from stretchr/testify

All issues in stretchr/testify

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.