Skip to content

Colorize 'expected' and 'actual'#994

Open
hcmlinj wants to merge 2 commits intostretchr:masterfrom
hcmlinj:colorize-expected-and-actual
Open

Colorize 'expected' and 'actual'#994
hcmlinj wants to merge 2 commits intostretchr:masterfrom
hcmlinj:colorize-expected-and-actual

Conversation

@hcmlinj
Copy link

@hcmlinj hcmlinj commented Aug 20, 2020 •
edited
Loading

Summary

Colorize "expected" and "actual"

Changes

Resolves #946

Motivation

  1. @boyan-soubachov says "It's an interesting idea."

  2. @mvdkleijn says "I like this idea."

package testify

import (
	"errors"
	"testing"

	"github.com/stretchr/testify/assert"
)

func TestExamples(t *testing.T) {
	wrapT := assert.WrapColorize(t)
	newAssert := assert.New(wrapT)

	assert.Equal(wrapT, 1, 2)
	assert.Equal(wrapT, "A", "b")
	newAssert.Equal(3, 4)

	assert.Same(wrapT, new(assert.Colorize), new(assert.Colorize))
	newAssert.Same(new(assert.Colorize), new(assert.Colorize))

	assert.EqualValues(wrapT, uint32(123), int32(124))
	newAssert.EqualValues(uint32(123), int32(124))

	assert.EqualError(wrapT, errors.New("foo"), "bar")
	newAssert.EqualError(errors.New("foo"), "bar")
}

Related issues

N/A

Screenshot

TestColorize

TestColorize

Equal

Equal

Same

Same

EqualValues

EqualValues

EqualError

EqualError

@hcmlinj hcmlinj force-pushed the colorize-expected-and-actual branch from 630cc70 to 2480372 Compare August 20, 2020 14:59
@hcmlinj
Copy link
Author

hcmlinj commented Sep 10, 2020

Dear @boyan-soubachov , do you mind review this PR or give some suggestion?

@alxn
Copy link
Contributor

alxn commented Jan 16, 2021

Can you retest by redirecting to a file and see if you see control characters ?

@hcmlinj
Copy link
Author

hcmlinj commented Jan 30, 2021

I think yes.

Please refer this unit test: assert/colorize_test.go#L31

func TestColorize_Message(t *testing.T) {
	failureMessage := fmt.Sprintf("Not equal: \n"+
		"expected: %s\n"+
		"actual  : %s%s", "expected", "actual", "diff")
	fmt.Println(WrapColorize(t).Message(failureMessage))
}

output:
Screen Shot 2021-01-30 at 10 59 43 AM

@alxn
Copy link
Contributor

alxn commented Jan 30, 2021

I think yes.

Please refer this unit test: assert/colorize_test.go#L31

func TestColorize_Message(t *testing.T) {
	failureMessage := fmt.Sprintf("Not equal: \n"+
		"expected: %s\n"+
		"actual  : %s%s", "expected", "actual", "diff")
	fmt.Println(WrapColorize(t).Message(failureMessage))
}

output:
Screen Shot 2021-01-30 at 10 59 43 AM

