mirror of
https://gitea.com/gitea/act_runner.git
synced 2026-06-23 10:14:22 +02:00
fix cleanup network
This commit is contained in:
Lunny Xiao
@@ -8,12 +8,24 @@ package container
|
||||
|
||||
import (
|
||||
"context"
|
||||
"time"
|
||||
|
||||
"gitea.com/gitea/runner/act/common"
|
||||
|
||||
"github.com/moby/moby/client"
|
||||
)
|
||||
|
||||
var (
|
||||
dockerNetworkRemoveRetryInterval = 200 * time.Millisecond
|
||||
dockerNetworkRemoveTimeout = 10 * time.Second
|
||||
)
|
||||
|
||||
type dockerNetworkClient interface {
|
||||
NetworkList(ctx context.Context, options client.NetworkListOptions) (client.NetworkListResult, error)
|
||||
NetworkInspect(ctx context.Context, networkID string, options client.NetworkInspectOptions) (client.NetworkInspectResult, error)
|
||||
NetworkRemove(ctx context.Context, networkID string, options client.NetworkRemoveOptions) (client.NetworkRemoveResult, error)
|
||||
}
|
||||
|
||||
func NewDockerNetworkCreateExecutor(name string) common.Executor {
|
||||
return func(ctx context.Context) error {
|
||||
cli, err := GetDockerClient(ctx)
|
||||
@@ -56,31 +68,64 @@ func NewDockerNetworkRemoveExecutor(name string) common.Executor {
|
||||
}
|
||||
defer cli.Close()
|
||||
|
||||
// Make sure that all network of the specified name are removed
|
||||
// cli.NetworkRemove refuses to remove a network if there are duplicates
|
||||
networks, err := cli.NetworkList(ctx, client.NetworkListOptions{})
|
||||
return removeDockerNetworks(ctx, cli, name)
|
||||
}
|
||||
}
|
||||
|
||||
func removeDockerNetworks(ctx context.Context, cli dockerNetworkClient, name string) error {
|
||||
cleanupCtx, cancel := context.WithTimeout(ctx, dockerNetworkRemoveTimeout)
|
||||
defer cancel()
|
||||
|
||||
for {
|
||||
pendingRemoval, err := removeDockerNetworksOnce(cleanupCtx, cli, name)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// For Gitea, reduce log noise
|
||||
// common.Logger(ctx).Debugf("%v", networks)
|
||||
for _, n := range networks.Items {
|
||||
if n.Name == name {
|
||||
result, err := cli.NetworkInspect(ctx, n.ID, client.NetworkInspectOptions{})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if len(result.Network.Containers) == 0 {
|
||||
if _, err = cli.NetworkRemove(ctx, n.ID, client.NetworkRemoveOptions{}); err != nil {
|
||||
common.Logger(ctx).Debugf("%v", err)
|
||||
}
|
||||
} else {
|
||||
common.Logger(ctx).Debugf("Refusing to remove network %v because it still has active endpoints", name)
|
||||
}
|
||||
}
|
||||
if !pendingRemoval {
|
||||
return nil
|
||||
}
|
||||
|
||||
return err
|
||||
select {
|
||||
case <-cleanupCtx.Done():
|
||||
common.Logger(ctx).Warnf("Timed out waiting for Docker network %v endpoints to detach; leaving network behind", name)
|
||||
return nil
|
||||
case <-time.After(dockerNetworkRemoveRetryInterval):
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func removeDockerNetworksOnce(ctx context.Context, cli dockerNetworkClient, name string) (bool, error) {
|
||||
// Make sure that all network of the specified name are removed.
|
||||
// cli.NetworkRemove refuses to remove a network if there are duplicates.
|
||||
networks, err := cli.NetworkList(ctx, client.NetworkListOptions{})
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
// For Gitea, reduce log noise
|
||||
// common.Logger(ctx).Debugf("%v", networks)
|
||||
|
||||
pendingRemoval := false
|
||||
for _, n := range networks.Items {
|
||||
if n.Name != name {
|
||||
continue
|
||||
}
|
||||
|
||||
result, err := cli.NetworkInspect(ctx, n.ID, client.NetworkInspectOptions{})
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
|
||||
if len(result.Network.Containers) != 0 {
|
||||
pendingRemoval = true
|
||||
common.Logger(ctx).Debugf("Waiting to remove network %v because it still has active endpoints", name)
|
||||
continue
|
||||
}
|
||||
|
||||
if _, err = cli.NetworkRemove(ctx, n.ID, client.NetworkRemoveOptions{}); err != nil {
|
||||
pendingRemoval = true
|
||||
common.Logger(ctx).Debugf("Retrying Docker network removal for %v: %v", name, err)
|
||||
}
|
||||
}
|
||||
|
||||
return pendingRemoval, nil
|
||||
}
|
||||
|
||||
115
act/container/docker_network_test.go
Normal file
115
act/container/docker_network_test.go
Normal file
@@ -0,0 +1,115 @@
|
||||
// Copyright 2026 The Gitea Authors. All rights reserved.
|
||||
// Copyright 2026 The nektos/act Authors. All rights reserved.
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
//go:build !(WITHOUT_DOCKER || !(linux || darwin || windows || netbsd))
|
||||
|
||||
package container
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
containernetwork "github.com/moby/moby/api/types/network"
|
||||
"github.com/moby/moby/client"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
type fakeDockerNetworkClient struct {
|
||||
listResult client.NetworkListResult
|
||||
inspectByID map[string][]client.NetworkInspectResult
|
||||
inspectCalls map[string]int
|
||||
removeCalls []string
|
||||
removeErrs map[string][]error
|
||||
removeIdx map[string]int
|
||||
}
|
||||
|
||||
func (f *fakeDockerNetworkClient) NetworkList(context.Context, client.NetworkListOptions) (client.NetworkListResult, error) {
|
||||
return f.listResult, nil
|
||||
}
|
||||
|
||||
func (f *fakeDockerNetworkClient) NetworkInspect(_ context.Context, networkID string, _ client.NetworkInspectOptions) (client.NetworkInspectResult, error) {
|
||||
idx := f.inspectCalls[networkID]
|
||||
f.inspectCalls[networkID] = idx + 1
|
||||
results := f.inspectByID[networkID]
|
||||
if len(results) == 0 {
|
||||
return client.NetworkInspectResult{}, nil
|
||||
}
|
||||
if idx >= len(results) {
|
||||
return results[len(results)-1], nil
|
||||
}
|
||||
return results[idx], nil
|
||||
}
|
||||
|
||||
func (f *fakeDockerNetworkClient) NetworkRemove(_ context.Context, networkID string, _ client.NetworkRemoveOptions) (client.NetworkRemoveResult, error) {
|
||||
f.removeCalls = append(f.removeCalls, networkID)
|
||||
idx := f.removeIdx[networkID]
|
||||
f.removeIdx[networkID] = idx + 1
|
||||
if errs := f.removeErrs[networkID]; idx < len(errs) {
|
||||
return client.NetworkRemoveResult{}, errs[idx]
|
||||
}
|
||||
return client.NetworkRemoveResult{}, nil
|
||||
}
|
||||
|
||||
func TestRemoveDockerNetworksRetriesUntilEndpointsDetach(t *testing.T) {
|
||||
originalInterval := dockerNetworkRemoveRetryInterval
|
||||
originalTimeout := dockerNetworkRemoveTimeout
|
||||
dockerNetworkRemoveRetryInterval = time.Millisecond
|
||||
dockerNetworkRemoveTimeout = 50 * time.Millisecond
|
||||
t.Cleanup(func() {
|
||||
dockerNetworkRemoveRetryInterval = originalInterval
|
||||
dockerNetworkRemoveTimeout = originalTimeout
|
||||
})
|
||||
|
||||
cli := &fakeDockerNetworkClient{
|
||||
listResult: client.NetworkListResult{
|
||||
Items: []containernetwork.Summary{{Network: containernetwork.Network{ID: "n1", Name: "test"}}},
|
||||
},
|
||||
inspectByID: map[string][]client.NetworkInspectResult{
|
||||
"n1": {
|
||||
{Network: containernetwork.Inspect{Containers: map[string]containernetwork.EndpointResource{"c1": {}}}},
|
||||
{Network: containernetwork.Inspect{Containers: map[string]containernetwork.EndpointResource{}}},
|
||||
},
|
||||
},
|
||||
inspectCalls: map[string]int{},
|
||||
removeErrs: map[string][]error{},
|
||||
removeIdx: map[string]int{},
|
||||
}
|
||||
|
||||
err := removeDockerNetworks(context.Background(), cli, "test")
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, []string{"n1"}, cli.removeCalls)
|
||||
assert.GreaterOrEqual(t, cli.inspectCalls["n1"], 2)
|
||||
}
|
||||
|
||||
func TestRemoveDockerNetworksStopsRetryingAfterTimeout(t *testing.T) {
|
||||
originalInterval := dockerNetworkRemoveRetryInterval
|
||||
originalTimeout := dockerNetworkRemoveTimeout
|
||||
dockerNetworkRemoveRetryInterval = time.Millisecond
|
||||
dockerNetworkRemoveTimeout = 5 * time.Millisecond
|
||||
t.Cleanup(func() {
|
||||
dockerNetworkRemoveRetryInterval = originalInterval
|
||||
dockerNetworkRemoveTimeout = originalTimeout
|
||||
})
|
||||
|
||||
cli := &fakeDockerNetworkClient{
|
||||
listResult: client.NetworkListResult{
|
||||
Items: []containernetwork.Summary{{Network: containernetwork.Network{ID: "n1", Name: "test"}}},
|
||||
},
|
||||
inspectByID: map[string][]client.NetworkInspectResult{
|
||||
"n1": {
|
||||
{Network: containernetwork.Inspect{Containers: map[string]containernetwork.EndpointResource{"c1": {}}}},
|
||||
},
|
||||
},
|
||||
inspectCalls: map[string]int{},
|
||||
removeErrs: map[string][]error{},
|
||||
removeIdx: map[string]int{},
|
||||
}
|
||||
|
||||
err := removeDockerNetworks(context.Background(), cli, "test")
|
||||
require.NoError(t, err)
|
||||
assert.Empty(t, cli.removeCalls)
|
||||
assert.Positive(t, cli.inspectCalls["n1"])
|
||||
}
|
||||
Reference in New Issue
Block a user