【Go言語】 gomock モックメソッドの指定方法まとめ

func (s *Service) CreateOrUpdateEntity(name string, cat int) error {
	entities, err := s.EntityRepo.ListEntities()
	if err != nil {
		return err
	}

	for _, entity := range entities {
		if entity.Name == name {
			err := s.EntityRepo.UpdateEntity(&Entity{entity.Id, name, cat})
			if err != nil {
				return err
			}
			return nil
		}
	}

	err = s.EntityRepo.CreateEntity(name, cat)
	if err != nil {
		return err
	}

    return nil
}

// ListEntities() の戻り値に、指定した name を持つレコードが存在するため、category を更新し、CreateEntity() は行わない
func TestCreateOrUpdateEntity(t *testing.T) {
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()

	stubList := []app.Entity{
		{1, "dummy1", 1},
		{2, "dummy2", 2},
		{3, "dummy3", 3},
	}
	repoMock := mock.NewMockEntityRepository(ctrl)
	repoMock.EXPECT().ListEntities().Return(stubList, nil).Times(1) // Times(1) は省略可
	repoMock.EXPECT().UpdateEntity(&app.Entity{2, "dummy2", 200}).Return(nil)
	repoMock.EXPECT().CreateEntity(gomock.Any(), gomock.Any()).Times(0) // gomock.Any() は引数の期待値を未指定にする

	srv := app.Service{repoMock}
	err := srv.CreateOrUpdateEntity("dummy2", 200)
	if err != nil {
		t.Errorf("予期せぬエラー: %v", err)
	}
}

func (s *Service) DeleteEntities(ids []int) error {
	for _, id := range ids {
		err := s.EntityRepo.DeleteEntity(id)
		if err != nil {
			return err
		}
	}

	return nil
}

// ID が 1, 2, 3 であるレコードを順に削除する
func TestDeleteEntities(t *testing.T) {
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()

	repoMock := mock.NewMockEntityRepository(ctrl)
	repoMock.EXPECT().DeleteEntity(3).Return(nil).After(
		repoMock.EXPECT().DeleteEntity(2).Return(nil).After(
			repoMock.EXPECT().DeleteEntity(1).Return(nil),
		),
	)
	// 以下と同義です
	// gomock.InOrder(
	// 	repoMock.EXPECT().DeleteEntity(1).Return(nil),
	// 	repoMock.EXPECT().DeleteEntity(2).Return(nil),
	// 	repoMock.EXPECT().DeleteEntity(3).Return(nil),
	// )
	// 以下でも PASS します
	// repoMock.EXPECT().DeleteEntity(gomock.Any()).Return(nil).Times(3)

	srv := app.Service{repoMock}
	err := srv.DeleteEntities([]int{1, 2, 3})
	if err != nil {
		t.Errorf("予期せぬエラー: %v", err)
	}
}

// ID が 2 となるエンティティは存在しない
func TestGetEntities(t *testing.T) {
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()

	want := []app.Entity{
		{1, "dummy1", 1},
		{3, "dummy3", 3},
	}

	repoMock := mock.NewMockEntityRepository(ctrl)
	repoMock.EXPECT().GetEntity(gomock.Any()).DoAndReturn(
		// 無名関数の引数と戻り値はモックメソッドに揃える
		func(id int) (*app.Entity, error) {
			switch id {
			case 1:
				return &app.Entity{1, "dummy1", 1}, nil
			case 2:
				return nil, nil
			case 3:
				return &app.Entity{3, "dummy3", 3}, nil
			}
			return nil, nil
		},
	).AnyTimes()

	srv := app.Service{repoMock}
	got, err := srv.GetEntities([]int{1, 2, 3})
	if err != nil {
		t.Errorf("予期せぬエラー: %v", err)
	} else if !reflect.DeepEqual(want, got) {
		t.Errorf("期待: %v, 実際: %v", want, got)
	}
}

DoAndReturn() や Do() では、任意の処理を埋め込むことができます。しかし（メソッド内部で、メソッドのスコープを超えて影響を与える実装になることは少ないため）、引数によって戻り値を変化させたい場合に使うのが主だと思います。

func (s *Service) UpdateEntity(e *Entity) error {
	err := s.EntityRepo.UpdateEntity(e)
	if err != nil {
		return err
	}

	return nil
}

// UpdateEntity() 実行後、category が 100 から 1 に書き変わる
func TestUpdateEntity(t *testing.T) {
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()

	entity := &app.Entity{1, "dummy", 100}
	want := &app.Entity{1, "dummy", 0}

	repoMock := mock.NewMockEntityRepository(ctrl)
	repoMock.EXPECT().UpdateEntity(gomock.Any()).SetArg(0, app.Entity{1, "dummy", 0})

	srv := app.Service{repoMock}
	err := srv.UpdateEntity(entity)
	if err != nil {
		t.Errorf("予期せぬエラー: %v", err)
	} else if !reflect.DeepEqual(entity, want) {
		t.Errorf("期待: %v, 実際: %v", want, entity)
	}
}