itest: add custom oracle address harness option

Not all itests need to use an oracle server harness, so we introduce a
functional option that may be defined when setting up a harness. This
will reduce the overall diff as previous callers of the harness setup
functions won't need to change their arguments.

Author: GeorgeTsagk

itest/rfq_test.go

@@ -546,13 +546,69 @@ type rfqTestScenario struct {
 	CarolTapd *tapdHarness
 }
 
+// rfqTestScenarioOpts is a struct that holds options related to creating an rfq
+// test scenario.
+type rfqTestScenarioOpts struct {
+	oracleServerAddr  string
+	oracleServerAlice string
+	oracleServerBob   string
+	oracleServerCarol string
+}
+
+// RfqOption is a functional option that edits an existing instance of rfq
+// test scenario options.
+type RfqOption func(*rfqTestScenarioOpts)
+
+// DefaultRfqOptions returns the default set of rfq test scenario options.
+func DefaultRfqOptions() rfqTestScenarioOpts {
+	return rfqTestScenarioOpts{}
+}
+
+// WithRfqOracleServer is a functional option that sets the oracle server option
+// to the provided string. This oracle server will be the default oracle for
+// all test scenario tapd nodes.
+func WithRfqOracleServer(s string) RfqOption {
+	return func(rtso *rfqTestScenarioOpts) {
+		rtso.oracleServerAddr = s
+	}
+}
+
+// WithAliceOracleServer sets the oracle server to be used by Alice tapd. This
+// will override the global oracle server option.
+func WithAliceOracleServer(s string) RfqOption {
+	return func(rtso *rfqTestScenarioOpts) {
+		rtso.oracleServerAlice = s
+	}
+}
+
+// WithBobOracleServer sets the oracle server to be used by Bob tapd. This will
+// override the global oracle server option.
+func WithBobOracleServer(s string) RfqOption {
+	return func(rtso *rfqTestScenarioOpts) {
+		rtso.oracleServerBob = s
+	}
+}
+
+// WithCarolOracleServer sets the oracle server to be used by Carol tapd. This
+// will override the global oracle server option.
+func WithCarolOracleServer(s string) RfqOption {
+	return func(rtso *rfqTestScenarioOpts) {
+		rtso.oracleServerCarol = s
+	}
+}
+
 // newRfqTestScenario initializes a new test scenario with three new LND nodes
 // and connects them to have the following topology,
 //
 //	Alice --> Bob --> Carol
 //
 // It also creates new tapd nodes for each of the LND nodes.
