lnd.xprv/channeldb/migration13/migration_test.go

package migration13

import (
	"testing"

	"github.com/lightningnetwork/lnd/channeldb/kvdb"
	"github.com/lightningnetwork/lnd/channeldb/migtest"
)

var (
	hex = migtest.Hex

	zeroTime             = hex("0000000000000000")
	noFailureMessage     = hex("00")
	failureReasonUnknown = hex("00")
	zeroFailureSourceIdx = hex("00000000")

	hash1                 = hex("02acee76ebd53d00824410cf6adecad4f50334dac702bd5a2d3ba01b91709f0e")
	creationInfoAmt1      = hex("00000000004c4b40")
	creationInfoTime1     = hex("000000005e4fb7ab") // 1582282667 (decimal)
	creationInfoTimeNano1 = hex("15f565b3cccaee00") // 1582282667000000000 (decimal)
	creationInfoPayReq1   = hex("00000000")
	attemptInfo1          = hex("2997a72e129fc9d638ef2fa4e233567d808d4f18a4f087637582427962eb3bf800005ce600000000004c4b402102ec12e83eafe27ce6d03bbe0c0de4b79fe2b9934615c8aa7693f73d2e41b089700000000121028c2dd128c7a6c1a0fceb3e3eb5ed55e0a0ae1a939eb786b097322d830d47db75005ca4000001000000005ce600000000004c4b400000000000")
	attemptID1            = hex("0000000000000001")
	paymentID1            = hex("0000000000000001")

	hash2                 = hex("62eb3f0a48f954e495d0c14ac63df04a67cefa59dafdbcd3d5046d1f5647840c")
	preimage2             = hex("479593b7d3cbb45beb22d448451a2f3619b2095adfb38f4d92e9886e96534368")
	attemptID2            = hex("00000000000003e8")
	paymentID2            = hex("0000000000000002")
	attemptInfo2          = hex("8de663f9bb4b8d1ebdb496d22dc1cb657a346215607308549f41b01e2adf2ce900005ce600000000005b8d802102ec12e83eafe27ce6d03bbe0c0de4b79fe2b9934615c8aa7693f73d2e41b089700000000121028c2dd128c7a6c1a0fceb3e3eb5ed55e0a0ae1a939eb786b097322d830d47db75005ca4000001000000005ce600000000005b8d8000000000010000000000000008233d281e2cbe01f0b82dd6750967c9233426b98ae6549c696365f57f86f942a3795b8d80")
	creationInfoAmt2      = hex("00000000005b8d80")
	creationInfoTime2     = hex("000000005e4fb97f") // 1582283135 (decimal)
	creationInfoTimeNano2 = hex("15F56620C3C43600") // 1582283135000000000 (decimal)
	creationInfoPayReq2   = hex("000000fc6c6e62637274363075317030796c7774367070357674346e377a6a676c39327766397773633939767630307366666e7561376a656d74376d6535373471336b3337346a387373787164717163717a70677370353835357075743937713863747374776b7735796b306a667278736e746e7a6878326a77786a636d3937346c636437327a3564757339717939717371653872336b3578733379367868667366366d6a6e706d717172306661797a677a63336a6b663571787a6c376866787a6666763578667a7679647564327275767974706571787072376868796830726a747574373033333274737774686661616e303773766b6667716b7174667275")

	hash3                 = hex("62eb3f0a48f954e495d0c14ac63df04a67cefa59dafdbcd3d5046d1f5647840d")
	attemptInfo3          = hex("53ce0a4c1507cc5ea00ec88b76bd43a3978ac13605497030b821af6ce9c110f300005ce600000000006acfc02102ec12e83eafe27ce6d03bbe0c0de4b79fe2b9934615c8aa7693f73d2e41b089700000000121028c2dd128c7a6c1a0fceb3e3eb5ed55e0a0ae1a939eb786b097322d830d47db75005ca4000001000000005ce600000000006acfc000000000010000000000000008233044f235354472318b381fad3e21eb5a58f5099918868b0610e7b7bcb7a4adc96acfc0")
	attemptID3            = hex("00000000000003e9")
	paymentID3            = hex("0000000000000003")
	creationInfoAmt3      = hex("00000000006acfc0")
	creationInfoTime3     = hex("000000005e4fb98d") // 1582283149
	creationInfoTimeNano3 = hex("15F56624063B4200") // 1582283149000000000 (decimal)
	creationInfoPayReq3   = hex("000000fc6c6e62637274373075317030796c7776327070357674346e377a6a676c39327766397773633939767630307366666e7561376a656d74376d6535373471336b3337346a387373787364717163717a706773703578707a307964663467336572727a656372376b6e7567307474667630327a7665727a72676b70737375376d6d6564617934687973397179397173717774656479336e666c323534787a36787a75763974746767757a647473356e617a7461616a6735667772686438396b336d70753971726d7a6c3779637a306e30666e6e763077753032726632706e64636c393761646c667636376a7a6e7063677477356434366771323571326e32")

	// pre is the data in the payments root bucket in database version 12 format.
	pre = map[string]interface{}{
		// A failed payment.
		hash1: map[string]interface{}{
			"payment-attempt-info":  attemptID1 + attemptInfo1,
			"payment-creation-info": hash1 + creationInfoAmt1 + creationInfoTime1 + creationInfoPayReq1,
			"payment-fail-info":     hex("03"),
			"payment-sequence-key":  paymentID1,
		},

		// A settled payment.
		hash2: map[string]interface{}{
			"payment-attempt-info":  attemptID2 + attemptInfo2,
			"payment-creation-info": hash2 + creationInfoAmt2 + creationInfoTime2 + creationInfoPayReq2,
			"payment-sequence-key":  paymentID2,
			"payment-settle-info":   preimage2,
		},

		// An in-flight payment.
		hash3: map[string]interface{}{
			"payment-attempt-info":  attemptID3 + attemptInfo3,
			"payment-creation-info": hash3 + creationInfoAmt3 + creationInfoTime3 + creationInfoPayReq3,
			"payment-sequence-key":  paymentID3,
		},
	}

	// post is the expected data after migration.
	post = map[string]interface{}{
		hash1: map[string]interface{}{
			"payment-creation-info": hash1 + creationInfoAmt1 + creationInfoTimeNano1 + creationInfoPayReq1,
			"payment-fail-info":     hex("03"),
			"payment-htlcs-bucket": map[string]interface{}{
				attemptID1: map[string]interface{}{
					"htlc-attempt-info": attemptInfo1 + zeroTime,
					"htlc-fail-info":    zeroTime + noFailureMessage + failureReasonUnknown + zeroFailureSourceIdx,
				},
			},
			"payment-sequence-key": paymentID1,
		},
		hash2: map[string]interface{}{
			"payment-creation-info": hash2 + creationInfoAmt2 + creationInfoTimeNano2 + creationInfoPayReq2,
			"payment-htlcs-bucket": map[string]interface{}{
				attemptID2: map[string]interface{}{
					"htlc-attempt-info": attemptInfo2 + zeroTime,
					"htlc-settle-info":  preimage2 + zeroTime,
				},
			},
			"payment-sequence-key": paymentID2,
		},
		hash3: map[string]interface{}{
			"payment-creation-info": hash3 + creationInfoAmt3 + creationInfoTimeNano3 + creationInfoPayReq3,
			"payment-htlcs-bucket": map[string]interface{}{
				attemptID3: map[string]interface{}{
					"htlc-attempt-info": attemptInfo3 + zeroTime,
				},
			},
			"payment-sequence-key": paymentID3,
		},
	}
)

// TestMigrateMpp asserts that the database is properly migrated to the mpp
// payment structure.
func TestMigrateMpp(t *testing.T) {
	var paymentsRootBucket = []byte("payments-root-bucket")

	migtest.ApplyMigration(
		t,
		func(tx kvdb.RwTx) error {
			return migtest.RestoreDB(tx, paymentsRootBucket, pre)
		},
		func(tx kvdb.RwTx) error {
			return migtest.VerifyDB(tx, paymentsRootBucket, post)
		},
		MigrateMPP,
		false,
	)
}