Make DB connection use PingContext

db.go

@@ -1,6 +1,7 @@
 package gocommerce
 
 import (
+	"context"
 	"database/sql"
 	"os"
 
@@ -13,7 +14,7 @@ var defaultSockets = []string{
 }
 
 // NB copy StoreConfig, as we may modify it
-func ConnectDB(cfg DBConfig) (*sql.DB, error) {
+func ConnectDB(ctx context.Context, cfg DBConfig) (*sql.DB, error) {
 	// Mimic libmysql behavior, where "localhost" is overridden with
 	// system specific unix socket.
 	if cfg.Host == "localhost" || cfg.Host == "" {
@@ -29,7 +30,11 @@ func ConnectDB(cfg DBConfig) (*sql.DB, error) {
 	if err != nil {
 		return nil, err
 	}
-	err = db.Ping()
+
+	if ctx == nil {
+		ctx = context.Background()
+	}
+	err = db.PingContext(ctx)
 	if err != nil {
 		return nil, err
 	}

magento1.go

@@ -1,6 +1,7 @@
 package gocommerce
 
 import (
+	"context"
 	"errors"
 	"fmt"
 	"os"
@@ -62,15 +63,15 @@ func (m1 *Magento1) ParseConfig(cfgPath string) (*StoreConfig, error) {
 	}, nil
 }
 
-func (m1 *Magento1) BaseURLs(docroot string) ([]string, error) {
+func (m1 *Magento1) BaseURLs(ctx context.Context, docroot string) ([]string, error) {
 	cfgPath := filepath.Join(docroot, m1.ConfigPath())
 
 	cfg, err := m1.ParseConfig(cfgPath)
 	if err != nil {
 		return nil, err
 	}
 
-	db, err := ConnectDB(*cfg.DB)
+	db, err := ConnectDB(ctx, *cfg.DB)
 	if err != nil {
 		return nil, err
 	}

magento1_integration_test.go

@@ -4,12 +4,13 @@ package gocommerce
 
 import (
 	"testing"
+	"context"
 
 	"github.com/stretchr/testify/assert"
 )
 
 func TestGetMagento1BaseURLsFromDatabase(t *testing.T) {
-	baseURLs, err := m1store.BaseURLs(fixtureBase + "magento1_integration")
+	baseURLs, err := m1store.BaseURLs(context.TODO(), fixtureBase+"magento1_integration")
 	assert.Nil(t, err)
 	assert.ElementsMatch(t, []string{"https://app.magento1.test/", "https://second.magento1.test/"}, baseURLs)
 }

magento2.go

@@ -1,6 +1,7 @@
 package gocommerce
 
 import (
+	"context"
 	"encoding/json"
 	"errors"
 	"fmt"
@@ -69,10 +70,10 @@ func (m2 *Magento2) ParseConfig(cfgPath string) (*StoreConfig, error) {
 	}, nil
 }
 
-func (m2 *Magento2) BaseURLs(docroot string) ([]string, error) {
+func (m2 *Magento2) BaseURLs(ctx context.Context, docroot string) ([]string, error) {
 	cfgPath := filepath.Join(docroot, m2.ConfigPath())
 	urls := []string{}
-	if ud, err := m2.getBaseURLsFromDatabase(cfgPath); err == nil {
+	if ud, err := m2.getBaseURLsFromDatabase(ctx, cfgPath); err == nil {
 		urls = append(urls, ud...)
 	}
 	if uc, err := m2.getBaseURLsFromConfig(cfgPath); err == nil {
@@ -120,13 +121,13 @@ func (m2 *Magento2) getBaseURLsFromConfig(cfgPath string) ([]string, error) {
 	return nil, errors.New("base url(s) not found in config")
 }
 
-func (m2 *Magento2) getBaseURLsFromDatabase(cfgPath string) ([]string, error) {
+func (m2 *Magento2) getBaseURLsFromDatabase(ctx context.Context, cfgPath string) ([]string, error) {
 	cfg, err := m2.ParseConfig(cfgPath)
 	if err != nil {
 		return nil, err
 	}
 
-	db, err := ConnectDB(*cfg.DB)
+	db, err := ConnectDB(ctx, *cfg.DB)
 	if err != nil {
 		return nil, err
 	}

magento2_integration_test.go

@@ -4,12 +4,13 @@ package gocommerce
 
 import (
 	"testing"
+	"context"
 
 	"github.com/stretchr/testify/assert"
 )
 
 func TestGetMagento2BaseURLsFromDatabase(t *testing.T) {
-	baseURLs, err := m2store.BaseURLs(fixtureBase + "magento2_integration")
+	baseURLs, err := m2store.BaseURLs(context.TODO(), fixtureBase+"magento2_integration")
 	assert.Nil(t, err)
 	assert.ElementsMatch(t, []string{"https://sansec.io/", "https://api.sansec.io/"}, baseURLs)
 }

magento2_test.go

@@ -1,6 +1,7 @@
 package gocommerce
 
 import (
+	"context"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -62,8 +63,8 @@ func TestGetMagentoVersionWithoutSystemPackages(t *testing.T) {
 	assert.Equal(t, "2.4.2-p2", version)
 }
 
-func TestGetMagentoBaseURLsFromConfig(t *testing.T) {
-	baseURLs, err := m2store.BaseURLs(fixtureBase + "magento2")
+func TestGetMagentoBaseURLsFromConfigNilCtx(t *testing.T) {
+	baseURLs, err := m2store.BaseURLs(context.TODO(), fixtureBase+"magento2")
 	assert.Nil(t, err)
 	assert.ElementsMatch(t, []string{"https://sansec.io/", "https://api.sansec.io/"}, baseURLs)
 }

opencart4.go

@@ -1,6 +1,7 @@
 package gocommerce
 
 import (
+	"context"
 	"errors"
 	"os"
 	"path/filepath"
@@ -57,7 +58,7 @@ func (oc4 *OpenCart4) ParseConfig(cfgPath string) (*StoreConfig, error) {
 	}, nil
 }
 
-func (oc4 *OpenCart4) BaseURLs(docroot string) ([]string, error) {
+func (oc4 *OpenCart4) BaseURLs(ctx context.Context, docroot string) ([]string, error) {
 	cfgPath := filepath.Join(docroot, "config.php")
 	cfg, err := os.ReadFile(cfgPath)
 	if err != nil {

opencart4_config_test.go

@@ -1,6 +1,7 @@
 package gocommerce
 
 import (
+	"context"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -14,7 +15,7 @@ func TestOpenCartConfig(t *testing.T) {
 
 func TestOpenCartURL(t *testing.T) {
 	oc4 := OpenCart4{}
-	urls, err := oc4.BaseURLs(fixtureBase + "opencart4")
+	urls, err := oc4.BaseURLs(context.TODO(), fixtureBase+"opencart4")
 	assert.NoError(t, err)
 	assert.NotEmpty(t, urls)
 	assert.Equal(t, "http://sansec.io/", urls[0])

phpcfg/phpcfg_test.go

@@ -1,8 +1,9 @@
 package phpcfg
 
 import (
-	"github.com/google/go-cmp/cmp"
 	"testing"
+
+	"github.com/google/go-cmp/cmp"
 )
 
 func TestParseShortArray(t *testing.T) {

platform.go

@@ -1,6 +1,7 @@
 package gocommerce
 
 import (
+	"context"
 	"errors"
 	"fmt"
 	"regexp"
@@ -38,7 +39,7 @@ type (
 		Name() string
 		ParseConfig(cfgPath string) (*StoreConfig, error)
 		Version(docroot string) (string, error)
-		BaseURLs(docroot string) ([]string, error)
+		BaseURLs(ctx context.Context, docroot string) ([]string, error)
 		ConfigPath() string
 		UniquePath() string
 	}
@@ -121,7 +122,7 @@ func (b *basePlatform) ParseConfig(cfgPath string) (*StoreConfig, error) {
 	return nil, errors.New("not implemented")
 }
 
-func (b *basePlatform) BaseURLs(docroot string) ([]string, error) {
+func (b *basePlatform) BaseURLs(ctx context.Context, docroot string) ([]string, error) {
 	return nil, errors.New("not implemented")
 }
 

store.go

@@ -34,11 +34,11 @@ var commonDocRoots = []string{
 	"/var/www/*",
 	"/var/www/*/public_html",
 	"/var/www/vhosts/*/htdocs",
-	"/vhosts/*/httpdocs",         // plesk
-	"$HOME/public_html/..",       // nexcess
-	"$HOME/public/..",            // hypernode
-	"$HOME/public",               // hypernode, nimbus hosting
-	"$HOME/??*.*",                // generic domain pattern
+	"/vhosts/*/httpdocs",   // plesk
+	"$HOME/public_html/..", // nexcess
+	"$HOME/public/..",      // hypernode
+	"$HOME/public",         // hypernode, nimbus hosting
+	"$HOME/??*.*",          // generic domain pattern
 }
 
 func (s *Store) ConfigPath() string {

tests.go

@@ -7,7 +7,7 @@ import (
 
 const fixtureBase = "fixture/"
 
-func dbConfigFromSource(t *testing.T, src string, pl PlatformInterface) *DBConfig {
+func dbConfigFromSource(_ *testing.T, src string, pl PlatformInterface) *DBConfig {
 	cfg, e := pl.ParseConfig(src)
 	if e != nil {
 		fmt.Println(e)