github.com/MediaExchange/assert

assert

Lightweight assertion library based on the fluent interface from assertj

Features

The matchers included in our assert library are fully compatible with, and depend on the standard Go testing package. These just add a little syntactic sugar on top of the familiar test patterns.

To use the example from the testing documentation, here is how one would normally write a test in Go:

func TestAbs(t *testing.T) {
    got := Abs(-1)
    if got != 1 {
        t.Errorf("Abs(-1) = %d; want 1", got)
    }
}

With the matchers included in our assert package, one would write:

import "github.com/mediaexchange-io/assert"

func TestAbs(t *testing.T) {
    got := Abs(-1)
    assert.With(t).
        That(got).
        IsEqualTo(1)
}

This is much more readable and ultimately leads to more maintainable code.

Usage

The matchers currently included in the assert package are:

• IsEmpty/IsNotEmpty

  func TestIsEmpty(t *testing.T) {
      s := ""
      assert.With(t).
          That(s).
          IsEmpty()
  }
  

  func TestIsNotEmpty(t *testing.T) {
      s := "foobar"
      assert.With(t).
          That(s).
          IsNotEmpty()
  }
  

• IsEqualTo

  func TestEquals(t *testing.T) {
      got := Abs(-1)
      assert.With(t).
          That(got).
          IsEqualTo(1)
  }
  

• IsGreaterThan

  func TestIsEmpty(t *testing.T) {
      x := 1
      assert.With(t).
          That(x).
          IsGreaterThan(0)
  }
  

• IsNil/IsNotNil

  func TestIsNil(t *testing.T) {
      var s *string
      assert.With(t).
          That(s).
          IsNil()
  }
  

  func TestIsNotNil(t *testing.T) {
      var s string
      assert.With(t).
          That(s).
          IsNotNil()
  }
  

• IsOk

  func TestIsOk(t *testing.T) {
      f, err := io.Open("filename.ext")
      assert.With(t).
          That(err).
          IsOk()
  }
  

• ThatPanics

  func TestThatPanics(t *testing.T) {
      f := func() {
          panic("error")
      }
      assert.With(t).
          ThatPanics(f)
  }
  

Contributing

• Fork it
• Create a feature branch (git checkout -b new-feature)
• Commit changes (git commit -am "Added new feature xyz")
• Push the branch (git push origin new-feature)
• Create a new pull request.

Maintainers

• Media Exchange

License

Copyright 2019 MediaExchange.io

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.