Skip to content

mtca/mtpublisher: Rename the checkpoint row structs to checkpointRow #8971

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
beautifulentropy wants to merge 1 commit into from
+20 −20
Open

mtca/mtpublisher: Rename the checkpoint row structs to checkpointRow #8971

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions mtca/mtca.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ func getCAID(issuerCert *x509.Certificate) (string, error) {
}

func initDB(dbMap *borp.DbMap) *db.WrappedMap {
dbMap.AddTableWithName(checkpoint{}, "checkpoints").SetKeys(true, "ID")
dbMap.AddTableWithName(checkpointRow{}, "checkpoints").SetKeys(true, "ID")
return db.NewWrappedMap(dbMap)
}

Expand Down Expand Up @@ -188,7 +188,7 @@ func (m *mtca) InitLog(ctx context.Context) error {
m.logID.String(), numCheckpoints, numLatestCheckpoints)
}

firstCheckpoint := checkpoint{
firstCheckpoint := checkpointRow{
MTCLogID: m.logID.String(),
TreeSize: candidate.TreeSize(),
RootHash: rootHash[:],
Expand Down Expand Up @@ -482,7 +482,7 @@ func (m *mtca) sequence(ctx context.Context) error {
return fmt.Errorf("staging candidate tiles: %s", err)
}

newCheckpoint := checkpoint{
newCheckpoint := checkpointRow{
ID: 0,
MTCLogID: m.logID.String(),
MTCASignature: nil,
Expand Down Expand Up @@ -593,7 +593,7 @@ func (m *mtca) sequence(ctx context.Context) error {
// checkpoint represents the database storage of a checkpoint and associated signatures.
//
// For signing, the TreeSize and RootHash fields are incorporated into a `cosigned.Message`.
type checkpoint struct {
type checkpointRow struct {
ID int64 `db:"id"`
MTCLogID string `db:"mtcLogID"`
MTCASignature []byte `db:"mtcaSignature"`
Expand All @@ -603,7 +603,7 @@ type checkpoint struct {
RootHash []byte `db:"rootHash"`
}

func (c *checkpoint) valid() error {
func (c *checkpointRow) valid() error {
if len(c.MTCLogID) == 0 {
return errors.New("MTCLogID is empty")
}
Expand All @@ -620,12 +620,12 @@ func (c *checkpoint) valid() error {
return nil
}

func (c *checkpoint) mirrored() bool {
func (c *checkpointRow) mirrored() bool {
return len(c.MTCASignature) > 0 && len(c.MirrorSignature) > 0
}

// String returns a string that is reasonable to print in logs, omitting the (large) signatures.
func (c *checkpoint) String() string {
func (c *checkpointRow) String() string {
caSig := "empty"
if len(c.MTCASignature) > 0 {
caSig = "non-empty"
Expand All @@ -638,8 +638,8 @@ func (c *checkpoint) String() string {
c.ID, c.MTCLogID, caSig, c.MirrorID, mirrorSig, c.TreeSize, c.RootHash)
}

func (m *mtca) latestCheckpoint(ctx context.Context) (*checkpoint, error) {
var latest checkpoint
func (m *mtca) latestCheckpoint(ctx context.Context) (*checkpointRow, error) {
var latest checkpointRow
err := m.db.SelectOne(ctx, &latest,
`SELECT id, checkpoints.mtcLogID, mtcaSignature, mirrorID,
mirrorSignature, treeSize, rootHash
Expand All @@ -659,7 +659,7 @@ func (m *mtca) latestCheckpoint(ctx context.Context) (*checkpoint, error) {
return &latest, nil
}

func (m *mtca) signCheckpoint(c *checkpoint) ([]byte, error) {
func (m *mtca) signCheckpoint(c *checkpointRow) ([]byte, error) {
err := c.valid()
if err != nil {
return nil, fmt.Errorf("validating checkpoint: %s", err)
Expand Down
16 changes: 8 additions & 8 deletions mtca/mtca_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,16 +150,16 @@ func TestPool(t *testing.T) {
func TestCheckpointValid(t *testing.T) {
type testCase struct {
name string
value checkpoint
value checkpointRow
}

rootHash := [32]byte{}

testCases := []testCase{
{"no MTCLogID", checkpoint{ID: 7, TreeSize: 9, RootHash: rootHash[:]}},
{"no TreeSize", checkpoint{ID: 7, MTCLogID: "TestLog", RootHash: rootHash[:]}},
{"short RootHash", checkpoint{ID: 7, MTCLogID: "TestLog", TreeSize: 9, RootHash: rootHash[:4]}},
{"no RootHash", checkpoint{ID: 7, MTCLogID: "TestLog", TreeSize: 9}},
{"no MTCLogID", checkpointRow{ID: 7, TreeSize: 9, RootHash: rootHash[:]}},
{"no TreeSize", checkpointRow{ID: 7, MTCLogID: "TestLog", RootHash: rootHash[:]}},
{"short RootHash", checkpointRow{ID: 7, MTCLogID: "TestLog", TreeSize: 9, RootHash: rootHash[:4]}},
{"no RootHash", checkpointRow{ID: 7, MTCLogID: "TestLog", TreeSize: 9}},
}

for _, tc := range testCases {
Expand All @@ -171,7 +171,7 @@ func TestCheckpointValid(t *testing.T) {
})
}

goodCheckpoint := checkpoint{
goodCheckpoint := checkpointRow{
ID: 7,
MTCLogID: "TestLog",
TreeSize: 9,
Expand Down Expand Up @@ -293,7 +293,7 @@ func mirrorCosign(t *testing.T, m *mtca) {
// - m.frontier
// - m.latestCheckpoint()
// - fake tile storage
func verifyStores(t *testing.T, m *mtca, fs3 *bs3test.FakeS3) *checkpoint {
func verifyStores(t *testing.T, m *mtca, fs3 *bs3test.FakeS3) *checkpointRow {
t.Helper()
latest, err := m.latestCheckpoint(t.Context())
if err != nil {
Expand Down Expand Up @@ -536,7 +536,7 @@ func TestInitLog(t *testing.T) {
verifyCheckpoint(t, mtca, latest)
}

func verifyCheckpoint(t *testing.T, mtca *mtca, checkpoint *checkpoint) {
func verifyCheckpoint(t *testing.T, mtca *mtca, checkpoint *checkpointRow) {
t.Helper()
message := cosigned.Message{
CosignerName: "oid/1.3.6.1.4.1." + mtca.logID.CAID,
Expand Down
4 changes: 2 additions & 2 deletions mtpublisher/mtpublisher.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ func New(dbMap *db.WrappedMap, interval time.Duration, logID issuancelog.ID, mir
}, nil
}

type checkpointEntry struct {
type checkpointRow struct {
ID int64 `db:"id"`
MTCLogID string `db:"mtcLogID"`
MTCASignature []byte `db:"mtcaSignature"`
Expand Down Expand Up @@ -111,7 +111,7 @@ func (p *publisher) cosign(tree tlog.Tree) (string, error) {
// cosignature and stores the raw signature in the database. Start calls it at
// each interval.
func (p *publisher) Publish(ctx context.Context) error {
var latest checkpointEntry
var latest checkpointRow
err := p.db.SelectOne(ctx, &latest,
`SELECT id, checkpoints.mtcLogID, mtcaSignature, mirrorID,
mirrorSignature, treeSize, rootHash
Expand Down
Loading