1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
|
// Copyright 2024 The Tessera authors. All Rights Reserved.
//
// 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
//
// http://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.
// Package integration_test contains some integration tests which are intended to
// serve as a way of checking that example binary works as intended,
// as well as providing a simple example of how to run and use it.
package integration_test
import (
"bytes"
"context"
"flag"
"fmt"
"io"
"net/http"
"net/url"
"os"
"strconv"
"strings"
"sync"
"testing"
"time"
"github.com/transparency-dev/merkle/proof"
"github.com/transparency-dev/merkle/rfc6962"
"github.com/transparency-dev/tessera/api/layout"
"github.com/transparency-dev/tessera/client"
"golang.org/x/mod/sumdb/note"
"golang.org/x/sync/errgroup"
"k8s.io/klog/v2"
)
var (
runIntegrationTest = flag.Bool("run_integration_test", false, "If true, the integration tests in this package will not be skipped")
logURL = flag.String("log_url", "http://localhost:2024", "Log storage read root URL, e.g. https://log.server/and/path/")
writeLogURL = flag.String("write_log_url", "http://localhost:2024", "Log storage write root URL, e.g. https://log.server/and/path/")
logPublicKey = flag.String("log_public_key", "", "The log's public key value for checkpoint note verification")
testEntrySize = flag.Int("test_entry_size", 1024, "The number of entries to be tested in the live log integration")
noteVerifier note.Verifier
logReadBaseURL *url.URL
logReadCP client.CheckpointFetcherFunc
logReadTile client.TileFetcherFunc
logReadEntryBundle client.EntryBundleFetcherFunc
hc = &http.Client{
Transport: &http.Transport{
MaxIdleConns: 256,
MaxIdleConnsPerHost: 256,
},
Timeout: 60 * time.Second,
}
)
func TestMain(m *testing.M) {
klog.InitFlags(nil)
flag.Parse()
if !*runIntegrationTest {
klog.Warning("example binary integration tests are skipped")
return
}
var err error
noteVerifier, err = note.NewVerifier(*logPublicKey)
if err != nil {
klog.Fatalf("Failed to create new verifier: %v", err)
}
logReadBaseURL, err = url.Parse(*logURL)
if err != nil {
klog.Fatalf("failed to parse logURL: %v", err)
}
switch logReadBaseURL.Scheme {
case "http", "https":
hf, err := client.NewHTTPFetcher(logReadBaseURL, nil)
if err != nil {
klog.Fatalf("NewHTTPFetcher: %v", err)
}
logReadCP = hf.ReadCheckpoint
logReadTile = hf.ReadTile
logReadEntryBundle = hf.ReadEntryBundle
case "file":
ff := client.FileFetcher{Root: logReadBaseURL.Path}
logReadCP = ff.ReadCheckpoint
logReadTile = ff.ReadTile
logReadEntryBundle = ff.ReadEntryBundle
default:
klog.Fatalf("unsupported url scheme: %s", logReadBaseURL.Scheme)
}
os.Exit(m.Run())
}
func TestLiveLogIntegration(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
defer cancel()
var entryIndexMap sync.Map
// Step 1 - Get checkpoint initial size for increment validation.
lst, err := client.NewLogStateTracker(ctx, logReadTile, nil, noteVerifier, noteVerifier.Name(), client.UnilateralConsensus(logReadCP))
if err != nil {
t.Fatalf("client.NewLogStateTracker: %v", err)
}
checkpointInitSize := lst.Latest().Size
// Step 2 - Add entries and get new checkpoints. The entry data comes from the int loop ranging from 0 to the test entry size - 1.
addEntriesURL, err := url.JoinPath(*writeLogURL, "add")
if err != nil {
t.Errorf("url.JoinPath: %v", err)
}
entryWriter := entryWriter{
addURL: addEntriesURL,
}
var miMu sync.Mutex
var maxIndex uint64
errG := errgroup.Group{}
for i := range *testEntrySize {
errG.Go(func() error {
index, err := entryWriter.add(ctx, fmt.Appendf(nil, "%d", i))
if err != nil {
return fmt.Errorf("entryWriter.add(%d): %v", i, err)
}
entryIndexMap.Store(i, index)
miMu.Lock()
defer miMu.Unlock()
if maxIndex < index {
maxIndex = index
}
return nil
})
}
if err := errG.Wait(); err != nil {
t.Fatalf("addEntry: %v", err)
}
// All entries are queued. Wait for a checkpoint committing to maxIndex.
for size := lst.Latest().Size; size <= maxIndex; {
if _, _, _, err := lst.Update(ctx); err != nil {
t.Errorf("lst.Update: %v", err)
}
size = lst.Latest().Size
time.Sleep(50 * time.Millisecond)
}
gotIncrease := lst.Latest().Size - checkpointInitSize
if gotIncrease < uint64(*testEntrySize) {
t.Logf("checkpoint size increase (%d) is < %d, entries may have been deduplicated.", gotIncrease, *testEntrySize)
}
// Step 3 - Loop through the entry data index map to verify leaves and inclusion proofs.
entryIndexMap.Range(func(k, v any) bool {
data := k.(int)
index := v.(uint64)
// Step 4.1 - Get entry bundles to read back what was written, check leaves are correct.
entryBundle, err := client.GetEntryBundle(ctx, logReadEntryBundle, index/layout.EntryBundleWidth, lst.Latest().Size)
if err != nil {
t.Fatalf("client.GetEntryBundle: %v", err)
}
got, want := entryBundle.Entries[index%layout.EntryBundleWidth], fmt.Appendf(nil, "%d", data)
if !bytes.Equal(got, want) {
t.Errorf("Entry bundle (index: %d) got %v want %v", index, got, want)
}
// Step 4.2 - Test inclusion proofs.
pb, err := client.NewProofBuilder(ctx, lst.Latest().Size, logReadTile)
if err != nil {
t.Errorf("client.NewProofBuilder: %v", err)
}
ip, err := pb.InclusionProof(ctx, index)
if err != nil {
t.Errorf("pb.InclusionProof: %v", err)
}
leafHash := rfc6962.DefaultHasher.HashLeaf(fmt.Append(nil, data))
if err := proof.VerifyInclusion(rfc6962.DefaultHasher, index, lst.Latest().Size, leafHash, ip, lst.Latest().Hash); err != nil {
t.Errorf("proof.VerifyInclusion: %v", err)
}
return true
})
}
type entryWriter struct {
addURL string
}
func (w *entryWriter) add(ctx context.Context, entry []byte) (uint64, error) {
req, err := http.NewRequestWithContext(ctx, http.MethodPost, w.addURL, bytes.NewReader(entry))
if err != nil {
return 0, err
}
resp, err := hc.Do(req)
if err != nil {
return 0, err
}
body, err := io.ReadAll(resp.Body)
defer func() {
if err := resp.Body.Close(); err != nil {
klog.Warningf("resp.Body.Close(): %v", err)
}
}()
if err != nil {
return 0, fmt.Errorf("failed to read response from %s: %w", w.addURL, err)
}
if resp.StatusCode != http.StatusOK {
return 0, fmt.Errorf("code: %s, path: %s, body: %s", resp.Status, w.addURL, strings.TrimSpace(string(body)))
}
index, err := strconv.ParseUint(string(body), 10, 64)
if err != nil {
return 0, err
}
return index, nil
}
|