-
Notifications
You must be signed in to change notification settings - Fork 912
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Produce archival tasks conditionally (#3823)
- Loading branch information
1 parent
5175ab6
commit 6c82542
Showing
11 changed files
with
361 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| // The MIT License | ||
| // | ||
| // Copyright (c) 2020 Temporal Technologies Inc. All rights reserved. | ||
| // | ||
| // Copyright (c) 2020 Uber Technologies, Inc. | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| // THE SOFTWARE. | ||
|
|
||
| package archiver | ||
|
|
||
| import ( | ||
| "github.com/golang/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() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| // The MIT License | ||
| // | ||
| // Copyright (c) 2020 Temporal Technologies Inc. All rights reserved. | ||
| // | ||
| // Copyright (c) 2020 Uber Technologies, Inc. | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| // THE SOFTWARE. | ||
|
|
||
| package archiver | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/golang/mock/gomock" | ||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestMetadataMock(t *testing.T) { | ||
| t.Run("GetHistoryConfig", func(t *testing.T) { | ||
| metadata := NewMetadataMock(gomock.NewController(t)) | ||
| config := metadata.GetHistoryConfig() | ||
|
|
||
| assert.False(t, config.ClusterConfiguredForArchival()) | ||
| }) | ||
| t.Run("GetVisibilityConfig", func(t *testing.T) { | ||
| metadata := NewMetadataMock(gomock.NewController(t)) | ||
| config := metadata.GetVisibilityConfig() | ||
|
|
||
| assert.False(t, config.ClusterConfiguredForArchival()) | ||
| }) | ||
| t.Run("GetHistoryConfig_SetHistoryEnabledByDefault", func(t *testing.T) { | ||
| metadata := NewMetadataMock(gomock.NewController(t)) | ||
| metadata.SetHistoryEnabledByDefault() | ||
| config := metadata.GetHistoryConfig() | ||
|
|
||
| assert.True(t, config.ClusterConfiguredForArchival()) | ||
|
|
||
| metadata.EXPECT().GetHistoryConfig().Return(NewDisabledArchvialConfig()) | ||
| config = metadata.GetHistoryConfig() | ||
|
|
||
| assert.False(t, config.ClusterConfiguredForArchival()) | ||
| }) | ||
| t.Run("GetVisibilityConfig_SetVisibilityEnabledByDefault", func(t *testing.T) { | ||
| metadata := NewMetadataMock(gomock.NewController(t)) | ||
| metadata.SetVisibilityEnabledByDefault() | ||
| config := metadata.GetVisibilityConfig() | ||
|
|
||
| assert.True(t, config.ClusterConfiguredForArchival()) | ||
|
|
||
| metadata.EXPECT().GetVisibilityConfig().Return(NewDisabledArchvialConfig()) | ||
| config = metadata.GetVisibilityConfig() | ||
|
|
||
| assert.False(t, config.ClusterConfiguredForArchival()) | ||
| }) | ||
| t.Run("EXPECT_GetHistoryConfig", func(t *testing.T) { | ||
| metadata := NewMetadataMock(gomock.NewController(t)) | ||
| metadata.EXPECT().GetHistoryConfig().Return(NewEnabledArchivalConfig()) | ||
| config := metadata.GetHistoryConfig() | ||
|
|
||
| assert.True(t, config.ClusterConfiguredForArchival()) | ||
|
|
||
| metadata.EXPECT().GetHistoryConfig().Return(NewDisabledArchvialConfig()) | ||
| config = metadata.GetHistoryConfig() | ||
|
|
||
| assert.False(t, config.ClusterConfiguredForArchival()) | ||
| }) | ||
|
|
||
| t.Run("EXPECT_GetVisibilityConfig", func(t *testing.T) { | ||
| metadata := NewMetadataMock(gomock.NewController(t)) | ||
| metadata.EXPECT().GetVisibilityConfig().Return(NewEnabledArchivalConfig()) | ||
| config := metadata.GetVisibilityConfig() | ||
|
|
||
| assert.True(t, config.ClusterConfiguredForArchival()) | ||
|
|
||
| metadata.EXPECT().GetVisibilityConfig().Return(NewDisabledArchvialConfig()) | ||
| config = metadata.GetVisibilityConfig() | ||
|
|
||
| assert.False(t, config.ClusterConfiguredForArchival()) | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.