1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
// Copyright 2021-present The Atlas Authors. All rights reserved.
// This source code is licensed under the Apache 2.0 license found
// in the LICENSE file in the root directory of this source tree.
package destructive
import (
"context"
"errors"
"fmt"
"strings"
"ariga.io/atlas/schemahcl"
"ariga.io/atlas/sql/internal/sqlx"
"ariga.io/atlas/sql/schema"
"ariga.io/atlas/sql/sqlcheck"
)
// Analyzer checks for destructive changes.
type Analyzer struct {
sqlcheck.Options
}
// New creates a new destructive changes Analyzer with the given options.
func New(r *schemahcl.Resource) (*Analyzer, error) {
az := &Analyzer{}
az.Error = sqlx.P(true)
if r, ok := r.Resource(az.Name()); ok {
if err := r.As(&az.Options); err != nil {
return nil, fmt.Errorf("sql/sqlcheck: parsing destructive check options: %w", err)
}
}
return az, nil
}
// List of codes.
var (
codeDropS = sqlcheck.Code("DS101")
codeDropT = sqlcheck.Code("DS102")
codeDropC = sqlcheck.Code("DS103")
)
// Name of the analyzer. Implements the sqlcheck.NamedAnalyzer interface.
func (*Analyzer) Name() string {
return "destructive"
}
// Analyze implements sqlcheck.Analyzer.
func (a *Analyzer) Analyze(_ context.Context, p *sqlcheck.Pass) error {
var diags []sqlcheck.Diagnostic
for _, sc := range p.File.Changes {
for _, c := range sc.Changes {
switch c := c.(type) {
case *schema.DropSchema:
if p.File.SchemaSpan(c.S) != sqlcheck.SpanTemporary {
var text string
switch n := len(c.S.Tables); {
case n == 0:
text = fmt.Sprintf("Dropping schema %q", c.S.Name)
case n == 1:
text = fmt.Sprintf("Dropping non-empty schema %q with 1 table", c.S.Name)
case n > 1:
text = fmt.Sprintf("Dropping non-empty schema %q with %d tables", c.S.Name, n)
}
diags = append(diags, sqlcheck.Diagnostic{
Code: codeDropS,
Pos: sc.Stmt.Pos,
Text: text,
})
}
case *schema.DropTable:
if p.File.SchemaSpan(c.T.Schema) != sqlcheck.SpanDropped && p.File.TableSpan(c.T) != sqlcheck.SpanTemporary {
diags = append(diags, sqlcheck.Diagnostic{
Code: codeDropT,
Pos: sc.Stmt.Pos,
Text: fmt.Sprintf("Dropping table %q", c.T.Name),
})
}
case *schema.ModifyTable:
for i := range c.Changes {
d, ok := c.Changes[i].(*schema.DropColumn)
if !ok || p.File.ColumnSpan(c.T, d.C) == sqlcheck.SpanTemporary {
continue
}
if g := (schema.GeneratedExpr{}); !sqlx.Has(d.C.Attrs, &g) || strings.ToUpper(g.Type) != "VIRTUAL" {
diags = append(diags, sqlcheck.Diagnostic{
Code: codeDropC,
Pos: sc.Stmt.Pos,
Text: fmt.Sprintf("Dropping non-virtual column %q", d.C.Name),
})
}
}
}
}
}
if len(diags) > 0 {
const reportText = "destructive changes detected"
p.Reporter.WriteReport(sqlcheck.Report{Text: reportText, Diagnostics: diags})
if sqlx.V(a.Error) {
return errors.New(reportText)
}
}
return nil
}
|
