go-neb/pkg/testing/quick/index.html

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#375EAB">

  <title>quick - The Go Programming Language</title>

<link type="text/css" rel="stylesheet" href="../../../lib/godoc/style.css">

<link rel="stylesheet" href="../../../lib/godoc/jquery.treeview.css">
<script type="text/javascript">window.initFuncs = [];</script>
</head>
<body>

<div id='lowframe' style="position: fixed; bottom: 0; left: 0; height: 0; width: 100%; border-top: thin solid grey; background-color: white; overflow: auto;">
...
</div><!-- #lowframe -->

<div id="topbar" class="wide"><div class="container">
<div class="top-heading" id="heading-wide"><a href="http://localhost:6060/">The Go Programming Language</a></div>
<div class="top-heading" id="heading-narrow"><a href="http://localhost:6060/">Go</a></div>
<a href="index.html#" id="menu-button"><span id="menu-button-arrow">&#9661;</span></a>
<form method="GET" action="http://localhost:6060/search">
<div id="menu">
<a href="http://localhost:6060/doc/">Documents</a>
<a href="http://localhost:6060/pkg/">Packages</a>
<a href="http://localhost:6060/project/">The Project</a>
<a href="http://localhost:6060/help/">Help</a>
<a href="http://localhost:6060/blog/">Blog</a>

<input type="text" id="search" name="q" class="inactive" value="Search" placeholder="Search">
</div>
</form>

</div></div>


<div id="page" class="wide">
<div class="container">


  <h1>Package quick</h1>


<div id="nav"></div>


<!--
	Copyright 2009 The Go Authors. All rights reserved.
	Use of this source code is governed by a BSD-style
	license that can be found in the LICENSE file.
-->
<!--
	Note: Static (i.e., not template-generated) href and id
	attributes start with "pkg-" to make it impossible for
	them to conflict with generated attributes (some of which
	correspond to Go identifiers).
-->

	<script type='text/javascript'>
	document.ANALYSIS_DATA = null;
	document.CALLGRAPH = null;
	</script>

	
		<div id="short-nav">
			<dl>
			<dd><code>import "testing/quick"</code></dd>
			</dl>
			<dl>
			<dd><a href="index.html#pkg-overview" class="overviewLink">Overview</a></dd>
			<dd><a href="index.html#pkg-index" class="indexLink">Index</a></dd>
			
			
			</dl>
		</div>
		<!-- The package's Name is printed as title by the top-level template -->
		<div id="pkg-overview" class="toggleVisible">
			<div class="collapsed">
				<h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2>
			</div>
			<div class="expanded">
				<h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2>
				<p>
Package quick implements utility functions to help with black box testing.
</p>

			</div>
		</div>
		

		<div id="pkg-index" class="toggleVisible">
		<div class="collapsed">
			<h2 class="toggleButton" title="Click to show Index section">Index ▹</h2>
		</div>
		<div class="expanded">
			<h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>

		<!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
			<div id="manual-nav">
			<dl>
			
			
				<dd><a href="index.html#Check">func Check(f interface{}, config *Config) (err error)</a></dd>
			
				
				<dd><a href="index.html#CheckEqual">func CheckEqual(f, g interface{}, config *Config) (err error)</a></dd>
			
				
				<dd><a href="index.html#Value">func Value(t reflect.Type, rand *rand.Rand) (value reflect.Value, ok bool)</a></dd>
			
			
				<dd><a href="index.html#CheckEqualError">type CheckEqualError</a></dd>
				
				
					<dd>&nbsp; &nbsp; <a href="index.html#CheckEqualError.Error">func (s *CheckEqualError) Error() string</a></dd>
				
			
				<dd><a href="index.html#CheckError">type CheckError</a></dd>
				
				
					<dd>&nbsp; &nbsp; <a href="index.html#CheckError.Error">func (s *CheckError) Error() string</a></dd>
				
			
				<dd><a href="index.html#Config">type Config</a></dd>
				
				
				<dd><a href="index.html#Generator">type Generator</a></dd>
				
				
				<dd><a href="index.html#SetupError">type SetupError</a></dd>
				
				
					<dd>&nbsp; &nbsp; <a href="index.html#SetupError.Error">func (s SetupError) Error() string</a></dd>
				
			
			</dl>
			</div><!-- #manual-nav -->

		
			<h4>Package files</h4>
			<p>
			<span style="font-size:90%">
			
				<a href="http://localhost:6060/src/testing/quick/quick.go">quick.go</a>
			
			</span>
			</p>
		
		</div><!-- .expanded -->
		</div><!-- #pkg-index -->

		<div id="pkg-callgraph" class="toggle" style="display: none">
		<div class="collapsed">
			<h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
		</div> <!-- .expanded -->
		<div class="expanded">
			<h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
			<p>
			  In the call graph viewer below, each node
			  is a function belonging to this package
			  and its children are the functions it
			  calls&mdash;perhaps dynamically.
			</p>
			<p>
			  The root nodes are the entry points of the
			  package: functions that may be called from
			  outside the package.
			  There may be non-exported or anonymous
			  functions among them if they are called
			  dynamically from another package.
			</p>
			<p>
			  Click a node to visit that function's source code.
			  From there you can visit its callers by
			  clicking its declaring <code>func</code>
			  token.
			</p>
			<p>
			  Functions may be omitted if they were
			  determined to be unreachable in the
			  particular programs or tests that were
			  analyzed.
			</p>
			<!-- Zero means show all package entry points. -->
			<ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
		</div>
		</div> <!-- #pkg-callgraph -->

		
			<h2 id="Check">func <a href="http://localhost:6060/src/testing/quick/quick.go?s=7371:7424#L246">Check</a></h2>
			<pre>func Check(f interface{}, config *<a href="index.html#Config">Config</a>) (err <a href="../../builtin/index.html#error">error</a>)</pre>
			<p>
