test(x) add psiphon integration tests (#430)

* adding a possible psiphon integration test

* split config out into its own file

* add fetch example

* reviewer comments

Author: ohnorobo

x/psiphon/psiphon_integration_test.go

@@ -0,0 +1,102 @@
+// Copyright 2023 The Outline Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//go:build psiphon && nettest
+// +build psiphon,nettest
+
+package psiphon
+
+import (
+	"context"
+	"encoding/json"
+	"io"
+	"net"
+	"net/http"
+	"os"
+	"path/filepath"
+	"strings"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/require"
+)
+
+func readPsiphonConfigFromFile(tb testing.TB) string {
+	// It's useful to test actually starting psiphon connections,
+	// but doing so requires supplying a valid psiphon config with private information.
+	// To run these tests please supply your own config in integration_test_config.yaml
+	configPath := filepath.Join("testdata", "integration_test_config.yaml")
+	configBytes, err := os.ReadFile(configPath)
+	if err != nil {
+		require.NoError(tb, err)
+	}
+	return string(configBytes)
+}
+
+func newValidTestConfig(tb testing.TB) (*DialerConfig, func()) {
+	privatePsiphonConfig := readPsiphonConfigFromFile(tb)
+	if strings.Contains(privatePsiphonConfig, "{<YOUR_CONFIG_HERE>}") {
+		tb.Skip("Integration testing for Psiphon requires adding a user-supplied config in integration_test_config.yaml")
+	}
+	tempDir, err := os.MkdirTemp("", "psiphon")
+	require.NoError(tb, err)
+	return &DialerConfig{
+		DataRootDirectory: tempDir,
+		ProviderConfig:    json.RawMessage(privatePsiphonConfig),
+	}, func() { os.RemoveAll(tempDir) }
+}
+
+func TestDialer_CancelinledAfterStart_DoesntCloseTunnel(t *testing.T) {
+	cfg, delete := newValidTestConfig(t)
+	defer delete()
+	startCtx, startCancel := context.WithCancel(context.Background())
+	dialer := GetSingletonDialer()
+
+	startDone := make(chan error)
+	go func() { startDone <- dialer.Start(startCtx, cfg) }()
+	<-startDone
+	startCancel() // Cancel only after start is done.
+
+	// Cancelling the start does not nix the tunnel.
+	require.NotNil(t, dialer.tunnel)
+
+	dialer.Stop()
+}
+
+func TestDialer_FetchExample(t *testing.T) {
+	cfg, delete := newValidTestConfig(t)
+	defer delete()
+	startCtx, startCancel := context.WithCancel(context.Background())
+	defer startCancel()
+	dialer := GetSingletonDialer()
+
+	startDone := make(chan error)
+	go func() { startDone <- dialer.Start(startCtx, cfg) }()
+	require.NoError(t, <-startDone)
+
+	dialContext := func(ctx context.Context, network, addr string) (net.Conn, error) {
+		return dialer.DialStream(ctx, addr)
+	}
+	httpClient := &http.Client{Transport: &http.Transport{DialContext: dialContext}, Timeout: 5 * time.Second}
+
+	req, err := http.NewRequest("GET", "http://www.gstatic.com/generate_204", nil)
+	require.NoError(t, err)
+	resp, err := httpClient.Do(req)
+	require.NoError(t, err)
+	defer resp.Body.Close()
+	_, err = io.Copy(io.Discard, resp.Body)
+	require.NoError(t, err)
+
+	dialer.Stop()
+}

x/psiphon/testdata/integration_test_config.yaml

@@ -0,0 +1 @@
+{<YOUR_CONFIG_HERE>}