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.

Sign up for GitHub

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

Integration tests: write more logs, check exit code #152

Merged
merged 1 commit into from
May 27, 2020
Merged

Integration tests: write more logs, check exit code #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ jobs:
name: Integration tests
command: |
make integration
- store_artifacts:
path: /tmp/scion-apps-integration/
- save_cache:
key: v1-pkg-cache-{{ checksum "~/scion/go.sum" }}-{{ checksum "go.sum" }}
paths:
Expand Down
10 changes: 1 addition & 9 deletions _examples/helloworld/helloworld_integration_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ func TestHelloworldSample(t *testing.T) {
if err := integration.Init(name); err != nil {
t.Fatalf("Failed to init: %s\n", err)
}
cmd := integration.AppBinPath(bin)
cmd := integration.AppBinPath(bin)
// Common arguments
cmnArgs := []string{}
// Server
Expand All @@ -59,14 +59,6 @@ func TestHelloworldSample(t *testing.T) {
integration.Contains("Done. Wrote 11 bytes."),
nil,
},
{
"client_error",
append([]string{"-remote", "1-ff00:0:bad,[127.0.0.1]:" + serverPort}, cmnArgs...),
nil,
nil,
nil,
integration.RegExp("^Fatal error.*err_code=\"No paths available\"$"),
},
}

