mock

package
v1.277.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 8, 2023 License: Apache-2.0 Imports: 20 Imported by: 8

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func OpenFileMock 

func OpenFileMock(name string, tokens map[string]string) (io.ReadCloser, error)

Types

type DockerExecConfig added in v1.40.0 

type DockerExecConfig struct {
	// Image is the fully qualified docker image name that is passed to docker for this tool.
	Image string
	// Workspace is the (optional) directory to which the current working directory is mapped
	// within the docker container.
	Workspace string
}

DockerExecConfig is the configuration for an individual tool that shall be executed in docker.

type DockerExecRunner added in v1.40.0 

type DockerExecRunner struct {
	// Runner is the ExecRunner to which all executions are forwarded in the end.
	Runner baseRunner
	// contains filtered or unexported fields
}

DockerExecRunner can be used "in place" of another ExecRunner in order to transparently execute commands within a docker container. One use-case is to test locally with tools that are not available on the current platform. When entering the run*() function of a step implementation, a DockerExecRunner can be wrapped around a command.Command{} an be configured to run certain executables within docker.

func (*DockerExecRunner) AddExecConfig added in v1.40.0 

func (d *DockerExecRunner) AddExecConfig(executable string, config DockerExecConfig) error

AddExecConfig needs to be called to store a configuration for a specific executable, in order to run this executable within docker.

func (*DockerExecRunner) RunExecutable added in v1.40.0 

func (d *DockerExecRunner) RunExecutable(executable string, parameters ...string) error

RunExecutable runs the provided executable within docker, if a DockerExecConfig has been previously associated with this executable via AddExecConfig(). Otherwise runs it directly. The BaseRunner is used for execution in any case.

Example 
package main

import (
	"bytes"
	"fmt"
	"github.com/SAP/jenkins-library/pkg/command"
	"github.com/SAP/jenkins-library/pkg/mock"
	"io"
	"strings"
)

type ExecRunner interface {
	SetDir(d string)
	SetEnv(e []string)
	Stdout(out io.Writer)
	Stderr(err io.Writer)
	RunExecutable(e string, p ...string) error
}

func getMavenVersion(runner ExecRunner) (string, error) {
	output := bytes.Buffer{}
	runner.Stdout(&output)
	err := runner.RunExecutable("mvn", "--version")
	if err != nil {
		return "", fmt.Errorf("failed to run maven: %w", err)
	}
	logLines := strings.Split(output.String(), "\n")
	if len(logLines) < 1 {
		return "", fmt.Errorf("failed to obtain maven output")
	}
	return logLines[0], nil
}

func main() {
	// getMavenVersion(runner ExecRunner) executes the command "mvn --version"
	// and returns the command output as string
	runner := command.Command{}
	localMavenVersion, _ := getMavenVersion(&runner)

	dockerRunner := mock.DockerExecRunner{Runner: &runner}
	_ = dockerRunner.AddExecConfig("mvn", mock.DockerExecConfig{
		Image: "maven:3.6.1-jdk-8",
	})

	dockerMavenVersion, _ := getMavenVersion(&dockerRunner)

	fmt.Printf("Your local mvn version is %v, while the version in docker is %v", localMavenVersion, dockerMavenVersion)
}

Output:

func (*DockerExecRunner) SetDir added in v1.40.0 

func (d *DockerExecRunner) SetDir(dir string)

SetDir directly forwards to the provided BaseRunner.

func (*DockerExecRunner) SetEnv added in v1.40.0 

func (d *DockerExecRunner) SetEnv(env []string)

SetEnv directly forwards to the provided BaseRunner.

func (*DockerExecRunner) Stderr added in v1.40.0 

func (d *DockerExecRunner) Stderr(err io.Writer)

Stderr directly forwards to the provided BaseRunner.

func (*DockerExecRunner) Stdout added in v1.40.0 

func (d *DockerExecRunner) Stdout(out io.Writer)

Stdout directly forwards to the provided BaseRunner.

type DownloadMock added in v1.207.0 

type DownloadMock struct {
	FilePath       string
	ImageRef       string
	RemoteImageRef string
	RegistryURL    string

	ReturnImage     v1.Image
	RemoteImageInfo v1.Image
	ReturnError     string

	Stub func(imageRef, targetDir string) (v1.Image, error)
}

DownloadMock .

func (*DownloadMock) DownloadImage added in v1.207.0 

func (c *DownloadMock) DownloadImage(imageRef, targetDir string) (v1.Image, error)

DownloadImage .

func (*DownloadMock) DownloadImageContent added in v1.207.0 

func (c *DownloadMock) DownloadImageContent(imageRef, targetFile string) (v1.Image, error)

DownloadImageContent .