Check looks for an input to f, any function that returns bool,
such that f returns false.  It calls f repeatedly, with arbitrary
values for each argument.  If f returns false on a given input,
Check returns that input as a *CheckError.
For example:
</p>
<pre>func TestOddMultipleOfThree(t *testing.T) {
	f := func(x int) bool {
		y := OddMultipleOfThree(x)
		return y%2 == 1 &amp;&amp; y%3 == 0
	}
	if err := quick.Check(f, nil); err != nil {
		t.Error(err)
	}
}
</pre>

			
			<h2 id="CheckEqual">func <a href="http://localhost:6060/src/testing/quick/quick.go?s=8414:8475#L289">CheckEqual</a></h2>
			<pre>func CheckEqual(f, g interface{}, config *<a href="index.html#Config">Config</a>) (err <a href="../../builtin/index.html#error">error</a>)</pre>
			<p>
CheckEqual looks for an input on which f and g return different results.
It calls f and g repeatedly with arbitrary values for each argument.
If f and g return different answers, CheckEqual returns a *CheckEqualError
describing the input and the outputs.
</p>

			
			<h2 id="Value">func <a href="http://localhost:6060/src/testing/quick/quick.go?s=1568:1642#L44">Value</a></h2>
			<pre>func Value(t <a href="../../reflect/index.html">reflect</a>.<a href="../../reflect/index.html#Type">Type</a>, rand *<a href="../../math/rand/index.html">rand</a>.<a href="../../math/rand/index.html#Rand">Rand</a>) (value <a href="../../reflect/index.html">reflect</a>.<a href="../../reflect/index.html#Value">Value</a>, ok <a href="../../builtin/index.html#bool">bool</a>)</pre>
			<p>
Value returns an arbitrary value of the given type.
If the type implements the Generator interface, that will be used.
Note: To create arbitrary values for structs, all the fields must be exported.
</p>

			
			<h2 id="CheckEqualError">type <a href="http://localhost:6060/src/testing/quick/quick.go?s=6605:6688#L221">CheckEqualError</a></h2>
			<pre>type CheckEqualError struct {
    <a href="index.html#CheckError">CheckError</a>
    Out1 []interface{}
    Out2 []interface{}
}</pre>
			<p>
A CheckEqualError is the result CheckEqual finding an error.
</p>


				<h3 id="CheckEqualError.Error">func (*CheckEqualError) <a href="http://localhost:6060/src/testing/quick/quick.go?s=6690:6730#L227">Error</a></h3>
				<pre>func (s *<a href="index.html#CheckEqualError">CheckEqualError</a>) Error() <a href="../../builtin/index.html#string">string</a></pre>
				
				
			<h2 id="CheckError">type <a href="http://localhost:6060/src/testing/quick/quick.go?s=6368:6426#L211">CheckError</a></h2>
			<pre>type CheckError struct {
    Count <a href="../../builtin/index.html#int">int</a>
    In    []interface{}
}</pre>
			<p>
