bulk_test.go

// 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 kivik

import (
	"context"
	"encoding/json"
	"errors"
	"fmt"
	"net/http"
	"testing"

	"gitlab.com/flimzy/testy"

	"github.com/go-kivik/kivik/v4/driver"
	internal "github.com/go-kivik/kivik/v4/int/errors"
	"github.com/go-kivik/kivik/v4/int/mock"
)

func TestDocsInterfaceSlice(t *testing.T) {
	type diTest struct {
		name     string
		input    []interface{}
		expected interface{}
		status   int
		err      string
	}
	tests := []diTest{
		{
			name:     "InterfaceSlice",
			input:    []interface{}{map[string]string{"foo": "bar"}},
			expected: []interface{}{map[string]string{"foo": "bar"}},
		},
		{
			name: "JSONDoc",
			input: []interface{}{
				map[string]string{"foo": "bar"},
				json.RawMessage(`{"foo":"bar"}`),
			},
			expected: []interface{}{
				map[string]string{"foo": "bar"},
				map[string]string{"foo": "bar"},
			},
		},
	}
	for _, test := range tests {
		func(test diTest) {
			t.Run(test.name, func(t *testing.T) {
				result, err := docsInterfaceSlice(test.input)
				if d := internal.StatusErrorDiff(test.err, test.status, err); d != "" {
					t.Error(d)
				}
				if d := testy.DiffAsJSON(test.expected, result); d != nil {
					t.Errorf("%s", d)
				}
			})
		}(test)
	}
}

func TestBulkDocs(t *testing.T) { // nolint: gocyclo
	type tt struct {
		db       *DB
		docs     []interface{}
		options  Option
		expected []BulkResult
		status   int
		err      string
	}

	tests := testy.NewTable()
	tests.Add("invalid JSON", tt{
		db: &DB{
			client: &Client{},
			driverDB: &mock.BulkDocer{
				BulkDocsFunc: func(_ context.Context, docs []interface{}, _ driver.Options) ([]driver.BulkResult, error) {
					_, err := json.Marshal(docs)
					return nil, err
				},
			},
		},
		docs:   []interface{}{json.RawMessage("invalid json")},
		status: http.StatusInternalServerError,
		err:    "json: error calling MarshalJSON for type json.RawMessage: invalid character 'i' looking for beginning of value",
	})
	tests.Add("emulated BulkDocs support", tt{
		db: &DB{
			client: &Client{},
			driverDB: &mock.DocCreator{
				DB: mock.DB{
					PutFunc: func(_ context.Context, docID string, doc interface{}, options driver.Options) (string, error) {
						if docID == "error" {
							return "", errors.New("error")
						}
						if docID != "foo" { // nolint: goconst
							return "", fmt.Errorf("Unexpected docID: %s", docID)
						}
						expectedDoc := map[string]string{"_id": "foo"}
						if d := testy.DiffInterface(expectedDoc, doc); d != nil {
							return "", fmt.Errorf("Unexpected doc:\n%s", d)
						}
						gotOpts := map[string]interface{}{}
						options.Apply(gotOpts)
						if d := testy.DiffInterface(testOptions, gotOpts); d != nil {
							return "", fmt.Errorf("Unexpected opts:\n%s", d)
						}
						return "2-xxx", nil // nolint: goconst
					},
				},
				CreateDocFunc: func(_ context.Context, doc interface{}, options driver.Options) (string, string, error) {
					gotOpts := map[string]interface{}{}
					options.Apply(gotOpts)
					expectedDoc := int(123)
					if d := testy.DiffInterface(expectedDoc, doc); d != nil {
						return "", "", fmt.Errorf("Unexpected doc:\n%s", d)
					}
					if d := testy.DiffInterface(testOptions, gotOpts); d != nil {
						return "", "", fmt.Errorf("Unexpected opts:\n%s", d)
					}
					return "newDocID", "1-xxx", nil // nolint: goconst
				},
			},
		},
		docs: []interface{}{
			map[string]string{"_id": "foo"},
			123,
			map[string]string{"_id": "error"},
		},
		options: Params(testOptions),
		expected: []BulkResult{
			{ID: "foo", Rev: "2-xxx"},
			{ID: "newDocID", Rev: "1-xxx"},
			{ID: "error", Error: errors.New("error")},
		},
	})
	tests.Add("new_edits", tt{
		db: &DB{
			client: &Client{},
			driverDB: &mock.BulkDocer{
				BulkDocsFunc: func(_ context.Context, docs []interface{}, options driver.Options) ([]driver.BulkResult, error) {
					expectedDocs := []interface{}{map[string]string{"_id": "foo"}, 123}
					wantOpts := map[string]interface{}{"new_edits": true}
					gotOpts := map[string]interface{}{}
					options.Apply(gotOpts)
					if d := testy.DiffInterface(expectedDocs, docs); d != nil {
						return nil, fmt.Errorf("Unexpected docs:\n%s", d)
					}
					if d := testy.DiffInterface(wantOpts, gotOpts); d != nil {
						return nil, fmt.Errorf("Unexpected opts:\n%s", d)
					}
					return []driver.BulkResult{
						{ID: "foo"},
					}, nil
				},
			},
		},
		docs: []interface{}{
			map[string]string{"_id": "foo"},
			123,
		},
		options: Param("new_edits", true),
		expected: []BulkResult{
			{ID: "foo"},
		},
	})
	tests.Add("client closed", tt{
		db: &DB{
			client: &Client{
				closed: true,
			},
		},
		docs: []interface{}{
			map[string]string{"_id": "foo"},
		},
		status: http.StatusServiceUnavailable,
		err:    "kivik: client closed",
	})
	tests.Add("db error", tt{
		db: &DB{
			err: errors.New("db error"),
		},
		status: http.StatusInternalServerError,
		err:    "db error",
	})
	tests.Add("unreadable doc", tt{
		db: &DB{
			client: &Client{},
			driverDB: &mock.BulkDocer{
				BulkDocsFunc: func(_ context.Context, docs []interface{}, _ driver.Options) ([]driver.BulkResult, error) {
					_, err := json.Marshal(docs)
					return nil, err
				},
			},
		},
		docs:   []interface{}{testy.ErrorReader("", errors.New("read error"))},
		status: http.StatusBadRequest,
		err:    "read error",
	})
	tests.Add("no docs", tt{
		db: &DB{
			client: &Client{},
			driverDB: &mock.BulkDocer{
				BulkDocsFunc: func(_ context.Context, docs []interface{}, _ driver.Options) ([]driver.BulkResult, error) {
					_, err := json.Marshal(docs)
					return nil, err
				},
			},
		},
		docs:   []interface{}{},
		status: http.StatusBadRequest,
		err:    "kivik: no documents provided",
	})

	tests.Run(t, func(t *testing.T, tt tt) {
		result, err := tt.db.BulkDocs(context.Background(), tt.docs, tt.options)
		if d := internal.StatusErrorDiff(tt.err, tt.status, err); d != "" {
			t.Error(d)
		}
		if d := testy.DiffInterface(tt.expected, result); d != nil {
			t.Error(d)
		}
	})
}