func (*DownloadMock) GetRemoteImageInfo added in v1.212.0 

func (c *DownloadMock) GetRemoteImageInfo(imageRef string) (v1.Image, error)

GetRemoteImageInfo .

type ExecCall 

type ExecCall struct {
	Execution *Execution
	Async     bool
	Exec      string
	Params    []string
}

type ExecMockRunner 

type ExecMockRunner struct {
	Dir      []string
	Env      []string
	ExitCode int
	Calls    []ExecCall

	Stub                func(call string, stdoutReturn map[string]string, shouldFailOnCommand map[string]error, stdout io.Writer) error
	StdoutReturn        map[string]string
	ShouldFailOnCommand map[string]error
	// contains filtered or unexported fields
}

func (*ExecMockRunner) AppendEnv added in v1.62.0 

func (m *ExecMockRunner) AppendEnv(e []string)

func (*ExecMockRunner) GetExitCode added in v1.51.0 

func (m *ExecMockRunner) GetExitCode() int

func (*ExecMockRunner) GetStderr added in v1.124.0 

func (m *ExecMockRunner) GetStderr() io.Writer

func (*ExecMockRunner) GetStdout added in v1.124.0 

func (m *ExecMockRunner) GetStdout() io.Writer

func (*ExecMockRunner) RunExecutable 

func (m *ExecMockRunner) RunExecutable(e string, p ...string) error

func (*ExecMockRunner) RunExecutableInBackground added in v1.45.0 

func (m *ExecMockRunner) RunExecutableInBackground(e string, p ...string) (command.Execution, error)

func (*ExecMockRunner) SetDir 

func (m *ExecMockRunner) SetDir(d string)

func (*ExecMockRunner) SetEnv 

func (m *ExecMockRunner) SetEnv(e []string)

func (*ExecMockRunner) Stderr 

func (m *ExecMockRunner) Stderr(err io.Writer)

func (*ExecMockRunner) Stdin added in v1.139.0 

func (m *ExecMockRunner) Stdin(in io.Reader)

func (*ExecMockRunner) Stdout 

func (m *ExecMockRunner) Stdout(out io.Writer)

type Execution added in v1.45.0 

type Execution struct {
	Killed bool
}

func (*Execution) Kill added in v1.45.0 

func (e *Execution) Kill() error

func (*Execution) Wait added in v1.45.0 

func (e *Execution) Wait() error

type FileMock added in v1.87.0 

type FileMock struct {
	// contains filtered or unexported fields
}

FileMock can be used in places where a io.Closer, io.StringWriter or io.Writer is expected. It is the concrete type returned from FilesMock.OpenFile()

func (*FileMock) Close added in v1.87.0 

func (f *FileMock) Close() error

Close mocks freeing the associated OS resources.

func (*FileMock) Read added in v1.191.0 

func (f *FileMock) Read(b []byte) (n int, err error)

Reads the content of the mock

func (*FileMock) Write added in v1.87.0 

func (f *FileMock) Write(p []byte) (n int, err error)

Write appends the provided byte array to the end of the current virtual file contents. It fails if the FileMock has been closed already, but it does not fail in case the path has already been removed from the FilesMock instance that created this FileMock. In this situation, the written contents will not become visible in the FilesMock.

func (*FileMock) WriteString added in v1.87.0 

func (f *FileMock) WriteString(s string) (n int, err error)

WriteString converts the passed string to a byte array and forwards to Write().

type FilesMock added in v1.19.0 

type FilesMock struct {
	CurrentDir       string
	Separator        string
	FileExistsErrors map[string]error
	FileReadErrors   map[string]error
	FileWriteError   error
	FileWriteErrors  map[string]error
	// contains filtered or unexported fields
}

FilesMock implements the functions from piperutils.Files with an in-memory file system.

func (*FilesMock) Abs added in v1.62.0 

func (f *FilesMock) Abs(path string) (string, error)

func (*FilesMock) AddDir added in v1.43.0 

func (f *FilesMock) AddDir(path string)

AddDir establishes the existence of a virtual directory. The directory is add with default mode 755.

func (*FilesMock) AddDirWithMode added in v1.50.0 

func (f *FilesMock) AddDirWithMode(path string, mode os.FileMode)

AddDirWithMode establishes the existence of a virtual directory.

func (*FilesMock) AddFile added in v1.43.0 

func (f *FilesMock) AddFile(path string, contents []byte)

AddFile establishes the existence of a virtual file. The file is added with mode 644.

func (*FilesMock) AddFileWithMode added in v1.50.0 

func (f *FilesMock) AddFileWithMode(path string, contents []byte, mode os.FileMode)

AddFileWithMode establishes the existence of a virtual file.

func (*FilesMock) Chdir added in v1.43.0 

