feat: support to terminate script with ctrl+c

LinuxSuRen · LinuxSuRen · commit a5440e21e77a · 2023-02-19T19:40:51.000+08:00
diff --git a/cli/golang_runner.go b/cli/golang_runner.go
@@ -1,6 +1,7 @@
 package cli
 
 import (
+	"context"
 	"fmt"
 	"os"
 	"path"
@@ -21,7 +22,7 @@ func main(){
 `
 
 // Run executes the script
-func (s *GolangScript) Run() (err error) {
+func (s *GolangScript) Run(ctx context.Context) (err error) {
 	s.Content = strings.ReplaceAll(s.Content, "#!title: "+s.Title, "")
 
 	var shellFile string
diff --git a/cli/golang_runner_test.go b/cli/golang_runner_test.go
@@ -1,9 +1,11 @@
 package cli
 
 import (
+	"context"
+	"testing"
+
 	"github.com/linuxsuren/http-downloader/pkg/exec"
 	"github.com/stretchr/testify/assert"
-	"testing"
 )
 
 func TestGolangRunner(t *testing.T) {
@@ -31,7 +33,7 @@ echo 1`,
 				},
 			}
 			assert.Equal(t, tt.title, shell.GetTitle())
-			err := shell.Run()
+			err := shell.Run(context.Background())
 			assert.Equal(t, tt.hasErr, err != nil)
 		})
 	}
diff --git a/cli/python_runner.go b/cli/python_runner.go
@@ -1,6 +1,7 @@
 package cli
 
 import (
+	"context"
 	"os"
 	"path"
 )
@@ -11,7 +12,7 @@ type PythonScript struct {
 }
 
 // Run executes the script
