diff --git a/cgc-test.yaml b/cgc-test.yaml new file mode 100644 index 00000000..9eef14ef --- /dev/null +++ b/cgc-test.yaml @@ -0,0 +1,18 @@ +id: cgc_validation_test +name: "CGC Validation Test" +timeout: 5m +config: + description: "Comprehensive test to validate CGC (Custody Group Count) values in consensus layer client ENR records" + +tasks: + - name: "check_consensus_cgc" + description: "Basic CGC check for all consensus clients" + timeout: 2m + config: + clientPattern: ".*" + pollInterval: 10s + expectedNonValidating: 0x04 + expectedValidating: 0x08 + minClientCount: 1 + failOnCheckMiss: true + resultVar: "detected_cgc_value" \ No newline at end of file diff --git a/pkg/coordinator/web/api/post_tests_register_upload_api.go b/pkg/coordinator/web/api/post_tests_register_upload_api.go new file mode 100644 index 00000000..3d35fb61 --- /dev/null +++ b/pkg/coordinator/web/api/post_tests_register_upload_api.go @@ -0,0 +1,156 @@ +package api + +import ( + "fmt" + "io" + "net/http" + "time" + + "github.com/ethpandaops/assertoor/pkg/coordinator/helper" + "github.com/ethpandaops/assertoor/pkg/coordinator/types" + "gopkg.in/yaml.v3" +) + +type PostTestsRegisterUploadResponse struct { + TestID string `json:"test_id"` + Name string `json:"name"` + Config map[string]any `json:"config"` +} + +// PostTestsRegisterUpload godoc +// @Id postTestsRegisterUpload +// @Summary Register new test via uploaded YAML file +// @Tags Test +// @Description Upload a YAML test configuration file and register the test. Returns the test id and name of the added test. +// @Produce json +// @Accept multipart/form-data +// @Param playbook formData file true "YAML test configuration file" +// @Param name formData string false "Custom test name override" +// @Param timeout formData integer false "Custom timeout in seconds" +// @Param config formData string false "Custom config overrides as YAML" +// @Param configVars formData string false "Custom config variables as YAML" +// @Success 200 {object} Response{data=PostTestsRegisterUploadResponse} "Success" +// @Failure 400 {object} Response "Failure" +// @Failure 500 {object} Response "Server Error" +// @Router /api/v1/tests/register_upload [post] +func (ah *APIHandler) PostTestsRegisterUpload(w http.ResponseWriter, r *http.Request) { + w.Header().Set("Content-Type", contentTypeJSON) + + // Parse multipart form + err := r.ParseMultipartForm(10 << 20) // 10 MB max + if err != nil { + ah.sendErrorResponse(w, r.URL.String(), fmt.Sprintf("error parsing multipart form: %v", err), http.StatusBadRequest) + return + } + + // Get uploaded file + file, fileHeader, err := r.FormFile("playbook") + if err != nil { + ah.sendErrorResponse(w, r.URL.String(), fmt.Sprintf("error retrieving uploaded file: %v", err), http.StatusBadRequest) + return + } + defer file.Close() + + // Read file content + fileContent, err := io.ReadAll(file) + if err != nil { + ah.sendErrorResponse(w, r.URL.String(), fmt.Sprintf("error reading uploaded file: %v", err), http.StatusBadRequest) + return + } + + // Parse YAML test configuration + var testConfig types.TestConfig + err = yaml.Unmarshal(fileContent, &testConfig) + if err != nil { + ah.sendErrorResponse(w, r.URL.String(), fmt.Sprintf("error parsing YAML test configuration: %v", err), http.StatusBadRequest) + return + } + + // Validate required fields + if testConfig.ID == "" { + ah.sendErrorResponse(w, r.URL.String(), "test id missing or empty in uploaded file", http.StatusBadRequest) + return + } + + if testConfig.Name == "" { + ah.sendErrorResponse(w, r.URL.String(), "test name missing or empty in uploaded file", http.StatusBadRequest) + return + } + + if len(testConfig.Tasks) == 0 { + ah.sendErrorResponse(w, r.URL.String(), "test must have 1 or more tasks", http.StatusBadRequest) + return + } + + // Apply form overrides + customName := r.FormValue("name") + if customName != "" { + testConfig.Name = customName + } + + customTimeout := r.FormValue("timeout") + if customTimeout != "" { + timeoutDuration, err := time.ParseDuration(customTimeout + "s") + if err != nil { + ah.sendErrorResponse(w, r.URL.String(), fmt.Sprintf("invalid timeout format: %v", err), http.StatusBadRequest) + return + } + testConfig.Timeout = helper.Duration{Duration: timeoutDuration} + } + + // Parse custom config overrides + customConfig := r.FormValue("config") + if customConfig != "" { + var configOverrides map[string]interface{} + err = yaml.Unmarshal([]byte(customConfig), &configOverrides) + if err != nil { + ah.sendErrorResponse(w, r.URL.String(), fmt.Sprintf("error parsing config overrides: %v", err), http.StatusBadRequest) + return + } + // Merge with existing config + if testConfig.Config == nil { + testConfig.Config = make(map[string]interface{}) + } + for key, value := range configOverrides { + testConfig.Config[key] = value + } + } + + // Parse custom config variables + customConfigVars := r.FormValue("configVars") + if customConfigVars != "" { + var configVars map[string]string + err = yaml.Unmarshal([]byte(customConfigVars), &configVars) + if err != nil { + ah.sendErrorResponse(w, r.URL.String(), fmt.Sprintf("error parsing config variables: %v", err), http.StatusBadRequest) + return + } + // Merge with existing config vars + if testConfig.ConfigVars == nil { + testConfig.ConfigVars = make(map[string]string) + } + for key, value := range configVars { + testConfig.ConfigVars[key] = value + } + } + + // Add metadata about the upload + if testConfig.Config == nil { + testConfig.Config = make(map[string]interface{}) + } + testConfig.Config["_uploadedFile"] = fileHeader.Filename + testConfig.Config["_uploadedAt"] = time.Now().UTC().Format(time.RFC3339) + + // Register the test + testDescriptor, err := ah.coordinator.TestRegistry().AddLocalTest(&testConfig) + if err != nil { + ah.sendErrorResponse(w, r.URL.String(), fmt.Sprintf("failed adding test: %v", err), http.StatusInternalServerError) + return + } + + ah.sendOKResponse(w, r.URL.String(), &PostTestsRegisterUploadResponse{ + TestID: testDescriptor.ID(), + Name: testDescriptor.Config().Name, + Config: testDescriptor.Config().Config, + }) +} \ No newline at end of file diff --git a/pkg/coordinator/web/server.go b/pkg/coordinator/web/server.go index 98333e09..cae0dd15 100644 --- a/pkg/coordinator/web/server.go +++ b/pkg/coordinator/web/server.go @@ -90,6 +90,7 @@ func (ws *Server) ConfigureRoutes(frontendConfig *types.FrontendConfig, apiConfi if !securityTrimmed { ws.router.HandleFunc("/api/v1/tests/register", apiHandler.PostTestsRegister).Methods("POST") ws.router.HandleFunc("/api/v1/tests/register_external", apiHandler.PostTestsRegisterExternal).Methods("POST") + ws.router.HandleFunc("/api/v1/tests/register_upload", apiHandler.PostTestsRegisterUpload).Methods("POST") ws.router.HandleFunc("/api/v1/tests/delete", apiHandler.PostTestsDelete).Methods("POST") ws.router.HandleFunc("/api/v1/test_run", apiHandler.PostTestRunsSchedule).Methods("POST") // legacy ws.router.HandleFunc("/api/v1/test_runs/schedule", apiHandler.PostTestRunsSchedule).Methods("POST") diff --git a/pkg/coordinator/web/templates/sidebar/sidebar.html b/pkg/coordinator/web/templates/sidebar/sidebar.html index bff8bfe8..6d03f2c2 100644 --- a/pkg/coordinator/web/templates/sidebar/sidebar.html +++ b/pkg/coordinator/web/templates/sidebar/sidebar.html @@ -64,20 +64,52 @@