func (f *FilesMock) Chdir(path string) error

Chdir changes virtually into the given directory. The directory needs to exist according to the files and directories via AddFile() and AddDirectory(). The implementation does not support relative path components such as "..".

func (*FilesMock) Chmod added in v1.57.0 

func (f *FilesMock) Chmod(path string, mode os.FileMode) error

Chmod changes the file mode for the entry at the given path

func (*FilesMock) Copy added in v1.19.0 

func (f *FilesMock) Copy(src, dst string) (int64, error)

Copy checks if content has been associated with the given src path, and if so copies it under the given path dst.

func (*FilesMock) Create added in v1.207.0 

func (f *FilesMock) Create(name string) (io.ReadWriteCloser, error)

func (*FilesMock) CreateArchive added in v1.262.0 

func (f *FilesMock) CreateArchive(content map[string][]byte) ([]byte, error)

CreateArchive creates in memory tar.gz archive, with the content provided.

func (*FilesMock) CurrentTime added in v1.204.0 

func (f *FilesMock) CurrentTime(format string) string

CurrentTime returns the current time as a fixed value

func (*FilesMock) DirExists added in v1.43.0 

func (f *FilesMock) DirExists(path string) (bool, error)

DirExists returns true, if the given path is a previously added directory, or a parent directory for any of the previously added files.

func (*FilesMock) FileExists added in v1.19.0 

func (f *FilesMock) FileExists(path string) (bool, error)

FileExists returns true if file content has been associated with the given path, false otherwise. Only relative paths are supported.

func (*FilesMock) FileRead added in v1.19.0 

func (f *FilesMock) FileRead(path string) ([]byte, error)

FileRead returns the content previously associated with the given path via AddFile(), or an error if no content has been associated.

func (*FilesMock) FileRemove added in v1.43.0 

func (f *FilesMock) FileRemove(path string) error

FileRemove deletes the association of the given path with any content and records the removal of the file. If the path has not been registered before, it returns an error.

func (*FilesMock) FileRename added in v1.85.0 

func (f *FilesMock) FileRename(oldPath, newPath string) error

FileRename changes the path under which content is associated in the virtual file system. Only leaf-entries are supported as of yet.

func (*FilesMock) FileWrite added in v1.19.0 

func (f *FilesMock) FileWrite(path string, content []byte, mode os.FileMode) error

FileWrite just forwards to AddFile(), i.e. the content is associated with the given path.

func (*FilesMock) Getwd added in v1.43.0 

func (f *FilesMock) Getwd() (string, error)

Getwd returns the rooted current virtual working directory

func (*FilesMock) Glob added in v1.43.0 

func (f *FilesMock) Glob(pattern string) ([]string, error)

Glob returns an array of path strings which match the given glob-pattern. Double star matching is supported.

func (*FilesMock) HasCopiedFile added in v1.107.0 

func (f *FilesMock) HasCopiedFile(src string, dest string) bool

HasCopiedFile returns true if the virtual file system at one point contained an entry for the given source and destination, and it was written via CopyFile(). 

func (f *FilesMock) HasCreatedSymlink(oldname, newname string) bool

HasCreatedSymlink returns true if the virtual file system has a symlink with a specific target.

func (*FilesMock) HasFile added in v1.43.0 

func (f *FilesMock) HasFile(path string) bool

HasFile returns true if the virtual file system contains an entry for the given path.

func (*FilesMock) HasRemovedFile added in v1.43.0 

func (f *FilesMock) HasRemovedFile(path string) bool

HasRemovedFile returns true if the virtual file system at one point contained an entry for the given path, and it was removed via FileRemove().

func (*FilesMock) HasWrittenFile added in v1.49.0 

func (f *FilesMock) HasWrittenFile(path string) bool

HasWrittenFile returns true if the virtual file system at one point contained an entry for the given path, and it was written via FileWrite().

func (*FilesMock) MkdirAll added in v1.19.0 

func (f *FilesMock) MkdirAll(path string, mode os.FileMode) error

MkdirAll creates a directory in the in-memory file system, so that this path is established to exist.

func (*FilesMock) Move added in v1.200.0 

func (f *FilesMock) Move(src, dst string) error

Move moves a file to the given destination

func (*FilesMock) Open added in v1.87.0 

func (f *FilesMock) Open(name string) (io.ReadWriteCloser, error)

func (*FilesMock) OpenFile added in v1.198.0 

func (f *FilesMock) OpenFile(path string, flag int, perm os.FileMode) (*FileMock, error)

OpenFile mimics the behavior os.OpenFile(), but it cannot return an instance of the os.File struct. Instead, it returns a pointer to a FileMock instance, which implements a number of the same methods as os.File. The flag parameter is checked for os.O_CREATE and os.O_APPEND and behaves accordingly.

