https://github.com/tvastar/test

test utilities for golang
https://github.com/tvastar/test

golang golden golden-file markdown markdown-converter snippets testing

Last synced: about 1 month ago
JSON representation

test utilities for golang

• Host: GitHub
• URL: https://github.com/tvastar/test
• Owner: tvastar
• License: mit
• Created: 2019-03-23T21:47:36.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-09-23T01:09:27.000Z (about 5 years ago)
• Last Synced: 2024-08-03T19:10:00.024Z (5 months ago)
• Topics: golang, golden, golden-file, markdown, markdown-converter, snippets, testing
• Language: Go
• Homepage:
• Size: 52.7 KB
• Stars: 9
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-go-extra - test - 03-23T21:47:36Z|2019-09-23T01:09:27Z| (Testing / Testing Frameworks)

README

        
# Test

[![Status](https://travis-ci.com/tvastar/test.svg?branch=master)](https://travis-ci.com/tvastar/test?branch=master)

[![GoDoc](https://godoc.org/github.com/tvastar/test?status.svg)](https://godoc.org/github.com/tvastar/test)

[![codecov](https://codecov.io/gh/tvastar/test/branch/master/graph/badge.svg)](https://codecov.io/gh/tvastar/test)

[![Go Report Card](https://goreportcard.com/badge/github.com/tvastar/test)](https://goreportcard.com/report/github.com/tvastar/test)

Test is a simple golang test utils package.

## test.Artifact

test.Artifact allows a simple way to test artifacts against recorded

golden files.

The golden files are stored in `testdata/` folder of the caller of the

API and are expected to contain the JSON version of the value being

tested.  The [go-cmp](https://github.com/google/go-cmp) package is

used for better quality diffs.

## test.File

This is deprecated in favor of test.Artifact.

## test.Markdown

Markdown() converts a set of code snippets in markdown into test cases. For example:

````

```go

if len("hello") != 5 {

	fmt.Println("This should not happen")

}

// Output:

```

````

The above snippet is converted to an `ExampleXXX()` which runs the code.

Snippets can also be named, with ability to import code from elsewhere:

````

```go  TestBoo

// import runtime

_, fname, _, _ := runtime.Caller(1)

if fname == "" {

	t.Error("Could not find caller info")

}

```

````

The name of the snippet must be TestXYZ or ExampleXYZ or just a plain

function (presumably for use in other snippets).  Two sepcial cases

are "skip" to indicate the fence block should not be considered

testable and "global" to indicate the fence block is a global

variable:

````

```go skip

   // this has sample code that is not expected to compile

   booya

```

````

````

```go global

func stranger() string {

	return "stranger"

}

```

````

````

```go Example_UsingSomethingDefinedInGlobal

fmt.Println("ok", stranger())

// Output: ok stranger

```

````

If the info name has a dot in it, the word before the dot is compared

to the package name. If they don't match the fence block is

skipped. This allows a single markdown to have multiple fence blocks

destined for different packages:

````

```go firstPackage.DoSomething

...

```

```go secondPackage.

...

```

````