|
| 1 | +//go:build dockerd |
| 2 | + |
| 3 | +package docker |
| 4 | + |
| 5 | +import ( |
| 6 | + "encoding/json" |
| 7 | + "os" |
| 8 | + "os/exec" |
| 9 | + "path/filepath" |
| 10 | + "runtime" |
| 11 | + "strings" |
| 12 | + "sync" |
| 13 | + "testing" |
| 14 | + "time" |
| 15 | + |
| 16 | + "github.com/signalfx/defaults" |
| 17 | + "github.com/signalfx/golib/v3/datapoint" //nolint:staticcheck // SA1019: deprecated package still in use |
| 18 | + "github.com/signalfx/golib/v3/event" //nolint:staticcheck // SA1019: deprecated package still in use |
| 19 | + "github.com/signalfx/golib/v3/trace" //nolint:staticcheck // SA1019: deprecated package still in use |
| 20 | + "github.com/stretchr/testify/require" |
| 21 | + "go.opentelemetry.io/collector/pdata/pmetric" |
| 22 | + |
| 23 | + "github.com/signalfx/signalfx-agent/pkg/core/config" |
| 24 | + "github.com/signalfx/signalfx-agent/pkg/core/dpfilters" |
| 25 | + "github.com/signalfx/signalfx-agent/pkg/monitors/types" |
| 26 | +) |
| 27 | + |
| 28 | +const ( |
| 29 | + useDockerEngineDefault = "default" |
| 30 | +) |
| 31 | + |
| 32 | +func TestMinimumRequiredClientVersion(t *testing.T) { |
| 33 | + // Skip this test if not running on Linux GitHub runner |
| 34 | + if runtime.GOOS != "linux" { |
| 35 | + t.Skip("Skipping test on non-Linux OS") |
| 36 | + } |
| 37 | + if os.Getenv("GITHUB_ACTIONS") != "true" { |
| 38 | + t.Skip("Skipping test outside of GitHub Actions") |
| 39 | + } |
| 40 | + |
| 41 | + // Execute the dockerd upgrade script and fail the test if it fails. |
| 42 | + // This test is not rolling back the dockerd upgrade, so it can affect all subsequent tests. |
| 43 | + scriptPath := filepath.Join("testdata", "upgrade-dockerd-on-ubuntu.sh") |
| 44 | + scriptCmd := exec.Command("bash", scriptPath) |
| 45 | + scriptOut, err := scriptCmd.CombinedOutput() |
| 46 | + t.Logf("upgrade-dockerd-on-ubuntu.sh output:\n%s\n", string(scriptOut)) |
| 47 | + require.NoError(t, err, "upgrade-dockerd-on-ubuntu.sh failed with exit code %d", scriptCmd.ProcessState.ExitCode()) |
| 48 | + |
| 49 | + tt := []struct { |
| 50 | + minimumRequiredClientVersion string |
| 51 | + }{ |
| 52 | + { |
| 53 | + minimumRequiredClientVersion: useDockerEngineDefault, |
| 54 | + }, |
| 55 | + { |
| 56 | + minimumRequiredClientVersion: "1.24", |
| 57 | + }, |
| 58 | + } |
| 59 | + |
| 60 | + for _, tc := range tt { |
| 61 | + t.Run(tc.minimumRequiredClientVersion, func(t *testing.T) { |
| 62 | + if tc.minimumRequiredClientVersion != useDockerEngineDefault { |
| 63 | + updateGHLinuxRunnerDockerDaemonMinClientVersion(t, tc.minimumRequiredClientVersion) |
| 64 | + } |
| 65 | + |
| 66 | + cleanupContainer := runDockerContainerToGenerateMetrics(t) |
| 67 | + // This needs to be in a defer so the container is removed before the docker daemon settings are reset. |
| 68 | + defer cleanupContainer() |
| 69 | + |
| 70 | + output := &fakeOutput{} |
| 71 | + monitor := &Monitor{ |
| 72 | + Output: output, |
| 73 | + } |
| 74 | + config := &Config{ |
| 75 | + MonitorConfig: config.MonitorConfig{ |
| 76 | + IntervalSeconds: 1, |
| 77 | + }, |
| 78 | + } |
| 79 | + defaults.Set(config) |
| 80 | + |
| 81 | + err := monitor.Configure(config) |
| 82 | + require.NoError(t, err, "Expected no error during monitor configuration") |
| 83 | + defer monitor.Shutdown() |
| 84 | + |
| 85 | + require.Eventually(t, func() bool { |
| 86 | + return output.HasDatapoints() |
| 87 | + }, 10*time.Second, 100*time.Millisecond, "Expected datapoints to be collected") |
| 88 | + }) |
| 89 | + } |
| 90 | +} |
| 91 | + |
| 92 | +func updateGHLinuxRunnerDockerDaemonMinClientVersion(t *testing.T, minimumRequiredClientVersion string) { |
| 93 | + // Fail if there is already a daemon.json file |
| 94 | + if _, err := os.Stat("/etc/docker/daemon.json"); err == nil { |
| 95 | + t.Fatal("daemon.json already exists, cannot update minimum required client version") |
| 96 | + } |
| 97 | + |
| 98 | + daemonConfig := map[string]string{ |
| 99 | + "min-api-version": minimumRequiredClientVersion, |
| 100 | + } |
| 101 | + |
| 102 | + configJSON, err := json.MarshalIndent(daemonConfig, "", " ") |
| 103 | + require.NoError(t, err, "Failed to marshal daemon config") |
| 104 | + t.Logf("Docker daemon config JSON:\n%s", string(configJSON)) |
| 105 | + |
| 106 | + // Create a temporary daemon.json file with the new configuration then |
| 107 | + // move it using sudo to the correct location. |
| 108 | + tempFileName := filepath.Join(t.TempDir(), "daemon.json") |
| 109 | + err = os.WriteFile(tempFileName, configJSON, 0o644) |
| 110 | + require.NoError(t, err, "Failed to write daemon.json") |
| 111 | + |
| 112 | + cmd := exec.Command("sudo", "mv", tempFileName, "/etc/docker/") |
| 113 | + err = cmd.Run() |
| 114 | + require.NoError(t, err, "Failed to move daemon.json") |
| 115 | + |
| 116 | + cmd = exec.Command("sudo", "service", "docker", "restart") |
| 117 | + // Ignore error since the docker daemon might automatically restart after |
| 118 | + // adding the config file |
| 119 | + err = cmd.Run() |
| 120 | + if err != nil { |
| 121 | + t.Logf("Docker daemon restart error: %s", err) |
| 122 | + } |
| 123 | + |
| 124 | + t.Cleanup(func() { |
| 125 | + cmd := exec.Command("sudo", "rm", "/etc/docker/daemon.json") |
| 126 | + err := cmd.Run() |
| 127 | + require.NoError(t, err, "Failed to remove daemon.json") |
| 128 | + |
| 129 | + cmd = exec.Command("sudo", "service", "docker", "restart") |
| 130 | + // Ignore error since the docker daemon might automatically restart after |
| 131 | + // removing the config file |
| 132 | + err = cmd.Run() |
| 133 | + if err != nil { |
| 134 | + t.Logf("Docker daemon restart error: %s", err) |
| 135 | + } |
| 136 | + |
| 137 | + requireDockerDaemonRunning(t) |
| 138 | + }) |
| 139 | + |
| 140 | + requireDockerDaemonRunning(t) |
| 141 | +} |
| 142 | + |
| 143 | +func runDockerContainerToGenerateMetrics(t *testing.T) func() { |
| 144 | + cmd := exec.Command("docker", "run", "-d", "--name", "docker-client-test", "alpine", "sleep", "180") |
| 145 | + err := cmd.Run() |
| 146 | + require.NoError(t, err, "Failed to run docker container") |
| 147 | + return func() { |
| 148 | + cmd := exec.Command("docker", "rm", "-f", "docker-client-test") |
| 149 | + err := cmd.Run() |
| 150 | + require.NoError(t, err, "Failed to remove docker container") |
| 151 | + } |
| 152 | +} |
| 153 | + |
| 154 | +func requireDockerDaemonRunning(t *testing.T) { |
| 155 | + require.Eventually(t, func() bool { |
| 156 | + isRunning, err := isServiceRunning(t, "docker") |
| 157 | + require.NoError(t, err, "Failed to get docker service status") |
| 158 | + return isRunning |
| 159 | + }, 30*time.Second, 1*time.Second) |
| 160 | +} |
| 161 | + |
| 162 | +func isServiceRunning(t *testing.T, serviceName string) (bool, error) { |
| 163 | + cmd := exec.Command("service", serviceName, "status") |
| 164 | + output, err := cmd.CombinedOutput() |
| 165 | + if err != nil { |
| 166 | + // The 'service status' command often returns a non-zero exit code if the service is not running |
| 167 | + // or if there's an error. We still need to parse the output to determine the status. |
| 168 | + t.Logf("Error getting %q service status: %v", serviceName, err) |
| 169 | + } |
| 170 | + |
| 171 | + outputStr := string(output) |
| 172 | + |
| 173 | + if strings.Contains(outputStr, "active (running)") { |
| 174 | + return true, nil |
| 175 | + } |
| 176 | + |
| 177 | + return false, nil |
| 178 | +} |
| 179 | + |
| 180 | +type fakeOutput struct { |
| 181 | + datapoints []*datapoint.Datapoint |
| 182 | + mu sync.Mutex |
| 183 | +} |
| 184 | + |
| 185 | +var _ types.FilteringOutput = (*fakeOutput)(nil) |
| 186 | + |
| 187 | +func (fo *fakeOutput) AddDatapointExclusionFilter(_ dpfilters.DatapointFilter) { |
| 188 | + panic("unimplemented") |
| 189 | +} |
| 190 | + |
| 191 | +func (fo *fakeOutput) AddExtraDimension(_ string, _ string) { |
| 192 | + panic("unimplemented") |
| 193 | +} |
| 194 | + |
| 195 | +func (fo *fakeOutput) Copy() types.Output { |
| 196 | + panic("unimplemented") |
| 197 | +} |
| 198 | + |
| 199 | +func (fo *fakeOutput) EnabledMetrics() []string { |
| 200 | + return []string{} |
| 201 | +} |
| 202 | + |
| 203 | +func (fo *fakeOutput) HasAnyExtraMetrics() bool { |
| 204 | + panic("unimplemented") |
| 205 | +} |
| 206 | + |
| 207 | +func (fo *fakeOutput) HasEnabledMetricInGroup(_ string) bool { |
| 208 | + panic("unimplemented") |
| 209 | +} |
| 210 | + |
| 211 | +func (fo *fakeOutput) SendDimensionUpdate(_ *types.Dimension) { |
| 212 | + panic("unimplemented") |
| 213 | +} |
| 214 | + |
| 215 | +func (fo *fakeOutput) SendEvent(_ *event.Event) { |
| 216 | + panic("unimplemented") |
| 217 | +} |
| 218 | + |
| 219 | +func (fo *fakeOutput) SendMetrics(_ ...pmetric.Metric) { |
| 220 | + panic("unimplemented") |
| 221 | +} |
| 222 | + |
| 223 | +func (fo *fakeOutput) SendSpans(_ ...*trace.Span) { |
| 224 | + panic("unimplemented") |
| 225 | +} |
| 226 | + |
| 227 | +func (fo *fakeOutput) SendDatapoints(dps ...*datapoint.Datapoint) { |
| 228 | + fo.mu.Lock() |
| 229 | + defer fo.mu.Unlock() |
| 230 | + fo.datapoints = append(fo.datapoints, dps...) |
| 231 | +} |
| 232 | + |
| 233 | +func (fo *fakeOutput) HasDatapoints() bool { |
| 234 | + fo.mu.Lock() |
| 235 | + defer fo.mu.Unlock() |
| 236 | + return len(fo.datapoints) > 0 |
| 237 | +} |
0 commit comments