testing

Documentation

Overview

Copyright 2017 HootSuite Media Inc.

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. Modified hereafter by contributors to runatlantis/atlantis.

Index

• func Assert(tb testing.TB, condition bool, msg string, v ...interface{})
• func Contains(tb testing.TB, exp interface{}, slice []string)
• func DirStructure(t *testing.T, structure map[string]interface{}) (string, func())
• func Equals(tb testing.TB, exp, act interface{})
• func ErrContains(tb testing.TB, substr string, act error)
• func ErrEquals(tb testing.TB, exp string, act error)
• func Ok(tb testing.TB, err error)
• func TempDir(t *testing.T) (string, func())

Functions

func Assert

func Assert(tb testing.TB, condition bool, msg string, v ...interface{})

Assert fails the test if the condition is false. Taken from https://github.com/benbjohnson/testing.

func Contains

func Contains(tb testing.TB, exp interface{}, slice []string)

Contains fails the test if the slice doesn't contain the expected element

func DirStructure

func DirStructure(t *testing.T, structure map[string]interface{}) (string, func())

DirStructure creates a directory structure in a temporary directory. structure describes the dir structure. If the value is another map, then the key is the name of a directory. If the value is nil, then the key is the name of a file. It returns the path to the temp directory containing the defined structure and a cleanup function to delete the directory. Example usage:

	tmpDir, cleanup := DirStructure(t, map[string]interface{}{
		"pulldir": map[string]interface{}{
			"project1": map[string]interface{}{
				"main.tf": nil,
			},
			"project2": map[string]interface{}{,
				"main.tf": nil,
			},
		},
	})
 defer cleanup()

func Equals

func Equals(tb testing.TB, exp, act interface{})

Equals fails the test if exp is not equal to act. Taken from https://github.com/benbjohnson/testing.

func ErrContains

func ErrContains(tb testing.TB, substr string, act error)

ErrContains fails the test if act is nil or act.Error() does not contain substr.

func ErrEquals

func ErrEquals(tb testing.TB, exp string, act error)

ErrEquals fails the test if act is nil or act.Error() != exp

func Ok

func Ok(tb testing.TB, err error)

Ok fails the test if an err is not nil. Taken from https://github.com/benbjohnson/testing.

func TempDir

func TempDir(t *testing.T) (string, func())

TempDir creates a temporary directory and returns its path along with a cleanup function to be called via defer, ex:

dir, cleanup := TempDir()
defer cleanup()