Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix handleSummaryResult() usage and add tests
Browse files Browse the repository at this point in the history
na-- committed Jan 15, 2021
1 parent c00a85b commit 9f58bfd
Showing 2 changed files with 119 additions and 1 deletion.
2 changes: 1 addition & 1 deletion cmd/run.go
Original file line number Diff line number Diff line change
@@ -299,7 +299,7 @@ a commandline interface for interacting with it.`,
TestRunDuration: executionState.GetCurrentTestRunDuration(),
})
if err == nil {
err = handleSummaryResult(afero.NewOsFs(), os.Stdout, os.Stderr, summaryResult)
err = handleSummaryResult(afero.NewOsFs(), stdout, stderr, summaryResult)
}
if err != nil {
logger.WithError(err).Error("failed to handle the end-of-test summary")
118 changes: 118 additions & 0 deletions cmd/run_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
/*
*
* k6 - a next-generation load testing tool
* Copyright (C) 2020 Load Impact
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/

package cmd

import (
"bytes"
"errors"
"io"
"io/ioutil"
"os"
"path/filepath"
"testing"

"github.com/loadimpact/k6/lib/fsext"
"github.com/spf13/afero"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

type mockWriter struct {
err error
errAfter int
}

func (fw mockWriter) Write(p []byte) (n int, err error) {
if fw.err != nil {
return fw.errAfter, fw.err
}
return len(p), nil
}

var _ io.Writer = mockWriter{}

func getFiles(t *testing.T, fs afero.Fs) map[string]*bytes.Buffer {
result := map[string]*bytes.Buffer{}
walkFn := func(filePath string, info os.FileInfo, err error) error {
if filePath == "/" {
return nil
}
require.NoError(t, err)
contents, err := afero.ReadFile(fs, filePath)
require.NoError(t, err)
result[filePath] = bytes.NewBuffer(contents)
return nil
}

err := fsext.Walk(fs, afero.FilePathSeparator, filepath.WalkFunc(walkFn))
require.NoError(t, err)

return result
}

func assertEqual(t *testing.T, exp string, actual io.Reader) {
act, err := ioutil.ReadAll(actual)
require.NoError(t, err)
assert.Equal(t, []byte(exp), act)
}

func initVars() (
content map[string]io.Reader, stdout *bytes.Buffer, stderr *bytes.Buffer, fs afero.Fs,
) {
return map[string]io.Reader{}, bytes.NewBuffer([]byte{}), bytes.NewBuffer([]byte{}), afero.NewMemMapFs()
}

func TestHandleSummaryResultSimple(t *testing.T) {
t.Parallel()
content, stdout, stderr, fs := initVars()

// Test noop
assert.NoError(t, handleSummaryResult(fs, stdout, stderr, content))
require.Empty(t, getFiles(t, fs))
require.Empty(t, stdout.Bytes())
require.Empty(t, stderr.Bytes())

// Test stdout only
content["stdout"] = bytes.NewBufferString("some stdout summary")
assert.NoError(t, handleSummaryResult(fs, stdout, stderr, content))
require.Empty(t, getFiles(t, fs))
assertEqual(t, "some stdout summary", stdout)
require.Empty(t, stderr.Bytes())
}

func TestHandleSummaryResultError(t *testing.T) {
t.Parallel()
content, _, stderr, fs := initVars()

expErr := errors.New("test error")
stdout := mockWriter{err: expErr, errAfter: 10}

content["stdout"] = bytes.NewBufferString("some stdout summary")
content["stderr"] = bytes.NewBufferString("some stderr summary")
content["/path/file1"] = bytes.NewBufferString("file summary 1")
content["/path/file2"] = bytes.NewBufferString("file summary 2")
err := handleSummaryResult(fs, stdout, stderr, content)
assert.Error(t, err)
assert.Contains(t, err.Error(), expErr.Error())
files := getFiles(t, fs)
assertEqual(t, "file summary 1", files["/path/file1"])
assertEqual(t, "file summary 2", files["/path/file2"])
}

0 comments on commit 9f58bfd

Please sign in to comment.