-func (s *PythonScript) Run() (err error) {
+func (s *PythonScript) Run(ctx context.Context) (err error) {
 	var shellFile string
 	if shellFile, err = writeAsShell(s.Content, s.Dir); err == nil {
 		if !s.KeepScripts {
diff --git a/cli/python_runner_test.go b/cli/python_runner_test.go
@@ -1,9 +1,11 @@
 package cli
 
 import (
+	"context"
+	"testing"
+
 	"github.com/linuxsuren/http-downloader/pkg/exec"
 	"github.com/stretchr/testify/assert"
-	"testing"
 )
 
 func TestPythonRunner(t *testing.T) {
@@ -31,7 +33,7 @@ echo 1`,
 				},
 			}
 			assert.Equal(t, tt.title, shell.GetTitle())
-			err := shell.Run()
+			err := shell.Run(context.Background())
 			assert.Equal(t, tt.hasErr, err != nil)
 		})
 	}
diff --git a/cli/root.go b/cli/root.go
@@ -2,9 +2,11 @@
 package cli
 
 import (
+	"context"
 	"fmt"
 	"io"
 	"os"
+	"os/signal"
 	"path"
 	"path/filepath"
 	"strings"
@@ -15,7 +17,7 @@ import (
 	"github.com/spf13/cobra"
 )
 
-// should be inject during the build process
+// should be injected during the build process
 var version string
 
 // NewRootCommand returns the instance of cobra.Command
@@ -35,39 +37,42 @@ func NewRootCommand(execer exec.Execer, out io.Writer) (cmd *cobra.Command) {
 	flags.BoolVarP(&opt.loop, "loop", "", true, "Run the Markdown in loop mode.")
 	flags.BoolVarP(&opt.keepFilter, "keep-filter", "", true, "Indicate if keep the filter.")
 	flags.BoolVarP(&opt.keepScripts, "keep-scripts", "", false, "Indicate if keep the temporary scripts.")
+	flags.IntVarP(&opt.pageSize, "page-size", "", 6, "Number of the select items.")
 	return
 }
 
 func (o *option) runE(cmd *cobra.Command, args []string) (err error) {
-	scriptRunners := NewScriptRunners()
-
-	for _, mdFilePath := range args {
-		var files []string
-		if files, err = filepath.Glob(mdFilePath); err != nil {
-			return
-		}
-
-		for _, file := range files {
-			if !strings.HasSuffix(file, ".md") {
-				continue
+	var scriptRunners ScriptRunners
+	if scriptRunners, err = o.parseMarkdownRunners(args); err == nil && scriptRunners.Size() > 1 {
+		for {
+			if err = o.executeScripts(scriptRunners); err != nil {
+				_, _ = fmt.Fprintln(cmd.ErrOrStderr(), err.Error())
 			}
-			var runners ScriptRunners
-			if runners, err = o.parseMarkdownRunner(file); err != nil {
+
+			if !o.loop {
 				break
 			}
-
-			scriptRunners = append(scriptRunners, runners...)
 		}
 	}
+	return
+}
 
-	if scriptRunners.Size() > 1 {
-		for {
-			if err = o.executeScripts(scriptRunners); err != nil {
-				fmt.Fprintln(cmd.ErrOrStderr(), err.Error())
-			}
+func (o *option) parseMarkdownRunners(files []string) (scriptRunners ScriptRunners, err error) {
+	scriptRunners = NewScriptRunners()
 
-			if !o.loop {
-				break
+	for _, mdFilePath := range files {
+		var files []string
+		if files, err = filepath.Glob(mdFilePath); err == nil {
+			for _, file := range files {
+				if !strings.HasSuffix(file, ".md") {
+					continue
+				}
+				var runners ScriptRunners
+				if runners, err = o.parseMarkdownRunner(file); err != nil {
+					break
+				}
+
+				scriptRunners = append(scriptRunners, runners...)
 			}
 		}
 	}
@@ -147,17 +152,23 @@ type option struct {
 	loop        bool
 	keepFilter  bool
 	keepScripts bool
+	pageSize    int
 
 	execer exec.Execer
 }
 
 func (o *option) executeScripts(scriptRunners ScriptRunners) (err error) {
+	c := make(chan os.Signal)
+	signal.Notify(c, os.Interrupt)
+
 	selector := &survey.MultiSelect{
 		Message: "Choose the code block to run",
 		Options: scriptRunners.GetTitles(),
 	}
 	var titles []string
-	if err = survey.AskOne(selector, &titles, survey.WithKeepFilter(o.keepFilter)); err != nil {
+	if err = survey.AskOne(selector, &titles,
+		survey.WithKeepFilter(o.keepFilter),
+		survey.WithPageSize(o.pageSize)); err != nil {
 		return
 	}
 
@@ -167,9 +178,15 @@ func (o *option) executeScripts(scriptRunners ScriptRunners) (err error) {
 			break
 		}
 
+		ctx, cancel := context.WithCancel(context.Background())
+		go func() {
+			<-c
+			cancel()
+		}()
+
 		if runner := scriptRunners.GetRunner(title); runner == nil {
 			fmt.Println("cannot found runner:", title)
-		} else if err = runner.Run(); err != nil {
+		} else if err = runner.Run(ctx); err != nil {
 			break
 		}
 	}
diff --git a/cli/root_test.go b/cli/root_test.go
@@ -41,7 +41,7 @@ func TestNewRootCommand(t *testing.T) {
 	}
 }
 
-func TestParseMarkdownRUnner(t *testing.T) {
+func TestParseMarkdownRunner(t *testing.T) {
 	opt := &option{}
 	runners, err := opt.parseMarkdownRunner("../README.md")
 	if assert.Nil(t, err) {
@@ -52,3 +52,15 @@ func TestParseMarkdownRUnner(t *testing.T) {
 		assert.NotNil(t, runners.GetRunner("Golang Hello World"))
 	}
 }
+
+func TestParseMarkdownRunners(t *testing.T) {
+	opt := &option{}
+	runners, err := opt.parseMarkdownRunners([]string{"../README.md"})
+	if assert.Nil(t, err) {
+		assert.True(t, len(runners) > 0)
+		assert.NotNil(t, runners.GetRunner("Variable Input Hello World"))
+		assert.NotNil(t, runners.GetRunner("Python Hello World"))
+		assert.NotNil(t, runners.GetRunner("Run long time"))
+		assert.NotNil(t, runners.GetRunner("Golang Hello World"))
+	}
+}
diff --git a/cli/shell_runner.go b/cli/shell_runner.go
@@ -1,6 +1,7 @@
 package cli
 
 import (
+	"context"
 	"io"
 	"os"
 	"path"
@@ -19,13 +20,8 @@ type ShellScript struct {
 }
 
 // Run executes the script
-func (s *ShellScript) Run() (err error) {
-	// handle the break line
-	breakline := regexp.MustCompile(`\\\n`)
-	s.Content = breakline.ReplaceAllString(s.Content, "")
-
-	whitespaces := regexp.MustCompile(` +`)
-	s.Content = whitespaces.ReplaceAllString(s.Content, " ")
+func (s *ShellScript) Run(ctx context.Context) (err error) {
+	s.Content = strings.ReplaceAll(s.Content, "\r\n", "\n")
 
 	lines := strings.Split(s.Content, "\n")[1:]
 
@@ -89,6 +85,11 @@ func (s *ShellScript) runCmdLine(cmdLine, contextDir string, keepScripts bool) (
 }
 
 func findPotentialCommands(cmdLine string) (cmds []string) {
+	// TODO should find a better way to skip EOF part
+	if strings.Contains(cmdLine, "EOF") {
+		return
+	}
+
 	lines := strings.Split(cmdLine, "\n")
 	for _, line := range lines {
 		line = strings.TrimSpace(line)
diff --git a/cli/shell_runner_test.go b/cli/shell_runner_test.go
@@ -1,6 +1,7 @@
 package cli
 
 import (
+	"context"
 	"testing"
 
 	"github.com/linuxsuren/http-downloader/pkg/exec"
@@ -41,7 +42,7 @@ echo 1`,
 				ShellType: tt.shellType,
 			}
 			assert.Equal(t, tt.title, shell.GetTitle())
-			err := shell.Run()
+			err := shell.Run(context.Background())
 			assert.Equal(t, tt.hasErr, err != nil)
 		})
 	}
@@ -105,6 +106,11 @@ docker ps`,
 		name:   "with extra whitespace",
 		cmd:    " k3d   create    cluster",
 		expect: []string{"k3d"},
+	}, {
+		name: "with EOF",
+		cmd: `EOF
+k3d create cluster`,
+		expect: nil,
 	}}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
diff --git a/cli/types.go b/cli/types.go
@@ -1,6 +1,10 @@
 package cli
 
-import "github.com/linuxsuren/http-downloader/pkg/exec"
+import (
+	"context"
+
+	"github.com/linuxsuren/http-downloader/pkg/exec"
+)
 
 // Script represents a script object
 type Script struct {
@@ -14,7 +18,7 @@ type Script struct {
 
 // ScriptRunner is the interface of a common runner
 type ScriptRunner interface {
-	Run() error
+	Run(context.Context) error
 	GetTitle() string
 }
 
@@ -54,7 +58,7 @@ func (s ScriptRunners) Size() int {
 type QuitRunner struct{}
 
 // Run does nothing
-func (r *QuitRunner) Run() error {
+func (r *QuitRunner) Run(context.Context) error {
 	return nil
 }
 
diff --git a/cli/types_test.go b/cli/types_test.go
@@ -1,6 +1,7 @@
 package cli
 
 import (
+	"context"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -16,7 +17,7 @@ func TestScriptRunners(t *testing.T) {
 	quitRunner := runners.GetRunner("Quit")
 	if assert.NotNil(t, quitRunner) {
 		assert.Equal(t, "Quit", quitRunner.GetTitle())
-		assert.Nil(t, quitRunner.Run())
+		assert.Nil(t, quitRunner.Run(context.Background()))
 	}
 	assert.Equal(t, []string{"Quit"}, runners.GetTitles())
 }

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,11 @@`
`1`	`1`	`package cli`
`2`	`2`
`3`	`3`	`import (`
	`4`	`+ "context"`
	`5`	`+ "testing"`
	`6`	`+`
`4`	`7`	`"github.com/linuxsuren/http-downloader/pkg/exec"`
`5`	`8`	`"github.com/stretchr/testify/assert"`
`6`		`- "testing"`
`7`	`9`	`)`
`8`	`10`
`9`	`11`	`func TestGolangRunner(t *testing.T) {`
@@ -31,7 +33,7 @@ echo 1`,
`31`	`33`	`},`
`32`	`34`	`}`
`33`	`35`	`assert.Equal(t, tt.title, shell.GetTitle())`
`34`		`- err := shell.Run()`
	`36`	`+ err := shell.Run(context.Background())`
`35`	`37`	`assert.Equal(t, tt.hasErr, err != nil)`
`36`	`38`	`})`
`37`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package cli`
`2`	`2`
`3`	`3`	`import (`
	`4`	`+ "context"`
