Files
tasks/common/archiver/metadata_mock.go
Alex ShtinandGitHub 8e8f1b0f7c Remove license header from every file (#7689)
## What changed?
<!-- Describe what has changed in this PR -->
Remove license header from every file. Because it is really hard to
follow in this PR here is the summary:
1. License header is removed from all `.go` and `.proto` files
:fireworks::fireworks:🎆.
2. `LICENSE` file in the root directory has only Temporal and Uber
copyrights.
3. 5 other `LICENSE` files added to the packages which have copyrights
different from Temporal and Uber: Datadog, Xargin, "Mat Ryer, Tyler
Bunnell and contributors".
4. `license_file` flag is removed from all code generation tools.
5. `copyright_file` flag is removed from `go:generate mockgen`
directive.
6. All copyright related targets are removed from `Makefile`.
7. Updated Temporal copyright year to 2025 everywhere.

## Why?
<!-- Tell your future self why have you made these changes -->
I double checked with legal department that it is not needed to have
license header in every file. One file per repo is enough. I put all
copyrights to the root `LICENSE` file and removed header from all other
files. Also updated tools and `Makefile`.
2025-05-01 18:50:21 -07:00

86 lines
2.8 KiB
Go

package archiver
import (
"go.uber.org/mock/gomock"
)
// MetadataMock is an implementation of ArchivalMetadata that can be used for testing.
// It can be used as a mock, but it also provides default values, which is something that can't be done with
// *MockArchivalMetadata. This cuts down on the amount of boilerplate code needed to write tests.
type MetadataMock interface {
ArchivalMetadata
// EXPECT returns a MetadataMockRecorder which can be used to set expectations on the mock.
EXPECT() MetadataMockRecorder
// SetHistoryEnabledByDefault sets the default history archival config to be enabled.
SetHistoryEnabledByDefault()
// SetVisibilityEnabledByDefault sets the default visibility archival config to be enabled.
SetVisibilityEnabledByDefault()
}
// NewMetadataMock returns a new MetadataMock which uses the provided controller to create a MockArchivalMetadata
// instance.
func NewMetadataMock(controller *gomock.Controller) MetadataMock {
m := &metadataMock{
MockArchivalMetadata: NewMockArchivalMetadata(controller),
defaultHistoryConfig: NewDisabledArchvialConfig(),
defaultVisibilityConfig: NewDisabledArchvialConfig(),
}
return m
}
// MetadataMockRecorder is a wrapper around a ArchivalMetadata mock recorder.
// It is used to determine whether any calls to EXPECT().GetHistoryConfig() or EXPECT().GetVisibilityConfig() were made.
// A call to EXPECT().GetSomeConfig() causes that default config to no longer be used.
type MetadataMockRecorder interface {
GetHistoryConfig() *gomock.Call
GetVisibilityConfig() *gomock.Call
}
type metadataMock struct {
*MockArchivalMetadata
defaultHistoryConfig ArchivalConfig
defaultVisibilityConfig ArchivalConfig
historyOverwritten bool
visibilityOverwritten bool
}
func (m *metadataMock) SetHistoryEnabledByDefault() {
m.defaultHistoryConfig = NewEnabledArchivalConfig()
}
func (m *metadataMock) SetVisibilityEnabledByDefault() {
m.defaultVisibilityConfig = NewEnabledArchivalConfig()
}
func (m *metadataMock) GetHistoryConfig() ArchivalConfig {
if !m.historyOverwritten {
return m.defaultHistoryConfig
}
return m.MockArchivalMetadata.GetHistoryConfig()
}
func (m *metadataMock) GetVisibilityConfig() ArchivalConfig {
if !m.visibilityOverwritten {
return m.defaultVisibilityConfig
}
return m.MockArchivalMetadata.GetVisibilityConfig()
}
func (m *metadataMock) EXPECT() MetadataMockRecorder {
return metadataMockRecorder{m}
}
type metadataMockRecorder struct {
*metadataMock
}
func (r metadataMockRecorder) GetHistoryConfig() *gomock.Call {
r.metadataMock.historyOverwritten = true
return r.MockArchivalMetadata.EXPECT().GetHistoryConfig()
}
func (r metadataMockRecorder) GetVisibilityConfig() *gomock.Call {
r.metadataMock.visibilityOverwritten = true
return r.MockArchivalMetadata.EXPECT().GetVisibilityConfig()
}