GoConvey Documentation

Install the GoConvey tool using go install to make the goconvey binary available in your $GOPATH/bin.

$ go install github.com/smartystreets/goconvey

You can run a local web server that watches your tests and automatically updates the results in your browser as you change your code.

1. Navigate to your project's path in the terminal.
2. Run the goconvey command.
3. Open http://localhost:8080 in your browser.

The Web UI supports both GoConvey-style tests and traditional Go tests.

$ $GOPATH/bin/goconvey

You can include Font Awesome as a component by running the following command or adding it to your component.json dependencies.

$ component install FortAwesome/Font-Awesome

Or add to component.json:

"FortAwesome/Font-Awesome": "*"

To build the project or work on its source, you must install the following prerequisites:

• Ruby and Ruby Development Headers (on Ubuntu: sudo apt-get install ruby-dev; on Windows: DevKit)
• Bundler: Install via gem install bundler
• NPM (Node Package Manager)
• Less: Install via npm install -g less
• Less Plugin: Clean CSS: Install via npm install -g less-plugin-clean-css

After installing prerequisites, run these commands from the root of the repository to install development tools:

$ bundle install
$ npm install

GoConvey uses a BDD-style (Behavior Driven Development) syntax. You use the Convey function to define scopes and the So function to define assertions.

Important: Only pass the *testing.T object into the top-level Convey call. Nested Convey calls should only take the function body.

package package_name

import (
    "testing"
    . "github.com/smartystreets/goconvey/convey"
)

func TestSpec(t *testing.T) {

	// Only pass t into top-level Convey calls
	Convey("Given some integer with a starting value", t, func() {
		x := 1

		Convey("When the integer is incremented", func() {
			x++

			Convey("The value should be greater by one", func() {
				So(x, ShouldEqual, 2)
			})
		})
	})
}

These methods allow the user to manage which paths are monitored by the watcher.

• Ignore(): Sends a messaging.WatcherIgnore command. Requires a paths query parameter (e.g., /ignore?paths=pkg/internal).
• Reinstate(): Sends a messaging.WatcherReinstate command. Requires a paths query parameter to re-enable monitoring for specific paths.