`4`	`5`	`"os"`
`5`	`6`	`"path"`
`6`	`7`	`)`
`@@ -11,7 +12,7 @@ type PythonScript struct {`
`11`	`12`	`}`
`12`	`13`
`13`	`14`	`// Run executes the script`
`14`		`-func (s *PythonScript) Run() (err error) {`
	`15`	`+func (s *PythonScript) Run(ctx context.Context) (err error) {`
`15`	`16`	`var shellFile string`
`16`	`17`	`if shellFile, err = writeAsShell(s.Content, s.Dir); err == nil {`
`17`	`18`	`if !s.KeepScripts {`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ func TestNewRootCommand(t *testing.T) {`
`41`	`41`	`}`
`42`	`42`	`}`
`43`	`43`
`44`		`-func TestParseMarkdownRUnner(t *testing.T) {`
	`44`	`+func TestParseMarkdownRunner(t *testing.T) {`
`45`	`45`	`opt := &option{}`
`46`	`46`	`runners, err := opt.parseMarkdownRunner("../README.md")`
`47`	`47`	`if assert.Nil(t, err) {`
`@@ -52,3 +52,15 @@ func TestParseMarkdownRUnner(t *testing.T) {`
`52`	`52`	`assert.NotNil(t, runners.GetRunner("Golang Hello World"))`
`53`	`53`	`}`
`54`	`54`	`}`
	`55`	`+`
	`56`	`+func TestParseMarkdownRunners(t *testing.T) {`
	`57`	`+ opt := &option{}`
	`58`	`+ runners, err := opt.parseMarkdownRunners([]string{"../README.md"})`
	`59`	`+ if assert.Nil(t, err) {`
	`60`	`+ assert.True(t, len(runners) > 0)`
	`61`	`+ assert.NotNil(t, runners.GetRunner("Variable Input Hello World"))`
	`62`	`+ assert.NotNil(t, runners.GetRunner("Python Hello World"))`
	`63`	`+ assert.NotNil(t, runners.GetRunner("Run long time"))`
	`64`	`+ assert.NotNil(t, runners.GetRunner("Golang Hello World"))`
	`65`	`+ }`
	`66`	`+}`