- Notifications
You must be signed in to change notification settings - Fork1k
chore: add network integration test suite scaffolding#13072
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
coadler merged 2 commits intomainfromcolin/chore_add_network_integration_test_suite_scaffoldingApr 26, 2024
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
2 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
128 changes: 128 additions & 0 deletionstailnet/test/integration/integration.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| package integration | ||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "io" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "net/netip" | ||
| "strings" | ||
| "sync/atomic" | ||
| "testing" | ||
| "time" | ||
| "github.com/google/uuid" | ||
| "github.com/stretchr/testify/require" | ||
| "golang.org/x/xerrors" | ||
| "nhooyr.io/websocket" | ||
| "tailscale.com/tailcfg" | ||
| "cdr.dev/slog" | ||
| "github.com/coder/coder/v2/coderd/httpapi" | ||
| "github.com/coder/coder/v2/codersdk" | ||
| "github.com/coder/coder/v2/tailnet" | ||
| "github.com/coder/coder/v2/testutil" | ||
| ) | ||
| func NetworkSetupDefault(*testing.T) {} | ||
| func DERPMapTailscale(ctx context.Context, t *testing.T) *tailcfg.DERPMap { | ||
| ctx, cancel := context.WithTimeout(ctx, testutil.WaitShort) | ||
| defer cancel() | ||
| req, err := http.NewRequestWithContext(ctx, "GET", "https://controlplane.tailscale.com/derpmap/default", nil) | ||
| require.NoError(t, err) | ||
| res, err := http.DefaultClient.Do(req) | ||
| require.NoError(t, err) | ||
| defer res.Body.Close() | ||
| dm := &tailcfg.DERPMap{} | ||
| dec := json.NewDecoder(res.Body) | ||
| err = dec.Decode(dm) | ||
| require.NoError(t, err) | ||
| return dm | ||
| } | ||
| func CoordinatorInMemory(t *testing.T, logger slog.Logger, dm *tailcfg.DERPMap) (coord tailnet.Coordinator, url string) { | ||
| coord = tailnet.NewCoordinator(logger) | ||
| var coordPtr atomic.Pointer[tailnet.Coordinator] | ||
| coordPtr.Store(&coord) | ||
| t.Cleanup(func() { _ = coord.Close() }) | ||
| csvc, err := tailnet.NewClientService(logger, &coordPtr, 10*time.Minute, func() *tailcfg.DERPMap { | ||
| return dm | ||
| }) | ||
| require.NoError(t, err) | ||
| srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| idStr := strings.TrimPrefix(r.URL.Path, "/") | ||
| id, err := uuid.Parse(idStr) | ||
| if err != nil { | ||
| httpapi.Write(r.Context(), w, http.StatusBadRequest, codersdk.Response{ | ||
| Message: "Bad agent id.", | ||
| Detail: err.Error(), | ||
| }) | ||
| return | ||
| } | ||
| conn, err := websocket.Accept(w, r, nil) | ||
| if err != nil { | ||
| httpapi.Write(r.Context(), w, http.StatusBadRequest, codersdk.Response{ | ||
| Message: "Failed to accept websocket.", | ||
| Detail: err.Error(), | ||
| }) | ||
| return | ||
| } | ||
| ctx, wsNetConn := codersdk.WebsocketNetConn(r.Context(), conn, websocket.MessageBinary) | ||
| defer wsNetConn.Close() | ||
| err = csvc.ServeConnV2(ctx, wsNetConn, tailnet.StreamID{ | ||
| Name: "client-" + id.String(), | ||
| ID: id, | ||
| Auth: tailnet.SingleTailnetCoordinateeAuth{}, | ||
| }) | ||
| if err != nil && !xerrors.Is(err, io.EOF) && !xerrors.Is(err, context.Canceled) { | ||
| _ = conn.Close(websocket.StatusInternalError, err.Error()) | ||
| return | ||
| } | ||
| })) | ||
| t.Cleanup(srv.Close) | ||
| return coord, srv.URL | ||
| } | ||
| func TailnetSetupDRPC(ctx context.Context, t *testing.T, logger slog.Logger, | ||
| id, agentID uuid.UUID, | ||
| coordinateURL string, | ||
| dm *tailcfg.DERPMap, | ||
| ) *tailnet.Conn { | ||
| ip := tailnet.IPFromUUID(id) | ||
| conn, err := tailnet.NewConn(&tailnet.Options{ | ||
| Addresses: []netip.Prefix{netip.PrefixFrom(ip, 128)}, | ||
| DERPMap: dm, | ||
| Logger: logger, | ||
| }) | ||
| require.NoError(t, err) | ||
| t.Cleanup(func() { _ = conn.Close() }) | ||
| //nolint:bodyclose | ||
| ws, _, err := websocket.Dial(ctx, coordinateURL+"/"+id.String(), nil) | ||
| require.NoError(t, err) | ||
| client, err := tailnet.NewDRPCClient( | ||
| websocket.NetConn(ctx, ws, websocket.MessageBinary), | ||
| logger, | ||
| ) | ||
| require.NoError(t, err) | ||
| coord, err := client.Coordinate(ctx) | ||
| require.NoError(t, err) | ||
| coordination := tailnet.NewRemoteCoordination(logger, coord, conn, agentID) | ||
| t.Cleanup(func() { _ = coordination.Close() }) | ||
| return conn | ||
| } |
194 changes: 194 additions & 0 deletionstailnet/test/integration/integration_internal_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,194 @@ | ||
| package integration | ||
| import ( | ||
| "context" | ||
| "flag" | ||
| "fmt" | ||
| "os" | ||
| "os/exec" | ||
| "strconv" | ||
| "syscall" | ||
| "testing" | ||
| "github.com/google/uuid" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| "tailscale.com/tailcfg" | ||
| "cdr.dev/slog" | ||
| "cdr.dev/slog/sloggers/slogtest" | ||
| "github.com/coder/coder/v2/tailnet" | ||
| "github.com/coder/coder/v2/testutil" | ||
| ) | ||
| var ( | ||
| isChild = flag.Bool("child", false, "Run tests as a child") | ||
| childTestID = flag.Int("child-test-id", 0, "Which test is being run") | ||
| childCoordinateURL = flag.String("child-coordinate-url", "", "The coordinate url to connect back to") | ||
| childAgentID = flag.String("child-agent-id", "", "The agent id of the child") | ||
| ) | ||
| func TestMain(m *testing.M) { | ||
| if run := os.Getenv("CODER_TAILNET_TESTS"); run == "" { | ||
| _, _ = fmt.Println("skipping tests...") | ||
| return | ||
| } | ||
| if os.Getuid() != 0 { | ||
| _, _ = fmt.Println("networking integration tests must run as root") | ||
| return | ||
| } | ||
| flag.Parse() | ||
| os.Exit(m.Run()) | ||
| } | ||
| var tests = []Test{{ | ||
| Name: "Normal", | ||
| DERPMap: DERPMapTailscale, | ||
| Coordinator: CoordinatorInMemory, | ||
| Parent: Parent{ | ||
| NetworkSetup: NetworkSetupDefault, | ||
| TailnetSetup: TailnetSetupDRPC, | ||
| Run: func(ctx context.Context, t *testing.T, opts ParentOpts) { | ||
| reach := opts.Conn.AwaitReachable(ctx, tailnet.IPFromUUID(opts.AgentID)) | ||
| assert.True(t, reach) | ||
| }, | ||
| }, | ||
| Child: Child{ | ||
| NetworkSetup: NetworkSetupDefault, | ||
| TailnetSetup: TailnetSetupDRPC, | ||
| Run: func(ctx context.Context, t *testing.T, opts ChildOpts) { | ||
| // wait until the parent kills us | ||
| <-make(chan struct{}) | ||
| }, | ||
| }, | ||
| }} | ||
| //nolint:paralleltest | ||
| func TestIntegration(t *testing.T) { | ||
| if *isChild { | ||
| logger := slogtest.Make(t, nil).Leveled(slog.LevelDebug) | ||
| ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitSuperLong) | ||
| t.Cleanup(cancel) | ||
| agentID, err := uuid.Parse(*childAgentID) | ||
| require.NoError(t, err) | ||
| test := tests[*childTestID] | ||
| test.Child.NetworkSetup(t) | ||
| dm := test.DERPMap(ctx, t) | ||
| conn := test.Child.TailnetSetup(ctx, t, logger, agentID, uuid.Nil, *childCoordinateURL, dm) | ||
| test.Child.Run(ctx, t, ChildOpts{ | ||
| Logger: logger, | ||
| Conn: conn, | ||
| AgentID: agentID, | ||
| }) | ||
| return | ||
| } | ||
| for id, test := range tests { | ||
| t.Run(test.Name, func(t *testing.T) { | ||
| ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitSuperLong) | ||
| t.Cleanup(cancel) | ||
| logger := slogtest.Make(t, nil).Leveled(slog.LevelDebug) | ||
| parentID, childID := uuid.New(), uuid.New() | ||
| dm := test.DERPMap(ctx, t) | ||
| _, coordURL := test.Coordinator(t, logger, dm) | ||
| child, waitChild := execChild(ctx, id, coordURL, childID) | ||
| test.Parent.NetworkSetup(t) | ||
| conn := test.Parent.TailnetSetup(ctx, t, logger, parentID, childID, coordURL, dm) | ||
| test.Parent.Run(ctx, t, ParentOpts{ | ||
| Logger: logger, | ||
| Conn: conn, | ||
| ClientID: parentID, | ||
| AgentID: childID, | ||
| }) | ||
| child.Process.Signal(syscall.SIGINT) | ||
| <-waitChild | ||
| }) | ||
| } | ||
| } | ||
| type Test struct { | ||
| // Name is the name of the test. | ||
| Name string | ||
| // DERPMap returns the DERP map to use for both the parent and child. It is | ||
| // called once at the beginning of the test. | ||
| DERPMap func(ctx context.Context, t *testing.T) *tailcfg.DERPMap | ||
| // Coordinator returns a running tailnet coordinator, and the url to reach | ||
| // it on. | ||
| Coordinator func(t *testing.T, logger slog.Logger, dm *tailcfg.DERPMap) (coord tailnet.Coordinator, url string) | ||
| Parent Parent | ||
| Child Child | ||
| } | ||
| // Parent is the struct containing all of the parent specific configurations. | ||
| // Functions are invoked in order of struct definition. | ||
| type Parent struct { | ||
| // NetworkSetup is run before all test code. It can be used to setup | ||
| // networking scenarios. | ||
| NetworkSetup func(t *testing.T) | ||
| // TailnetSetup creates a tailnet network. | ||
| TailnetSetup func( | ||
| ctx context.Context, t *testing.T, logger slog.Logger, | ||
| id, agentID uuid.UUID, coordURL string, dm *tailcfg.DERPMap, | ||
| ) *tailnet.Conn | ||
| Run func(ctx context.Context, t *testing.T, opts ParentOpts) | ||
| } | ||
| // Child is the struct containing all of the child specific configurations. | ||
| // Functions are invoked in order of struct definition. | ||
| type Child struct { | ||
| // NetworkSetup is run before all test code. It can be used to setup | ||
| // networking scenarios. | ||
| NetworkSetup func(t *testing.T) | ||
| // TailnetSetup creates a tailnet network. | ||
| TailnetSetup func( | ||
| ctx context.Context, t *testing.T, logger slog.Logger, | ||
| id, agentID uuid.UUID, coordURL string, dm *tailcfg.DERPMap, | ||
| ) *tailnet.Conn | ||
| // Run runs the actual test. Parents and children run in separate processes, | ||
| // so it's important to ensure no communication happens over memory between | ||
| // run functions of parents and children. | ||
| Run func(ctx context.Context, t *testing.T, opts ChildOpts) | ||
| } | ||
| type ParentOpts struct { | ||
| Logger slog.Logger | ||
| Conn *tailnet.Conn | ||
| ClientID uuid.UUID | ||
| AgentID uuid.UUID | ||
| } | ||
| type ChildOpts struct { | ||
| Logger slog.Logger | ||
| Conn *tailnet.Conn | ||
| AgentID uuid.UUID | ||
| } | ||
| func execChild(ctx context.Context, testID int, coordURL string, agentID uuid.UUID) (*exec.Cmd, <-chan error) { | ||
| ch := make(chan error) | ||
| binary := os.Args[0] | ||
| args := os.Args[1:] | ||
| args = append(args, | ||
| "--child=true", | ||
| "--child-test-id="+strconv.Itoa(testID), | ||
| "--child-coordinate-url="+coordURL, | ||
| "--child-agent-id="+agentID.String(), | ||
| ) | ||
| cmd := exec.CommandContext(ctx, binary, args...) | ||
| cmd.Stdout = os.Stdout | ||
| cmd.Stderr = os.Stderr | ||
| go func() { | ||
| ch <- cmd.Run() | ||
| }() | ||
| return cmd, ch | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.