A CheckError is the result of Check finding an error.
</p>


				<h3 id="CheckError.Error">func (*CheckError) <a href="http://localhost:6060/src/testing/quick/quick.go?s=6428:6463#L216">Error</a></h3>
				<pre>func (s *<a href="index.html#CheckError">CheckError</a>) Error() <a href="../../builtin/index.html#string">string</a></pre>
				
				
			<h2 id="Config">type <a href="http://localhost:6060/src/testing/quick/quick.go?s=4904:5569#L162">Config</a></h2>
			<pre>type Config struct {
    <span class="comment">// MaxCount sets the maximum number of iterations. If zero,</span>
    <span class="comment">// MaxCountScale is used.</span>
    MaxCount <a href="../../builtin/index.html#int">int</a>
    <span class="comment">// MaxCountScale is a non-negative scale factor applied to the default</span>
    <span class="comment">// maximum. If zero, the default is unchanged.</span>
    MaxCountScale <a href="../../builtin/index.html#float64">float64</a>
    <span class="comment">// If non-nil, rand is a source of random numbers. Otherwise a default</span>
    <span class="comment">// pseudo-random source will be used.</span>
    Rand *<a href="../../math/rand/index.html">rand</a>.<a href="../../math/rand/index.html#Rand">Rand</a>
    <span class="comment">// If non-nil, the Values function generates a slice of arbitrary</span>
    <span class="comment">// reflect.Values that are congruent with the arguments to the function</span>
    <span class="comment">// being tested. Otherwise, the top-level Value function is used</span>
    <span class="comment">// to generate them.</span>
    Values func([]<a href="../../reflect/index.html">reflect</a>.<a href="../../reflect/index.html#Value">Value</a>, *<a href="../../math/rand/index.html">rand</a>.<a href="../../math/rand/index.html#Rand">Rand</a>)
}</pre>
			<p>
A Config structure contains options for running a test.
</p>


			<h2 id="Generator">type <a href="http://localhost:6060/src/testing/quick/quick.go?s=490:679#L10">Generator</a></h2>
			<pre>type Generator interface {
    <span class="comment">// Generate returns a random instance of the type on which it is a</span>
    <span class="comment">// method using the size as a size hint.</span>
    Generate(rand *<a href="../../math/rand/index.html">rand</a>.<a href="../../math/rand/index.html#Rand">Rand</a>, size <a href="../../builtin/index.html#int">int</a>) <a href="../../reflect/index.html">reflect</a>.<a href="../../reflect/index.html#Value">Value</a>
}</pre>
			<p>
A Generator can generate random values of its own type.
</p>


			<h2 id="SetupError">type <a href="http://localhost:6060/src/testing/quick/quick.go?s=6230:6252#L206">SetupError</a></h2>
			<pre>type SetupError <a href="../../builtin/index.html#string">string</a></pre>
			<p>
A SetupError is the result of an error in the way that check is being
used, independent of the functions being tested.
</p>


				<h3 id="SetupError.Error">func (SetupError) <a href="http://localhost:6060/src/testing/quick/quick.go?s=6254:6288#L208">Error</a></h3>
				<pre>func (s <a href="index.html#SetupError">SetupError</a>) Error() <a href="../../builtin/index.html#string">string</a></pre>
				
				
<div id="footer">
Build version go1.6.<br>
Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
the content of this page is licensed under the
Creative Commons Attribution 3.0 License,
and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
<a href="http://localhost:6060/doc/tos.html">Terms of Service</a> | 
<a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
</div>

</div><!-- .container -->
</div><!-- #page -->

<!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
<script type="text/javascript" src="../../../lib/godoc/jquery.js"></script>
<script type="text/javascript" src="../../../lib/godoc/jquery.treeview.js"></script>
<script type="text/javascript" src="../../../lib/godoc/jquery.treeview.edit.js"></script>


<script type="text/javascript" src="../../../lib/godoc/godocs.js"></script>

</body>
</html>