Update to last common bleve (#3986)

4 files changed, 590 insertions, 0 deletions

diff --git a/vendor/github.com/mschoch/smat/LICENSE b/vendor/github.com/mschoch/smat/LICENSE
new file mode 100644
index 0000000000..7a4a3ea242
--- /dev/null
+++ b/vendor/github.com/mschoch/smat/LICENSE
@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.
\ No newline at end of file
diff --git a/vendor/github.com/mschoch/smat/README.md b/vendor/github.com/mschoch/smat/README.md
new file mode 100644
index 0000000000..f5ca1c5440
--- /dev/null
+++ b/vendor/github.com/mschoch/smat/README.md
@@ -0,0 +1,166 @@
+# smat – State Machine Assisted Testing
+
+The concept is simple, describe valid uses of your library as states and actions.  States describe which actions are possible, and with what probability they should occur.  Actions mutate the context and transition to another state.
+
+By doing this, two things are possible:
+
+1.  Use [go-fuzz](https://github.com/dvyukov/go-fuzz) to find/test interesting sequences of operations on your library.
+
+2.  Automate longevity testing of your application by performing long sequences of valid operations.
+
+**NOTE**: both of these can also incorporate validation logic (not just failure detection by building validation into the state machine)
+
+## Status
+
+The API is still not stable.  This is brand new and we'll probably change things we don't like...
+
+[![Build Status](https://travis-ci.org/mschoch/smat.svg?branch=master)](https://travis-ci.org/mschoch/smat)
+[![Coverage Status](https://coveralls.io/repos/github/mschoch/smat/badge.svg?branch=master)](https://coveralls.io/github/mschoch/smat?branch=master)
+[![GoDoc](https://godoc.org/github.com/mschoch/smat?status.svg)](https://godoc.org/github.com/mschoch/smat)
+[![codebeat badge](https://codebeat.co/badges/c3ff6180-a241-4128-97f0-fa6bf6f48752)](https://codebeat.co/projects/github-com-mschoch-smat)
+[![Go Report Card](https://goreportcard.com/badge/github.com/mschoch/smat)](https://goreportcard.com/report/github.com/mschoch/smat)
+
+## License
+
+Apache 2.0
+
+## How do I use it?
+
+### smat.Context
+
+Choose a structure to keep track of any state.  You pass in an instance of this when you start, and it will be passed to every action when it executes.  The actions may mutate this context.
+
+For example, consider a database library, once you open a database handle, you need to use it inside of the other actions.  So you might use a structure like:
+
+```
+type context struct {
+  db *DB
+}
+```
+
+### smat.State
+
+A state represents a state that your application/library can be in, and the probabilities thats certain actions should be taken.
+
+For example, consider a database library, in a state where the database is open, there many things you can do.  Let's consider just two right now, you can set a value, or you can delete a value.
+
+```
+func dbOpen(next byte) smat.ActionID {
+	return smat.PercentExecute(next,
+		smat.PercentAction{50, setValue},
+		smat.PercentAction{50, deleteValue},
+	)
+}
+```
+
+This says that in the open state, there are two valid actions, 50% of the time you should set a value and 50% of the time you should delete a value.  **NOTE**: these percentages are just for characterizing the test workload.
+
+### smat.Action
+
+Actions are functions that do some work, optionally mutate the context, and indicate the next state to transition to.  Below we see an example action to set value in a database.
+
+```
+func setValueFunc(ctx smat.Context) (next smat.State, err error) {
+  // type assert to our custom context type
+	context := ctx.(*context)
+  // perform the operation
+  err = context.db.Set("k", "v")
+  if err != nil {
+    return nil, err
+  }
+  // return the new state
+  return dbOpen, nil
+}
+```
+
+### smat.ActionID and smat.ActionMap
+
+Actions are just functions, and since we can't compare functions in Go, we need to introduce an external identifier for them.  This allows us to build a bi-directional mapping which we'll take advantage of later.
+
+```
+const (
+  setup smat.ActionID = iota
+  teardown
+  setValue
+  deleteValue
+)
+
+var actionMap = smat.ActionMap{
+  setup:       setupFunc,
+  teardown:    teardownFunc,
+	setValue:    setValueFunc,
+	deleteValue: deleteValueFunc,
+}
+```
+
+### smat.ActionSeq
+
+A common way that many users think about a library is as a sequence of actions to be performed.  Using the ActionID's that we've already seen we can build up sequences of operations.
+
+```
+  actionSeq := smat.ActionSeq{
+		open,
+		setValue,
+		setValue,
+		setValue,
+	}
+```
+
+Notice that we build these actions using the constants we defined above, and because of this we can have a bi-directional mapping between a stream of bytes (driving the state machine) and a sequence of actions to be performed.
+
+## Fuzzing
+
+We've built a lot of pieces, lets wire it up to go-fuzz.
+
+```
+func Fuzz(data []byte) int {
+	return smat.Fuzz(&context{}, setup, teardown, actionMap, data)
+}
+```
+
+* The first argument is an instance of context structure.
+* The second argument is the ActionID of our setup function.  The setup function does not consume any of the input stream and is used to initialize the context and determine the start state.
+* The third argument is the teardown function.  This will be called unconditionally to clean up any resources associated with the test.
+* The fourth argument is the actionMap which maps all ActionIDs to Actions.
+* The fifth argument is the data passed in from the go-fuzz application.
+
+### Generating Initial go-fuzz Corpus
+
+Earlier we mentioned the bi-directional mapping between Actions and the byte stream driving the state machine.  We can now leverage this to build the inital go-fuzz corpus.
+
+Using the `ActinSeq`s we learned about earlier we can build up a list of them as:
+
+    var actionSeqs = []smat.ActionSeq{...}
+
+Then, we can write them out to disk using:
+
+```
+for i, actionSeq := range actionSeqs {
+  byteSequence, err := actionSeq.ByteEncoding(&context{}, setup, teardown, actionMap)
+  if err != nil {
+    // handle error
+  }
+  os.MkdirAll("workdir/corpus", 0700)
+  ioutil.WriteFile(fmt.Sprintf("workdir/corpus/%d", i), byteSequence, 0600)
+}
+```
+
+You can then either put this into a test case or a main application depending on your needs.
+
+## Longevity Testing
+
+Fuzzing is great, but most of your corpus is likely to be shorter meaningful sequences.  And go-fuzz works to find shortest sequences that cause problems, but sometimes you actually want to explore longer sequences that appear to go-fuzz as not triggering additional code coverage.
+
+For these cases we have another helper you can use:
+
+```
+  Longevity(ctx, setup, teardown, actionMap, 0, closeChan)
+```
+
+The first four arguments are the same, the last two are:
+* random seed used to ensure repeatable tests
+* closeChan (chan struct{}) - close this channel if you want the function to stop and return ErrClosed, otherwise it will run forever
+
+## Examples
+
+See the examples directory for a working example that tests some BoltDB functionality.
diff --git a/vendor/github.com/mschoch/smat/actionseq.go b/vendor/github.com/mschoch/smat/actionseq.go
new file mode 100644
index 0000000000..6c8297f891
--- /dev/null
+++ b/vendor/github.com/mschoch/smat/actionseq.go
@@ -0,0 +1,61 @@
+//  Copyright (c) 2016 Marty Schoch
+
+//  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.
+
+package smat
+
+// ActionSeq represents a sequence of actions, used for populating a corpus
+// of byte sequences for the corresponding fuzz tests
+type ActionSeq []ActionID
+
+// ByteEncoding runs the FSM to produce a byte sequence to trigger the
+// desired action
+func (a ActionSeq) ByteEncoding(ctx Context, setup, teardown ActionID, actionMap ActionMap) ([]byte, error) {
+	setupFunc, teardownFunc, err := actionMap.findSetupTeardown(setup, teardown)
+	if err != nil {
+		return nil, err
+	}
+	state, err := setupFunc(ctx)
+	if err != nil {
+		return nil, err
+	}
+	defer func() {
+		_, _ = teardownFunc(ctx)
+	}()
+
+	var rv []byte
+	for _, actionID := range a {
+		b, err := probeStateForAction(state, actionID)
+		if err != nil {
+			return nil, err
+		}
+		rv = append(rv, b)
+		action, ok := actionMap[actionID]
+		if !ok {
+			continue
+		}
+		state, err = action(ctx)
+		if err != nil {
+			return nil, err
+		}
+	}
+	return rv, nil
+}
+
+func probeStateForAction(state State, actionID ActionID) (byte, error) {
+	for i := 0; i < 256; i++ {
+		nextActionID := state(byte(i))
+		if nextActionID == actionID {
+			return byte(i), nil
+		}
+	}
+	return 0, ErrActionNotPossible
+}
diff --git a/vendor/github.com/mschoch/smat/smat.go b/vendor/github.com/mschoch/smat/smat.go
new file mode 100644
index 0000000000..f6ea4975f2
--- /dev/null
+++ b/vendor/github.com/mschoch/smat/smat.go
@@ -0,0 +1,161 @@
+//  Copyright (c) 2016 Marty Schoch
+
+//  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.
+
+package smat
+
+import (
+	"bufio"
+	"bytes"
+	"fmt"
+	"io"
+	"io/ioutil"
+	"log"
+	"math/rand"
+)
+
+// Logger is a configurable logger used by this package
+// by default output is discarded
+var Logger = log.New(ioutil.Discard, "smat ", log.LstdFlags)
+
+// Context is a container for any user state
+type Context interface{}
+
+// State is a function which describes which action to perform in the event
+// that a particular byte is seen
+type State func(next byte) ActionID
+
+// PercentAction describes the frequency with which an action should occur
+// for example: Action{Percent:10, Action:DonateMoney} means that 10% of
+// the time you should donate money.
+type PercentAction struct {
+	Percent int
+	Action  ActionID
+}
+
+// Action is any function which returns the next state to transition to
+// it can optionally mutate the provided context object
+// if any error occurs, it may return an error which will abort execution
+type Action func(Context) (State, error)
+
+// ActionID is a unique identifier for an action
+type ActionID int
+
+// NopAction does nothing and simply continues to the next input
+var NopAction ActionID = -1
+
+// ActionMap is a mapping form ActionID to Action
+type ActionMap map[ActionID]Action
+
+func (a ActionMap) findSetupTeardown(setup, teardown ActionID) (Action, Action, error) {
+	setupFunc, ok := a[setup]
+	if !ok {
+		return nil, nil, ErrSetupMissing
+	}
+	teardownFunc, ok := a[teardown]
+	if !ok {
+		return nil, nil, ErrTeardownMissing
+	}
+	return setupFunc, teardownFunc, nil
+}
+
+// Fuzz runs the fuzzing state machine with the provided context
+// first, the setup action is executed unconditionally
+// the start state is determined by this action
+// actionMap is a lookup table for all actions
+// the data byte slice determines all future state transitions
+// finally, the teardown action is executed unconditionally for cleanup
+func Fuzz(ctx Context, setup, teardown ActionID, actionMap ActionMap, data []byte) int {
+	reader := bytes.NewReader(data)
+	err := runReader(ctx, setup, teardown, actionMap, reader, nil)
+	if err != nil {
+		panic(err)
+	}
+	return 1
+}
+
+// Longevity runs the state machine with the provided context
+// first, the setup action is executed unconditionally
+// the start state is determined by this action
+// actionMap is a lookup table for all actions
+// random bytes are generated to determine all future state transitions
+// finally, the teardown action is executed unconditionally for cleanup
+func Longevity(ctx Context, setup, teardown ActionID, actionMap ActionMap, seed int64, closeChan chan struct{}) error {
+	source := rand.NewSource(seed)
+	return runReader(ctx, setup, teardown, actionMap, rand.New(source), closeChan)
+}
+
+var (
+	// ErrSetupMissing is returned when the setup action cannot be found
+	ErrSetupMissing = fmt.Errorf("setup action missing")
+	// ErrTeardownMissing is returned when the teardown action cannot be found
+	ErrTeardownMissing = fmt.Errorf("teardown action missing")
+	// ErrClosed is returned when the closeChan was closed to cancel the op
+	ErrClosed = fmt.Errorf("closed")
+	// ErrActionNotPossible is returned when an action is encountered in a
+	// FuzzCase that is not possible in the current state
+	ErrActionNotPossible = fmt.Errorf("action not possible in state")
+)
+
+func runReader(ctx Context, setup, teardown ActionID, actionMap ActionMap, r io.Reader, closeChan chan struct{}) error {
+	setupFunc, teardownFunc, err := actionMap.findSetupTeardown(setup, teardown)
+	if err != nil {
+		return err
+	}
+	Logger.Printf("invoking setup action")
+	state, err := setupFunc(ctx)
+	if err != nil {
+		return err
+	}
+	defer func() {
+		Logger.Printf("invoking teardown action")
+		_, _ = teardownFunc(ctx)
+	}()
+
+	reader := bufio.NewReader(r)
+	for next, err := reader.ReadByte(); err == nil; next, err = reader.ReadByte() {
+		select {
+		case <-closeChan:
+			return ErrClosed
+		default:
+			actionID := state(next)
+			action, ok := actionMap[actionID]
+			if !ok {
+				Logger.Printf("no such action defined, continuing")
+				continue
+			}
+			Logger.Printf("invoking action - %d", actionID)
+			state, err = action(ctx)
+			if err != nil {
+				Logger.Printf("it was action %d that returned err %v", actionID, err)
+				return err
+			}
+		}
+	}
+	return err
+}
+
+// PercentExecute interprets the next byte as a random value and normalizes it
+// to values 0-99, it then looks to see which action should be execued based
+// on the action distributions
+func PercentExecute(next byte, pas ...PercentAction) ActionID {
+	percent := int(99 * int(next) / 255)
+
+	sofar := 0
+	for _, pa := range pas {
+		sofar = sofar + pa.Percent
+		if percent < sofar {
+			return pa.Action
+		}
+
+	}
+	return NopAction
+}