fake-command.go

/*
MIT License

Copyright (c) 2023-2024 Rick

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/

package exec

import (
	"bytes"
	"context"
	"io"
	"os"
)

// FakeExecer is for the unit test purposes
type FakeExecer struct {
	ExpectError         error
	ExpectLookPathError error
	ExpectOutput        string
	ExpectErrOutput     string
	ExpectOS            string
	ExpectArch          string
	ExpectLookPath      string
	Env                 map[string]string
}

func (f *FakeExecer) WithContext(ctx context.Context) Execer {
	return f
}

// LookPath is a fake method
func (f *FakeExecer) LookPath(path string) (string, error) {
	return f.ExpectLookPath, f.ExpectLookPathError
}

// Command is a fake method
func (f *FakeExecer) Command(name string, arg ...string) ([]byte, error) {
	return []byte(f.ExpectOutput), f.ExpectError
}

// RunCommand runs a command
func (f *FakeExecer) RunCommand(name string, arg ...string) error {
	return f.ExpectError
}

// RunCommandInDir is a fake method
func (f *FakeExecer) RunCommandInDir(name, dir string, args ...string) error {
	return f.ExpectError
}

// RunCommandAndReturn is a fake method
func (f *FakeExecer) RunCommandAndReturn(name, dir string, args ...string) (result string, err error) {
	if err = f.ExpectError; err == nil {
		result = f.ExpectOutput
	} else {
		result = f.ExpectOutput
		result += f.ExpectErrOutput
	}
	return
}

// RunCommandWithSudo is a fake method
func (f *FakeExecer) RunCommandWithSudo(name string, args ...string) (err error) {
	return f.ExpectError
}

// RunCommandWithBuffer is a fake method
func (f *FakeExecer) RunCommandWithBuffer(name, dir string, stdout, stderr *bytes.Buffer, args ...string) error {
	return f.ExpectError
}

// RunCommandWithIO is a fake method
func (f *FakeExecer) RunCommandWithIO(name, dir string, stdout, stderr io.Writer, p chan Process, args ...string) error {
	return f.ExpectError
}

// RunCommandWithEnv is a fake method
func (f *FakeExecer) RunCommandWithEnv(name string, argv, envv []string, stdout, stderr io.Writer) error {
	return f.ExpectError
}

// SystemCall is a fake method
func (f *FakeExecer) SystemCall(name string, argv []string, envv []string) error {
	return f.ExpectError
}

// MkdirAll is the wrapper of os.MkdirAll
func (f *FakeExecer) MkdirAll(path string, perm os.FileMode) error {
	return f.ExpectError
}

// OS returns the os name
func (f *FakeExecer) OS() string {
	return f.ExpectOS
}

// Arch returns the os arch
func (f *FakeExecer) Arch() string {
	return f.ExpectArch
}

// Getenv returns the env value by key
func (f *FakeExecer) Getenv(key string) string {
	return f.Env[key]
}

// Setenv sets the key-value pair into the env
func (f *FakeExecer) Setenv(key, value string) error {
	if f.Env == nil {
		f.Env = make(map[string]string)
	}
	f.Env[key] = value
	return nil
}

var _ Execer = &FakeExecer{}