Switch to borp

This switches to an early version of borp, before the PR that adds
contexts to all of borp's relevant functions. It involves mainly the
dependency change, plus a bunch of renamings.

Author: jsha

cmd/cert-checker/main.go

@@ -82,7 +82,7 @@ type reportEntry struct {
 	Problems []string `json:"problems,omitempty"`
 }
 
-// certDB is an interface collecting the gorp.saDbMap functions that the various
+// certDB is an interface collecting the borp.DbMap functions that the various
 // parts of cert-checker rely on. Using this adapter shim allows tests to swap
 // out the saDbMap implementation.
 type certDB interface {

cmd/id-exporter/main.go

@@ -119,9 +119,9 @@ func (c idExporter) findIDsWithExampleHostnames() (idExporterResults, error) {
 func (c idExporter) findIDsForHostnames(hostnames []string) (idExporterResults, error) {
 	var holder idExporterResults
 	for _, hostname := range hostnames {
-		// Pass the same list in each time, gorp will happily just append to the slice
+		// Pass the same list in each time, borp will happily just append to the slice
 		// instead of overwriting it each time
-		// https://github.com/go-gorp/gorp/blob/2ae7d174a4cf270240c4561092402affba25da5e/select.go#L348-L355
+		// https://github.com/letsencrypt/borp/blob/c87bd6443d59746a33aca77db34a60cfc344adb2/select.go#L349-L353
 		_, err := c.dbMap.Select(
 			&holder,
 			`SELECT DISTINCT c.registrationID AS id

cmd/notify-mailer/main.go

@@ -258,7 +258,7 @@ func (m *mailer) resolveAddresses() (addressToRecipientMap, error) {
 	return result, nil
 }
 
-// dbSelector abstracts over a subset of methods from `gorp.DbMap` objects to
+// dbSelector abstracts over a subset of methods from `borp.DbMap` objects to
 // facilitate mocking in unit tests.
 type dbSelector interface {
 	SelectOne(holder interface{}, query string, args ...interface{}) error

db/gorm.go

@@ -51,7 +51,7 @@ func NewMappedSelector[T any](executor MappedExecutor) (MappedSelector[T], error
 	//   - Note that the reverse is not true: it's perfectly okay for there to be
 	//     database columns which do not correspond to fields in the struct; those
 	//     columns will be ignored.
-	// TODO: In the future, when we replace gorp's TableMap with our own, this
+	// TODO: In the future, when we replace borp's TableMap with our own, this
 	// check should be performed at the time the mapping is declared.
 	columns := make([]string, 0)
 	seen := make(map[string]struct{})
@@ -81,15 +81,15 @@ type mappedSelector[T any] struct {
 }
 
 // Query performs a SELECT on the appropriate table for T. It combines the best
-// features of gorp, the go stdlib, and generics, using the type parameter of
+// features of borp, the go stdlib, and generics, using the type parameter of
 // the typeSelector object to automatically look up the proper table name and
 // columns to select. It returns an iterable which yields fully-populated
 // objects of the parameterized type directly. The given clauses MUST be only
 // the bits of a sql query from "WHERE ..." onwards; if they contain any of the
 // "SELECT ... FROM ..." portion of the query it will result in an error. The
-// args take the same kinds of values as gorp's SELECT: either one argument per
+// args take the same kinds of values as borp's SELECT: either one argument per
 // positional placeholder, or a map of placeholder names to their arguments
-// (see https://pkg.go.dev/gopkg.in/gorp.v2#readme-ad-hoc-sql).
+// (see https://pkg.go.dev/github.com/letsencrypt/borp#readme-ad-hoc-sql).
 //
 // The caller is responsible for calling `Rows.Close()` when they are done with
 // the query. The caller is also responsible for ensuring that the clauses
@@ -106,7 +106,7 @@ func (ts mappedSelector[T]) Query(ctx context.Context, clauses string, args ...i
 }
 
 // QueryFrom is the same as Query, but it additionally takes a table name to
-// select from, rather than automatically computing the table name from gorp's
+// select from, rather than automatically computing the table name from borp's
 // DbMap.
 //
 // The caller is responsible for calling `Rows.Close()` when they are done with

db/interfaces.go

@@ -6,7 +6,7 @@ import (
 	"errors"
 	"reflect"
 
-	"github.com/go-gorp/gorp/v3"
+	"github.com/letsencrypt/borp"
 )
 
 // These interfaces exist to aid in mocking database operations for unit tests.
@@ -36,7 +36,7 @@ type Execer interface {
 	Exec(string, ...interface{}) (sql.Result, error)
 }
 
-// SelectExecer offers a subset of gorp.SqlExecutor's methods: Select and
+// SelectExecer offers a subset of borp.SqlExecutor's methods: Select and
 // Exec.
 type SelectExecer interface {
 	Selector
@@ -53,7 +53,7 @@ type DatabaseMap interface {
 }
 
 // Executor offers the full combination of OneSelector, Inserter, SelectExecer
-// and adds a handful of other high level Gorp methods we use in Boulder.
+// and adds a handful of other high level borp methods we use in Boulder.
 type Executor interface {
 	OneSelector
 	Inserter
@@ -77,14 +77,14 @@ type Transaction interface {
 	Executor
 	Rollback() error
 	Commit() error
-	WithContext(ctx context.Context) gorp.SqlExecutor
+	WithContext(ctx context.Context) borp.SqlExecutor
 }
 
 // MappedExecutor is anything that can map types to tables, and which can
 // produce a SqlExecutor bound to a context.
 type MappedExecutor interface {
-	TableFor(reflect.Type, bool) (*gorp.TableMap, error)
-	WithContext(ctx context.Context) gorp.SqlExecutor
+	TableFor(reflect.Type, bool) (*borp.TableMap, error)
+	WithContext(ctx context.Context) borp.SqlExecutor
 }
 
 // MappedSelector is anything that can execute various kinds of SQL statements
@@ -106,7 +106,7 @@ type Rows[T any] interface {
 // MockSqlExecuter implement SqlExecutor by returning errors from every call.
 //
 // To mock out WithContext, we need to be able to return objects that satisfy
-// gorp.SqlExecutor. That's a pretty big interface, so we specify one no-op mock
+// borp.SqlExecutor. That's a pretty big interface, so we specify one no-op mock
 // that we can embed everywhere we need to satisfy it.
 // Note: MockSqlExecutor does *not* implement WithContext. The expectation is
 // that structs that embed MockSqlExecutor will define their own WithContext

db/map.go

@@ -7,8 +7,8 @@ import (
 	"fmt"
 	"regexp"
 
-	gorp "github.com/go-gorp/gorp/v3"
 	"github.com/go-sql-driver/mysql"
+	"github.com/letsencrypt/borp"
 )
 
 // ErrDatabaseOp wraps an underlying err with a description of the operation
@@ -44,7 +44,7 @@ func (e ErrDatabaseOp) Unwrap() error {
 
 // IsNoRows is a utility function for determining if an error wraps the go sql
 // package's ErrNoRows, which is returned when a Scan operation has no more
-// results to return, and as such is returned by many gorp methods.
+// results to return, and as such is returned by many borp methods.
 func IsNoRows(err error) bool {
 	return errors.Is(err, sql.ErrNoRows)
 }
@@ -57,10 +57,10 @@ func IsDuplicate(err error) bool {
 	return errors.As(err, &dbErr) && dbErr.Number == 1062
 }
 
-// WrappedMap wraps a *gorp.DbMap such that its major functions wrap error
+// WrappedMap wraps a *borp.DbMap such that its major functions wrap error
 // results in ErrDatabaseOp instances before returning them to the caller.
 type WrappedMap struct {
-	*gorp.DbMap
+	*borp.DbMap
 }
 
 func (m *WrappedMap) Get(holder interface{}, keys ...interface{}) (interface{}, error) {
@@ -95,7 +95,7 @@ func (m *WrappedMap) Exec(query string, args ...interface{}) (sql.Result, error)
 	return WrappedExecutor{SqlExecutor: m.DbMap}.Exec(query, args...)
 }
 
-func (m *WrappedMap) WithContext(ctx context.Context) gorp.SqlExecutor {
+func (m *WrappedMap) WithContext(ctx context.Context) borp.SqlExecutor {
 	return WrappedExecutor{SqlExecutor: m.DbMap.WithContext(ctx)}
 }
 
@@ -112,14 +112,14 @@ func (m *WrappedMap) Begin() (Transaction, error) {
 	}, err
 }
 
-// WrappedTransaction wraps a *gorp.Transaction such that its major functions
+// WrappedTransaction wraps a *borp.Transaction such that its major functions
 // wrap error results in ErrDatabaseOp instances before returning them to the
 // caller.
 type WrappedTransaction struct {
-	*gorp.Transaction
+	*borp.Transaction
 }
 
-func (tx WrappedTransaction) WithContext(ctx context.Context) gorp.SqlExecutor {
+func (tx WrappedTransaction) WithContext(ctx context.Context) borp.SqlExecutor {
 	return WrappedExecutor{SqlExecutor: tx.Transaction.WithContext(ctx)}
 }
 
@@ -163,11 +163,11 @@ func (tx WrappedTransaction) Exec(query string, args ...interface{}) (sql.Result
 	return (WrappedExecutor{SqlExecutor: tx.Transaction}).Exec(query, args...)
 }
 
-// WrappedExecutor wraps a gorp.SqlExecutor such that its major functions
+// WrappedExecutor wraps a borp.SqlExecutor such that its major functions
 // wrap error results in ErrDatabaseOp instances before returning them to the
 // caller.
 type WrappedExecutor struct {
-	gorp.SqlExecutor
+	borp.SqlExecutor
 }
 
 func errForOp(operation string, err error, list []interface{}) ErrDatabaseOp {
@@ -271,7 +271,7 @@ var (
 
 	// tableRegexps is a list of regexps that tableFromQuery will try to use in
 	// succession to find the table name for an SQL query. While tableFromQuery
-	// isn't used by the higher level gorp Insert/Update/Select/etc functions we
+	// isn't used by the higher level borp Insert/Update/Select/etc functions we
 	// include regexps for matching inserts, updates, selects, etc because we want
 	// to match the correct table when these types of queries are run through
 	// Exec().

db/map_test.go

@@ -7,7 +7,7 @@ import (
 	"fmt"
 	"testing"
 
-	gorp "github.com/go-gorp/gorp/v3"
+	"github.com/letsencrypt/borp"
 
 	"github.com/go-sql-driver/mysql"
 	"github.com/letsencrypt/boulder/core"
@@ -236,10 +236,10 @@ func testDbMap(t *testing.T) *WrappedMap {
 	dbConn, err := sql.Open("mysql", config.FormatDSN())
 	test.AssertNotError(t, err, "opening DB connection")
 
-	dialect := gorp.MySQLDialect{Engine: "InnoDB", Encoding: "UTF8"}
+	dialect := borp.MySQLDialect{Engine: "InnoDB", Encoding: "UTF8"}
 	// NOTE(@cpu): We avoid giving a sa.BoulderTypeConverter to the DbMap field to
 	// avoid the cyclic dep. We don't need to convert any types in the db tests.
-	dbMap := &gorp.DbMap{Db: dbConn, Dialect: dialect, TypeConverter: nil}
+	dbMap := &borp.DbMap{Db: dbConn, Dialect: dialect, TypeConverter: nil}
 	return &WrappedMap{DbMap: dbMap}
 }
 

db/multi.go

@@ -68,7 +68,7 @@ func (mi *MultiInserter) Add(row []interface{}) error {
 }
 
 // query returns the formatted query string, and the slice of arguments for
-// for gorp to use in place of the query's question marks. Currently only
+// for borp to use in place of the query's question marks. Currently only
 // used by .Insert(), below.
 func (mi *MultiInserter) query() (string, []interface{}) {
 	var questionsBuf strings.Builder

docs/CONTRIBUTING.md

@@ -191,10 +191,10 @@ Specifically, that means that all of our `SELECT` statements should enumerate
 columns to select, and not use `*`. Also, generally speaking, we will need a
 separate model `struct` for serializing and deserializing data before and
 after the migration. This is because the ORM package we use,
-[`gorp`](https://github.com/go-gorp/gorp), expects every field in a struct to
+[`borp`](https://github.com/letsencrypt/borp), expects every field in a struct to
 map to a column in the table. If we add a new field to a model struct and
 Boulder attempts to write that struct to a table that doesn't yet have the
-corresponding column (case 1), gorp will fail with `Insert failed table posts
+corresponding column (case 1), borp will fail with `Insert failed table posts
 has no column named Foo`. There are examples of such models in sa/model.go,
 along with code to turn a model into a `struct` used internally.
 
@@ -270,14 +270,14 @@ func (ssa *SQLStorageAuthority) AddPerson(p Person) (error) {
 ```
 
 You will also need to update the `initTables` function from `sa/database.go` to
-tell Gorp which table to use for your versioned model structs. Make sure to
+tell borp which table to use for your versioned model structs. Make sure to
 consult the flag you defined so that only **one** of the table maps is added at
-any given time, otherwise Gorp will error.  Depending on your table you may also
+any given time, otherwise borp will error.  Depending on your table you may also
 need to add `SetKeys` and `SetVersionCol` entries for your versioned models.
 Example:
 
 ```go
-func initTables(dbMap *gorp.DbMap) {
+func initTables(dbMap *borp.DbMap) {
  // < unrelated lines snipped for brevity >
 
  if features.Enabled(features.AllowWizards) {

go.mod

@@ -9,7 +9,6 @@ require (
 	github.com/aws/smithy-go v1.13.5
 	github.com/beeker1121/goque v1.0.3-0.20191103205551-d618510128af
 	github.com/eggsampler/acme/v3 v3.4.0
-	github.com/go-gorp/gorp/v3 v3.1.0
 	github.com/go-logr/stdr v1.2.2
 	github.com/go-redis/redis/v8 v8.11.5
 	github.com/go-sql-driver/mysql v1.5.0
@@ -18,6 +17,7 @@ require (
 	github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0
 	github.com/hpcloud/tail v1.0.0
 	github.com/jmhodges/clock v1.2.0
+	github.com/letsencrypt/borp v0.0.0-20230705195456-792de221e471
 	github.com/letsencrypt/challtestsrv v1.2.1
 	github.com/letsencrypt/pkcs11key/v4 v4.0.0
 	github.com/letsencrypt/validator/v10 v10.0.0-20230215210743-a0c7dfc17158
@@ -73,11 +73,12 @@ require (
 	github.com/golang/protobuf v1.5.3 // indirect
 	github.com/golang/snappy v0.0.0-20180518054509-2e65f85255db // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.15.2 // indirect
+	github.com/kr/pretty v0.3.1 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect
 	github.com/pelletier/go-toml v1.9.3 // indirect
+	github.com/poy/onpar v1.1.2 // indirect
 	github.com/prometheus/common v0.37.0 // indirect
 	github.com/prometheus/procfs v0.8.0 // indirect
-	github.com/rogpeppe/go-internal v1.9.0 // indirect
 	github.com/syndtr/goleveldb v1.0.0 // indirect
 	go.opentelemetry.io/otel/exporters/otlp/internal/retry v1.15.0 // indirect
 	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.15.0 // indirect
@@ -87,6 +88,7 @@ require (
 	golang.org/x/sys v0.9.0 // indirect
 	golang.org/x/tools v0.8.0 // indirect
 	google.golang.org/genproto v0.0.0-20230410155749-daa745c078e1 // indirect
+	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
 	gopkg.in/fsnotify.v1 v1.4.7 // indirect
 	gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 // indirect
 	k8s.io/klog/v2 v2.80.1 // indirect
@@ -96,3 +98,5 @@ require (
 // that we do not rely upon. It appears to introduce performance regressions
 // for us.
 exclude github.com/go-sql-driver/mysql v1.6.0
+
+exclude github.com/go-sql-driver/mysql v1.7.1