Register Test

-
-
- Playbook URL: + +
+
+
+ + + + + +
-
- +
+ + +
+
+
+ Playbook URL: +
+
+ +
-
+ + + + + +
Custom Name:
+
Optional: Override the test name from the file
@@ -86,6 +118,7 @@

Register Test

+
Optional: YAML configuration overrides
@@ -104,53 +137,118 @@

Register Test

window.editor = editor; resetConfigOverrides(); $("#registerTestButton").on("click", registerTest); + + // Handle registration method toggle + $('input[name="registrationMethod"]').on('change', function() { + if ($("#urlMethod").is(':checked')) { + $("#urlRegistrationFields").show(); + $("#uploadRegistrationFields").hide(); + } else { + $("#urlRegistrationFields").hide(); + $("#uploadRegistrationFields").show(); + } + // Clear inputs when switching methods + $("#registerTestFile").val(""); + $("#registerTestFileUpload").val(""); + }); function resetConfigOverrides() { editor.setValue("", -1); } function registerTest() { + var configYaml = editor.getValue(); var configJson; - try { - var configYaml = editor.getValue(); - configJson = YAML.parse(configYaml); - } catch(ex) { - alert("invalid config yaml: " + ex.toString()); - return; + + // Only parse config if it's not empty + if (configYaml.trim()) { + try { + configJson = YAML.parse(configYaml); + } catch(ex) { + alert("invalid config yaml: " + ex.toString()); + return; + } } - var testFile = $("#registerTestFile").val(); - if(!testFile) { - alert("playbook link is required"); - return; - } - - var reqPromise = new Promise(function(resolve, reject) { - $.ajax({ - type: "POST", - url: "/api/v1/tests/register_external", - dataType: "json", - async: false, - data: JSON.stringify({ - file: testFile, - name: $("#registerTestName").val() || "", - config: configJson - }), - success: resolve, - error: reject + if ($("#urlMethod").is(':checked')) { + // URL-based registration + var testFile = $("#registerTestFile").val(); + if(!testFile) { + alert("playbook link is required"); + return; + } + + var reqPromise = new Promise(function(resolve, reject) { + $.ajax({ + type: "POST", + url: "/api/v1/tests/register_external", + dataType: "json", + async: false, + data: JSON.stringify({ + file: testFile, + name: $("#registerTestName").val() || "", + config: configJson + }), + success: resolve, + error: reject + }); }); - }); - - reqPromise.then(function(res) { - if(!res || res.status !== "OK") { - throw res.status; + + reqPromise.then(function(res) { + if(!res || res.status !== "OK") { + throw res.status; + } + location.reload(); + }, function(rsp) { + throw rsp.responseJSON ? rsp.responseJSON.status : rsp.statusText; + }).catch(function(err) { + alert("Could not register test: " + err.toString()); + }); + } else { + // File upload registration + var fileInput = $("#registerTestFileUpload")[0]; + if(!fileInput.files || fileInput.files.length === 0) { + alert("please select a playbook file to upload"); + return; } - location.reload(); - }, function(rsp) { - throw rsp.responseJSON ? rsp.responseJSON.status : rsp.statusText; - }).catch(function(err) { - alert("Could not register test: " + err.toString()); - }); + + var formData = new FormData(); + formData.append('playbook', fileInput.files[0]); + + var customName = $("#registerTestName").val(); + if (customName) { + formData.append('name', customName); + } + + if (configYaml.trim()) { + formData.append('config', configYaml); + } + + var reqPromise = new Promise(function(resolve, reject) { + $.ajax({ + type: "POST", + url: "/api/v1/tests/register_upload", + dataType: "json", + async: false, + data: formData, + processData: false, + contentType: false, + success: resolve, + error: reject + }); + }); + + reqPromise.then(function(res) { + if(!res || res.status !== "OK") { + throw res.status; + } + location.reload(); + }, function(rsp) { + throw rsp.responseJSON ? rsp.responseJSON.status : rsp.statusText; + }).catch(function(err) { + alert("Could not register test: " + err.toString()); + }); + } } });