-
Notifications
You must be signed in to change notification settings - Fork 2
Ensure all configs are used or checked in the constructor #172
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
284e322
Ensure constructor checks for non 0 config values
yushan8 1616786
Update constructors
yushan8 b127d12
Update
yushan8 799b96e
Make sure config fields are all set in constructor
yushan8 b5aeafc
Update with tests
yushan8 9316ed5
Update
yushan8 29d8555
Update
yushan8 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,186 @@ | ||
| // Copyright (c) 2025 Uber Technologies, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package config | ||
|
|
||
| import ( | ||
| "os" | ||
| "path/filepath" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestParse_Validation(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| validConfig := ` | ||
| repository: | ||
| - remote: "git@github.com:org/repo" | ||
| query_timeout_seconds: 300 | ||
| storage: | ||
| type: memory | ||
| service: | ||
| worker_pool_size: 5 | ||
| repo_manager_clone_path: /tmp/tango | ||
| chunking: | ||
| target_chunk_size: 250 | ||
| changed_target_chunk_size: 125 | ||
| metadata_map_chunk_size: 50000 | ||
| ` | ||
|
|
||
| tests := []struct { | ||
| name string | ||
| yaml string | ||
| wantErr bool | ||
| }{ | ||
| { | ||
| name: "valid config", | ||
| yaml: validConfig, | ||
| }, | ||
| { | ||
| name: "worker_pool_size not set", | ||
| yaml: ` | ||
| repository: | ||
| - remote: "git@github.com:org/repo" | ||
| query_timeout_seconds: 300 | ||
| service: | ||
| chunking: | ||
| target_chunk_size: 250 | ||
| changed_target_chunk_size: 125 | ||
| metadata_map_chunk_size: 50000 | ||
| `, | ||
| wantErr: true, | ||
| }, | ||
| { | ||
| name: "target_chunk_size not set", | ||
| yaml: ` | ||
| repository: | ||
| - remote: "git@github.com:org/repo" | ||
| query_timeout_seconds: 300 | ||
| service: | ||
| worker_pool_size: 5 | ||
| chunking: | ||
| changed_target_chunk_size: 125 | ||
| metadata_map_chunk_size: 50000 | ||
| `, | ||
| wantErr: true, | ||
| }, | ||
| { | ||
| name: "changed_target_chunk_size not set", | ||
| yaml: ` | ||
| repository: | ||
| - remote: "git@github.com:org/repo" | ||
| query_timeout_seconds: 300 | ||
| service: | ||
| worker_pool_size: 5 | ||
| chunking: | ||
| target_chunk_size: 250 | ||
| metadata_map_chunk_size: 50000 | ||
| `, | ||
| wantErr: true, | ||
| }, | ||
| { | ||
| name: "metadata_map_chunk_size not set", | ||
| yaml: ` | ||
| repository: | ||
| - remote: "git@github.com:org/repo" | ||
| query_timeout_seconds: 300 | ||
| service: | ||
| worker_pool_size: 5 | ||
| chunking: | ||
| target_chunk_size: 250 | ||
| changed_target_chunk_size: 125 | ||
| `, | ||
| wantErr: true, | ||
| }, | ||
| { | ||
| name: "repository remote not set", | ||
| yaml: ` | ||
| repository: | ||
| - query_timeout_seconds: 300 | ||
| service: | ||
| worker_pool_size: 5 | ||
| chunking: | ||
| target_chunk_size: 250 | ||
| changed_target_chunk_size: 125 | ||
| metadata_map_chunk_size: 50000 | ||
| `, | ||
| wantErr: true, | ||
| }, | ||
| { | ||
| name: "query_timeout_seconds not set", | ||
| yaml: ` | ||
| repository: | ||
| - remote: "git@github.com:org/repo" | ||
| service: | ||
| worker_pool_size: 5 | ||
| chunking: | ||
| target_chunk_size: 250 | ||
| changed_target_chunk_size: 125 | ||
| metadata_map_chunk_size: 50000 | ||
| `, | ||
| wantErr: true, | ||
| }, | ||
| { | ||
| name: "duplicate repository remote", | ||
| yaml: ` | ||
| repository: | ||
| - remote: "git@github.com:org/repo" | ||
| query_timeout_seconds: 300 | ||
| - remote: "git@github.com:org/repo" | ||
| query_timeout_seconds: 300 | ||
| service: | ||
| worker_pool_size: 5 | ||
| chunking: | ||
| target_chunk_size: 250 | ||
| changed_target_chunk_size: 125 | ||
| metadata_map_chunk_size: 50000 | ||
| `, | ||
| wantErr: true, | ||
| }, | ||
| { | ||
| name: "worker_root_path without repo_manager_clone_path", | ||
| yaml: ` | ||
| repository: | ||
| - remote: "git@github.com:org/repo" | ||
| query_timeout_seconds: 300 | ||
| service: | ||
| worker_pool_size: 5 | ||
| worker_root_path: /tmp/workers | ||
| chunking: | ||
| target_chunk_size: 250 | ||
| changed_target_chunk_size: 125 | ||
| metadata_map_chunk_size: 50000 | ||
| `, | ||
| wantErr: true, | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| t.Parallel() | ||
| path := filepath.Join(t.TempDir(), "config.yaml") | ||
| require.NoError(t, os.WriteFile(path, []byte(tt.yaml), 0o644)) | ||
|
|
||
| cfg, err := Parse(path) | ||
| if tt.wantErr { | ||
| require.Error(t, err, "expected error when %s", tt.name) | ||
| } else { | ||
| require.NoError(t, err) | ||
| require.NotNil(t, cfg) | ||
| } | ||
| }) | ||
| } | ||
| } |
This file contains hidden or 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 hidden or 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 hidden or 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.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are we removing the default values and erroring out. Should we not have default values if user do not provide for timeout or chunks?
I am not sure what the config document will look like but initial gut reaction is that we are asking users of the library to be quite knowledgable in the code base vs working out of the box
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also if we do decide to change that these must be provided, then please update service_config comments as it mentions
// streaming chunk sizes; zero values fall back to package defaults