-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add toolset configuration (#12)
Add `Toolset` implementation to the `tools` package: - struct and configs. - Custom `UnmarshalYAML` function. - Initialization function that validates if tools specified for the toolset exist.
- Loading branch information
1 parent
27edd3b
commit 59b4bc0
Showing
6 changed files
with
147 additions
and
24 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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| // Copyright 2024 Google LLC | ||
| // | ||
| // 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 tools | ||
|
|
||
| import ( | ||
| "regexp" | ||
| ) | ||
|
|
||
| var validName = regexp.MustCompile(`^[a-zA-Z0-9_-]+$`) | ||
|
|
||
| func IsValidName(s string) bool { | ||
| return validName.MatchString(s) | ||
| } |
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,69 @@ | ||
| // Copyright 2024 Google LLC | ||
| // | ||
| // 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 tools | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "gopkg.in/yaml.v3" | ||
| ) | ||
|
|
||
| type Toolset struct { | ||
| Name string `yaml:"name"` | ||
| Tools []*Tool `yaml:",inline"` | ||
| } | ||
|
|
||
| type ToolsetConfig struct { | ||
| Name string `yaml:"name"` | ||
| ToolNames []string `yaml:",inline"` | ||
| } | ||
| type ToolsetConfigs map[string]ToolsetConfig | ||
|
|
||
| // validate interface | ||
| var _ yaml.Unmarshaler = &ToolsetConfigs{} | ||
|
|
||
| func (c *ToolsetConfigs) UnmarshalYAML(node *yaml.Node) error { | ||
| *c = make(ToolsetConfigs) | ||
|
|
||
| var raw map[string][]string | ||
| if err := node.Decode(&raw); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| for name, toolList := range raw { | ||
| (*c)[name] = ToolsetConfig{Name: name, ToolNames: toolList} | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (t ToolsetConfig) Initialize(toolsMap map[string]Tool) (Toolset, error) { | ||
| // finish toolset setup | ||
| // Check each declared tool name exists | ||
| var toolset Toolset | ||
| toolset.Name = t.Name | ||
| if !IsValidName(toolset.Name) { | ||
| return toolset, fmt.Errorf("invalid toolset name: %s", t) | ||
| } | ||
| toolset.Tools = make([]*Tool, len(t.ToolNames)) | ||
| for _, toolName := range t.ToolNames { | ||
| tool, ok := toolsMap[toolName] | ||
| if !ok { | ||
| return toolset, fmt.Errorf("tool does not exist: %s", t) | ||
| } | ||
| toolset.Tools = append(toolset.Tools, &tool) | ||
|
|
||
| } | ||
| return toolset, nil | ||
| } |