for _, tc := range testCases {
Expand Down
13 changes: 6 additions & 7 deletions netcat/netcat_integration_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ func TestIntegrationScionNetcat(t *testing.T) {
},
{
"client_hello",
append(cmnArgs, integration.DstAddrPattern + ":" + serverPort),
append(cmnArgs, integration.DstAddrPattern+":"+serverPort),
integration.RegExp(fmt.Sprintf("^%s$", testMessage)),
nil,
nil,
Expand All @@ -100,7 +100,7 @@ func TestIntegrationScionNetcat(t *testing.T) {
IAPairs := integration.IAPairs(hostAddr)
IAPairs = IAPairs[:5]

if err := integration.RunTests(in, IAPairs, integration.DefaultClientTimeout, 250 * time.Millisecond); err != nil {
if err := integration.RunTests(in, IAPairs, integration.DefaultClientTimeout, 250*time.Millisecond); err != nil {
t.Fatalf("Error during tests err: %v", err)
}
}
Expand Down Expand Up @@ -140,7 +140,7 @@ func TestIntegrationScionNetcatUDP(t *testing.T) {
}{
{
"client_hello_UDP",
append(cmnArgs, integration.DstAddrPattern + ":" + serverPort),
append(cmnArgs, integration.DstAddrPattern+":"+serverPort),
nil,
nil,
nil,
Expand All @@ -160,14 +160,13 @@ func TestIntegrationScionNetcatUDP(t *testing.T) {
IAPairs := integration.IAPairs(hostAddr)
IAPairs = IAPairs[:5]

if err := integration.RunTests(in, IAPairs, integration.DefaultClientTimeout, 250 * time.Millisecond); err != nil {
if err := integration.RunTests(in, IAPairs, integration.DefaultClientTimeout, 250*time.Millisecond); err != nil {
t.Fatalf("Error during tests err: %v", err)
}
}
}


func wrapperCommand(tmpDir string, inputSource string, command string) (wrapperCmd string, err error){
func wrapperCommand(tmpDir string, inputSource string, command string) (wrapperCmd string, err error) {
wrapperCmd = path.Join(tmpDir, fmt.Sprintf("%s_wrapper.sh", serverBin))
f, err := os.OpenFile(wrapperCmd, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0777)
if err != nil {
Expand All @@ -176,7 +175,7 @@ func wrapperCommand(tmpDir string, inputSource string, command string) (wrapperC
defer f.Close()
w := bufio.NewWriter(f)
defer w.Flush()
_, _ = w.WriteString(fmt.Sprintf("#!/bin/bash\ntimeout 5 /bin/bash -c \"%s | %s $1 $2 $3 $4\"",
_, _ = w.WriteString(fmt.Sprintf("#!/bin/bash\ntimeout 5 /bin/bash -c \"%s | %s $1 $2 $3 $4\" || true",
inputSource, command))
return wrapperCmd, nil
}
115 changes: 48 additions & 67 deletions pkg/integration/apps.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"io/ioutil"
"os"
"os/exec"
"path"
"regexp"
"strings"
"time"
Expand Down Expand Up @@ -107,14 +108,17 @@ func (sai *ScionAppsIntegration) StartServer(ctx context.Context,
return nil, err
}

logfile := fmt.Sprintf("server_%s", dst.IA.FileFmt(false))
startInfo := dst.IA.FileFmt(false)

ready := make(chan struct{})
signal := ReadySignal
init := true
// parse stdout until we have the ready signal
// and check the output with serverOutMatchFun.
sp = sai.pipeLog(logfile+".log", startInfo, sp)
go func() {
defer log.HandlePanic()
defer sp.Close()

var stdoutMatch bool
scanner := bufio.NewScanner(sp)
Expand All @@ -131,7 +135,6 @@ func (sai *ScionAppsIntegration) StartServer(ctx context.Context,
if sai.serverOutMatchFun != nil {
stdoutMatch = sai.serverOutMatchFun(stdoutMatch, line)
}
log.Debug("Server stdout", "log line", line)
}
if sai.serverOutMatchFun != nil {
r.stdoutMatch <- stdoutMatch
Expand All @@ -140,25 +143,10 @@ func (sai *ScionAppsIntegration) StartServer(ctx context.Context,
}
}()

var logPipeR *io.PipeReader
var logPipeW *io.PipeWriter
if sai.logDir != "" {
// log stderr to file
logPipeR, logPipeW = io.Pipe()
go func() {
sai.writeLog("server", dst.IA.FileFmt(false), dst.IA.FileFmt(false), logPipeR)
}()
}

// Check the stderr with serverErrMatchFun.
ep = sai.pipeLog(logfile+".err", startInfo, ep)
go func() {
defer log.HandlePanic()
defer ep.Close()
defer func() {
if logPipeW != nil {
_ = logPipeW.Close()
}
}()
var stderrMatch bool
scanner := bufio.NewScanner(ep)
for scanner.Scan() {
Expand All @@ -174,11 +162,6 @@ func (sai *ScionAppsIntegration) StartServer(ctx context.Context,
if sai.serverErrMatchFun != nil {
stderrMatch = sai.serverErrMatchFun(stderrMatch, line)
}
log.Debug("Server stderr", "log line", line)
if logPipeW != nil {
// Propagate to file logger
_, _ = fmt.Fprint(logPipeW, fmt.Sprintf("%s\n", line))
}
}
if sai.serverErrMatchFun != nil {
r.stderrMatch <- stderrMatch
Expand Down Expand Up @@ -230,6 +213,10 @@ func (sai *ScionAppsIntegration) StartClient(ctx context.Context,
return nil, err
}

logfile := fmt.Sprintf("client_%s", clientID(src, dst))
startInfo := fmt.Sprintf("%s -> %s", src.IA, dst.IA)

sp = sai.pipeLog(logfile+".log", startInfo, sp)
// check the output with clientOutMatchFun
go func() {
var stdoutMatch bool
Expand All @@ -242,7 +229,6 @@ func (sai *ScionAppsIntegration) StartClient(ctx context.Context,
if sai.clientOutMatchFun != nil {
stdoutMatch = sai.clientOutMatchFun(stdoutMatch, line)
}
log.Debug("Client stdout", "msg", line)
}
if sai.clientOutMatchFun != nil {
r.stdoutMatch <- stdoutMatch
Expand All @@ -251,23 +237,9 @@ func (sai *ScionAppsIntegration) StartClient(ctx context.Context,
}
}()

var logPipeR *io.PipeReader
var logPipeW *io.PipeWriter
if sai.logDir != "" {
// log stderr to file
logPipeR, logPipeW = io.Pipe()
go func() {
sai.writeLog("client", clientID(src, dst), fmt.Sprintf("%s -> %s", src.IA, dst.IA), logPipeR)
}()
}

// Check the stderr with clientErrMatchFun
ep = sai.pipeLog(logfile+".err", startInfo, ep)
go func() {
defer func() {
if logPipeW != nil {
_ = logPipeW.Close()
}
}()
var stderrMatch bool
scanner := bufio.NewScanner(ep)
for scanner.Scan() {
Expand All @@ -278,11 +250,6 @@ func (sai *ScionAppsIntegration) StartClient(ctx context.Context,
if sai.clientErrMatchFun != nil {
stderrMatch = sai.clientErrMatchFun(stderrMatch, line)
}
log.Debug("Client stderr", "msg", line)
if logPipeW != nil {
// Propagate to file logger
_, _ = fmt.Fprint(logPipeW, fmt.Sprintf("%s\n", line))
}
}
if sai.clientErrMatchFun != nil {
r.stderrMatch <- stderrMatch
Expand Down Expand Up @@ -311,7 +278,12 @@ func (sai *ScionAppsIntegration) ClientStderr(errMatch func(bool, string) bool)
}

func (sai *ScionAppsIntegration) initLogDir(name string) error {
logDir, err := ioutil.TempDir("", name)
tmpDir := path.Join(os.TempDir(), "scion-apps-integration")
err := os.MkdirAll(tmpDir, 0777)
if err != nil {
log.Error("Failed to create log folder for testrun", "dir", tmpDir, "err", err)
}
logDir, err := ioutil.TempDir(tmpDir, name)
if err != nil {
log.Error("Failed to create log folder for testrun", "dir", name, "err", err)
return err
Expand All @@ -321,32 +293,34 @@ func (sai *ScionAppsIntegration) initLogDir(name string) error {
return nil
}

func (sai *ScionAppsIntegration) writeLog(name, id, startInfo string, ep io.ReadCloser) {
defer ep.Close()
f, err := os.OpenFile(fmt.Sprintf("%s/%s_%s.log", sai.logDir, name, id),
os.O_CREATE|os.O_WRONLY, os.FileMode(0644))
func (sai *ScionAppsIntegration) pipeLog(name, startInfo string, r io.ReadCloser) io.ReadCloser {
if sai.logDir != "" {
// tee to log
pipeR, pipeW := io.Pipe()
tee := io.TeeReader(r, pipeW)
go func() {
sai.writeLog(name, startInfo, tee)
pipeW.Close()
}()
return pipeR
}
return r
}

func (sai *ScionAppsIntegration) writeLog(name, startInfo string, pipe io.Reader) {
file := path.Join(sai.logDir, name)
f, err := os.OpenFile(file, os.O_CREATE|os.O_APPEND|os.O_WRONLY, os.FileMode(0644))
if err != nil {
log.Error("Failed to create log file for test run (create)",
"name", name, "id", id, "err", err)
"file", file, "err", err)
return
}
defer f.Close()
// seek to end of file.
if _, err := f.Seek(0, 2); err != nil {
log.Error("Failed to create log file for test run (seek)",
"name", name, "id", id, "err", err)
return
}
w := bufio.NewWriter(f)
defer w.Flush()
_, _ = w.WriteString(sintegration.WithTimestamp(fmt.Sprintf("Starting %s %s\n", name, startInfo)))
_, _ = f.WriteString(sintegration.WithTimestamp(fmt.Sprintf("Starting %s %s\n", name, startInfo)))
defer func() {
_, _ = w.WriteString(sintegration.WithTimestamp(fmt.Sprintf("Finished %s %s\n", name, startInfo)))
_, _ = f.WriteString(sintegration.WithTimestamp(fmt.Sprintf("Finished %s %s\n", name, startInfo)))
}()
scanner := bufio.NewScanner(ep)
for scanner.Scan() {
_, _ = w.WriteString(fmt.Sprintf("%s\n", scanner.Text()))
}
_, _ = io.Copy(f, pipe)
}

func clientID(src, dst *snet.UDPAddr) string {
Expand All @@ -361,14 +335,21 @@ type appsWaiter struct {
stderrMatch chan bool
}

func (aw *appsWaiter) Wait() (err error) {
_, _ = aw.Process.Wait()
func (aw *appsWaiter) Wait() error {
state, err := aw.Process.Wait()
if err != nil {
return err
}
if state.ExitCode() > 0 { // Ignore servers killed by the framework
return fmt.Errorf("the program under test returned non-zero exit code:\n%s [exit code=%d]",
aw.Cmd.String(), state.ExitCode())
}
err = checkOutputMatches(aw.stdoutMatch, aw.stderrMatch)
if err != nil {
return err
}
_ = aw.Cmd.Wait()
return
return nil
}

func checkOutputMatches(stdoutRes chan bool, stderrRes chan bool) error {
Expand Down