forked from cockroachdb/cockroach
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
sql, tests, sqlccl: split TestExplainRedactDDL out of TestExplainRedact
Create another version of TestExplainRedact which also tests `EXPLAIN (REDACT)` of DDL statements. This version is in sqlccl to allow for DDL statements using partitions. Part of: cockroachdb#68570 Epic: CRDB-19756 Release note: None
- Loading branch information
Showing
6 changed files
with
273 additions
and
99 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| // Copyright 2023 The Cockroach Authors. | ||
| // | ||
| // Licensed as a CockroachDB Enterprise file under the Cockroach Community | ||
| // License (the "License"); you may not use this file except in compliance with | ||
| // the License. You may obtain a copy of the License at | ||
| // | ||
| // https://github.com/cockroachdb/cockroach/blob/master/licenses/CCL.txt | ||
|
|
||
| package sqlccl | ||
|
|
||
| import ( | ||
| "context" | ||
| gosql "database/sql" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/cockroachdb/cockroach/pkg/internal/sqlsmith" | ||
| "github.com/cockroachdb/cockroach/pkg/sql/lexbase" | ||
| "github.com/cockroachdb/cockroach/pkg/sql/tests" | ||
| "github.com/cockroachdb/cockroach/pkg/testutils/serverutils" | ||
| "github.com/cockroachdb/cockroach/pkg/util/leaktest" | ||
| "github.com/cockroachdb/cockroach/pkg/util/log" | ||
| "github.com/cockroachdb/cockroach/pkg/util/randutil" | ||
| "github.com/cockroachdb/errors" | ||
| ) | ||
|
|
||
| // TestExplainRedactDDL tests that variants of EXPLAIN (REDACT) do not leak | ||
| // PII. This is very similar to sql.TestExplainRedact but includes CREATE TABLE | ||
| // and ALTER TABLE statements, which could include partitioning (hence this is | ||
| // in CCL). | ||
| func TestExplainRedactDDL(t *testing.T) { | ||
| defer leaktest.AfterTest(t)() | ||
| defer log.Scope(t).Close(t) | ||
|
|
||
| const numStatements = 10 | ||
|
|
||
| ctx := context.Background() | ||
| rng, seed := randutil.NewTestRand() | ||
| t.Log("seed:", seed) | ||
|
|
||
| params, _ := tests.CreateTestServerParams() | ||
| s, sqlDB, _ := serverutils.StartServer(t, params) | ||
| defer s.Stopper().Stop(ctx) | ||
| defer sqlDB.Close() | ||
|
|
||
| query := func(sql string) (*gosql.Rows, error) { | ||
| return sqlDB.QueryContext(ctx, sql) | ||
| } | ||
|
|
||
| // To check for PII leaks, we inject a single unlikely string into some of the | ||
| // query constants produced by SQLSmith, and then search the redacted EXPLAIN | ||
| // output for this string. | ||
| pii := "pachycephalosaurus" | ||
| containsPII := func(sql, output string) error { | ||
| lowerOutput := strings.ToLower(output) | ||
| if strings.Contains(lowerOutput, pii) { | ||
| return errors.Newf( | ||
| "output contained PII (%q):\n%s\noutput:\n%s\n", pii, sql, output, | ||
| ) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // Perform a few random initial CREATE TABLEs. | ||
| setup := sqlsmith.RandTablesPrefixStringConsts(rng, pii) | ||
| setup = append(setup, "SET CLUSTER SETTING sql.stats.automatic_collection.enabled = off;") | ||
| setup = append(setup, "SET statement_timeout = '5s';") | ||
| for _, stmt := range setup { | ||
| t.Log(stmt) | ||
| if _, err := sqlDB.ExecContext(ctx, stmt); err != nil { | ||
| // Ignore errors. | ||
| t.Log("-- ignoring error:", err) | ||
| continue | ||
| } | ||
| } | ||
|
|
||
| // Check EXPLAIN (OPT, CATALOG, REDACT) for each table. | ||
| rows, err := query("SELECT table_name FROM [SHOW TABLES]") | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| var tables []string | ||
| for rows.Next() { | ||
| var table string | ||
| if err = rows.Scan(&table); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| tables = append(tables, table) | ||
| } | ||
| for _, table := range tables { | ||
| explain := "EXPLAIN (OPT, CATALOG, REDACT) SELECT * FROM " + lexbase.EscapeSQLIdent(table) | ||
| t.Log(explain) | ||
| rows, err = query(explain) | ||
| if err != nil { | ||
| // This explain should always succeed. | ||
| t.Fatal(err) | ||
| } | ||
| var output strings.Builder | ||
| for rows.Next() { | ||
| var out string | ||
| if err = rows.Scan(&out); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| output.WriteString(out) | ||
| output.WriteRune('\n') | ||
| } | ||
| if err = containsPII(explain, output.String()); err != nil { | ||
| t.Error(err) | ||
| continue | ||
| } | ||
|
|
||
| } | ||
|
|
||
| // Set up smither to generate random DDL and DML statements. | ||
| smith, err := sqlsmith.NewSmither(sqlDB, rng, | ||
| sqlsmith.PrefixStringConsts(pii), | ||
| sqlsmith.EnableAlters(), | ||
| ) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| defer smith.Close() | ||
|
|
||
| tests.GenerateAndCheckRedactedExplainsForPII(t, smith, numStatements, query, containsPII) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.