Merge pull request #84 from Microsoft/console_resize

Adds console resize support.

service/gcs/bridge/bridge.go

@@ -355,8 +355,6 @@ func (b *bridge) waitOnProcess(message []byte, header *prot.MessageHeader) (*pro
 	return response, nil
 }
 
-// resizeConsole is currently a nop until the functionality is implemented.
-// TODO: Tests still need to be written when it's no longer a nop.
 func (b *bridge) resizeConsole(message []byte) (*prot.MessageResponseBase, error) {
 	response := newResponseBase()
 	var request prot.ContainerResizeConsole
@@ -365,7 +363,9 @@ func (b *bridge) resizeConsole(message []byte) (*prot.MessageResponseBase, error
 	}
 	response.ActivityID = request.ActivityID
 
-	// NOP
+	if err := b.coreint.ResizeConsole(int(request.ProcessID), request.Height, request.Width); err != nil {
+		return response, err
+	}
 
 	return response, nil
 }

service/gcs/bridge/bridge_test.go

@@ -587,7 +587,7 @@ var _ = Describe("Bridge", func() {
 		Describe("calling resizeConsole", func() {
 			var (
 				response prot.MessageResponseBase
-				//callArgs mockcore.ResizeConsoleCall
+				callArgs mockcore.ResizeConsoleCall
 			)
 			BeforeEach(func() {
 				messageType = prot.ComputeSystemResizeConsoleV1
@@ -597,7 +597,7 @@ var _ = Describe("Bridge", func() {
 				err := json.Unmarshal([]byte(responseString), &response)
 				Expect(err).NotTo(HaveOccurred())
 				responseBase = &response
-				//callArgs = coreint.LastResizeConsole
+				callArgs = coreint.LastResizeConsole
 			})
 			Context("the message is normal ASCII", func() {
 				BeforeEach(func() {
@@ -613,10 +613,10 @@ var _ = Describe("Bridge", func() {
 				})
 				AssertNoResponseErrors()
 				AssertActivityIDCorrect()
-				// TODO: Add tests on callArgs when resizing the console is
-				// implemented.
 				It("should receive the correct values", func() {
-					//e.g. Expect(callArgs.Pid).To(Equal(101))
+					Expect(callArgs.Pid).To(Equal(101))
+					Expect(callArgs.Height).To(Equal(uint16(30)))
+					Expect(callArgs.Width).To(Equal(uint16(72)))
 				})
 			})
 		})

service/gcs/core/core.go

@@ -22,4 +22,5 @@ type Core interface {
 	ModifySettings(id string, request prot.ResourceModificationRequestResponse) error
 	RegisterContainerExitHook(id string, onExit func(oslayer.ProcessExitState)) error
 	RegisterProcessExitHook(pid int, onExit func(oslayer.ProcessExitState)) error
+	ResizeConsole(pid int, height, width uint16) error
 }

service/gcs/core/gcs/gcs.go

@@ -16,10 +16,10 @@ import (
 	"github.com/Microsoft/opengcs/service/gcs/prot"
 	"github.com/Microsoft/opengcs/service/gcs/runtime"
 	"github.com/Microsoft/opengcs/service/gcs/stdio"
-	"github.com/sirupsen/logrus"
 	shellwords "github.com/mattn/go-shellwords"
 	oci "github.com/opencontainers/runtime-spec/specs-go"
 	"github.com/pkg/errors"
+	"github.com/sirupsen/logrus"
 )
 
 // gcsCore is an implementation of the Core interface, defining the
@@ -38,39 +38,31 @@ type gcsCore struct {
 	containerCache map[string]*containerCacheEntry
 
 	processCacheMutex sync.RWMutex
-	// processCache stores information about processes which persists between
-	// calls into the gcsCore. It is structured as a map from pid to cache
-	// entry.
+	// processCache stores information about processes which persists between calls
+	// into the gcsCore. It is structured as a map from pid to cache entry.
 	processCache map[int]*processCacheEntry
-
-	externalProcessCacheMutex sync.RWMutex
-	// externalProcessCache stores information about external processes which
-	// persists between calls into the gcsCore. It is structured as a map from
-	// pid to cache entry.
-	externalProcessCache map[int]*processCacheEntry
 }
 
 // NewGCSCore creates a new gcsCore struct initialized with the given Runtime.
 func NewGCSCore(rtime runtime.Runtime, os oslayer.OS) *gcsCore {
 	return &gcsCore{
-		Rtime:                rtime,
-		OS:                   os,
-		containerCache:       make(map[string]*containerCacheEntry),
-		processCache:         make(map[int]*processCacheEntry),
-		externalProcessCache: make(map[int]*processCacheEntry),
+		Rtime:          rtime,
+		OS:             os,
+		containerCache: make(map[string]*containerCacheEntry),
+		processCache:   make(map[int]*processCacheEntry),
 	}
 }
 
 // containerCacheEntry stores cached information for a single container.
 type containerCacheEntry struct {
 	ID                 string
 	ExitStatus         oslayer.ProcessExitState
-	Processes          []int
 	ExitHooks          []func(oslayer.ProcessExitState)
 	MappedVirtualDisks map[uint8]prot.MappedVirtualDisk
 	MappedDirectories  map[uint32]prot.MappedDirectory
 	NetworkAdapters    []prot.NetworkAdapter
 	container          runtime.Container
+	hasRunInitProcess  bool
 }
 
 func newContainerCacheEntry(id string) *containerCacheEntry {
@@ -83,9 +75,6 @@ func newContainerCacheEntry(id string) *containerCacheEntry {
 func (e *containerCacheEntry) AddExitHook(hook func(oslayer.ProcessExitState)) {
 	e.ExitHooks = append(e.ExitHooks, hook)
 }
-func (e *containerCacheEntry) AddProcess(pid int) {
-	e.Processes = append(e.Processes, pid)
-}
 func (e *containerCacheEntry) AddNetworkAdapter(adapter prot.NetworkAdapter) {
 	e.NetworkAdapters = append(e.NetworkAdapters, adapter)
 }
@@ -120,12 +109,14 @@ func (e *containerCacheEntry) RemoveMappedDirectory(dir prot.MappedDirectory) {
 
 // processCacheEntry stores cached information for a single process.
 type processCacheEntry struct {
-	ExitStatus oslayer.ProcessExitState
-	ExitHooks  []func(oslayer.ProcessExitState)
+	ExitStatus  oslayer.ProcessExitState
+	ExitHooks   []func(oslayer.ProcessExitState)
+	Tty         *stdio.TtyRelay
+	ContainerID string // If "" a host process otherwise a container process.
 }
 
-func newProcessCacheEntry() *processCacheEntry {
-	return &processCacheEntry{}
+func newProcessCacheEntry(containerID string) *processCacheEntry {
+	return &processCacheEntry{ContainerID: containerID}
 }
 func (e *processCacheEntry) AddExitHook(hook func(oslayer.ProcessExitState)) {
 	e.ExitHooks = append(e.ExitHooks, hook)
@@ -203,12 +194,11 @@ func (c *gcsCore) ExecProcess(id string, params prot.ProcessParameters, stdioSet
 	if containerEntry == nil {
 		return -1, errors.WithStack(gcserr.NewContainerDoesNotExistError(id))
 	}
-	processEntry := newProcessCacheEntry()
+	processEntry := newProcessCacheEntry(id)
 
 	var p runtime.Process
-
-	isInitProcess := len(containerEntry.Processes) == 0
-	if isInitProcess {
+	if !containerEntry.hasRunInitProcess {
+		containerEntry.hasRunInitProcess = true
 		if err := c.writeConfigFile(id, params.OCISpecification); err != nil {
 			return -1, err
 		}
@@ -220,6 +210,7 @@ func (c *gcsCore) ExecProcess(id string, params prot.ProcessParameters, stdioSet
 
 		containerEntry.container = container
 		p = container
+		processEntry.Tty = p.Tty()
 
 		// Configure network adapters in the namespace.
 		for _, adapter := range containerEntry.NetworkAdapters {
@@ -271,6 +262,7 @@ func (c *gcsCore) ExecProcess(id string, params prot.ProcessParameters, stdioSet
 		if err != nil {
 			return -1, err
 		}
+		processEntry.Tty = p.Tty()
 
 		go func() {
 			state, err := p.Wait()
@@ -306,7 +298,6 @@ func (c *gcsCore) ExecProcess(id string, params prot.ProcessParameters, stdioSet
 	// applies to external processes as well.
 	c.processCache[p.Pid()] = processEntry
 	c.processCacheMutex.Unlock()
-	containerEntry.AddProcess(p.Pid())
 	return p.Pid(), nil
 }
 
@@ -332,16 +323,11 @@ func (c *gcsCore) SignalContainer(id string, signal oslayer.Signal) error {
 // SignalProcess sends the signal specified in options to the given process.
 func (c *gcsCore) SignalProcess(pid int, options prot.SignalProcessOptions) error {
 	c.processCacheMutex.Lock()
-	c.externalProcessCacheMutex.Lock()
 	if _, ok := c.processCache[pid]; !ok {
-		if _, ok := c.externalProcessCache[pid]; !ok {
-			c.processCacheMutex.Unlock()
-			c.externalProcessCacheMutex.Unlock()
-			return errors.WithStack(gcserr.NewProcessDoesNotExistError(pid))
-		}
+		c.processCacheMutex.Unlock()
+		return errors.WithStack(gcserr.NewProcessDoesNotExistError(pid))
 	}
 	c.processCacheMutex.Unlock()
-	c.externalProcessCacheMutex.Unlock()
 
 	// Interpret signal value 0 as SIGKILL.
 	// TODO: Remove this special casing when we are not worried about breaking
@@ -398,8 +384,8 @@ func (c *gcsCore) RunExternalProcess(params prot.ProcessParameters, stdioSet *st
 	if params.EmulateConsole {
 		// Allocate a console for the process.
 		var (
-			consolePath string
 			master      *os.File
+			consolePath string
 		)
 		master, consolePath, err = stdio.NewConsole()
 		if err != nil {
@@ -440,7 +426,8 @@ func (c *gcsCore) RunExternalProcess(params prot.ProcessParameters, stdioSet *st
 		relay.Start()
 	}
 
-	processEntry := newProcessCacheEntry()
+	processEntry := newProcessCacheEntry("")
+	processEntry.Tty = relay
 	go func() {
 		if err := cmd.Wait(); err != nil {
 			// TODO: When cmd is a shell, and last command in the shell
@@ -458,18 +445,18 @@ func (c *gcsCore) RunExternalProcess(params prot.ProcessParameters, stdioSet *st
 
 		// Run exit hooks for the process.
 		state := cmd.ExitState()
-		c.externalProcessCacheMutex.Lock()
+		c.processCacheMutex.Lock()
 		processEntry.ExitStatus = state
 		for _, hook := range processEntry.ExitHooks {
 			hook(state)
 		}
-		c.externalProcessCacheMutex.Unlock()
+		c.processCacheMutex.Unlock()
 	}()
 
 	pid = cmd.Process().Pid()
-	c.externalProcessCacheMutex.Lock()
-	c.externalProcessCache[pid] = processEntry
-	c.externalProcessCacheMutex.Unlock()
+	c.processCacheMutex.Lock()
+	c.processCache[pid] = processEntry
+	c.processCacheMutex.Unlock()
 	return pid, nil
 }
 
@@ -556,17 +543,11 @@ func (c *gcsCore) RegisterContainerExitHook(id string, exitHook func(oslayer.Pro
 func (c *gcsCore) RegisterProcessExitHook(pid int, exitHook func(oslayer.ProcessExitState)) error {
 	c.processCacheMutex.Lock()
 	defer c.processCacheMutex.Unlock()
-	c.externalProcessCacheMutex.Lock()
-	defer c.externalProcessCacheMutex.Unlock()
 
 	var entry *processCacheEntry
 	var ok bool
-	entry, ok = c.processCache[pid]
-	if !ok {
-		entry, ok = c.externalProcessCache[pid]
-		if !ok {
-			return errors.WithStack(gcserr.NewProcessDoesNotExistError(pid))
-		}
+	if entry, ok = c.processCache[pid]; !ok {
+		return errors.WithStack(gcserr.NewProcessDoesNotExistError(pid))
 	}
 
 	exitStatus := entry.ExitStatus
@@ -580,6 +561,23 @@ func (c *gcsCore) RegisterProcessExitHook(pid int, exitHook func(oslayer.Process
 	return nil
 }
 
+func (c *gcsCore) ResizeConsole(pid int, height, width uint16) error {
+	c.processCacheMutex.Lock()
+	var p *processCacheEntry
+	var ok bool
+	if p, ok = c.processCache[pid]; !ok {
+		c.processCacheMutex.Unlock()
+		return errors.WithStack(gcserr.NewProcessDoesNotExistError(pid))
+	}
+	c.processCacheMutex.Unlock()
+
+	if p.Tty == nil {
+		return fmt.Errorf("pid: %d, is not a tty and cannot be resized", pid)
+	}
+
+	return p.Tty.ResizeConsole(height, width)
+}
+
 // setupMappedVirtualDisks is a helper function which calls into the functions
 // in storage.go to set up a set of mapped virtual disks for a given container.
 // It then adds them to the container's cache entry.

service/gcs/core/mockcore/mockcore.go

@@ -65,6 +65,13 @@ type RegisterProcessExitHookCall struct {
 	ExitHook func(oslayer.ProcessExitState)
 }
 
+// ResizeConsoleCall captures the arguments of ResizeConsole
+type ResizeConsoleCall struct {
+	Pid    int
+	Height uint16
+	Width  uint16
+}
+
 // MockCore serves as an argument capture mechanism which implements the Core
 // interface. Arguments passed to one of its methods are stored to be queried
 // later.
@@ -78,6 +85,7 @@ type MockCore struct {
 	LastModifySettings            ModifySettingsCall
 	LastRegisterContainerExitHook RegisterContainerExitHookCall
 	LastRegisterProcessExitHook   RegisterProcessExitHookCall
+	LastResizeConsole             ResizeConsoleCall
 }
 
 // CreateContainer captures its arguments and returns a nil error.
@@ -167,3 +175,14 @@ func (c *MockCore) RegisterProcessExitHook(pid int, exitHook func(oslayer.Proces
 	exitHook(mockos.NewProcessExitState(103))
 	return nil
 }
+
+// ResizeConsole captures its arguments and returns a nil error.
+func (c *MockCore) ResizeConsole(pid int, height, width uint16) error {
+	c.LastResizeConsole = ResizeConsoleCall{
+		Pid:    pid,
+		Height: height,
+		Width:  width,
+	}
+
+	return nil
+}

service/gcs/runtime/mockruntime/mockruntime.go

@@ -46,6 +46,10 @@ func (c *container) Pid() int {
 	return 101
 }
 
+func (c *container) Tty() *stdio.TtyRelay {
+	return nil
+}
+
 func (c *container) ExecProcess(process oci.Process, stdioSet *stdio.ConnectionSet) (p runtime.Process, err error) {
 	return c, nil
 }

service/gcs/runtime/runc/runc.go

@@ -48,6 +48,10 @@ func (c *container) Pid() int {
 	return c.init.Pid()
 }
 
+func (c *container) Tty() *stdio.TtyRelay {
+	return c.init.relay
+}
+
 type process struct {
 	c     *container
 	pid   int
@@ -58,6 +62,10 @@ func (p *process) Pid() int {
 	return p.pid
 }
 
+func (p *process) Tty() *stdio.TtyRelay {
+	return p.relay
+}
+
 // NewRuntime instantiates a new runcRuntime struct.
 func NewRuntime() (*runcRuntime, error) {
 	rtime := &runcRuntime{}

service/gcs/runtime/runtime.go

@@ -43,6 +43,7 @@ type Process interface {
 	Wait() (oslayer.ProcessExitState, error)
 	Pid() int
 	Delete() error
+	Tty() *stdio.TtyRelay
 }
 
 // Container is an interface to manipulate container state.