mock

Documentation

Index

• type AuthHandlerMock
  • func (mock *AuthHandlerMock) Require(required auth.Permissions, handler http.HandlerFunc) http.HandlerFunc
  • func (mock *AuthHandlerMock) RequireCalls() []struct{ ... }
• type DataStorerMock
  • func (mock *DataStorerMock) AcquireJobLock(ctx context.Context, id string) (string, error)
  • func (mock *DataStorerMock) AcquireJobLockCalls() []struct{ ... }
  • func (mock *DataStorerMock) CreateJob(ctx context.Context, id string) (models.Job, error)
  • func (mock *DataStorerMock) CreateJobCalls() []struct{ ... }
  • func (mock *DataStorerMock) CreateTask(ctx context.Context, jobID string, taskName string, numDocuments int) (models.Task, error)
  • func (mock *DataStorerMock) CreateTaskCalls() []struct{ ... }
  • func (mock *DataStorerMock) GetJob(ctx context.Context, id string) (models.Job, error)
  • func (mock *DataStorerMock) GetJobCalls() []struct{ ... }
  • func (mock *DataStorerMock) GetJobs(ctx context.Context, offsetParam string, limitParam string) (models.Jobs, error)
  • func (mock *DataStorerMock) GetJobsCalls() []struct{ ... }
  • func (mock *DataStorerMock) GetTask(ctx context.Context, jobID string, taskName string) (models.Task, error)
  • func (mock *DataStorerMock) GetTaskCalls() []struct{ ... }
  • func (mock *DataStorerMock) GetTasks(ctx context.Context, offset int, limit int, jobID string) (models.Tasks, error)
  • func (mock *DataStorerMock) GetTasksCalls() []struct{ ... }
  • func (mock *DataStorerMock) PutNumberOfTasks(ctx context.Context, id string, count int) error
  • func (mock *DataStorerMock) PutNumberOfTasksCalls() []struct{ ... }
  • func (mock *DataStorerMock) UnlockJob(lockID string) error
  • func (mock *DataStorerMock) UnlockJobCalls() []struct{ ... }

Types

type AuthHandlerMock

type AuthHandlerMock struct {
	// RequireFunc mocks the Require method.
	RequireFunc func(required auth.Permissions, handler http.HandlerFunc) http.HandlerFunc
	// contains filtered or unexported fields
}

AuthHandlerMock is a mock implementation of api.AuthHandler.

    func TestSomethingThatUsesAuthHandler(t *testing.T) {

        // make and configure a mocked api.AuthHandler
        mockedAuthHandler := &AuthHandlerMock{
            RequireFunc: func(required auth.Permissions, handler http.HandlerFunc) http.HandlerFunc {
	               panic("mock out the Require method")
            },
        }

        // use mockedAuthHandler in code that requires api.AuthHandler
        // and then make assertions.

    }

func (*AuthHandlerMock) Require

func (mock *AuthHandlerMock) Require(required auth.Permissions, handler http.HandlerFunc) http.HandlerFunc

Require calls RequireFunc.

func (*AuthHandlerMock) RequireCalls

func (mock *AuthHandlerMock) RequireCalls() []struct {
	Required auth.Permissions
	Handler  http.HandlerFunc
}

RequireCalls gets all the calls that were made to Require. Check the length with:

len(mockedAuthHandler.RequireCalls())

type DataStorerMock

type DataStorerMock struct {
	// AcquireJobLockFunc mocks the AcquireJobLock method.
	AcquireJobLockFunc func(ctx context.Context, id string) (string, error)

	// CreateJobFunc mocks the CreateJob method.
	CreateJobFunc func(ctx context.Context, id string) (models.Job, error)

	// CreateTaskFunc mocks the CreateTask method.
	CreateTaskFunc func(ctx context.Context, jobID string, taskName string, numDocuments int) (models.Task, error)

	// GetJobFunc mocks the GetJob method.
	GetJobFunc func(ctx context.Context, id string) (models.Job, error)

	// GetJobsFunc mocks the GetJobs method.
	GetJobsFunc func(ctx context.Context, offsetParam string, limitParam string) (models.Jobs, error)

	// GetTaskFunc mocks the GetTask method.
	GetTaskFunc func(ctx context.Context, jobID string, taskName string) (models.Task, error)

	// GetTasksFunc mocks the GetTasks method.
	GetTasksFunc func(ctx context.Context, offset int, limit int, jobID string) (models.Tasks, error)

	// PutNumberOfTasksFunc mocks the PutNumberOfTasks method.
	PutNumberOfTasksFunc func(ctx context.Context, id string, count int) error

	// UnlockJobFunc mocks the UnlockJob method.
	UnlockJobFunc func(lockID string) error
	// contains filtered or unexported fields
}

DataStorerMock is a mock implementation of api.DataStorer.

