mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Carly de FrondevilleandGitHub
68fe1f306a
## What changed? This change adds a flag to `temporal-sql-tool` and `temporal-cassandra-tool`'s `update-schema` and `setup-schema` to specify an embedded schema instead of a path to the schema directory or schema file. ``` NAME: temporal-cassandra-tool update-schema - update cassandra schema to a specific version USAGE: temporal-cassandra-tool update-schema [command options] [arguments...] OPTIONS: --version value, -v value target version for the schema update, defaults to latest --schema-dir value, -d value path to directory containing versioned schema --schema-name value, -s value name of embedded versioned schema, one of: [cassandra/temporal cassandra/visibility] ``` ``` NAME: temporal-sql-tool update-schema - update sql schema to a specific version USAGE: temporal-sql-tool update-schema [command options] [arguments...] OPTIONS: --version value, -v value target version for the schema update, defaults to latest --schema-dir value, -d value path to directory containing versioned schema --schema-name value, -s value name of embedded versioned schema, one of: [mysql/v57/temporal mysql/v57/visibility mysql/v8/temporal mysql/v8/visibility postgresql/v96/temporal postgresql/v96/visibility postgresql/v12/temporal postgresql/v12/visibility] ``` ## Why? We want to embed the db schemas in the `temporal-sql-tool` and `temporal-cassandra-tool` with `go:embed` so that customers can simply specify which schema they want using a flag instead of having to copy the schema files to wherever they're running the db tool and passing the path to the schema. https://github.com/temporalio/temporal/issues/2059 ## How did you test it? I wrote a new unit test for reading the embedded file system, and the existing codepath of the changed functions are all tested by the existing unit tests. I also updated the unit test for config validation to reflect the new changes. I tested this locally with a locally running Postgres. Since the more complex changes are in `updatetask.go`, which is shared by the sql and the cassandra tool, I think there is no need to also test with a real cassandra db. I also built the cassandra command line tool and confirmed that the flags and validation checks behaved as expected. ## Potential risks Schema updates could fail. But the changes are pretty contained to the new `-s` flag which isn't used anywhere in production yet, so the risk is very low. The code for the `-d` flag remained basically the same. ## Is hotfix candidate? No
150 lines
4.5 KiB
Go
150 lines
4.5 KiB
Go
// 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 schema
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
"github.com/stretchr/testify/suite"
|
|
)
|
|
|
|
type (
|
|
HandlerTestSuite struct {
|
|
*require.Assertions // override suite.Suite.Assertions with require.Assertions; this means that s.NotNil(nil) will stop the test, not merely log an error
|
|
suite.Suite
|
|
db *mockSQLDB
|
|
}
|
|
)
|
|
|
|
func TestHandlerTestSuite(t *testing.T) {
|
|
suite.Run(t, new(HandlerTestSuite))
|
|
}
|
|
|
|
func (s *HandlerTestSuite) SetupTest() {
|
|
s.Assertions = require.New(s.T()) // Have to define our overridden assertions in the test setup. If we did it earlier, s.T() will return nil
|
|
s.db = new(mockSQLDB)
|
|
}
|
|
|
|
func (s *HandlerTestSuite) TestValidateSetupConfig() {
|
|
config := new(SetupConfig)
|
|
s.assertValidateSetupFails(config, s.db)
|
|
|
|
s.assertValidateSetupFails(config, s.db)
|
|
|
|
config.InitialVersion = "0.1"
|
|
config.DisableVersioning = true
|
|
config.SchemaFilePath = ""
|
|
s.assertValidateSetupFails(config, s.db)
|
|
|
|
config.InitialVersion = "0.1"
|
|
config.DisableVersioning = true
|
|
config.SchemaFilePath = "/tmp/foo.cql"
|
|
s.assertValidateSetupFails(config, s.db)
|
|
|
|
config.InitialVersion = ""
|
|
config.DisableVersioning = true
|
|
config.SchemaFilePath = ""
|
|
s.assertValidateSetupFails(config, s.db)
|
|
|
|
config.InitialVersion = "0.1"
|
|
config.DisableVersioning = false
|
|
config.SchemaFilePath = "/tmp/foo.cql"
|
|
s.assertValidateSetupSucceeds(config, s.db)
|
|
|
|
config.InitialVersion = "0.1"
|
|
config.DisableVersioning = false
|
|
config.SchemaFilePath = ""
|
|
s.assertValidateSetupSucceeds(config, s.db)
|
|
|
|
config.InitialVersion = ""
|
|
config.DisableVersioning = true
|
|
config.SchemaFilePath = "/tmp/foo.cql"
|
|
s.assertValidateSetupSucceeds(config, s.db)
|
|
|
|
config.SchemaName = "mysql/v57/temporal"
|
|
s.assertValidateSetupFails(config, s.db)
|
|
config.SchemaFilePath = ""
|
|
s.assertValidateSetupSucceeds(config, s.db)
|
|
config.SchemaName = "foo"
|
|
s.assertValidateSetupFails(config, s.db)
|
|
}
|
|
|
|
func (s *HandlerTestSuite) TestValidateUpdateConfig() {
|
|
|
|
config := new(UpdateConfig)
|
|
s.assertValidateUpdateFails(config, s.db)
|
|
|
|
s.assertValidateUpdateFails(config, s.db)
|
|
|
|
config.SchemaDir = "/tmp"
|
|
config.TargetVersion = "abc"
|
|
s.assertValidateUpdateFails(config, s.db)
|
|
|
|
config.SchemaDir = "/tmp"
|
|
config.TargetVersion = ""
|
|
s.assertValidateUpdateSucceeds(config, s.db)
|
|
|
|
config.SchemaDir = "/tmp"
|
|
config.TargetVersion = "1.2"
|
|
s.assertValidateUpdateSucceeds(config, s.db)
|
|
|
|
config.SchemaDir = "/tmp"
|
|
config.TargetVersion = "v1.2"
|
|
s.assertValidateUpdateSucceeds(config, s.db)
|
|
s.Equal("1.2", config.TargetVersion)
|
|
|
|
config.SchemaName = "mysql/v57/temporal"
|
|
s.assertValidateUpdateFails(config, s.db)
|
|
config.SchemaDir = ""
|
|
s.assertValidateUpdateSucceeds(config, s.db)
|
|
config.SchemaName = "foo"
|
|
s.assertValidateUpdateFails(config, s.db)
|
|
}
|
|
|
|
func (s *HandlerTestSuite) assertValidateSetupSucceeds(input *SetupConfig, db DB) {
|
|
err := validateSetupConfig(input, db)
|
|
s.Nil(err)
|
|
}
|
|
|
|
func (s *HandlerTestSuite) assertValidateSetupFails(input *SetupConfig, db DB) {
|
|
err := validateSetupConfig(input, db)
|
|
s.NotNil(err)
|
|
_, ok := err.(*ConfigError)
|
|
s.True(ok)
|
|
}
|
|
|
|
func (s *HandlerTestSuite) assertValidateUpdateSucceeds(input *UpdateConfig, db DB) {
|
|
err := validateUpdateConfig(input, db)
|
|
s.Nil(err)
|
|
}
|
|
|
|
func (s *HandlerTestSuite) assertValidateUpdateFails(input *UpdateConfig, db DB) {
|
|
err := validateUpdateConfig(input, db)
|
|
s.NotNil(err)
|
|
_, ok := err.(*ConfigError)
|
|
s.True(ok)
|
|
}
|