chore(ci): provisioning should not hand-roll SQL escapes (#2949)

jakedoublev · web-flow · commit 73df4c304a5b · 2025-12-09T16:30:12.000Z
### Proposed Changes

* provisioning should not hand-roll SQL escapes
* provisiong and db client interface should have better context handling
rather than using background contexts

### Checklist

- [ ] I have added or updated unit tests
- [ ] I have added or updated integration tests (if appropriate)
- [ ] I have added or updated documentation

### Testing Instructions
diff --git a/service/cmd/provisionFixtures.go b/service/cmd/provisionFixtures.go
@@ -1,7 +1,6 @@
 package cmd
 
 import (
-	"context"
 	"fmt"
 
 	"github.com/opentdf/platform/service/internal/fixtures"
@@ -36,6 +35,7 @@ to run this command in a clean database. This command is intended for local deve
 ** Teardown or Issues **
 You can clear/recycle your database with 'docker compose down' and 'docker compose up' to start fresh.`,
 		Run: func(cmd *cobra.Command, _ []string) {
+			ctx := cmd.Context()
 			configFile, _ := cmd.Flags().GetString(configFileFlag)
 			configKey, _ := cmd.Flags().GetString(configKeyFlag)
 			legacyLoader, err := config.NewLegacyLoader(configKey, configFile)
@@ -47,15 +47,15 @@ You can clear/recycle your database with 'docker compose down' and 'docker compo
 				panic(fmt.Errorf("could not load config: %w", err))
 			}
 			cfg, err := config.Load(
-				cmd.Context(),
+				ctx,
 				legacyLoader,
 				defaultSettingsLoader,
 			)
 			if err != nil {
 				panic(fmt.Errorf("could not load config: %w", err))
 			}
 
-			dbClient, err := db.New(context.Background(), cfg.DB, cfg.Logger, nil)
+			dbClient, err := db.New(ctx, cfg.DB, cfg.Logger, nil)
 			if err != nil {
 				panic(fmt.Errorf("issue creating database client: %w", err))
 			}
@@ -64,10 +64,10 @@ You can clear/recycle your database with 'docker compose down' and 'docker compo
 			// update the schema
 			cfg.DB.Schema += "_policy"
 
-			dbI := fixtures.NewDBInterface(*cfg)
+			dbI := fixtures.NewDBInterface(ctx, *cfg)
 			f := fixtures.NewFixture(dbI)
 			fixtures.LoadFixtureData("./service/internal/fixtures/policy_fixtures.yaml")
-			f.Provision()
+			f.Provision(ctx)
 
 			cmd.Print("fixtures provision fully applied\n")
 		},
diff --git a/service/integration/actions_test.go b/service/integration/actions_test.go
@@ -28,14 +28,14 @@ func (s *ActionsSuite) SetupSuite() {
 	c := *Config
 
 	c.DB.Schema = "test_opentdf_actions"
-	s.db = fixtures.NewDBInterface(c)
+	s.db = fixtures.NewDBInterface(s.ctx, c)
 	s.f = fixtures.NewFixture(s.db)
-	s.f.Provision()
+	s.f.Provision(s.ctx)
 }
 
 func (s *ActionsSuite) TearDownSuite() {
 	slog.Info("tearing down db.Actions test suite")
-	s.f.TearDown()
+	s.f.TearDown(s.ctx)
 }
 
 func (s *ActionsSuite) Test_ListActions_NoPagination_Succeeds() {
diff --git a/service/integration/attribute_fqns_test.go b/service/integration/attribute_fqns_test.go
@@ -54,14 +54,14 @@ func (s *AttributeFqnSuite) SetupSuite() {
 	s.ctx = context.Background()
 	c := *Config
 	c.DB.Schema = "test_opentdf_attribute_fqn"
-	s.db = fixtures.NewDBInterface(c)
+	s.db = fixtures.NewDBInterface(s.ctx, c)
 	s.f = fixtures.NewFixture(s.db)
-	s.f.Provision()
+	s.f.Provision(s.ctx)
 }
 
 func (s *AttributeFqnSuite) TearDownSuite() {
 	slog.Info("tearing down db.AttributeFqn test suite")
-	s.f.TearDown()
+	s.f.TearDown(s.ctx)
 }
 
 // Test Create Namespace
diff --git a/service/integration/attribute_values_test.go b/service/integration/attribute_values_test.go
@@ -38,9 +38,9 @@ func (s *AttributeValuesSuite) SetupSuite() {
 	fixtureKeyAccessServerID = s.f.GetKasRegistryKey("key_access_server_1").ID
 	c := *Config
 	c.DB.Schema = "test_opentdf_attribute_values"
-	s.db = fixtures.NewDBInterface(c)
+	s.db = fixtures.NewDBInterface(s.ctx, c)
 	s.f = fixtures.NewFixture(s.db)
-	s.f.Provision()
+	s.f.Provision(s.ctx)
 	stillActiveNsID, stillActiveAttributeID, deactivatedAttrValueID = setupDeactivateAttributeValue(s)
 }
 
@@ -65,7 +65,7 @@ func (s *AttributeValuesSuite) TearDownTest() {
 
 func (s *AttributeValuesSuite) TearDownSuite() {
 	slog.Info("tearing down db.AttributeValues test suite")
-	s.f.TearDown()
+	s.f.TearDown(s.ctx)
 }
 
 func (s *AttributeValuesSuite) Test_ListAttributeValues_WithAttributeID_Succeeds() {
diff --git a/service/integration/attributes_test.go b/service/integration/attributes_test.go
@@ -42,15 +42,15 @@ func (s *AttributesSuite) SetupSuite() {
 	fixtureKeyAccessServerID = s.f.GetKasRegistryKey("key_access_server_1").ID
 	c := *Config
 	c.DB.Schema = "test_opentdf_attribute_definitions"
-	s.db = fixtures.NewDBInterface(c)
+	s.db = fixtures.NewDBInterface(s.ctx, c)
 	s.f = fixtures.NewFixture(s.db)
-	s.f.Provision()
+	s.f.Provision(s.ctx)
 	stillActiveNsID, deactivatedAttrID, deactivatedAttrValueID = setupCascadeDeactivateAttribute(s)
 }
 
 func (s *AttributesSuite) TearDownSuite() {
 	slog.Info("tearing down db.Attributes test suite")
-	s.f.TearDown()
+	s.f.TearDown(s.ctx)
 }
 
 func (s *AttributesSuite) Test_CreateAttribute_NoMetadataSucceeds() {
diff --git a/service/integration/kas_registry_key_test.go b/service/integration/kas_registry_key_test.go
@@ -51,16 +51,16 @@ func (s *KasRegistryKeySuite) SetupSuite() {
 	s.ctx = context.Background()
 	c := *Config
 	c.DB.Schema = "test_opentdf_kas_keys"
-	s.db = fixtures.NewDBInterface(c)
+	s.db = fixtures.NewDBInterface(s.ctx, c)
 	s.f = fixtures.NewFixture(s.db)
-	s.f.Provision()
+	s.f.Provision(s.ctx)
 	s.kasFixtures = s.getKasRegistryFixtures()
 	s.kasKeys = s.getKasRegistryServerKeysFixtures()
 }
 
 func (s *KasRegistryKeySuite) TearDownSuite() {
 	slog.Info("tearing down db.KasKeys test suite")
-	s.f.TearDown()
+	s.f.TearDown(s.ctx)
 }
 
 func TestKasRegistryKeysSuite(t *testing.T) {
diff --git a/service/integration/kas_registry_test.go b/service/integration/kas_registry_test.go
@@ -32,14 +32,14 @@ func (s *KasRegistrySuite) SetupSuite() {
 	s.ctx = context.Background()
 	c := *Config
 	c.DB.Schema = "test_opentdf_kas_registry"
-	s.db = fixtures.NewDBInterface(c)
+	s.db = fixtures.NewDBInterface(s.ctx, c)
 	s.f = fixtures.NewFixture(s.db)
-	s.f.Provision()
+	s.f.Provision(s.ctx)
 }
 
 func (s *KasRegistrySuite) TearDownSuite() {
 	slog.Info("tearing down db.KasRegistry test suite")
-	s.f.TearDown()
+	s.f.TearDown(s.ctx)
 }
 
 func (s *KasRegistrySuite) Test_ListKeyAccessServers_NoPagination_Succeeds() {
diff --git a/service/integration/keymanagement_test.go b/service/integration/keymanagement_test.go
@@ -41,9 +41,9 @@ func (s *KeyManagementSuite) SetupSuite() {
 	s.ctx = context.Background()
 	c := *Config
 	c.DB.Schema = "test_opentdf_provider_config"
-	s.db = fixtures.NewDBInterface(c)
+	s.db = fixtures.NewDBInterface(s.ctx, c)
 	s.f = fixtures.NewFixture(s.db)
-	s.f.Provision()
+	s.f.Provision(s.ctx)
 }
 
 func (s *KeyManagementSuite) SetupTest() {
@@ -52,7 +52,7 @@ func (s *KeyManagementSuite) SetupTest() {
 
 func (s *KeyManagementSuite) TearDownSuite() {
 	slog.Info("tearing down db.KeyManagement test suite")
-	s.f.TearDown()
+	s.f.TearDown(s.ctx)
 }
 
 func (s *KeyManagementSuite) Test_CreateProviderConfig_NoMetada_Succeeds() {
diff --git a/service/integration/namespaces_test.go b/service/integration/namespaces_test.go
@@ -41,15 +41,15 @@ func (s *NamespacesSuite) SetupSuite() {
 	s.ctx = context.Background()
 	c := *Config
 	c.DB.Schema = "test_opentdf_namespaces"
-	s.db = fixtures.NewDBInterface(c)
+	s.db = fixtures.NewDBInterface(s.ctx, c)
 	s.f = fixtures.NewFixture(s.db)
-	s.f.Provision()
+	s.f.Provision(s.ctx)
 	deactivatedNsID, deactivatedAttrID, deactivatedAttrValueID = setupCascadeDeactivateNamespace(s)
 }
 
 func (s *NamespacesSuite) TearDownSuite() {
 	slog.Info("tearing down db.Namespaces test suite")
-	s.f.TearDown()
+	s.f.TearDown(s.ctx)
 }
 
 func (s *NamespacesSuite) Test_CreateNamespace() {
diff --git a/service/integration/obligation_triggers_test.go b/service/integration/obligation_triggers_test.go
@@ -59,9 +59,9 @@ func (s *ObligationTriggersSuite) SetupSuite() {
 	s.ctx = context.Background()
 	c := *Config
 	c.DB.Schema = "test_opentdf_obligation_triggers"
-	s.db = fixtures.NewDBInterface(c)
+	s.db = fixtures.NewDBInterface(s.ctx, c)
 	s.f = fixtures.NewFixture(s.db)
-	s.f.Provision()
+	s.f.Provision(s.ctx)
 
 	var err error
 
diff --git a/service/integration/obligations_test.go b/service/integration/obligations_test.go
@@ -49,14 +49,14 @@ func (s *ObligationsSuite) SetupSuite() {
 	s.ctx = context.Background()
 	c := *Config
 	c.DB.Schema = "test_opentdf_obligations"
-	s.db = fixtures.NewDBInterface(c)
+	s.db = fixtures.NewDBInterface(s.ctx, c)
 	s.f = fixtures.NewFixture(s.db)
-	s.f.Provision()
+	s.f.Provision(s.ctx)
 }
 
 func (s *ObligationsSuite) TearDownSuite() {
 	slog.Info("tearing down db.Obligations test suite")
-	s.f.TearDown()
+	s.f.TearDown(s.ctx)
 }
 
 func TestObligationsSuite(t *testing.T) {
diff --git a/service/integration/policy_test.go b/service/integration/policy_test.go
@@ -25,14 +25,14 @@ func (s *PolicyDBClientSuite) SetupSuite() {
 	s.ctx = context.Background()
 	c := *Config
 	c.DB.Schema = "text_opentdf_policy_db_client"
-	s.db = fixtures.NewDBInterface(c)
+	s.db = fixtures.NewDBInterface(s.ctx, c)
 	s.f = fixtures.NewFixture(s.db)
-	s.f.Provision()
+	s.f.Provision(s.ctx)
 }
 
 func (s *PolicyDBClientSuite) TearDownSuite() {
 	slog.Info("tearing down db.PolicyDbClient test suite")
-	s.f.TearDown()
+	s.f.TearDown(s.ctx)
 }
 
 func (s *PolicyDBClientSuite) Test_RunInTx_CommitsOnSuccess() {
diff --git a/service/integration/registered_resources_test.go b/service/integration/registered_resources_test.go
@@ -33,14 +33,14 @@ func (s *RegisteredResourcesSuite) SetupSuite() {
 	s.ctx = context.Background()
 	c := *Config
 	c.DB.Schema = "test_opentdf_registered_resources"
-	s.db = fixtures.NewDBInterface(c)
+	s.db = fixtures.NewDBInterface(s.ctx, c)
 	s.f = fixtures.NewFixture(s.db)
-	s.f.Provision()
+	s.f.Provision(s.ctx)
 }
 
 func (s *RegisteredResourcesSuite) TearDownSuite() {
 	slog.Info("tearing down db.RegisteredResources test suite")
-	s.f.TearDown()
+	s.f.TearDown(s.ctx)
 }
 
 func TestRegisteredResourcesSuite(t *testing.T) {
diff --git a/service/integration/resource_mappings_test.go b/service/integration/resource_mappings_test.go
@@ -35,14 +35,14 @@ func (s *ResourceMappingsSuite) SetupSuite() {
 	s.ctx = context.Background()
 	c := *Config
 	c.DB.Schema = "test_opentdf_resource_mappings"
-	s.db = fixtures.NewDBInterface(c)
+	s.db = fixtures.NewDBInterface(s.ctx, c)
 	s.f = fixtures.NewFixture(s.db)
-	s.f.Provision()
+	s.f.Provision(s.ctx)
 }
 
 func (s *ResourceMappingsSuite) TearDownSuite() {
 	slog.Info("tearing down db.ResourceMappings test suite")
-	s.f.TearDown()
+	s.f.TearDown(s.ctx)
 }
 
 /*
diff --git a/service/integration/subject_mappings_test.go b/service/integration/subject_mappings_test.go
@@ -31,18 +31,17 @@ type SubjectMappingsSuite struct {
 
 func (s *SubjectMappingsSuite) SetupSuite() {
 	slog.Info("setting up db.SubjectMappings test suite")
+	s.ctx = context.Background()
 	c := *Config
 	c.DB.Schema = "test_opentdf_subject_mappings"
-	s.db = fixtures.NewDBInterface(c)
-	s.ctx = context.Background()
+	s.db = fixtures.NewDBInterface(s.ctx, c)
 	s.f = fixtures.NewFixture(s.db)
-	s.ctx = context.Background()
-	s.f.Provision()
+	s.f.Provision(s.ctx)
 }
 
 func (s *SubjectMappingsSuite) TearDownSuite() {
 	slog.Info("tearing down db.SubjectMappings test suite")
-	s.f.TearDown()
+	s.f.TearDown(s.ctx)
 }
 
 // a set of easily accessible actions for use in tests
diff --git a/service/internal/fixtures/db.go b/service/internal/fixtures/db.go
diff --git a/service/internal/fixtures/fixtures.go b/service/internal/fixtures/fixtures.go