func TestSomethingThatUsesDataStorer(t *testing.T) {

	// make and configure a mocked api.DataStorer
	mockedDataStorer := &DataStorerMock{
		AcquireJobLockFunc: func(ctx context.Context, id string) (string, error) {
			panic("mock out the AcquireJobLock method")
		},
		CreateJobFunc: func(ctx context.Context, id string) (models.Job, error) {
			panic("mock out the CreateJob method")
		},
		CreateTaskFunc: func(ctx context.Context, jobID string, taskName string, numDocuments int) (models.Task, error) {
			panic("mock out the CreateTask method")
		},
		GetJobFunc: func(ctx context.Context, id string) (models.Job, error) {
			panic("mock out the GetJob method")
		},
		GetJobsFunc: func(ctx context.Context, offsetParam string, limitParam string) (models.Jobs, error) {
			panic("mock out the GetJobs method")
		},
		GetTaskFunc: func(ctx context.Context, jobID string, taskName string) (models.Task, error) {
			panic("mock out the GetTask method")
		},
		GetTasksFunc: func(ctx context.Context, offset int, limit int, jobID string) (models.Tasks, error) {
			panic("mock out the GetTasks method")
		},
		PutNumberOfTasksFunc: func(ctx context.Context, id string, count int) error {
			panic("mock out the PutNumberOfTasks method")
		},
		UnlockJobFunc: func(lockID string) error {
			panic("mock out the UnlockJob method")
		},
	}

	// use mockedDataStorer in code that requires api.DataStorer
	// and then make assertions.

}

func (*DataStorerMock) AcquireJobLock

func (mock *DataStorerMock) AcquireJobLock(ctx context.Context, id string) (string, error)

AcquireJobLock calls AcquireJobLockFunc.

func (*DataStorerMock) AcquireJobLockCalls

func (mock *DataStorerMock) AcquireJobLockCalls() []struct {
	Ctx context.Context
	ID  string
}

AcquireJobLockCalls gets all the calls that were made to AcquireJobLock. Check the length with:

len(mockedDataStorer.AcquireJobLockCalls())

func (*DataStorerMock) CreateJob

func (mock *DataStorerMock) CreateJob(ctx context.Context, id string) (models.Job, error)

CreateJob calls CreateJobFunc.

func (*DataStorerMock) CreateJobCalls

func (mock *DataStorerMock) CreateJobCalls() []struct {
	Ctx context.Context
	ID  string
}

CreateJobCalls gets all the calls that were made to CreateJob. Check the length with:

len(mockedDataStorer.CreateJobCalls())

func (*DataStorerMock) CreateTask

func (mock *DataStorerMock) CreateTask(ctx context.Context, jobID string, taskName string, numDocuments int) (models.Task, error)

CreateTask calls CreateTaskFunc.

func (*DataStorerMock) CreateTaskCalls

func (mock *DataStorerMock) CreateTaskCalls() []struct {
	Ctx          context.Context
	JobID        string
	TaskName     string
	NumDocuments int
}

CreateTaskCalls gets all the calls that were made to CreateTask. Check the length with:

len(mockedDataStorer.CreateTaskCalls())

func (*DataStorerMock) GetJob

func (mock *DataStorerMock) GetJob(ctx context.Context, id string) (models.Job, error)

GetJob calls GetJobFunc.

func (*DataStorerMock) GetJobCalls

func (mock *DataStorerMock) GetJobCalls() []struct {
	Ctx context.Context
	ID  string
}

GetJobCalls gets all the calls that were made to GetJob. Check the length with:

len(mockedDataStorer.GetJobCalls())

func (*DataStorerMock) GetJobs

func (mock *DataStorerMock) GetJobs(ctx context.Context, offsetParam string, limitParam string) (models.Jobs, error)

GetJobs calls GetJobsFunc.

func (*DataStorerMock) GetJobsCalls

func (mock *DataStorerMock) GetJobsCalls() []struct {
	Ctx         context.Context
	OffsetParam string
	LimitParam  string
}

GetJobsCalls gets all the calls that were made to GetJobs. Check the length with:

len(mockedDataStorer.GetJobsCalls())

func (*DataStorerMock) GetTask

func (mock *DataStorerMock) GetTask(ctx context.Context, jobID string, taskName string) (models.Task, error)

GetTask calls GetTaskFunc.

func (*DataStorerMock) GetTaskCalls

func (mock *DataStorerMock) GetTaskCalls() []struct {
	Ctx      context.Context
	JobID    string
	TaskName string
}

GetTaskCalls gets all the calls that were made to GetTask. Check the length with:

len(mockedDataStorer.GetTaskCalls())

func (*DataStorerMock) GetTasks

func (mock *DataStorerMock) GetTasks(ctx context.Context, offset int, limit int, jobID string) (models.Tasks, error)

GetTasks calls GetTasksFunc.

func (*DataStorerMock) GetTasksCalls

func (mock *DataStorerMock) GetTasksCalls() []struct {
	Ctx    context.Context
	Offset int
	Limit  int
	JobID  string
}

GetTasksCalls gets all the calls that were made to GetTasks. Check the length with:

len(mockedDataStorer.GetTasksCalls())

func (*DataStorerMock) PutNumberOfTasks

func (mock *DataStorerMock) PutNumberOfTasks(ctx context.Context, id string, count int) error

PutNumberOfTasks calls PutNumberOfTasksFunc.

func (*DataStorerMock) PutNumberOfTasksCalls

func (mock *DataStorerMock) PutNumberOfTasksCalls() []struct {
	Ctx   context.Context
	ID    string
	Count int
}

PutNumberOfTasksCalls gets all the calls that were made to PutNumberOfTasks. Check the length with:

len(mockedDataStorer.PutNumberOfTasksCalls())

func (*DataStorerMock) UnlockJob

func (mock *DataStorerMock) UnlockJob(lockID string) error

UnlockJob calls UnlockJobFunc.

func (*DataStorerMock) UnlockJobCalls

func (mock *DataStorerMock) UnlockJobCalls() []struct {
	LockID string
}

UnlockJobCalls gets all the calls that were made to UnlockJob. Check the length with:

len(mockedDataStorer.UnlockJobCalls())