-func newRfqTestScenario(t *harnessTest) *rfqTestScenario {
+func newRfqTestScenario(t *harnessTest, opts ...RfqOption) *rfqTestScenario {
+	rfqOpts := DefaultRfqOptions()
+	for _, opt := range opts {
+		opt(&rfqOpts)
+	}
+
 	// Specify wallet outputs to fund the wallets of the new nodes.
 	const fundAmount = 1 * btcutil.SatoshiPerBitcoin
 
@@ -607,9 +663,22 @@ func newRfqTestScenario(t *harnessTest) *rfqTestScenario {
 	t.lndHarness.AssertTopologyChannelOpen(carolLnd, aliceBobChannel)
 
 	// Create tapd nodes.
-	aliceTapd := setupTapdHarness(t.t, t, aliceLnd, t.universeServer)
-	bobTapd := setupTapdHarness(t.t, t, bobLnd, t.universeServer)
-	carolTapd := setupTapdHarness(t.t, t, carolLnd, t.universeServer)
+	aliceTapd := setupTapdHarness(
+		t.t, t, aliceLnd, t.universeServer, WithOracleServer(
+			rfqOpts.oracleServerAddr, rfqOpts.oracleServerAlice,
+		),
+	)
+
+	bobTapd := setupTapdHarness(
+		t.t, t, bobLnd, t.universeServer, WithOracleServer(
+			rfqOpts.oracleServerAddr, rfqOpts.oracleServerBob,
+		),
+	)
+	carolTapd := setupTapdHarness(
+		t.t, t, carolLnd, t.universeServer, WithOracleServer(
+			rfqOpts.oracleServerAddr, rfqOpts.oracleServerCarol,
+		),
+	)
 
 	ts := rfqTestScenario{
 		testHarness: t,

itest/tapd_harness.go

@@ -118,6 +118,7 @@ type harnessOpts struct {
 	proofCourier                 proof.CourierHarness
 	custodianProofRetrievalDelay *time.Duration
 	addrAssetSyncerDisable       bool
+	oracleServerAddress          string
 
 	// fedSyncTickerInterval is the interval at which the federation envoy
 	// sync ticker will fire.
@@ -138,6 +139,14 @@ func defaultHarnessOpts() *harnessOpts {
 	return &harnessOpts{}
 }
 
+// withOracleAddress is a functional option that sets the oracle address option
+// to the provided string.
+func withOracleAddress(addr string) harnessOption {
+	return func(ho *harnessOpts) {
+		ho.oracleServerAddress = addr
+	}
+}
+
 // newTapdHarness creates a new tapd server harness with the given
 // configuration.
 func newTapdHarness(t *testing.T, ht *harnessTest, cfg tapdConfig,
@@ -218,13 +227,20 @@ func newTapdHarness(t *testing.T, ht *harnessTest, cfg tapdConfig,
 	// was not set, this will be false, which is the default.
 	tapCfg.AddrBook.DisableSyncer = opts.addrAssetSyncerDisable
 
-	// Set the experimental config for the RFQ service.
-	tapCfg.Experimental = &tapcfg.ExperimentalConfig{
-		Rfq: rfq.CliConfig{
-			//nolint:lll
-			PriceOracleAddress:     rfq.MockPriceOracleServiceAddress,
-			MockOracleAssetsPerBTC: 5_820_600,
-		},
+	switch {
+	case len(opts.oracleServerAddress) > 0:
+		tapCfg.Experimental.Rfq.PriceOracleAddress =
+			opts.oracleServerAddress
+
+	default:
+		// Set the experimental config for the RFQ service.
+		tapCfg.Experimental = &tapcfg.ExperimentalConfig{
+			Rfq: rfq.CliConfig{
+				//nolint:lll
+				PriceOracleAddress:     rfq.MockPriceOracleServiceAddress,
+				MockOracleAssetsPerBTC: 5_820_600,
+			},
+		}
 	}
 
 	cfgLogger := tapCfg.LogWriter.GenSubLogger("CONF", nil)

itest/test_harness.go

@@ -386,10 +386,29 @@ type tapdHarnessParams struct {
 
 	// disableSyncCache indicates whether the sync cache should be disabled.
 	disableSyncCache bool
+
+	// oracleServerAddress defines the oracle server's address that this
+	// tapd harness is going to use.
+	oracleServerAddress string
 }
 
+// Option is a tapd harness option.
 type Option func(*tapdHarnessParams)
 
+// WithOracleServer is a functional option that sets the oracle server address
+// option to the provided string.
+func WithOracleServer(global, override string) Option {
+	return func(th *tapdHarnessParams) {
+		switch {
+		case len(override) > 0:
+			th.oracleServerAddress = override
+
+		case len(global) > 0:
+			th.oracleServerAddress = global
+		}
+	}
+}
+
 // 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,
@@ -422,6 +441,7 @@ func setupTapdHarness(t *testing.T, ht *harnessTest,
 		ho.fedSyncTickerInterval = params.fedSyncTickerInterval
 		ho.sqliteDatabaseFilePath = params.sqliteDatabaseFilePath
 		ho.disableSyncCache = params.disableSyncCache
+		ho.oracleServerAddress = params.oracleServerAddress
 	}
 
 	tapdCfg := tapdConfig{