Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add ability to control a background process execution #71

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion cmd/gophermarttest/gophermart_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"context"
"errors"
"os"
"os/exec"
"syscall"
"time"

Expand Down Expand Up @@ -83,12 +84,16 @@ func (suite *GophermartSuite) SetupSuite() {
ctx, cancel := context.WithTimeout(context.Background(), 20*time.Second)
defer cancel()

err := p.Start(ctx)
waitCh := make(chan error, 1)
err := p.Start(ctx, waitCh)
if err != nil {
suite.T().Errorf("Невозможно запустить процесс командой %s: %s. Переменные окружения: %+v", p, err, envs)
return
}

// Exit tests if background process returns error
suite.controlExecution(p, waitCh)

port := flagGophermartPort
err = p.WaitPort(ctx, "tcp", port)
if err != nil {
Expand Down Expand Up @@ -140,3 +145,27 @@ func (suite *GophermartSuite) stopBinaryProcess(p *fork.BackgroundProcess) {
suite.T().Logf("Получен STDOUT лог процесса:\n\n%s", string(out))
}
}

// controlExecution controls of background process exit with err code
func (suite *GophermartSuite) controlExecution(p *fork.BackgroundProcess, waitCh <-chan error) {
go func() {
err := <-waitCh

ctx, cancel := context.WithTimeout(context.Background(), 500*time.Millisecond)
defer cancel()

var errExit *exec.ExitError
if errors.As(err, &errExit) && errExit.ExitCode() != 0 {
suite.T().Errorf("Процесс %s завершился с ошибкой: %v ", p.String(), errExit)
out := p.Stderr(ctx)
if len(out) > 0 {
suite.T().Logf("Получен STDERR лог процесса:\n\n%s", string(out))
}
out = p.Stdout(ctx)
if len(out) > 0 {
suite.T().Logf("Получен STDOUT лог процесса:\n\n%s", string(out))
}
os.Exit(1)
}
}()
}
305 changes: 155 additions & 150 deletions internal/fork/process.go
Original file line number Diff line number Diff line change
@@ -1,150 +1,155 @@
package fork

import (
"context"
"fmt"
"net"
"os"
"os/exec"
"strings"
"time"
)

// BackgroundProcess является удобной оберткой над exec.Cmd
// для работы с запущенными процессами
type BackgroundProcess struct {
cmd *exec.Cmd
stdout *buffer
stderr *buffer

waitPortInterval time.Duration
waitPortConnTimeout time.Duration
}

// NewBackgroundProcess returns new unstarted background process instance.
func NewBackgroundProcess(ctx context.Context, command string, opts ...ProcessOpt) *BackgroundProcess {
p := &BackgroundProcess{
cmd: exec.CommandContext(ctx, command),
waitPortInterval: 100 * time.Millisecond,
waitPortConnTimeout: 50 * time.Millisecond,
}

for _, opt := range opts {
opt(p)
}

p.stdout = new(buffer)
p.cmd.Stdout = p.stdout
p.stderr = new(buffer)
p.cmd.Stderr = p.stdout

return p
}

// Start является аналогом (*exec.Cmd).Start с поддержкой контекста
func (p *BackgroundProcess) Start(ctx context.Context) error {
startChan := make(chan error, 1)
go func() {
startChan <- p.cmd.Start()
}()

for {
select {
case err := <-startChan:
return err
case <-ctx.Done():
return ctx.Err()
}
}
}

// WaitPort позволяет дождаться занятия порта процессом
func (p *BackgroundProcess) WaitPort(ctx context.Context, network, port string) error {
ticker := time.NewTicker(p.waitPortInterval)
defer ticker.Stop()

port = strings.TrimLeft(port, ":")

for {
select {
case <-ctx.Done():
return ctx.Err()
case <-ticker.C:
conn, _ := net.DialTimeout(network, ":"+port, p.waitPortConnTimeout)
if conn != nil {
_ = conn.Close()
return nil
}
}
}
}

// ListenPort позволяет проверить наличие свободного порта
func (p *BackgroundProcess) ListenPort(ctx context.Context, network, port string) error {
ticker := time.NewTicker(p.waitPortInterval)
defer ticker.Stop()

port = strings.TrimLeft(port, ":")

for {
select {
case <-ctx.Done():
return ctx.Err()
case <-ticker.C:
lc := &net.ListenConfig{}
ln, _ := lc.Listen(ctx, network, ":"+port)
if ln != nil {
defer ln.Close()
done := make(chan struct{})
go func() {
conn, _ := ln.Accept()
if conn != nil {
_ = conn.Close()
}
close(done)
}()
select {
case <-done:
return nil
case <-ctx.Done():
return ctx.Err()
}
}
}
}
}

// Stdout вычитывает и возвращает новый блок данных из stdout
func (p *BackgroundProcess) Stdout(ctx context.Context) []byte {
return p.stdout.Bytes()
}

// Stderr вычитывает и возвращает новый блок данных из stderr
func (p *BackgroundProcess) Stderr(ctx context.Context) []byte {
return p.stderr.Bytes()
}

// Stop пытается остановить процесс последовательной передачей процессу данных сигналов
func (p *BackgroundProcess) Stop(signals ...os.Signal) (exitCode int, err error) {
for _, sig := range signals {
err = p.cmd.Process.Signal(sig)
if err == nil {
break
}
}

if err != nil {
return -1, fmt.Errorf("error sending signal to process: %w", err)
}

state, err := p.cmd.Process.Wait()
if state == nil {
return -1, err
}
return state.ExitCode(), err
}

// String возвращает человекочитаемую команду, которая породила процесс
func (p *BackgroundProcess) String() string {
return p.cmd.String()
}
package fork

import (
"context"
"fmt"
"net"
"os"
"os/exec"
"strings"
"time"
)

// BackgroundProcess является удобной оберткой над exec.Cmd
// для работы с запущенными процессами
type BackgroundProcess struct {
cmd *exec.Cmd
stdout *buffer
stderr *buffer

waitPortInterval time.Duration
waitPortConnTimeout time.Duration
}

// NewBackgroundProcess returns new unstarted background process instance.
func NewBackgroundProcess(ctx context.Context, command string, opts ...ProcessOpt) *BackgroundProcess {
p := &BackgroundProcess{
cmd: exec.CommandContext(ctx, command),
waitPortInterval: 100 * time.Millisecond,
waitPortConnTimeout: 50 * time.Millisecond,
}

for _, opt := range opts {
opt(p)
}

p.stdout = new(buffer)
p.cmd.Stdout = p.stdout
p.stderr = new(buffer)
p.cmd.Stderr = p.stdout

return p
}

// Start является аналогом (*exec.Cmd).Start с поддержкой контекста
// Также предоставляет возможность контролировать выполнение процесса
// с помощью канала waitChan
func (p *BackgroundProcess) Start(ctx context.Context, waitChan ...chan<- error) error {
startChan := make(chan error, 1)
go func() {
startChan <- p.cmd.Start()
if len(waitChan) == 1 {
waitChan[0] <- p.cmd.Wait()
}
}()

for {
select {
case err := <-startChan:
return err
case <-ctx.Done():
return ctx.Err()
}
}
}

// WaitPort позволяет дождаться занятия порта процессом
func (p *BackgroundProcess) WaitPort(ctx context.Context, network, port string) error {
ticker := time.NewTicker(p.waitPortInterval)
defer ticker.Stop()

port = strings.TrimLeft(port, ":")

for {
select {
case <-ctx.Done():
return ctx.Err()
case <-ticker.C:
conn, _ := net.DialTimeout(network, ":"+port, p.waitPortConnTimeout)
if conn != nil {
_ = conn.Close()
return nil
}
}
}
}

// ListenPort позволяет проверить наличие свободного порта
func (p *BackgroundProcess) ListenPort(ctx context.Context, network, port string) error {
ticker := time.NewTicker(p.waitPortInterval)
defer ticker.Stop()

port = strings.TrimLeft(port, ":")

for {
select {
case <-ctx.Done():
return ctx.Err()
case <-ticker.C:
lc := &net.ListenConfig{}
ln, _ := lc.Listen(ctx, network, ":"+port)
if ln != nil {
defer ln.Close()
done := make(chan struct{})
go func() {
conn, _ := ln.Accept()
if conn != nil {
_ = conn.Close()
}
close(done)
}()
select {
case <-done:
return nil
case <-ctx.Done():
return ctx.Err()
}
}
}
}
}

// Stdout вычитывает и возвращает новый блок данных из stdout
func (p *BackgroundProcess) Stdout(ctx context.Context) []byte {
return p.stdout.Bytes()
}

// Stderr вычитывает и возвращает новый блок данных из stderr
func (p *BackgroundProcess) Stderr(ctx context.Context) []byte {
return p.stderr.Bytes()
}

// Stop пытается остановить процесс последовательной передачей процессу данных сигналов
func (p *BackgroundProcess) Stop(signals ...os.Signal) (exitCode int, err error) {
for _, sig := range signals {
err = p.cmd.Process.Signal(sig)
if err == nil {
break
}
}

if err != nil {
return -1, fmt.Errorf("error sending signal to process: %w", err)
}

state, err := p.cmd.Process.Wait()
if state == nil {
return -1, err
}
return state.ExitCode(), err
}

// String возвращает человекочитаемую команду, которая породила процесс
func (p *BackgroundProcess) String() string {
return p.cmd.String()
}