I think that proves it fails - you can see the terminal escapes e.g. [31m and [0m.

@walles walles mentioned this pull request Nov 23, 2021
Closed
@dolmen dolmen added enhancement: colored output About adding colored output pkg-assert Change related to package testify/assert labels Mar 6, 2024
fredbi added a commit to fredbi/testify that referenced this pull request Jan 12, 2026
@fredbi
feat: added optional support for colorized output
88534f2 
This PR adds support for colorized output, with minimal extra
dependencies.

- Actual / Expected in equal colorized
- Diff output is colorized

It is enabled with the specific extra blank import:

_ "github.com/go-openapi/testify/enable/colors/v2"

When enabled, colorized output is:
* enabled by go test flag -testify.colorize
* or by environment variable TESTIFY_COLORIZE=true

By default, colors are chose to be rendered on a dark terminal.

You may use darker colors on a bright terminal with:

* go test flag -testify.colorize -testify.theme=light
* or by environment variable TESTIFY_THEME=light

This work is inspired and adapts the following PRs:

* github.com/stretchr#1467
* github.com/stretchr#1480
* github.com/stretchr#1232
* github.com/stretchr#994

Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
@fredbi fredbi mentioned this pull request Jan 12, 2026
Merged
5 tasks
fredbi added a commit to fredbi/testify that referenced this pull request Jan 12, 2026
@fredbi
feat: added optional support for colorized output
e5c1f93 
This PR adds support for colorized output, with minimal extra
dependencies.

- Actual / Expected in equal colorized
- Diff output is colorized

It is enabled with the specific extra blank import:

_ "github.com/go-openapi/testify/enable/colors/v2"

When enabled, colorized output is:
* enabled by go test flag -testify.colorize
* or by environment variable TESTIFY_COLORIZE=true

By default, colors are chose to be rendered on a dark terminal.

You may use darker colors on a bright terminal with:

* go test flag -testify.colorize -testify.theme=light
* or by environment variable TESTIFY_THEME=light

This work is inspired and adapts the following PRs:

* github.com/stretchr#1467
* github.com/stretchr#1480
* github.com/stretchr#1232
* github.com/stretchr#994

Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
fredbi added a commit to fredbi/testify that referenced this pull request Jan 12, 2026
@fredbi
feat: added optional support for colorized output
844ab46 
This PR adds support for colorized output, with minimal extra
dependencies.

- Actual / Expected in equal colorized
- Diff output is colorized

It is enabled with the specific extra blank import:

_ "github.com/go-openapi/testify/enable/colors/v2"

When enabled, colorized output is:
* enabled by go test flag -testify.colorized
* or by environment variable TESTIFY_COLORIZED=true

By default, colors are chose to be rendered on a dark terminal.

You may use darker colors on a bright terminal with:

* go test flag -testify.colorized -testify.theme=light
* or by environment variable TESTIFY_THEME=light

This work is inspired and adapts the following PRs:

* github.com/stretchr#1467
* github.com/stretchr#1480
* github.com/stretchr#1232
* github.com/stretchr#994

Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
fredbi added a commit to fredbi/testify that referenced this pull request Jan 12, 2026
@fredbi
feat: added optional support for colorized output
bdf9d89 
This PR adds support for colorized output, with minimal extra
dependencies.

- Actual / Expected in equal colorized
- Diff output is colorized

It is enabled with the specific extra blank import:

_ "github.com/go-openapi/testify/enable/colors/v2"

When enabled, colorized output is:
* enabled by go test flag -testify.colorized
* or by environment variable TESTIFY_COLORIZED=true

By default, colors are chose to be rendered on a dark terminal.

You may use darker colors on a bright terminal with:

* go test flag -testify.colorized -testify.theme=light
* or by environment variable TESTIFY_THEME=light

This work is inspired and adapts the following PRs:

* github.com/stretchr#1467
* github.com/stretchr#1480
* github.com/stretchr#1232
* github.com/stretchr#994

Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
fredbi added a commit to go-openapi/testify that referenced this pull request Jan 12, 2026
@fredbi
feat: added optional support for colorized output (#33)
d432be4 
This PR adds support for colorized output, with minimal extra
dependencies.

- Actual / Expected in equal colorized
- Diff output is colorized

It is enabled with the specific extra blank import:

_ "github.com/go-openapi/testify/enable/colors/v2"

When enabled, colorized output is:
* enabled by go test flag -testify.colorized
* or by environment variable TESTIFY_COLORIZED=true

By default, colors are chose to be rendered on a dark terminal.

You may use darker colors on a bright terminal with:

* go test flag -testify.colorized -testify.theme=light
* or by environment variable TESTIFY_THEME=light

This work is inspired and adapts the following PRs:

* github.com/stretchr#1467
* github.com/stretchr#1480
* github.com/stretchr#1232
* github.com/stretchr#994

Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

enhancement: colored output About adding colored output pkg-assert Change related to package testify/assert

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Colorize "expected" and "actual"

3 participants

@hcmlinj @alxn @dolmen