From a3deb3d974d765548e4c2bd03c519af07c24cc07 Mon Sep 17 00:00:00 2001
From: Boming Zhang <bomingzh@sjtu.edu.cn>
Date: Mon, 4 Mar 2024 02:32:00 -0500
Subject: [PATCH] style: rename Result -> ExecutorResult

---
 README.md                              | 10 +++++-----
 internal/executors/dummy/executor.go   |  4 ++--
 internal/executors/sandbox/convert.go  |  6 +++---
 internal/executors/sandbox/executor.go |  2 +-
 internal/parsers/dummy/parser.go       |  2 +-
 internal/stage/executor.go             |  2 +-
 internal/stage/model.go                |  6 +++---
 internal/stage/parser.go               |  2 +-
 8 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/README.md b/README.md
index 2a9e5bf..07c3dbd 100644
--- a/README.md
+++ b/README.md
@@ -36,22 +36,22 @@ The program parse the TOML file to run multiple stages.
 
 Each stage contains a executor and parser.
 
-Executor takes a `Cmd` and returns a `Result`.
+Executor takes a `Cmd` and returns a `ExecutorResult`.
 
-Parser takes a `Result` and its config and returns a `ParserResult`.
+Parser takes a `ExecutorResult` and its config and returns a `ParserResult`.
 
 ### `Cmd`
 
-Check <https://github.com/criyle/go-judge#rest-api-interface>.
+Check `Cmd` in <https://github.com/criyle/go-judge#rest-api-interface>.
 
 Some extra fields:
 
 -   `CopyInCwd bool`: set to `true` to add everything in the current working directory to `CopyIn`.
 -   `CopyInCached map[string]string`: key: file name in sandbox, value: file name used in `CopyOutCached`.
 
-### `Result`
+### `ExecutorResult`
 
-Check <https://github.com/criyle/go-judge#rest-api-interface>.
+Check `Result` in <https://github.com/criyle/go-judge#rest-api-interface>.
 
 ### `ParserResult`
 
diff --git a/internal/executors/dummy/executor.go b/internal/executors/dummy/executor.go
index cd15eec..9764ac9 100644
--- a/internal/executors/dummy/executor.go
+++ b/internal/executors/dummy/executor.go
@@ -7,8 +7,8 @@ import (
 
 type Dummy struct{}
 
-func (e *Dummy) Run(stage.Cmd) (*stage.Result, error) {
-	return &stage.Result{
+func (e *Dummy) Run(stage.Cmd) (*stage.ExecutorResult, error) {
+	return &stage.ExecutorResult{
 		Status:     stage.Status(envexec.StatusInvalid),
 		ExitStatus: 0,
 		Error:      "I'm a dummy",
diff --git a/internal/executors/sandbox/convert.go b/internal/executors/sandbox/convert.go
index 64c29c4..77a9247 100644
--- a/internal/executors/sandbox/convert.go
+++ b/internal/executors/sandbox/convert.go
@@ -105,10 +105,10 @@ func convertPBFile(i stage.CmdFile) *pb.Request_File {
 	return nil
 }
 
-func convertPBResult(res []*pb.Response_Result) []stage.Result {
-	var ret []stage.Result
+func convertPBResult(res []*pb.Response_Result) []stage.ExecutorResult {
+	var ret []stage.ExecutorResult
 	for _, r := range res {
-		ret = append(ret, stage.Result{
+		ret = append(ret, stage.ExecutorResult{
 			Status:     stage.Status(r.Status),
 			ExitStatus: int(r.ExitStatus),
 			Error:      r.Error,
diff --git a/internal/executors/sandbox/executor.go b/internal/executors/sandbox/executor.go
index 28bb186..81d18da 100644
--- a/internal/executors/sandbox/executor.go
+++ b/internal/executors/sandbox/executor.go
@@ -16,7 +16,7 @@ type Sandbox struct {
 	cachedMap  map[string]string
 }
 
-func (e *Sandbox) Run(cmd stage.Cmd) (*stage.Result, error) {
+func (e *Sandbox) Run(cmd stage.Cmd) (*stage.ExecutorResult, error) {
 	slog.Info("sandbox run", "cmd", cmd)
 	if cmd.CopyIn == nil {
 		cmd.CopyIn = make(map[string]stage.CmdFile)
diff --git a/internal/parsers/dummy/parser.go b/internal/parsers/dummy/parser.go
index e5f98c7..00bacb3 100644
--- a/internal/parsers/dummy/parser.go
+++ b/internal/parsers/dummy/parser.go
@@ -15,7 +15,7 @@ type Config struct {
 
 type Dummy struct{}
 
-func (e *Dummy) Run(result *stage.Result, configAny any) (
+func (e *Dummy) Run(result *stage.ExecutorResult, configAny any) (
 	*stage.ParserResult, error,
 ) {
 	var config Config
diff --git a/internal/stage/executor.go b/internal/stage/executor.go
index 606961c..e282462 100644
--- a/internal/stage/executor.go
+++ b/internal/stage/executor.go
@@ -3,7 +3,7 @@ package stage
 var executorMap = map[string]Executor{}
 
 type Executor interface {
-	Run(Cmd) (*Result, error)
+	Run(Cmd) (*ExecutorResult, error)
 	Cleanup() error
 }
 
diff --git a/internal/stage/model.go b/internal/stage/model.go
index 3da0242..ef7b92d 100644
--- a/internal/stage/model.go
+++ b/internal/stage/model.go
@@ -104,8 +104,8 @@ func (s *Status) UnmarshalJSON(b []byte) error {
 	return nil
 }
 
-// Result defines single command result
-type Result struct {
+// ExecutorResult defines single command result
+type ExecutorResult struct {
 	Status     Status            `json:"status"`
 	ExitStatus int               `json:"exitStatus"`
 	Error      string            `json:"error,omitempty"`
@@ -119,7 +119,7 @@ type Result struct {
 	Buffs map[string][]byte `json:"-"`
 }
 
-func (r Result) String() string {
+func (r ExecutorResult) String() string {
 	type Result struct {
 		Status     Status
 		ExitStatus int
diff --git a/internal/stage/parser.go b/internal/stage/parser.go
index 5cbc45d..234a850 100644
--- a/internal/stage/parser.go
+++ b/internal/stage/parser.go
@@ -3,7 +3,7 @@ package stage
 var parserMap = map[string]Parser{}
 
 type Parser interface {
-	Run(*Result, any) (*ParserResult, error)
+	Run(*ExecutorResult, any) (*ParserResult, error)
 }
 
 func RegisterParser(name string, parser Parser) {