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
|
// Copyright 2024 Trillian 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 postgresql
import (
"context"
"fmt"
"testing"
"github.com/google/trillian"
"github.com/google/trillian/storage"
"github.com/google/trillian/storage/testonly"
"github.com/jackc/pgx/v5"
"github.com/jackc/pgx/v5/pgxpool"
"google.golang.org/protobuf/proto"
)
const selectTreeControlByID = "SELECT SigningEnabled,SequencingEnabled,SequenceIntervalSeconds " +
"FROM TreeControl " +
"WHERE TreeId=$1"
func TestPostgresqlAdminStorage(t *testing.T) {
tester := &testonly.AdminStorageTester{NewAdminStorage: func() storage.AdminStorage {
cleanTestDB(DB)
return NewAdminStorage(DB)
}}
tester.RunAllTests(t)
}
func TestAdminTX_CreateTree_InitializesStorageStructures(t *testing.T) {
cleanTestDB(DB)
s := NewAdminStorage(DB)
ctx := context.Background()
tree, err := storage.CreateTree(ctx, s, testonly.LogTree)
if err != nil {
t.Fatalf("CreateTree() failed: %v", err)
}
// Check if TreeControl is correctly written.
var signingEnabled, sequencingEnabled bool
var sequenceIntervalSeconds int
if err := DB.QueryRow(ctx, selectTreeControlByID, tree.TreeId).Scan(&signingEnabled, &sequencingEnabled, &sequenceIntervalSeconds); err != nil {
t.Fatalf("Failed to read TreeControl: %v", err)
}
// We don't mind about specific values, defaults change, but let's check
// that important numbers are not zeroed.
if sequenceIntervalSeconds <= 0 {
t.Errorf("sequenceIntervalSeconds = %v, want > 0", sequenceIntervalSeconds)
}
}
func TestCreateTreeInvalidStates(t *testing.T) {
cleanTestDB(DB)
s := NewAdminStorage(DB)
ctx := context.Background()
states := []trillian.TreeState{trillian.TreeState_DRAINING, trillian.TreeState_FROZEN}
for _, state := range states {
inTree := proto.Clone(testonly.LogTree).(*trillian.Tree)
inTree.TreeState = state
if _, err := storage.CreateTree(ctx, s, inTree); err == nil {
t.Errorf("CreateTree() state: %v got: nil want: err", state)
}
}
}
func TestAdminTX_TreeWithNulls(t *testing.T) {
cleanTestDB(DB)
s := NewAdminStorage(DB)
ctx := context.Background()
// Setup: create a tree and set all nullable columns to null.
// Some columns have to be manually updated, as it's not possible to set
// some proto fields to nil.
tree, err := storage.CreateTree(ctx, s, testonly.LogTree)
if err != nil {
t.Fatalf("CreateTree() failed: %v", err)
}
treeID := tree.TreeId
if err := setNulls(ctx, DB, treeID); err != nil {
t.Fatalf("setNulls() = %v, want = nil", err)
}
tests := []struct {
desc string
fn storage.AdminTXFunc
}{
{
desc: "GetTree",
fn: func(ctx context.Context, tx storage.AdminTX) error {
_, err := tx.GetTree(ctx, treeID)
return err
},
},
{
desc: "ListTrees",
fn: func(ctx context.Context, tx storage.AdminTX) error {
trees, err := tx.ListTrees(ctx, false /* includeDeleted */)
if err != nil {
return err
}
for _, tree := range trees {
if tree.TreeId == treeID {
return nil
}
}
return fmt.Errorf("ID not found: %v", treeID)
},
},
}
for _, test := range tests {
if err := s.ReadWriteTransaction(ctx, test.fn); err != nil {
t.Errorf("%v: err = %v, want = nil", test.desc, err)
}
}
}
func TestAdminTX_HardDeleteTree(t *testing.T) {
cleanTestDB(DB)
s := NewAdminStorage(DB)
ctx := context.Background()
tree, err := storage.CreateTree(ctx, s, testonly.LogTree)
if err != nil {
t.Fatalf("CreateTree() returned err = %v", err)
}
if err := s.ReadWriteTransaction(ctx, func(ctx context.Context, tx storage.AdminTX) error {
if _, err := tx.SoftDeleteTree(ctx, tree.TreeId); err != nil {
return err
}
return tx.HardDeleteTree(ctx, tree.TreeId)
}); err != nil {
t.Fatalf("ReadWriteTransaction() returned err = %v", err)
}
// Unlike the HardDelete tests on AdminStorageTester, here we have the chance to poke inside the
// database and check that the rows are gone, so let's do just that.
// If there's no record on Trees, then there can be no record in any of the dependent tables.
var name string
if err := DB.QueryRow(ctx, "SELECT DisplayName FROM Trees WHERE TreeId=$1", tree.TreeId).Scan(&name); err != pgx.ErrNoRows {
t.Errorf("QueryRow() returned err = %v, want = %v", err, pgx.ErrNoRows)
}
}
func TestCheckDatabaseAccessible_Fails(t *testing.T) {
ctx := context.Background()
// Pass in a closed database to provoke a failure.
db, done := openTestDBOrDie()
cleanTestDB(db)
s := NewAdminStorage(db)
done(ctx)
if err := s.CheckDatabaseAccessible(ctx); err == nil {
t.Error("TestCheckDatabaseAccessible_Fails got: nil, want: err")
}
}
func TestCheckDatabaseAccessible_OK(t *testing.T) {
cleanTestDB(DB)
s := NewAdminStorage(DB)
ctx := context.Background()
if err := s.CheckDatabaseAccessible(ctx); err != nil {
t.Errorf("TestCheckDatabaseAccessible_OK got: %v, want: nil", err)
}
}
func setNulls(ctx context.Context, db *pgxpool.Pool, treeID int64) error {
_, err := db.Exec(ctx, "UPDATE Trees SET DisplayName=NULL,Description=NULL WHERE TreeId=$1", treeID)
return err
}
|