[CLC-228] Scripting mode (hazelcast#305)

Added the scripting mode

base/commands/demo/dummy.go

@@ -0,0 +1,3 @@
+package demo
+
+// This file exists only for compilation

base/commands/script.go

@@ -65,7 +65,7 @@ func (cm ScriptCommand) Exec(ctx context.Context, ec plug.ExecContext) error {
 		Stderr: ec.Stderr(),
 		Stdout: ec.Stdout(),
 	}
-	m, err := ec.(*cmd.ExecContext).Main().Clone(false)
+	m, err := ec.(*cmd.ExecContext).Main().Clone(cmd.ModeScripting)
 	if err != nil {
 		return fmt.Errorf("cloning Main: %w", err)
 	}

base/commands/shell.go

@@ -59,7 +59,7 @@ func (cm *ShellCommand) ExecInteractive(ctx context.Context, ec plug.ExecContext
 	if len(ec.Args()) > 0 {
 		return puberrors.ErrNotAvailable
 	}
-	m, err := ec.(*cmd.ExecContext).Main().Clone(true)
+	m, err := ec.(*cmd.ExecContext).Main().Clone(cmd.ModeInteractive)
 	if err != nil {
 		return fmt.Errorf("cloning Main: %w", err)
 	}

clc/cmd/clc.go

@@ -30,22 +30,30 @@ var (
 	MainCommandShortHelp = "Hazelcast CLC"
 )
 
+type Mode int
+
+const (
+	ModeNonInteractive Mode = iota
+	ModeInteractive
+	ModeScripting
+)
+
 type Main struct {
-	root          *cobra.Command
-	cmds          map[string]*cobra.Command
-	lg            *logger.Logger
-	stderr        io.WriteCloser
-	stdout        io.WriteCloser
-	stdin         io.Reader
-	isInteractive bool
-	outputFormat  string
-	configLoaded  bool
-	props         *plug.Properties
-	cc            *CommandContext
-	cp            config.Provider
-	arg0          string
-	ciMu          *sync.Mutex
-	ci            *atomic.Pointer[hazelcast.ClientInternal]
+	root         *cobra.Command
+	cmds         map[string]*cobra.Command
+	lg           *logger.Logger
+	stderr       io.WriteCloser
+	stdout       io.WriteCloser
+	stdin        io.Reader
+	mode         Mode
+	outputFormat string
+	configLoaded bool
+	props        *plug.Properties
+	cc           *CommandContext
+	cp           config.Provider
+	arg0         string
+	ciMu         *sync.Mutex
+	ci           *atomic.Pointer[hazelcast.ClientInternal]
 }
 
 func NewMain(arg0, cfgPath string, cfgProvider config.Provider, logPath, logLevel string, sio clc.IO) (*Main, error) {
@@ -91,7 +99,7 @@ func NewMain(arg0, cfgPath string, cfgProvider config.Provider, logPath, logLeve
 	m.props.Set(clc.PropertyConfig, cfgPath)
 	m.props.Set(clc.PropertyLogPath, logPath)
 	m.props.Set(clc.PropertyLogLevel, logLevel)
-	m.cc = NewCommandContext(rc, cfgProvider, m.isInteractive)
+	m.cc = NewCommandContext(rc, cfgProvider, m.mode)
 	if err := m.runInitializers(m.cc); err != nil {
 		return nil, err
 	}
@@ -101,9 +109,9 @@ func NewMain(arg0, cfgPath string, cfgProvider config.Provider, logPath, logLeve
 	return m, nil
 }
 
-func (m *Main) Clone(interactive bool) (*Main, error) {
+func (m *Main) Clone(mode Mode) (*Main, error) {
 	mc := *m
-	mc.isInteractive = true
+	mc.mode = mode
 	rc := &cobra.Command{
 		SilenceErrors: true,
 	}
@@ -120,7 +128,7 @@ func (m *Main) Clone(interactive bool) (*Main, error) {
 		},
 	})
 	mc.cmds = map[string]*cobra.Command{}
-	mc.cc = NewCommandContext(rc, mc.cp, interactive)
+	mc.cc = NewCommandContext(rc, mc.cp, mode)
 	if err := mc.runInitializers(mc.cc); err != nil {
 		return nil, err
 	}
@@ -138,7 +146,7 @@ func (m *Main) Execute(ctx context.Context, args ...string) error {
 	var cm *cobra.Command
 	var cmdArgs []string
 	var err error
-	if !m.isInteractive {
+	if m.mode == ModeNonInteractive {
 		cm, cmdArgs, err = m.root.Find(args)
 		if err != nil {
 			return err
@@ -255,11 +263,11 @@ func (m *Main) createCommands() error {
 	for _, c := range plug.Registry.Commands() {
 		c := c
 		// check if current command available in current mode
-		if !plug.Registry.IsAvailable(m.isInteractive, c.Name) {
+		if !plug.Registry.IsAvailable(m.mode != ModeNonInteractive, c.Name) {
 			continue
 		}
 		// skip interactive commands in interactive mode
-		if m.isInteractive {
+		if m.mode == ModeInteractive {
 			if _, ok := c.Item.(plug.InteractiveCommander); ok {
 				continue
 			}
@@ -290,7 +298,7 @@ func (m *Main) createCommands() error {
 			SilenceUsage: true,
 		}
 		cmd.SetUsageTemplate(usageTemplate)
-		cc := NewCommandContext(cmd, m.cp, m.isInteractive)
+		cc := NewCommandContext(cmd, m.cp, m.mode)
 		if ci, ok := c.Item.(plug.Initializer); ok {
 			if err := ci.Init(cc); err != nil {
 				if errors.Is(err, puberrors.ErrNotAvailable) {
@@ -300,7 +308,7 @@ func (m *Main) createCommands() error {
 			}
 		}
 		// add the backslash prefix for top-level commands in the interactive mode
-		if m.isInteractive && parent == m.root {
+		if m.mode != ModeNonInteractive && parent == m.root {
 			cmd.Use = fmt.Sprintf("\\%s", cmd.Use)
 		}
 		addUniqueCommandGroup(cc, parent)
@@ -320,7 +328,7 @@ func (m *Main) createCommands() error {
 					Stderr: m.stderr,
 					Stdout: m.stdout,
 				}
-				ec, err := NewExecContext(m.lg, sio, m.props, m.isInteractive)
+				ec, err := NewExecContext(m.lg, sio, m.props, m.mode)
 				if err != nil {
 					return err
 				}
@@ -354,7 +362,7 @@ func (m *Main) createCommands() error {
 					return err
 				}
 				if ic, ok := c.Item.(plug.InteractiveCommander); ok {
-					ec.SetInteractive(true)
+					ec.SetMode(ModeInteractive)
 					if _, ok := c.Item.(plug.UnwrappableCommander); ok {
 						err = ic.ExecInteractive(ctx, ec)
 					} else {

clc/cmd/command_context.go

@@ -10,24 +10,24 @@ import (
 )
 
 type CommandContext struct {
-	Cmd           *cobra.Command
-	CP            config.Provider
-	stringValues  map[string]*string
-	boolValues    map[string]*bool
-	intValues     map[string]*int64
-	isInteractive bool
-	isTopLevel    bool
-	group         *cobra.Group
+	Cmd          *cobra.Command
+	CP           config.Provider
+	stringValues map[string]*string
+	boolValues   map[string]*bool
+	intValues    map[string]*int64
+	mode         Mode
+	isTopLevel   bool
+	group        *cobra.Group
 }
 
-func NewCommandContext(cmd *cobra.Command, cfgProvider config.Provider, isInteractive bool) *CommandContext {
+func NewCommandContext(cmd *cobra.Command, cfgProvider config.Provider, mode Mode) *CommandContext {
 	return &CommandContext{
-		Cmd:           cmd,
-		CP:            cfgProvider,
-		stringValues:  map[string]*string{},
-		boolValues:    map[string]*bool{},
-		intValues:     map[string]*int64{},
-		isInteractive: isInteractive,
+		Cmd:          cmd,
+		CP:           cfgProvider,
+		stringValues: map[string]*string{},
+		boolValues:   map[string]*bool{},
+		intValues:    map[string]*int64{},
+		mode:         mode,
 	}
 }
 
@@ -85,7 +85,7 @@ func (cc *CommandContext) Hide() {
 }
 
 func (cc *CommandContext) Interactive() bool {
-	return cc.isInteractive
+	return cc.mode == ModeInteractive
 }
 
 func (cc *CommandContext) SetCommandHelp(long, short string) {
@@ -118,7 +118,7 @@ func (cc *CommandContext) Group() *cobra.Group {
 
 func (cc *CommandContext) AddStringConfig(name, value, flag string, help string) {
 	cc.CP.Set(name, value)
-	if flag != "" && !cc.isInteractive {
+	if flag != "" && !cc.Interactive() {
 		f := cc.Cmd.Flag(flag)
 		if f != nil {
 			cc.CP.BindFlag(name, f)

clc/cmd/exec_context.go

@@ -33,29 +33,29 @@ const (
 type ClientFn func(ctx context.Context, cfg hazelcast.Config) (*hazelcast.ClientInternal, error)
 
 type ExecContext struct {
-	lg            log.Logger
-	stdout        io.Writer
-	stderr        io.Writer
-	stdin         io.Reader
-	args          []string
-	props         *plug.Properties
-	isInteractive bool
-	cmd           *cobra.Command
-	main          *Main
-	spinnerWait   time.Duration
-	printer       plug.Printer
-	cp            config.Provider
-}
-
-func NewExecContext(lg log.Logger, sio clc.IO, props *plug.Properties, interactive bool) (*ExecContext, error) {
+	lg          log.Logger
+	stdout      io.Writer
+	stderr      io.Writer
+	stdin       io.Reader
+	args        []string
+	props       *plug.Properties
+	mode        Mode
+	cmd         *cobra.Command
+	main        *Main
+	spinnerWait time.Duration
+	printer     plug.Printer
+	cp          config.Provider
+}
+
+func NewExecContext(lg log.Logger, sio clc.IO, props *plug.Properties, mode Mode) (*ExecContext, error) {
 	return &ExecContext{
-		lg:            lg,
-		stdout:        sio.Stdout,
-		stderr:        sio.Stderr,
-		stdin:         sio.Stdin,
-		props:         props,
-		isInteractive: interactive,
-		spinnerWait:   1 * time.Second,
+		lg:          lg,
+		stdout:      sio.Stdout,
+		stderr:      sio.Stderr,
+		stdin:       sio.Stdin,
+		props:       props,
+		mode:        mode,
+		spinnerWait: 1 * time.Second,
 	}, nil
 }
 
@@ -137,7 +137,7 @@ func (ec *ExecContext) ClientInternal(ctx context.Context) (*hazelcast.ClientInt
 }
 
 func (ec *ExecContext) Interactive() bool {
-	return ec.isInteractive
+	return ec.mode == ModeInteractive
 }
 
 func (ec *ExecContext) AddOutputRows(ctx context.Context, rows ...output.Row) error {
@@ -159,7 +159,7 @@ func (ec *ExecContext) AddOutputStream(ctx context.Context, ch <-chan output.Row
 
 func (ec *ExecContext) ShowHelpAndExit() {
 	Must(ec.cmd.Help())
-	if !ec.isInteractive {
+	if !ec.Interactive() {
 		os.Exit(0)
 	}
 }
@@ -168,8 +168,8 @@ func (ec *ExecContext) CommandName() string {
 	return ec.cmd.CommandPath()
 }
 
-func (ec *ExecContext) SetInteractive(value bool) {
-	ec.isInteractive = value
+func (ec *ExecContext) SetMode(mode Mode) {
+	ec.mode = mode
 }
 
 // ExecuteBlocking runs the given blocking function.

cmd/clc/imports.go

@@ -11,7 +11,6 @@ import (
 	_ "github.com/hazelcast/hazelcast-commandline-client/base/commands/multimap"
 	_ "github.com/hazelcast/hazelcast-commandline-client/base/commands/object"
 	_ "github.com/hazelcast/hazelcast-commandline-client/base/commands/project"
-	_ "github.com/hazelcast/hazelcast-commandline-client/base/commands/set"
 	_ "github.com/hazelcast/hazelcast-commandline-client/base/commands/queue"
 	_ "github.com/hazelcast/hazelcast-commandline-client/base/commands/set"
 	_ "github.com/hazelcast/hazelcast-commandline-client/base/commands/snapshot"