tasks/temporal/fx_test.go at release/v1.30.x

hanzoai/tasks

Fork 0

mirror of https://github.com/hanzoai/tasks.git synced 2026-10-04 02:04:03 +00:00

Files

T

298643d670 Update Configuration Loading (#8477 )

## What Changed

This PR introduces a new `--config-file` flag (and the
`TEMPORAL_SERVER_CONFIG_FILE_PATH ` environment variable) to remove the
dependency on `dockerize` in the Temporal server Docker image.

When a configuration file is specified using either the CLI flag or the
environment variable, the server will load configuration **only** from
that file.
Users who want templating behavior similar to `dockerize` can enable it
by adding the comment `# enable-template` at the top of the
configuration file.

---

### Key Changes

1. **New `--config-file` flag:**

* Adds a global `--config-file` flag that accepts a path to a single
configuration file (absolute or relative to the project root).
* Can also be set via the `TEMPORAL_SERVER_CONFIG_FILE_PATH `
environment variable.

2. **Deprecated legacy flags:**

* The `--config`, `--env`, and `--zone` flags are now marked as
**deprecated** in CLI help text.
   * These flags still work for backward compatibility.

3. **Embedded config template:**

* The `config_template.yaml` file is now embedded in the binary to
support loading configuration from environment variables.
* Templating is supported if the file includes the `# enable-template`
comment at the top.

4. **Templating support:**

* Configuration files can use templating by including `#
enable-template` at the beginning of the YAML file.

---

### Configuration Loading Priority (Highest to Lowest)

1. **`--config-file` specified** → Load that specific file
2. **`--config`, `--env`, or `--zone` specified** → Load from
configuration directory (**deprecated**)
3. **No configuration specified** → Load from embedded template using
environment variables (default)

---

### Expected Behavior

The following examples illustrate how the new configuration loading
logic behaves:

* **Default behavior:**
Running `temporal start` without flags loads configuration from
environment variables only using the embedded template.

* **Using `--config-file`:**
`temporal --config-file=/path/to/config.yaml start` loads configuration
from the specified file path.

* **Using `TEMPORAL_SERVER_CONFIG_FILE_PATH`:**
Setting `TEMPORAL_SERVER_CONFIG_FILE_PATH=/path/to/config.yaml temporal
start` has the same effect as using the flag.

* **Validation and error handling:**
The CLI returns clear error messages when conflicting flags or
environment variables are used, or when a specified file does not exist.
---

## Breaking Change

The default behavior of `temporal start` has changed.
It now loads configuration **from environment variables** instead of
using a default template path.

---------

Co-authored-by: Alex Stanfield <[email protected]>
Co-authored-by: michaely520 <[email protected]>
Co-authored-by: Yichao Yang <[email protected]>
Co-authored-by: David Reiss <[email protected]>

2025-11-18 16:23:25 +00:00

437 lines

16 KiB

Go

Raw Permalink Blame History

 package temporal
 import (
 	"context"
 	"path"
 	"testing"
 	"github.com/stretchr/testify/require"
 	enumspb "go.temporal.io/api/enums/v1"
 	persistencespb "go.temporal.io/server/api/persistence/v1"
 	"go.temporal.io/server/common/archiver"
 	"go.temporal.io/server/common/config"
 	"go.temporal.io/server/common/log"
 	"go.temporal.io/server/common/persistence"
 	"go.temporal.io/server/service/history/tasks"
 	"go.temporal.io/server/tests/testutils"
 	"go.uber.org/mock/gomock"
 )
 func TestInitCurrentClusterMetadataRecord(t *testing.T) {
 	configDir := path.Join(testutils.GetRepoRootDirectory(), "config")
 	cfg, err := config.Load(
 		config.WithEnv("development-cass-es"),
 		config.WithConfigDir(configDir),
 	)
 	require.NoError(t, err)
 	controller := gomock.NewController(t)
 	mockClusterMetadataManager := persistence.NewMockClusterMetadataManager(controller)
 	mockClusterMetadataManager.EXPECT().SaveClusterMetadata(gomock.Any(), gomock.Any()).DoAndReturn(
 		func(_ context.Context, request *persistence.SaveClusterMetadataRequest) (bool, error) {
 			require.Equal(t, cfg.ClusterMetadata.EnableGlobalNamespace, request.IsGlobalNamespaceEnabled)
 			require.Equal(t, cfg.ClusterMetadata.CurrentClusterName, request.ClusterName)
 			require.Equal(t, cfg.ClusterMetadata.ClusterInformation[cfg.ClusterMetadata.CurrentClusterName].RPCAddress, request.ClusterAddress)
 			require.Equal(t, cfg.ClusterMetadata.ClusterInformation[cfg.ClusterMetadata.CurrentClusterName].HTTPAddress, request.HttpAddress)
 			require.Equal(t, cfg.ClusterMetadata.ClusterInformation[cfg.ClusterMetadata.CurrentClusterName].InitialFailoverVersion, request.InitialFailoverVersion)
 			require.Equal(t, cfg.Persistence.NumHistoryShards, request.HistoryShardCount)
 			require.Equal(t, cfg.ClusterMetadata.FailoverVersionIncrement, request.FailoverVersionIncrement)
 			require.Equal(t, int64(0), request.Version)
 			return true, nil
 		},
 	)
 	err = initCurrentClusterMetadataRecord(
 		context.TODO(),
 		mockClusterMetadataManager,
 		cfg,
 		nil,
 		log.NewNoopLogger(),
 	)
 	require.NoError(t, err)
 }
 func TestUpdateCurrentClusterMetadataRecord(t *testing.T) {
 	configDir := path.Join(testutils.GetRepoRootDirectory(), "config")
 	cfg, err := config.Load(
 		config.WithEnv("development-cluster-a"),
 		config.WithConfigDir(configDir),
 	)
 	require.NoError(t, err)
 	controller := gomock.NewController(t)
 	mockClusterMetadataManager := persistence.NewMockClusterMetadataManager(controller)
 	mockClusterMetadataManager.EXPECT().SaveClusterMetadata(gomock.Any(), gomock.Any()).DoAndReturn(
 		func(_ context.Context, request *persistence.SaveClusterMetadataRequest) (bool, error) {
 			require.Equal(t, cfg.ClusterMetadata.EnableGlobalNamespace, request.IsGlobalNamespaceEnabled)
 			require.Equal(t, "", request.ClusterName)
 			require.Equal(t, cfg.ClusterMetadata.ClusterInformation[cfg.ClusterMetadata.CurrentClusterName].RPCAddress, request.ClusterAddress)
 			require.Equal(t, cfg.ClusterMetadata.ClusterInformation[cfg.ClusterMetadata.CurrentClusterName].HTTPAddress, request.HttpAddress)
 			require.Equal(t, cfg.ClusterMetadata.ClusterInformation[cfg.ClusterMetadata.CurrentClusterName].InitialFailoverVersion, request.InitialFailoverVersion)
 			require.Equal(t, int32(0), request.HistoryShardCount)
 			require.Equal(t, cfg.ClusterMetadata.FailoverVersionIncrement, request.FailoverVersionIncrement)
 			require.Equal(t, int64(1), request.Version)
 			return true, nil
 		},
 	)
 	updateRecord := &persistence.GetClusterMetadataResponse{
 		ClusterMetadata: &persistencespb.ClusterMetadata{},
 		Version:         1,
 	}
 	err = updateCurrentClusterMetadataRecord(
 		context.TODO(),
 		mockClusterMetadataManager,
 		cfg,
 		nil,
 		updateRecord,
 	)
 	require.NoError(t, err)
 }
 func TestOverwriteCurrentClusterMetadataWithDBRecord(t *testing.T) {
 	configDir := path.Join(testutils.GetRepoRootDirectory(), "config")
 	cfg, err := config.Load(
 		config.WithEnv("development-cass-es"),
 		config.WithConfigDir(configDir),
 	)
 	require.NoError(t, err)
 	dbRecord := &persistence.GetClusterMetadataResponse{
 		ClusterMetadata: &persistencespb.ClusterMetadata{
 			HistoryShardCount:        1024,
 			FailoverVersionIncrement: 10000,
 			IsGlobalNamespaceEnabled: true,
 		},
 		Version: 1,
 	}
 	overwriteCurrentClusterMetadataWithDBRecord(
 		cfg,
 		dbRecord,
 		log.NewNoopLogger(),
 	)
 	require.Equal(t, int64(10000), cfg.ClusterMetadata.FailoverVersionIncrement)
 	require.True(t, cfg.ClusterMetadata.EnableGlobalNamespace)
 	require.Equal(t, int32(1024), cfg.Persistence.NumHistoryShards)
 }
 func TestUpdateIndexSearchAttributes(t *testing.T) {
 	testCases := []struct {
 		name        string
 		initialISA  map[string]*persistencespb.IndexSearchAttributes
 		cmISA       map[string]*persistencespb.IndexSearchAttributes
 		expectedISA map[string]*persistencespb.IndexSearchAttributes
 		out         bool
 	}{
 		{
 			name:        "noop nil initial isa",
 			initialISA:  nil,
 			cmISA:       nil,
 			expectedISA: nil,
 			out:         false,
 		},
 		{
 			name:        "noop empty initial isa",
 			initialISA:  map[string]*persistencespb.IndexSearchAttributes{},
 			cmISA:       nil,
 			expectedISA: nil,
 			out:         false,
 		},
 		{
 			name: "noop no changes",
 			initialISA: map[string]*persistencespb.IndexSearchAttributes{
 				"my-index-1": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Keyword02": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 				"my-index-2": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 			},
 			cmISA: map[string]*persistencespb.IndexSearchAttributes{
 				"my-index-1": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Keyword02": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 				"my-index-2": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 			},
 			expectedISA: map[string]*persistencespb.IndexSearchAttributes{
 				"my-index-1": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Keyword02": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 				"my-index-2": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 			},
 			out: false,
 		},
 		{
 			name: "noop initial is subset",
 			initialISA: map[string]*persistencespb.IndexSearchAttributes{
 				"my-index-1": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Keyword02": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 				"my-index-2": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 			},
 			cmISA: map[string]*persistencespb.IndexSearchAttributes{
 				"my-index-1": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Keyword02": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 						"Int02":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 				"my-index-2": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 						"Int02":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 			},
 			expectedISA: map[string]*persistencespb.IndexSearchAttributes{
 				"my-index-1": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Keyword02": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 						"Int02":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 				"my-index-2": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 						"Int02":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 			},
 			out: false,
 		},
 		{
 			name: "cm is empty",
 			initialISA: map[string]*persistencespb.IndexSearchAttributes{
 				"my-index-1": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Keyword02": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 				"my-index-2": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 			},
 			cmISA: nil,
 			expectedISA: map[string]*persistencespb.IndexSearchAttributes{
 				"my-index-1": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Keyword02": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 				"my-index-2": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 			},
 			out: true,
 		},
 		{
 			name: "initial is superset",
 			initialISA: map[string]*persistencespb.IndexSearchAttributes{
 				"my-index-1": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Keyword02": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 				"my-index-2": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 			},
 			cmISA: map[string]*persistencespb.IndexSearchAttributes{
 				"my-index-1": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 					},
 				},
 				"my-index-2": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 					},
 				},
 			},
 			expectedISA: map[string]*persistencespb.IndexSearchAttributes{
 				"my-index-1": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Keyword02": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 				"my-index-2": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 			},
 			out: true,
 		},
 		{
 			name: "index is missing",
 			initialISA: map[string]*persistencespb.IndexSearchAttributes{
 				"my-index-1": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Keyword02": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 				"my-index-2": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 			},
 			cmISA: map[string]*persistencespb.IndexSearchAttributes{
 				"my-index-1": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Keyword02": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 			},
 			expectedISA: map[string]*persistencespb.IndexSearchAttributes{
 				"my-index-1": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Keyword02": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 				"my-index-2": &persistencespb.IndexSearchAttributes{
 					CustomSearchAttributes: map[string]enumspb.IndexedValueType{
 						"Keyword01": enumspb.INDEXED_VALUE_TYPE_KEYWORD,
 						"Int01":     enumspb.INDEXED_VALUE_TYPE_INT,
 					},
 				},
 			},
 			out: true,
 		},
 	}
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
 			cm := &persistence.GetClusterMetadataResponse{
 				ClusterMetadata: &persistencespb.ClusterMetadata{
 					IndexSearchAttributes: tc.cmISA,
 				},
 			}
 			out := updateIndexSearchAttributes(tc.initialISA, cm)
 			require.Equal(t, tc.out, out)
 			require.Equal(t, tc.expectedISA, cm.IndexSearchAttributes)
 		})
 	}
 }
 func TestTaskCategoryRegistryProvider(t *testing.T) {
 	for _, tc := range []struct {
 		name                   string
 		historyState           archiver.ArchivalState
 		visibilityState        archiver.ArchivalState
 		expectArchivalCategory bool
 	}{
 		{
 			name:                   "both disabled",
 			historyState:           archiver.ArchivalDisabled,
 			visibilityState:        archiver.ArchivalDisabled,
 			expectArchivalCategory: false,
 		},
 		{
 			name:                   "history enabled",
 			historyState:           archiver.ArchivalEnabled,
 			visibilityState:        archiver.ArchivalDisabled,
 			expectArchivalCategory: true,
 		},
 		{
 			name:                   "visibility enabled",
 			historyState:           archiver.ArchivalDisabled,
 			visibilityState:        archiver.ArchivalEnabled,
 			expectArchivalCategory: true,
 		},
 		{
 			name:                   "both enabled",
 			historyState:           archiver.ArchivalEnabled,
 			visibilityState:        archiver.ArchivalEnabled,
 			expectArchivalCategory: true,
 		},
 		{
 			name:                   "callbacks enabled, archival disabled",
 			historyState:           archiver.ArchivalDisabled,
 			visibilityState:        archiver.ArchivalDisabled,
 			expectArchivalCategory: false,
 		},
 	} {
 		t.Run(tc.name, func(t *testing.T) {
 			ctrl := gomock.NewController(t)
 			archivalMetadata := archiver.NewMockArchivalMetadata(ctrl)
 			historyArchivalConfig := archiver.NewMockArchivalConfig(ctrl)
 			historyArchivalConfig.EXPECT().StaticClusterState().Return(tc.historyState).AnyTimes()
 			archivalMetadata.EXPECT().GetHistoryConfig().Return(historyArchivalConfig).AnyTimes()
 			visibilityArchivalConfig := archiver.NewMockArchivalConfig(ctrl)
 			visibilityArchivalConfig.EXPECT().StaticClusterState().Return(tc.visibilityState).AnyTimes()
 			archivalMetadata.EXPECT().GetVisibilityConfig().Return(visibilityArchivalConfig).AnyTimes()
 			registry := TaskCategoryRegistryProvider(archivalMetadata)
 			_, ok := registry.GetCategoryByID(tasks.CategoryIDArchival)
 			if tc.expectArchivalCategory {
 				require.True(t, ok)
 			} else {
 				require.False(t, ok)
 			}
 		})
 	}
 }

437 lines 16 KiB Go Raw Permalink Blame History

437 lines

16 KiB

Go

Raw Permalink Blame History