How do I install and set up GoConvey?

Install it with `go install github.com/smartystreets/goconvey`, then run `goconvey` in your project directory to start the web server. The browser should open automatically at localhost:8080, or you can manually navigate there.

Can I use GoConvey with my existing Go tests?

Yes, GoConvey is fully compatible with standard Go tests. You can run `go test` in the terminal as usual, or use the web UI to view results for any Go test suite, even without the `Convey` syntax.

GoConvey vs Testify: which is better for Go testing?

GoConvey is ideal for behavioral testing with a visual, real-time UI, while Testify focuses on assertions and mocking. Choose GoConvey if you want interactive feedback, or Testify for lightweight, assertion-heavy tests.

How to write a basic behavioral test with GoConvey?

Import the package, use `Convey` to group tests and `So` for assertions. For example, as shown in the quick start: `Convey("Given x", t, func() { So(x, ShouldEqual, 2) })` to create nested, descriptive tests.

Does GoConvey work in continuous integration environments?

It can be used in CI, but the web UI is unnecessary. Run `go test` directly for terminal output, or if needed, configure `goconvey` in headless mode, though this may require additional setup for notifications or coverage.

What versions of Go does GoConvey support?

The README states support for Go 1.16 and 1.17, but check the latest documentation or GitHub issues for updates, as support for newer Go versions may lag due to the project's maintenance model.

How to customize GoConvey's desktop notifications?

Notifications are optional and can be enabled via the web UI settings. However, configuration might require manual tweaking, and support for different operating systems can vary, so refer to the wiki for specific instructions.

Open-Awesome

GoConvey

NOASSERTIONGov1.8.0

A Go testing framework with a web UI that integrates directly with `go test` for writing behavioral tests.

Visit Website GitHub

8.4k stars557 forks0 contributors

What is GoConvey?

GoConvey is a testing framework for Go that provides a web-based interface and expressive syntax for writing behavioral tests. It integrates directly with the standard `go test` tool, allowing developers to run tests automatically in the browser or terminal while viewing real-time results and coverage reports.

Target Audience

Go developers and teams practicing test-driven development (TDD) who want a more interactive and visual testing workflow alongside traditional terminal-based testing.

Value Proposition

Developers choose GoConvey for its unique combination of a fully-automatic web UI with native Go test integration, enabling immediate feedback, readable test syntax, and coverage visualization without leaving their development environment.

Overview

Go testing in the browser. Integrates with go test. Write behavioral tests in Go.

Use Cases

Best For

Writing expressive behavioral tests in Go with readable syntax
Visualizing test results and coverage in real-time via a web browser
Integrating automated testing into a TDD workflow with immediate feedback
Running Go tests automatically as code changes without manual commands
Teams wanting both terminal and browser-based test execution options
Projects that use standard `go test` but want enhanced reporting and UI

Not Ideal For

Projects running in headless CI/CD pipelines where a web UI offers no benefit
Developers who prefer the standard Go testing syntax without additional behavioral layers
Teams requiring extensive mocking frameworks or tight integration with BDD tools like Ginkgo
Environments with strict security policies that restrict local web server usage

Pros & Cons

Pros

Seamless Go Test Integration

Directly works with the standard `go test` command, allowing use of existing test suites without modification, as emphasized in the README.

Real-Time Web UI

Provides a fully-automatic browser interface that updates test results immediately as code changes, enhancing test-driven development workflows.

Expressive Behavioral Syntax

Uses `Convey` and `So` for nested, readable test cases that clearly describe behavior, making tests more understandable and maintainable.

Integrated Coverage Reports

Displays code coverage metrics alongside test results in the web UI, helping developers quickly identify untested code areas.

Cons

Web Server Dependency

Requires running the `goconvey` command to start a local web server, which adds complexity and may not be suitable for headless or resource-constrained environments.

Limited Third-Party Integrations

Has fewer extensions and IDE integrations compared to other frameworks; features like Sublime Text linking need manual setup, as noted with 'some assembly required' in the README.

Maintenance Uncertainty

The project's disclaimer states enhancement requests may not be entertained, potentially leading to slower updates or lack of support for newer Go versions over time.

Frequently Asked Questions

Related Projects

Testify

A toolkit with common assertions and mocks that plays nicely with the standard library

Stars26,011

Forks1,723

Last commit5 days ago

Keploy

Open-source platform for creating safe, isolated production sandboxes for API, integration, and E2E testing.

Testcontainers for Go is a Go package that makes it simple to create and clean up container-based dependencies for automated integration/smoke tests. The clean, easy-to-use API enables developers to programmatically define containers that should be run as part of a test and clean up those resources when the test is done.

Stars4,872

Forks608