Skip to content

Commit

Permalink
[#1057] Refactor test command executor
Browse files Browse the repository at this point in the history
  • Loading branch information
@fivitti
fivitti committed Jul 25, 2023
1 parent 2056f74 commit 3e59ae9
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 93 deletions.
76 changes: 37 additions & 39 deletions backend/agent/bind9_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -181,43 +181,44 @@ func TestGetCtrlAddressFromBind9Config(t *testing.T) {
}
}

type catCommandExecutor struct {
// The command executor implementation for the testing purposes.
// It implements the builder pattern for the configuration methods.
type testCommandExecutor struct {
configPathInNamedOutput *string
lookupPathPrefix *string
outputs map[string]string
}

func newCatCommandExecutor() *catCommandExecutor {
return &catCommandExecutor{
// Constructs a new instance of the test command executor.
func newTestCommandExecutor() *testCommandExecutor {
return &testCommandExecutor{
outputs: map[string]string{},
}
}

func (e *catCommandExecutor) clear() *catCommandExecutor {
// Clears all added outputs and the config path used in the named -V output.
func (e *testCommandExecutor) clear() *testCommandExecutor {
e.outputs = map[string]string{}
e.configPathInNamedOutput = nil
e.lookupPathPrefix = nil
return e
}

func (e *catCommandExecutor) addOutput(path, content string) *catCommandExecutor {
// Add a output mock of the named-checkconf call. It accepts the configuration
// path program and expected output text.
func (e *testCommandExecutor) addCheckConfOutput(path, content string) *testCommandExecutor {
e.outputs[path] = content
return e
}

func (e *catCommandExecutor) setConfigPathInNamedOutput(path string) *catCommandExecutor {
// Set the named configuration path used in the output of the named -V call.
// If the path is not set, the output doesn't contain the configuration path.
func (e *testCommandExecutor) setConfigPathInNamedOutput(path string) *testCommandExecutor {
e.configPathInNamedOutput = &path
return e
}

func (e *catCommandExecutor) setLookupPathPrefix(path string) *catCommandExecutor {
e.lookupPathPrefix = &path
return e
}

// Pretends to run named-checkconf, but instead does a simple read of the
// specified files contents, similar to "cat" command.
func (e *catCommandExecutor) Output(command string, args ...string) ([]byte, error) {
func (e *testCommandExecutor) Output(command string, args ...string) ([]byte, error) {
if strings.Contains(command, "named-checkconf") {
// Pretending to run named-checkconf -p <config-file>.
path := args[1]
Expand Down Expand Up @@ -249,15 +250,18 @@ func (e *catCommandExecutor) Output(command string, args ...string) ([]byte, err

// Looks for a given command in the system PATH and returns absolute path if found.
// (This is the standard behavior that we don't override in tests here.)
func (e *catCommandExecutor) LookPath(command string) (string, error) {
if e.lookupPathPrefix == nil {
return "", errors.New("missing default configuration path")
func (e *testCommandExecutor) LookPath(command string) (string, error) {
allowedCommands := []string{"named-checkconf", "named", "rndc"}
for _, allowedCommand := range allowedCommands {
if command == allowedCommand {
return "/usr/sbin/" + command, nil
}
}
return *e.lookupPathPrefix + "/" + command, nil
return "", errors.New("command not found")
}

// Check if there is a configuration for a given path.
func (e *catCommandExecutor) IsFileExist(path string) bool {
// Check if there is an output for a given configuration path.
func (e *testCommandExecutor) IsFileExist(path string) bool {
for configuredPath := range e.outputs {
if configuredPath == path {
return true
Expand All @@ -274,10 +278,8 @@ func TestDetectBind9Step1ProcessCmdLine(t *testing.T) {
controls { inet 1.1.1.1 port 1111 allow { localhost; } keys { "foo"; "bar"; }; };`

// check BIND 9 app detection
executor := newCatCommandExecutor().
addOutput(config1Path, config1).
addOutput("/sbin/named-checkconf", "").
addOutput("/sbin/rndc", "")
executor := newTestCommandExecutor().
addCheckConfOutput(config1Path, config1)

// Now run the detection as usual
app := detectBind9App([]string{"", "/dir", fmt.Sprintf("-c %s", config1Path)}, "", executor)
Expand Down Expand Up @@ -310,9 +312,8 @@ func TestDetectBind9Step2EnvVar(t *testing.T) {
os.Setenv("STORK_BIND9_CONFIG", confPath)

// check BIND 9 app detection
executor := newCatCommandExecutor().
addOutput(confPath, config).
setLookupPathPrefix("/usr/sbin")
executor := newTestCommandExecutor().
addCheckConfOutput(confPath, config)

namedDir := "/dir/usr/sbin"
app := detectBind9App([]string{"", namedDir, "-some -params"}, "", executor)
Expand All @@ -339,8 +340,8 @@ func TestDetectBind9Step3BindVOutput(t *testing.T) {
};`

// ... and tell the fake executor to return it as the output of named -V
executor := newCatCommandExecutor().
addOutput(varPath, config).
executor := newTestCommandExecutor().
addCheckConfOutput(varPath, config).
setConfigPathInNamedOutput(varPath)

// Now run the detection as usual
Expand All @@ -367,13 +368,12 @@ func TestDetectBind9Step4TypicalLocations(t *testing.T) {
inet 192.0.2.1 port 1234 allow { localhost; } keys { "foo"; "bar"; };
};`

executor := newCatCommandExecutor()
executor := newTestCommandExecutor()

for _, expectedPath := range getPotentialNamedConfLocations() {
executor.
clear().
addOutput(expectedPath, config).
setLookupPathPrefix("/usr/sbin")
addCheckConfOutput(expectedPath, config)

t.Run(expectedPath, func(t *testing.T) {
// Act
Expand All @@ -390,7 +390,6 @@ func TestDetectBind9Step4TypicalLocations(t *testing.T) {
require.EqualValues(t, "foo:hmac-sha256:abcd", point.Key)
})
}

}

// There is no reliable way to test step 4 (checking typical locations). The
Expand Down Expand Up @@ -427,12 +426,11 @@ func TestDetectBind9DetectOrder(t *testing.T) {
config3Path := "/dir/step3.conf"

// ... and tell the fake executor to return it as the output of named -V
executor := newCatCommandExecutor().
addOutput(config1Path, config1).
addOutput(config2Path, config2).
addOutput(config3Path, config3).
setConfigPathInNamedOutput(config3Path).
setLookupPathPrefix("/usr/sbin")
executor := newTestCommandExecutor().
addCheckConfOutput(config1Path, config1).
addCheckConfOutput(config2Path, config2).
addCheckConfOutput(config3Path, config3).
setConfigPathInNamedOutput(config3Path)

// ... and point STORK_BIND9_CONFIG to it
os.Setenv("STORK_BIND9_CONFIG", config2Path)
Expand Down
73 changes: 19 additions & 54 deletions backend/agent/monitor_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,53 +190,30 @@ func TestDetectAllowedLogsKeaUnreachable(t *testing.T) {
require.NotPanics(t, func() { am.detectAllowedLogs(sa) })
}

type testCommandExecutor struct{}

// Returns a fixed output and no error for any data. The output contains the
// Bind 9 response with statistic channel details.
func (e *testCommandExecutor) Output(command string, args ...string) ([]byte, error) {
text := `key "foo" {
algorithm "hmac-sha256";
secret "abcd";
};
controls {
inet 127.0.0.53 port 5353 allow { localhost; } keys { "foo"; "bar"; };
inet * port 5454 allow { localhost; 1.2.3.4; };
};
statistics-channels {
inet 127.0.0.80 port 80 allow { localhost; 1.2.3.4; };
inet 127.0.0.88 port 88 allow { localhost; 1.2.3.4; };
};`

return []byte(text), nil
}

// Returns fake data. Normal operation would call os.LookPath.
func (e *testCommandExecutor) LookPath(command string) (string, error) {
return "/some/path/" + command, nil
}

// Returns fake data.
func (e *testCommandExecutor) IsFileExist(string) bool {
return true
func newTestCommandExecutorDefault() *testCommandExecutor {
return newTestCommandExecutor().
addCheckConfOutput("/etc/named.conf", `key "foo" {
algorithm "hmac-sha256";
secret "abcd";
};
controls {
inet 127.0.0.53 port 5353 allow { localhost; } keys { "foo"; "bar"; };
inet * port 5454 allow { localhost; 1.2.3.4; };
};
statistics-channels {
inet 127.0.0.80 port 80 allow { localhost; 1.2.3.4; };
inet 127.0.0.88 port 88 allow { localhost; 1.2.3.4; };
};`).
setConfigPathInNamedOutput("/etc/named.conf")
}

// Check BIND 9 app detection when its conf file is absolute path.
func TestDetectBind9AppAbsPath(t *testing.T) {
sb := testutil.NewSandbox()
defer sb.Close()

// check BIND 9 app detection
executor := &testCommandExecutor{}
cfgPath, err := sb.Join("etc/path.cfg")
require.NoError(t, err)
namedDir, err := sb.JoinDir("usr/sbin")
require.NoError(t, err)
_, err = sb.Join("usr/bin/named-checkconf")
require.NoError(t, err)
_, err = sb.Join("usr/sbin/rndc")
require.NoError(t, err)
app := detectBind9App([]string{"", namedDir, fmt.Sprintf("-c %s", cfgPath)}, "", executor)
executor := newTestCommandExecutorDefault()
app := detectBind9App([]string{"", "/dir", "-c /etc/named.conf"}, "", executor)
require.NotNil(t, app)
require.Equal(t, app.GetBaseApp().Type, AppTypeBind9)
require.Len(t, app.GetBaseApp().AccessPoints, 2)
Expand All @@ -254,20 +231,8 @@ func TestDetectBind9AppAbsPath(t *testing.T) {

// Check BIND 9 app detection when its conf file is relative to CWD of its process.
func TestDetectBind9AppRelativePath(t *testing.T) {
sb := testutil.NewSandbox()
defer sb.Close()

cmdr := &testCommandExecutor{}
sb.Join("etc/path.cfg")
cfgDir, err := sb.JoinDir("etc")
require.NoError(t, err)
namedDir, err := sb.JoinDir("usr/sbin")
require.NoError(t, err)
_, err = sb.Join("usr/sbin/named-checkconf")
require.NoError(t, err)
_, err = sb.Join("usr/bin/rndc")
require.NoError(t, err)
app := detectBind9App([]string{"", namedDir, "-c path.cfg"}, cfgDir, cmdr)
executor := newTestCommandExecutorDefault()
app := detectBind9App([]string{"", "/dir", "-c named.conf"}, "/etc", executor)
require.NotNil(t, app)
require.Equal(t, app.GetBaseApp().Type, AppTypeBind9)
}
Expand Down

0 comments on commit 3e59ae9

Please sign in to comment.