aboutsummaryrefslogblamecommitdiffstats
path: root/swarm/storage/localstore/subscription_push_test.go
blob: 73e7c25f72dea3650204ec09cc75f8b9efa6f227 (plain) (tree)







































































































































































































                                                                                                                                          
// Copyright 2019 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package localstore

import (
    "bytes"
    "context"
    "fmt"
    "sync"
    "testing"
    "time"

    "github.com/ethereum/go-ethereum/swarm/storage"
)

// TestDB_SubscribePush uploads some chunks before and after
// push syncing subscription is created and validates if
// all addresses are received in the right order.
func TestDB_SubscribePush(t *testing.T) {
    db, cleanupFunc := newTestDB(t, nil)
    defer cleanupFunc()

    uploader := db.NewPutter(ModePutUpload)

    chunks := make([]storage.Chunk, 0)
    var chunksMu sync.Mutex

    uploadRandomChunks := func(count int) {
        for i := 0; i < count; i++ {
            chunk := generateRandomChunk()

            err := uploader.Put(chunk)
            if err != nil {
                t.Fatal(err)
            }

            chunksMu.Lock()
            chunks = append(chunks, chunk)
            chunksMu.Unlock()
        }
    }

    // prepopulate database with some chunks
    // before the subscription
    uploadRandomChunks(10)

    // set a timeout on subscription
    ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
    defer cancel()

    // collect all errors from validating addresses, even nil ones
    // to validate the number of addresses received by the subscription
    errChan := make(chan error)

    ch, stop := db.SubscribePush(ctx)
    defer stop()

    // receive and validate addresses from the subscription
    go func() {
        var i int // address index
        for {
            select {
            case got, ok := <-ch:
                if !ok {
                    return
                }
                chunksMu.Lock()
                want := chunks[i]
                chunksMu.Unlock()
                var err error
                if !bytes.Equal(got.Data(), want.Data()) {
                    err = fmt.Errorf("got chunk %v data %x, want %x", i, got.Data(), want.Data())
                }
                if !bytes.Equal(got.Address(), want.Address()) {
                    err = fmt.Errorf("got chunk %v address %s, want %s", i, got.Address().Hex(), want.Address().Hex())
                }
                i++
                // send one and only one error per received address
                errChan <- err
            case <-ctx.Done():
                return
            }
        }
    }()

    // upload some chunks just after subscribe
    uploadRandomChunks(5)

    time.Sleep(200 * time.Millisecond)

    // upload some chunks after some short time
    // to ensure that subscription will include them
    // in a dynamic environment
    uploadRandomChunks(3)

    checkErrChan(ctx, t, errChan, len(chunks))
}

// TestDB_SubscribePush_multiple uploads chunks before and after
// multiple push syncing subscriptions are created and
// validates if all addresses are received in the right order.
func TestDB_SubscribePush_multiple(t *testing.T) {
    db, cleanupFunc := newTestDB(t, nil)
    defer cleanupFunc()

    uploader := db.NewPutter(ModePutUpload)

    addrs := make([]storage.Address, 0)
    var addrsMu sync.Mutex

    uploadRandomChunks := func(count int) {
        for i := 0; i < count; i++ {
            chunk := generateRandomChunk()

            err := uploader.Put(chunk)
            if err != nil {
                t.Fatal(err)
            }

            addrsMu.Lock()
            addrs = append(addrs, chunk.Address())
            addrsMu.Unlock()
        }
    }

    // prepopulate database with some chunks
    // before the subscription
    uploadRandomChunks(10)

    // set a timeout on subscription
    ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
    defer cancel()

    // collect all errors from validating addresses, even nil ones
    // to validate the number of addresses received by the subscription
    errChan := make(chan error)

    subsCount := 10

    // start a number of subscriptions
    // that all of them will write every addresses error to errChan
    for j := 0; j < subsCount; j++ {
        ch, stop := db.SubscribePush(ctx)
        defer stop()

        // receive and validate addresses from the subscription
        go func(j int) {
            var i int // address index
            for {
                select {
                case got, ok := <-ch:
                    if !ok {
                        return
                    }
                    addrsMu.Lock()
                    want := addrs[i]
                    addrsMu.Unlock()
                    var err error
                    if !bytes.Equal(got.Address(), want) {
                        err = fmt.Errorf("got chunk %v address on subscription %v %s, want %s", i, j, got, want)
                    }
                    i++
                    // send one and only one error per received address
                    errChan <- err
                case <-ctx.Done():
                    return
                }
            }
        }(j)
    }

    // upload some chunks just after subscribe
    uploadRandomChunks(5)

    time.Sleep(200 * time.Millisecond)

    // upload some chunks after some short time
    // to ensure that subscription will include them
    // in a dynamic environment
    uploadRandomChunks(3)

    // number of addresses received by all subscriptions
    wantedChunksCount := len(addrs) * subsCount

    checkErrChan(ctx, t, errChan, wantedChunksCount)
}