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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
package App::Sqitch::Command::deploy;
use 5.010;
use strict;
use warnings;
use utf8;
use Moo;
use App::Sqitch::Types qw(Int URI Str Bool HashRef);
use Locale::TextDomain qw(App-Sqitch);
use Type::Utils qw(enum);
use App::Sqitch::X qw(hurl);
use List::Util qw(first);
use namespace::autoclean;
extends 'App::Sqitch::Command';
with 'App::Sqitch::Role::ContextCommand';
with 'App::Sqitch::Role::ConnectingCommand';
our $VERSION = 'v1.4.0'; # VERSION
has target => (
is => 'ro',
isa => Str,
);
has to_change => (
is => 'ro',
isa => Str,
);
has mode => (
is => 'ro',
isa => enum([qw(
change
tag
all
)]),
default => 'all',
);
has log_only => (
is => 'ro',
isa => Bool,
default => 0,
);
has lock_timeout => (
is => 'ro',
isa => Int,
lazy => 1,
default => sub { App::Sqitch::Engine::default_lock_timeout() },
);
has verify => (
is => 'ro',
isa => Bool,
default => 0,
);
has variables => (
is => 'ro',
isa => HashRef,
lazy => 1,
default => sub { {} },
);
sub options {
return qw(
target|t=s
to-change|to|change=s
mode=s
set|s=s%
log-only
lock-timeout=i
verify!
);
}
sub configure {
my ( $class, $config, $opt ) = @_;
my %params = (
mode => $opt->{mode} || $config->get( key => 'deploy.mode' ) || 'all',
verify => $opt->{verify} // $config->get( key => 'deploy.verify', as => 'boolean' ) // 0,
log_only => $opt->{log_only} || 0,
);
for my $key (qw(to_change target lock_timeout)) {
$params{$key} = $opt->{$key} if exists $opt->{$key};
}
if ( my $vars = $opt->{set} ) {
$params{variables} = $vars;
}
return \%params;
}
sub _collect_vars {
my ($self, $target) = @_;
my $cfg = $self->sqitch->config;
return (
%{ $cfg->get_section(section => 'core.variables') },
%{ $cfg->get_section(section => 'deploy.variables') },
%{ $target->variables }, # includes engine
%{ $self->variables }, # --set
);
}
sub execute {
my $self = shift;
my ($targets, $changes) = $self->parse_args(
target => $self->target,
args => \@_,
);
# Warn on multiple targets.
my $target = shift @{ $targets };
$self->warn(__x(
'Too many targets specified; connecting to {target}',
target => $target->name,
)) if @{ $targets };
# Warn on too many changes.
my $change = $self->to_change // shift @{ $changes };
$self->warn(__x(
'Too many changes specified; deploying to "{change}"',
change => $change,
)) if @{ $changes };
# Now get to work.
my $engine = $target->engine;
$engine->with_verify( $self->verify );
$engine->log_only( $self->log_only );
$engine->lock_timeout( $self->lock_timeout );
$engine->set_variables( $self->_collect_vars($target) );
$engine->deploy( $change, $self->mode );
return $self;
}
1;
__END__
=head1 Name
App::Sqitch::Command::deploy - Deploy Sqitch changes to a database
=head1 Synopsis
my $cmd = App::Sqitch::Command::deploy->new(%params);
$cmd->execute;
=head1 Description
If you want to know how to use the C<deploy> command, you probably want to be
reading C<sqitch-deploy>. But if you really want to know how the C<deploy> command
works, read on.
=head1 Interface
=head2 Class Methods
=head3 C<options>
my @opts = App::Sqitch::Command::deploy->options;
Returns a list of L<Getopt::Long> option specifications for the command-line
options for the C<deploy> command.
=head2 Attributes
=head3 C<log_only>
Boolean indicating whether to log the deploy without running the scripts.
=head3 C<lock_timeout>
The number of seconds to wait for an exclusive advisory lock on the target,
for engines that support the feature.
=head3 C<mode>
Deploy mode, one of "change", "tag", or "all".
=head3 C<target>
The deployment target URI.
=head3 C<to_change>
Change up to which to deploy.
=head3 C<verify>
Boolean indicating whether or not to run verify scripts after each change.
=head2 Instance Methods
=head3 C<execute>
$deploy->execute;
Executes the deploy command.
=head1 See Also
=over
=item L<sqitch-deploy>
Documentation for the C<deploy> command to the Sqitch command-line client.
=item L<sqitch>
The Sqitch command-line client.
=back
=head1 Author
David E. Wheeler <david@justatheory.com>
=head1 License
Copyright (c) 2012-2023 iovation Inc., David E. Wheeler
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
=cut
|