func (*FilesMock) ReadFile added in v1.238.0 

func (f *FilesMock) ReadFile(name string) ([]byte, error)

ReadFile can be used as replacement for os.ReadFile in a compatible manner

func (*FilesMock) RemoveAll added in v1.167.0 

func (f *FilesMock) RemoveAll(path string) error

RemoveAll is a proxy for FileRemove

func (*FilesMock) SHA256 added in v1.204.0 

func (f *FilesMock) SHA256(path string) (string, error)

SHA256 returns a random SHA256

func (*FilesMock) Stat added in v1.57.0 

func (f *FilesMock) Stat(path string) (os.FileInfo, error)

Stat returns an approximated os.FileInfo. For files, it returns properties that have been associated via the setup methods. For directories it depends. If a directory exists only implicitly, because it is the parent of an added file, default values will be reflected in the file info. 

func (f *FilesMock) Symlink(oldname, newname string) error

func (*FilesMock) TempDir added in v1.167.0 

func (f *FilesMock) TempDir(baseDir string, pattern string) (string, error)

TempDir create a temp-styled directory in the in-memory, so that this path is established to exist.

func (*FilesMock) WriteFile added in v1.238.0 

func (f *FilesMock) WriteFile(filename string, data []byte, perm os.FileMode) error

WriteFile can be used as replacement for os.WriteFile in a compatible manner

type HttpClientMock added in v1.204.0 

type HttpClientMock struct {
	ClientOptions          []piperhttp.ClientOptions // set by mock
	HTTPFileUtils          *FilesMock
	FileUploads            map[string]string // set by mock
	ReturnFileUploadStatus int               // expected to be set upfront
	ReturnFileUploadError  error             // expected to be set upfront
}

HttpClientMock mock struct

func (*HttpClientMock) DownloadFile added in v1.216.0 

func (utils *HttpClientMock) DownloadFile(url, filename string, header http.Header, cookies []*http.Cookie) error

DownloadFile mock

func (*HttpClientMock) SendRequest added in v1.204.0 

func (utils *HttpClientMock) SendRequest(method string, url string, r io.Reader, header http.Header, cookies []*http.Cookie) (*http.Response, error)

SendRequest mock

func (*HttpClientMock) SetOptions added in v1.204.0 

func (utils *HttpClientMock) SetOptions(options piperhttp.ClientOptions)

SetOptions mock

func (*HttpClientMock) Upload added in v1.204.0 

func (utils *HttpClientMock) Upload(data piperhttp.UploadRequestData) (*http.Response, error)

Upload mock

func (*HttpClientMock) UploadFile added in v1.204.0 

func (utils *HttpClientMock) UploadFile(url, file, fieldName string, header http.Header, cookies []*http.Cookie, uploadType string) (*http.Response, error)

UploadFile mock

func (*HttpClientMock) UploadRequest added in v1.204.0 

func (utils *HttpClientMock) UploadRequest(method, url, file, fieldName string, header http.Header, cookies []*http.Cookie, uploadType string) (*http.Response, error)

UploadRequest mock

type ShellMockRunner 

type ShellMockRunner struct {
	Dir      string
	Env      []string
	ExitCode int
	Calls    []string
	Shell    []string

	StdoutReturn        map[string]string
	ShouldFailOnCommand map[string]error
	// contains filtered or unexported fields
}

func (*ShellMockRunner) AppendEnv added in v1.62.0 

func (m *ShellMockRunner) AppendEnv(e []string)

func (*ShellMockRunner) GetExitCode added in v1.51.0 

func (m *ShellMockRunner) GetExitCode() int

func (*ShellMockRunner) GetStderr added in v1.124.0 

func (m *ShellMockRunner) GetStderr() io.Writer

func (*ShellMockRunner) GetStdout added in v1.124.0 

func (m *ShellMockRunner) GetStdout() io.Writer

func (*ShellMockRunner) RunShell 

func (m *ShellMockRunner) RunShell(s string, c string) error

func (*ShellMockRunner) SetDir 

func (m *ShellMockRunner) SetDir(d string)

func (*ShellMockRunner) SetEnv added in v1.16.0 

func (m *ShellMockRunner) SetEnv(e []string)

func (*ShellMockRunner) Stderr 

func (m *ShellMockRunner) Stderr(err io.Writer)

func (*ShellMockRunner) Stdin added in v1.139.0 

func (m *ShellMockRunner) Stdin(in io.Reader)

func (*ShellMockRunner) Stdout 

func (m *ShellMockRunner) Stdout(out io.Writer)

type StepOptions 

type StepOptions struct {
	TestParam string `json:"testParam,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.