feat: adds agent config command that returns the agent configuration
#4671
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| package agent | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/spf13/cobra" | ||
|
|
||
| "github.com/bacalhau-project/bacalhau/cmd/util" | ||
| "github.com/bacalhau-project/bacalhau/cmd/util/flags/cliflags" | ||
| "github.com/bacalhau-project/bacalhau/cmd/util/output" | ||
| "github.com/bacalhau-project/bacalhau/pkg/config/types" | ||
| "github.com/bacalhau-project/bacalhau/pkg/publicapi/client/v2" | ||
| ) | ||
|
|
||
| func NewConfigCmd() *cobra.Command { | ||
| o := output.NonTabularOutputOptions{ | ||
| Format: output.YAMLFormat, | ||
| Pretty: true, | ||
| } | ||
| configCmd := &cobra.Command{ | ||
| Use: "config", | ||
| Short: "Get the agent's configuration.", | ||
| Args: cobra.NoArgs, | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| cfg, err := util.SetupRepoConfig(cmd) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to setup repo: %w", err) | ||
| } | ||
| api, err := util.GetAPIClientV2(cmd, cfg) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to create api client: %w", err) | ||
| } | ||
| return run(cmd, api, o) | ||
| }, | ||
| } | ||
| configCmd.Flags().AddFlagSet(cliflags.OutputNonTabularFormatFlags(&o)) | ||
| return configCmd | ||
| } | ||
|
|
||
| func run(cmd *cobra.Command, api client.API, o output.NonTabularOutputOptions) error { | ||
| ctx := cmd.Context() | ||
| response, err := api.Agent().Config(ctx) | ||
| if err != nil { | ||
| return fmt.Errorf("cannot get agent config: %w", err) | ||
| } | ||
|
|
||
| return output.OutputOneNonTabular[types.Bacalhau](cmd, o, response.Config) | ||
| } | ||
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,46 @@ | ||
| //go:build unit || !integration | ||
|
|
||
| package agent_test | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/suite" | ||
| "gopkg.in/yaml.v3" | ||
|
|
||
| cmdtesting "github.com/bacalhau-project/bacalhau/cmd/testing" | ||
| "github.com/bacalhau-project/bacalhau/cmd/util/output" | ||
| "github.com/bacalhau-project/bacalhau/pkg/config/types" | ||
| ) | ||
|
|
||
| func TestConfigSuite(t *testing.T) { | ||
| suite.Run(t, new(ConfigSuite)) | ||
| } | ||
|
|
||
| type ConfigSuite struct { | ||
| cmdtesting.BaseSuite | ||
| } | ||
|
|
||
| func (s *ConfigSuite) TestConfigJSONOutput() { | ||
| _, out, err := s.ExecuteTestCobraCommand( | ||
| "agent", "config", "--output", string(output.JSONFormat), "--pretty=false", | ||
| ) | ||
| s.Require().NoError(err, "Could not request config with json output.") | ||
|
|
||
| var cfg types.Bacalhau | ||
| err = json.Unmarshal([]byte(out), &cfg) | ||
| s.Require().NoError(err, "Could not unmarshal the output into json - %+v", err) | ||
| s.Require().True(cfg.Orchestrator.Enabled) | ||
| } | ||
|
Comment on lines
+25
to
+35
There was a problem hiding this comment. 🛠️ Refactor suggestion Enhance test coverage for JSON output. While the basic functionality is tested, consider adding more assertions:
func (s *ConfigSuite) TestConfigJSONOutput() {
_, out, err := s.ExecuteTestCobraCommand(
"agent", "config", "--output", string(output.JSONFormat), "--pretty=false",
)
s.Require().NoError(err, "Could not request config with json output.")
var cfg types.Bacalhau
err = json.Unmarshal([]byte(out), &cfg)
s.Require().NoError(err, "Could not unmarshal the output into json - %+v", err)
+ // Verify structure and essential fields
s.Require().True(cfg.Orchestrator.Enabled)
+ s.Require().NotEmpty(cfg.APIServer.Host, "API server host should be set")
+ s.Require().NotEmpty(cfg.APIServer.Port, "API server port should be set")
+
+ // Verify sensitive data is redacted
+ s.Require().Equal("[REDACTED]", cfg.Compute.IPFS.SwarmKey, "SwarmKey should be redacted")
+
+ // Verify JSON structure
+ s.Require().Contains(out, "\"APIServer\":", "JSON should contain APIServer section")
+ s.Require().Contains(out, "\"Compute\":", "JSON should contain Compute section")
}
|
||
|
|
||
| func (s *ConfigSuite) TestConfigYAMLOutput() { | ||
| // NB: the default output is yaml, thus we don't specify it here. | ||
| _, out, err := s.ExecuteTestCobraCommand("agent", "config") | ||
| s.Require().NoError(err, "Could not request config with yaml output.") | ||
|
|
||
| var cfg types.Bacalhau | ||
| err = yaml.Unmarshal([]byte(out), &cfg) | ||
| s.Require().NoError(err, "Could not unmarshal the output into yaml - %+v", out) | ||
| s.Require().True(cfg.Orchestrator.Enabled) | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| //go:build unit || !integration | ||
|
|
||
| package agent | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "testing" | ||
|
|
||
| "github.com/labstack/echo/v4" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/bacalhau-project/bacalhau/pkg/config/types" | ||
| "github.com/bacalhau-project/bacalhau/pkg/publicapi/apimodels" | ||
| ) | ||
|
|
||
| // TestEndpointConfigRedactFields asserts that auth tokens in the config are redacted. | ||
| func TestEndpointConfigRedactFields(t *testing.T) { | ||
| router := echo.New() | ||
|
|
||
| // populate the fields that should be redacted with "secret" values. | ||
| NewEndpoint(EndpointParams{ | ||
| Router: router, | ||
| BacalhauConfig: types.Bacalhau{ | ||
| Orchestrator: types.Orchestrator{ | ||
| Auth: types.OrchestratorAuth{ | ||
| Token: "super-secret-orchestrator-token", | ||
| }, | ||
| }, | ||
| Compute: types.Compute{ | ||
| Auth: types.ComputeAuth{ | ||
| Token: "super-secret-orchestrator-token", | ||
| }, | ||
| }, | ||
| }, | ||
| }) | ||
|
|
||
| req := httptest.NewRequest(http.MethodGet, "/api/v1/agent/config", nil) | ||
| rr := httptest.NewRecorder() | ||
| router.ServeHTTP(rr, req) | ||
|
|
||
| require.Equal(t, http.StatusOK, rr.Code) | ||
|
|
||
| // assert the secret values are not present. | ||
| var payload apimodels.GetAgentConfigResponse | ||
| err := json.NewDecoder(rr.Body).Decode(&payload) | ||
| require.NoError(t, err) | ||
| assert.Equal(t, payload.Config.Orchestrator.Auth.Token, "<redacted>") | ||
| assert.Equal(t, payload.Config.Compute.Auth.Token, "<redacted>") | ||
| } | ||
|
Comment on lines
+19
to
+52
There was a problem hiding this comment. 🛠️ Refactor suggestion Consider enhancing test coverage with additional scenarios. The current test effectively verifies the redaction of sensitive tokens. However, consider these improvements:
Here's a suggested enhancement: func TestEndpointConfigRedactFields(t *testing.T) {
+ tests := []struct {
+ name string
+ config types.Bacalhau
+ expectedCode int
+ expectRedacted bool
+ }{
+ {
+ name: "should redact sensitive fields",
+ config: types.Bacalhau{
+ Orchestrator: types.Orchestrator{
+ Auth: types.OrchestratorAuth{
+ Token: "secret-token",
+ },
+ },
+ // Add more test fields here
+ },
+ expectedCode: http.StatusOK,
+ expectRedacted: true,
+ },
+ // Add more test cases
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ router := echo.New()
+ NewEndpoint(EndpointParams{
+ Router: router,
+ BacalhauConfig: tt.config,
+ })
+
+ req := httptest.NewRequest(http.MethodGet, "/api/v1/agent/config", nil)
+ rr := httptest.NewRecorder()
+ router.ServeHTTP(rr, req)
+
+ require.Equal(t, tt.expectedCode, rr.Code)
+ require.Equal(t, "application/json", rr.Header().Get("Content-Type"))
+
+ var payload apimodels.GetAgentConfigResponse
+ err := json.NewDecoder(rr.Body).Decode(&payload)
+ require.NoError(t, err)
+
+ // Verify sensitive fields are redacted
+ if tt.expectRedacted {
+ assert.Equal(t, "<redacted>", payload.Config.Orchestrator.Auth.Token)
+ assert.Equal(t, "<redacted>", payload.Config.Compute.Auth.Token)
+ }
+
+ // Verify non-sensitive fields remain unchanged
+ assert.Equal(t, tt.config.Orchestrator.Host, payload.Config.Orchestrator.Host)
+ // Add more field verifications
+ })
+ }
}
|
||
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.
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.
🛠️ Refactor suggestion
Enhance error handling and add timeout.
While the implementation is functional, consider these improvements:
Consider applying these changes:
func run(cmd *cobra.Command, api client.API, o output.NonTabularOutputOptions) error { - ctx := cmd.Context() + ctx, cancel := context.WithTimeout(cmd.Context(), 30*time.Second) + defer cancel() + response, err := api.Agent().Config(ctx) if err != nil { return fmt.Errorf("cannot get agent config: %w", err) } + if response == nil || response.Config == nil { + return fmt.Errorf("received empty configuration from agent") + } return output.OutputOneNonTabular[types.Bacalhau](cmd, o, response.Config) }Don't forget to add the imports: