Giter Club home page Giter Club logo

assert's Introduction

Build Status GoDoc License Go version

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/metaleaf-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:

  1. 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()
    }
  2. IsEqualTo

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

    func TestIsEmpty(t *testing.T) {
        x := 1
        assert.With(t).
            That(x).
            IsGreaterThan(0)
    }
  4. 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()
    }
  5. IsOk

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

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

Contributing

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

Maintainers

License

Copyright 2019 Metaleaf.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.

assert's People

Contributors

metaleaf-io avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.