itest: merge server harness and UniverseRPCHarness

The original server harness was meant to be the actual universe RPC
server from the beginning. So we can merge the two into a single one and
start/use that by default.

Author: guggero

itest/aperture_harness.go

@@ -27,7 +27,7 @@ type ApertureHarness struct {
 
 // NewApertureHarness creates a new instance of the aperture service. It returns
 // a harness which includes useful values for testing.
-func NewApertureHarness(t *testing.T, port int) ApertureHarness {
+func NewApertureHarness(t *testing.T, port int) *ApertureHarness {
 	// Create a temporary directory for the aperture service to use.
 	baseDir := filepath.Join(t.TempDir(), "aperture")
 	err := os.MkdirAll(baseDir, os.ModePerm)
@@ -55,7 +55,7 @@ func NewApertureHarness(t *testing.T, port int) ApertureHarness {
 	}
 	service := aperture.NewAperture(cfg)
 
-	return ApertureHarness{
+	return &ApertureHarness{
 		ListenAddr: listenAddr,
 		Service:    service,
 	}

itest/integration_test.go

@@ -59,11 +59,10 @@ func TestTaprootAssetsDaemon(t *testing.T) {
 			// The universe server and tapd client are both freshly
 			// created and later discarded for each test run to
 			// assure no state is taken over between runs.
-			tapdHarness, universeServer, proofCourier :=
-				setupHarnesses(
-					t1, ht, lndHarness,
-					testCase.proofCourierType,
-				)
+			tapdHarness, uniHarness, proofCourier := setupHarnesses(
+				t1, ht, lndHarness,
+				testCase.proofCourierType,
+			)
 			lndHarness.EnsureConnected(
 				lndHarness.Alice, lndHarness.Bob,
 			)
@@ -72,8 +71,8 @@ func TestTaprootAssetsDaemon(t *testing.T) {
 			lndHarness.Bob.AddToLogf(logLine)
 
 			ht := ht.newHarnessTest(
-				t1, lndHarness, universeServer,
-				tapdHarness, proofCourier,
+				t1, lndHarness, uniHarness, tapdHarness,
+				proofCourier,
 			)
 
 			// Now we have everything to run the test case.

itest/server_harness.go

@@ -213,7 +213,7 @@ func newTapdHarness(t *testing.T, ht *harnessTest, cfg tapdConfig,
 			typedProofCourier.ListenAddr,
 		)
 
-	case *UniverseRPCHarness:
+	case *universeServerHarness:
 		finalCfg.DefaultProofCourierAddr = fmt.Sprintf(
 			"%s://%s", proof.UniverseRpcCourierType,
 			typedProofCourier.ListenAddr,

itest/tapd_harness.go

@@ -95,7 +95,7 @@ type harnessTest struct {
 	// nil if not yet set up.
 	lndHarness *lntest.HarnessTest
 
-	universeServer *serverHarness
+	universeServer *universeServerHarness
 
 	tapd *tapdHarness
 
@@ -107,7 +107,7 @@ type harnessTest struct {
 // newHarnessTest creates a new instance of a harnessTest from a regular
 // testing.T instance.
 func (h *harnessTest) newHarnessTest(t *testing.T, net *lntest.HarnessTest,
-	universeServer *serverHarness, tapd *tapdHarness,
+	universeServer *universeServerHarness, tapd *tapdHarness,
 	proofCourier proof.CourierHarness) *harnessTest {
 
 	return &harnessTest{
@@ -174,7 +174,11 @@ func (h *harnessTest) LogfTimestamped(format string, args ...interface{}) {
 
 // shutdown stops both the mock universe and tapd server.
 func (h *harnessTest) shutdown(_ *testing.T) error {
-	h.universeServer.stop()
+	err := h.universeServer.Stop()
+	if err != nil {
+		return fmt.Errorf("unable to stop universe server harness: "+
+			"%w", err)
+	}
 
 	if h.proofCourier != nil {
 		err := h.proofCourier.Stop()
@@ -184,7 +188,7 @@ func (h *harnessTest) shutdown(_ *testing.T) error {
 		}
 	}
 
-	err := h.tapd.stop(!*noDelete)
+	err = h.tapd.stop(!*noDelete)
 	if err != nil {
 		return fmt.Errorf("unable to stop tapd: %v", err)
 	}
@@ -269,36 +273,34 @@ func nextAvailablePort() int {
 func setupHarnesses(t *testing.T, ht *harnessTest,
 	lndHarness *lntest.HarnessTest,
 	proofCourierType proof.CourierType) (*tapdHarness,
-	*serverHarness, proof.CourierHarness) {
+	*universeServerHarness, proof.CourierHarness) {
+
+	universeServer := newUniverseServerHarness(t, ht, lndHarness.Bob)
+
+	t.Logf("Starting universe server harness, listening on %v",
+		universeServer.ListenAddr)
+
+	err := universeServer.Start(nil)
+	require.NoError(t, err, "universe server harness")
 
 	// If a proof courier type is specified, start test specific proof
 	// courier service and attach to test harness.
 	var proofCourier proof.CourierHarness
 	switch proofCourierType {
 	case proof.HashmailCourierType:
 		port := nextAvailablePort()
-		apHarness := NewApertureHarness(ht.t, port)
-		proofCourier = &apHarness
+		apertureHarness := NewApertureHarness(ht.t, port)
+		err := apertureHarness.Start(nil)
+		require.NoError(t, err, "aperture proof courier harness")
+
+		proofCourier = apertureHarness
 
 	// If nothing is specified, we use the universe RPC proof courier by
 	// default.
 	default:
-		proofCourier = NewUniverseRPCHarness(t, ht, lndHarness.Bob)
+		proofCourier = universeServer
 	}
 
-	// Start the proof courier harness if specified.
-	if proofCourier != nil {
-		err := proofCourier.Start(nil)
-		require.NoError(t, err, "unable to start proof courier harness")
-	}
-
-	mockServerAddr := fmt.Sprintf(
-		node.ListenerFormat, node.NextAvailablePort(),
-	)
-	universeServer := newServerHarness(mockServerAddr)
-	err := universeServer.start()
-	require.NoError(t, err)
-
 	// Create a tapd that uses Bob and connect it to the universe server.
 	tapdHarness := setupTapdHarness(
 		t, ht, lndHarness.Alice, universeServer,
@@ -351,7 +353,7 @@ type Option func(*tapdHarnessParams)
 // setupTapdHarness creates a new tapd that connects to the given lnd node
 // and to the given universe server.
 func setupTapdHarness(t *testing.T, ht *harnessTest,
-	node *node.HarnessNode, universe *serverHarness,
+	node *node.HarnessNode, universe *universeServerHarness,
 	opts ...Option) *tapdHarness {
 
 	// Set parameters by executing option functions.
@@ -379,12 +381,10 @@ func setupTapdHarness(t *testing.T, ht *harnessTest,
 		ho.addrAssetSyncerDisable = params.addrAssetSyncerDisable
 	}
 
-	tapdHarness, err := newTapdHarness(
-		t, ht, tapdConfig{
-			NetParams: harnessNetParams,
-			LndNode:   node,
-		}, harnessOpts,
-	)
+	tapdHarness, err := newTapdHarness(t, ht, tapdConfig{
+		NetParams: harnessNetParams,
+		LndNode:   node,
+	}, harnessOpts)
 	require.NoError(t, err)
 
 	// Start the tapd harness now.

itest/test_harness.go

@@ -0,0 +1,48 @@
+package itest
+
+import (
+	"testing"
+
+	"github.com/lightninglabs/taproot-assets/proof"
+	"github.com/lightningnetwork/lnd/lntest/node"
+	"github.com/stretchr/testify/require"
+)
+
+type universeServerHarness struct {
+	// service is the instance of the universe tap service.
+	service *tapdHarness
+
+	// ListenAddr is the address that the service is listening on.
+	ListenAddr string
+}
+
+func newUniverseServerHarness(t *testing.T, ht *harnessTest,
+	lndHarness *node.HarnessNode) *universeServerHarness {
+
+	service, err := newTapdHarness(t, ht, tapdConfig{
+		NetParams: harnessNetParams,
+		LndNode:   lndHarness,
+	})
+	require.NoError(t, err)
+
+	return &universeServerHarness{
+		service:    service,
+		ListenAddr: service.rpcHost(),
+	}
+}
+
+// Start starts the service.
+func (h *universeServerHarness) Start(_ chan error) error {
+	return h.service.start(false)
+}
+
+// Stop stops the service.
+func (h *universeServerHarness) Stop() error {
+	// Don't delete temporary data on stop. This will allow us to cleanly
+	// restart the service mid-test.
+	return h.service.stop(false)
+}
+
+// Ensure that universeServerHarness implements the proof.CourierHarness
+// interface.
+var _ proof.CourierHarness = (*universeServerHarness)(nil)