github.com/ecodeclub/eorm@v0.0.2-0.20231001112437-dae71da914d0/delete_test.go

// Copyright 2021 ecodeclub
//
// 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 eorm

import (
	"context"
	"database/sql"
	"errors"
	"fmt"
	"testing"

	"github.com/ecodeclub/eorm/internal/datasource/single"

	"github.com/ecodeclub/eorm/internal/errs"

	"github.com/DATA-DOG/go-sqlmock"
	"github.com/stretchr/testify/require"

	"github.com/stretchr/testify/assert"
)

func TestDeleter_Build(t *testing.T) {
	db := memoryDB()
	testCases := []CommonTestCase{
		{
			name:    "no where",
			builder: NewDeleter[TestModel](db).From(&TestModel{}),
			wantSql: "DELETE FROM `test_model`;",
		},
		{
			name:     "where",
			builder:  NewDeleter[TestModel](db).Where(C("Id").EQ(16)),
			wantSql:  "DELETE FROM `test_model` WHERE `id`=?;",
			wantArgs: []interface{}{16},
		},
		{
			name:    "no where combination",
			builder: NewDeleter[TestCombinedModel](db).From(&TestCombinedModel{}),
			wantSql: "DELETE FROM `test_combined_model`;",
		},
		{
			name:     "where combination",
			builder:  NewDeleter[TestCombinedModel](db).Where(C("CreateTime").EQ(uint64(1000))),
			wantSql:  "DELETE FROM `test_combined_model` WHERE `create_time`=?;",
			wantArgs: []interface{}{uint64(1000)},
		},
	}

	for _, tc := range testCases {
		c := tc
		t.Run(c.name, func(t *testing.T) {
			query, err := c.builder.Build()
			assert.Equal(t, c.wantErr, err)
			assert.Equal(t, c.wantSql, query.SQL)
			assert.Equal(t, c.wantArgs, query.Args)
		})
	}
}

func TestDeleter_Exec(t *testing.T) {
	testCases := []struct {
		name      string
		mockOrder func(mock sqlmock.Sqlmock)
		delete    func(*sql.DB, *testing.T) Result
		wantErr   error
		wantVal   sql.Result
	}{
		{
			name: "exec err",
			mockOrder: func(mock sqlmock.Sqlmock) {
				mock.ExpectExec("DELETE FROM `test_model` WHERE `invalid`=").
					WithArgs(1).WillReturnError(errs.NewInvalidFieldError("Invalid"))
			},
			delete: func(db *sql.DB, t *testing.T) Result {
				defer func(db *sql.DB) { _ = db.Close() }(db)
				orm, err := OpenDS("mysql", single.NewDB(db))
				require.NoError(t, err)
				deleter := NewDeleter[TestModel](orm)
				result := deleter.From(&TestModel{}).Where(C("Invalid").EQ(1)).Exec(context.Background())
				return result
			},
			wantErr: errs.NewInvalidFieldError("Invalid"),
		},
		{
			name: "直接删除",
			mockOrder: func(mock sqlmock.Sqlmock) {
				mock.ExpectExec("DELETE FROM `test_model` WHERE `id`=").WithArgs(1).WillReturnResult(sqlmock.NewResult(100, 1000))
			},
			delete: func(db *sql.DB, t *testing.T) Result {
				defer func(db *sql.DB) { _ = db.Close() }(db)
				orm, err := OpenDS("mysql", single.NewDB(db))
				require.NoError(t, err)
				deleter := NewDeleter[TestModel](orm)
				result := deleter.From(&TestModel{}).Where(C("Id").EQ(1)).Exec(context.Background())
				return result
			},
			wantErr: nil,
			wantVal: sqlmock.NewResult(100, 1000),
		},
		{
			name: "事务删除",
			mockOrder: func(mock sqlmock.Sqlmock) {
				mock.ExpectBegin()
				mock.ExpectExec("DELETE FROM `test_model` WHERE `id`=").WithArgs(1).WillReturnResult(sqlmock.NewResult(10, 20))
				mock.ExpectCommit().WillReturnError(errors.New("commit 错误"))
			},
			delete: func(db *sql.DB, t *testing.T) Result {
				defer func(db *sql.DB) { _ = db.Close() }(db)

				orm, err := OpenDS("mysql", single.NewDB(db))
				require.NoError(t, err)
				tx, err := orm.BeginTx(context.Background(), &sql.TxOptions{})
				require.NoError(t, err)

				deleter := NewDeleter[TestModel](tx)
				result := deleter.From(&TestModel{}).Where(C("Id").EQ(1)).Exec(context.Background())
				require.NoError(t, result.Err())

				err = tx.Commit()
				if err != nil {
					return Result{err: err}
				}
				return result
			},
			wantErr: errors.New("commit 错误"),
			wantVal: sqlmock.NewResult(10, 20),
		},
	}

	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			mockDB, mock, err := sqlmock.New()
			if err != nil {
				t.Fatal(err)
			}
			tc.mockOrder(mock)
			result := tc.delete(mockDB, t)

			assert.Equal(t, tc.wantErr, result.Err())

			if result.Err() != nil {
				return
			}

			rowsAffectedExpect, err := tc.wantVal.RowsAffected()
			require.NoError(t, err)
			rowsAffected, err := result.RowsAffected()
			require.NoError(t, err)
			assert.Equal(t, rowsAffectedExpect, rowsAffected)

			lastInsertIdExpected, err := tc.wantVal.LastInsertId()
			require.NoError(t, err)
			lastInsertId, err := result.LastInsertId()
			require.NoError(t, err)
			assert.Equal(t, lastInsertIdExpected, lastInsertId)

			if err = mock.ExpectationsWereMet(); err != nil {
				t.Error(err)
			}
		})
	}
}

func ExampleDeleter_Build() {
	db := memoryDB()
	query, _ := NewDeleter[TestModel](db).From(&TestModel{}).Build()
	fmt.Printf("SQL: %s", query.SQL)
	// Output:
	// SQL: DELETE FROM `test_model`;
}

func ExampleDeleter_From() {
	db := memoryDB()
	query, _ := NewDeleter[TestModel](db).From(&TestModel{}).Build()
	fmt.Printf("SQL: %s", query.SQL)
	// Output:
	// SQL: DELETE FROM `test_model`;
}

func ExampleDeleter_Where() {
	db := memoryDB()
	query, _ := NewDeleter[TestModel](db).Where(C("Id").EQ(12)).Build()
	fmt.Printf("SQL: %s\nArgs: %v", query.SQL, query.Args)
	// Output:
	// SQL: DELETE FROM `test_model` WHERE `id`=?;
	// Args: [12]
}