Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
DBDiff/tests/Unit/AlterEnumSQLTest.php at master · DBDiff/DBDiff · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
DBDiff
DBDiff
Repository navigation
Code
Issues
3
(3)
Pull requests
Actions
Security and quality
Insights
More
items
Files
Expand file tree
master
Breadcrumbs
DBDiff
/
tests
/
Unit
/
AlterEnumSQLTest.php
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
194 lines (153 loc) · 7.37 KB
master
Breadcrumbs
DBDiff
/
tests
/
Unit
/
AlterEnumSQLTest.php
Copy path
Top
File metadata and controls
Code
Blame
194 lines (153 loc) · 7.37 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
<?php
namespace
Tests
\
Unit
;
use
DBDiff
\
Diff
\
AlterEnum
;
use
DBDiff
\
DB
\
Support
\
EnumLabels
;
use
DBDiff
\
SQLGen
\
DiffToSQL
\
AlterEnumSQL
;
use
PHPUnit
\
Framework
\
TestCase
;
/**
* Changing the labels of an enum (issue #228).
*
* The type used to be dropped and recreated in both directions, which
* PostgreSQL refuses while any column still uses it:
*
* ERROR: cannot drop type order_state because other objects depend on it
*
* A column of that type is the normal case, so the generated migration could
* not run. Adding a label needs no drop at all.
*/
class
AlterEnumSQLTest
extends
TestCase
{
private
function
enum
(
string
$
name
,
array
$
labels
):
string
{
$
quoted
=
array_map
(
static
fn
(
$
l
) =>
"
'
"
.
str_replace
(
"
'
"
,
"
''
"
,
$
l
) .
"
'
"
,
$
labels
);
return
'
CREATE TYPE "
'
.
$
name
.
'
" AS ENUM (
'
.
implode
(
'
,
'
,
$
quoted
) .
'
)
'
;
}
private
function
sqlFor
(
array
$
sourceLabels
,
array
$
targetLabels
):
AlterEnumSQL
{
return
new
AlterEnumSQL
(
new
AlterEnum
(
'
order_state
'
,
$
this
->
enum
(
'
order_state
'
,
$
sourceLabels
),
$
this
->
enum
(
'
order_state
'
,
$
targetLabels
)
));
}
// ── Adding a label ───────────────────────────────────────────────────────
public
function
testAppendedLabelIsAddedRatherThanReplacingTheType
():
void
{
// The target is behind; making it match the source appends one label.
$
sql
=
$
this
->
sqlFor
([
'
new
'
,
'
paid
'
,
'
shipped
'
], [
'
new
'
,
'
paid
'
])->
getUp
();
$
this
->
assertStringContainsString
(
"
ADD VALUE IF NOT EXISTS 'shipped'
"
,
$
sql
);
$
this
->
assertStringNotContainsString
(
'
DROP TYPE
'
,
$
sql
);
$
this
->
assertStringNotContainsString
(
'
CREATE TYPE
'
,
$
sql
);
}
public
function
testAppendedLabelIsPositionedAfterItsNeighbour
():
void
{
$
sql
=
$
this
->
sqlFor
([
'
new
'
,
'
paid
'
,
'
shipped
'
], [
'
new
'
,
'
paid
'
])->
getUp
();
$
this
->
assertStringContainsString
(
"
ADD VALUE IF NOT EXISTS 'shipped' AFTER 'paid';
"
,
$
sql
);
}
public
function
testLabelInsertedInTheMiddleKeepsItsPlaceInTheOrdering
():
void
{
// BEFORE/AFTER has been available since PostgreSQL 12, so a label does
// not have to go on the end.
$
sql
=
$
this
->
sqlFor
([
'
a
'
,
'
b
'
,
'
c
'
], [
'
a
'
,
'
c
'
])->
getUp
();
$
this
->
assertStringContainsString
(
"
ADD VALUE IF NOT EXISTS 'b' AFTER 'a';
"
,
$
sql
);
$
this
->
assertStringNotContainsString
(
'
DROP TYPE
'
,
$
sql
);
}
public
function
testLabelAddedAtTheFrontAnchorsToTheOneAfterIt
():
void
{
$
sql
=
$
this
->
sqlFor
([
'
first
'
,
'
a
'
,
'
b
'
], [
'
a
'
,
'
b
'
])->
getUp
();
$
this
->
assertStringContainsString
(
"
ADD VALUE IF NOT EXISTS 'first' BEFORE 'a';
"
,
$
sql
);
}
public
function
testSeveralAddedLabelsEachGetAStatement
():
void
{
$
sql
=
$
this
->
sqlFor
([
'
a
'
,
'
b
'
,
'
c
'
,
'
d
'
], [
'
a
'
,
'
c
'
])->
getUp
();
$
this
->
assertSame
(
2
,
substr_count
(
$
sql
,
'
ADD VALUE
'
));
$
this
->
assertStringContainsString
(
"
'b' AFTER 'a'
"
,
$
sql
);
$
this
->
assertStringContainsString
(
"
'd' AFTER 'c'
"
,
$
sql
);
$
this
->
assertStringNotContainsString
(
'
DROP TYPE
'
,
$
sql
);
}
public
function
testAddedLabelsAreIdempotent
():
void
{
// IF NOT EXISTS, so re-running a migration is not an error.
$
sql
=
$
this
->
sqlFor
([
'
a
'
,
'
b
'
], [
'
a
'
])->
getUp
();
$
this
->
assertStringContainsString
(
'
ADD VALUE IF NOT EXISTS
'
,
$
sql
);
}
public
function
testALabelWithAQuoteIsEscaped
():
void
{
$
sql
=
$
this
->
sqlFor
([
'
a
'
,
"
it's
"
], [
'
a
'
])->
getUp
();
$
this
->
assertStringContainsString
(
"
ADD VALUE IF NOT EXISTS 'it''s'
"
,
$
sql
);
}
// ── Removing or reordering, which ADD VALUE cannot do ────────────────────
public
function
testRemovedLabelStillReplacesTheType
():
void
{
// There is no DROP VALUE. Doing this properly means migrating every
// dependent column, which cannot be generated blind.
$
sql
=
$
this
->
sqlFor
([
'
a
'
], [
'
a
'
,
'
b
'
])->
getUp
();
$
this
->
assertStringContainsString
(
'
DROP TYPE
'
,
$
sql
);
$
this
->
assertStringContainsString
(
'
CREATE TYPE
'
,
$
sql
);
}
public
function
testReplacementSaysWhyItMayNotApply
():
void
{
$
sql
=
$
this
->
sqlFor
([
'
a
'
], [
'
a
'
,
'
b
'
])->
getUp
();
$
this
->
assertStringContainsString
(
'
while any column still uses it
'
,
$
sql
);
}
public
function
testReorderedLabelsReplaceTheType
():
void
{
// ADD VALUE cannot move a label that already exists.
$
sql
=
$
this
->
sqlFor
([
'
b
'
,
'
a
'
], [
'
a
'
,
'
b
'
])->
getUp
();
$
this
->
assertStringContainsString
(
'
DROP TYPE
'
,
$
sql
);
}
// ── The two directions are decided separately ────────────────────────────
public
function
testRevertingAnAdditionReplacesTheType
():
void
{
// UP adds a label; DOWN would have to remove it, which it cannot.
$
alter
=
$
this
->
sqlFor
([
'
new
'
,
'
paid
'
,
'
shipped
'
], [
'
new
'
,
'
paid
'
]);
$
this
->
assertStringContainsString
(
'
ADD VALUE
'
,
$
alter
->
getUp
());
$
this
->
assertStringContainsString
(
'
DROP TYPE
'
,
$
alter
->
getDown
());
}
public
function
testDownIsAdditiveWhenTheTargetIsTheOneAhead
():
void
{
// The source is behind here, so restoring the target appends.
$
alter
=
$
this
->
sqlFor
([
'
new
'
], [
'
new
'
,
'
paid
'
]);
$
this
->
assertStringContainsString
(
'
DROP TYPE
'
,
$
alter
->
getUp
());
$
this
->
assertStringContainsString
(
"
ADD VALUE IF NOT EXISTS 'paid'
"
,
$
alter
->
getDown
());
}
// ── Parsing ──────────────────────────────────────────────────────────────
public
function
testLabelsAreReadOutOfADefinition
():
void
{
$
this
->
assertSame
(
[
'
new
'
,
'
paid
'
],
EnumLabels::
of
(
$
this
->
enum
(
'
t
'
, [
'
new
'
,
'
paid
'
]))
);
}
public
function
testADoubledQuoteIsOneEscapedQuote
():
void
{
$
this
->
assertSame
([
"
it's
"
], EnumLabels::
of
(
"
CREATE TYPE
\"
t
\"
AS ENUM ('it''s')
"
));
}
public
function
testACommaInsideALabelIsNotASeparator
():
void
{
$
this
->
assertSame
([
'
a,b
'
], EnumLabels::
of
(
"
CREATE TYPE
\"
t
\"
AS ENUM ('a,b')
"
));
}
public
function
testAnUnparseableDefinitionFallsBackRatherThanGuessing
():
void
{
$
this
->
assertNull
(EnumLabels::
of
(
'
CREATE DOMAIN "d" AS integer
'
));
// And the generator takes the replacement path for it.
$
sql
= (
new
AlterEnumSQL
(
new
AlterEnum
(
'
d
'
,
'
CREATE DOMAIN "d" AS integer
'
,
'
CREATE DOMAIN "d" AS bigint
'
)))->
getUp
();
$
this
->
assertStringContainsString
(
'
DROP TYPE
'
,
$
sql
);
}
// ── The positioning helper ───────────────────────────────────────────────
public
function
testAdditionsReturnsNullWhenALabelWasRemoved
():
void
{
$
this
->
assertNull
(AlterEnumSQL::
additions
([
'
a
'
,
'
b
'
], [
'
a
'
]));
}
public
function
testAdditionsReturnsEmptyWhenNothingChanged
():
void
{
$
this
->
assertSame
([], AlterEnumSQL::
additions
([
'
a
'
,
'
b
'
], [
'
a
'
,
'
b
'
]));
}
public
function
testAdditionsAnchorsEachNewLabelToOneThatExists
():
void
{
$
this
->
assertSame
(
[[
'
b
'
,
'
AFTER
'
,
'
a
'
], [
'
d
'
,
'
AFTER
'
,
'
c
'
]],
AlterEnumSQL::
additions
([
'
a
'
,
'
c
'
], [
'
a
'
,
'
b
'
,
'
c
'
,
'
d
'
])
);
}
}
You can’t perform that action at this time.