Skip to content
Navigation Menu
{{ message }}
forked from ByteInternet/hypernode-deploy-configuration
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathConfiguration.php
More file actions
515 lines (436 loc) · 11.2 KB
/
Copy pathConfiguration.php
File metadata and controls
515 lines (436 loc) · 11.2 KB
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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
<?php
namespace Hypernode\DeployConfiguration;
use Hypernode\DeployConfiguration\Logging\LoggingFactory;
use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;
use function Deployer\task;
class Configuration
{
/**
* Default deploy excluded files
*/
private const DEFAULT_DEPLOY_EXCLUDE = [
'./.git',
'./.github',
'./deploy.php',
'./.gitlab-ci.yml',
'./Jenkinsfile',
'.DS_Store',
'.idea',
'.gitignore',
'.editorconfig',
'*.scss',
'*.less',
'*.jsx',
'*.ts',
];
/**
* Default composer options
*/
public const DEFAULT_COMPOSER_OPTIONS = [
'--verbose',
'--no-progress',
'--no-interaction',
'--optimize-autoloader',
'--no-dev',
];
/**
* Deploy stages / environments. Usually production and test.
*
* @var Stage[]
*/
private $stages = [];
/**
* Shared folders between deploys. Commonly used for `media`, `var/import` folders etc.
* @var string[]
*/
private $sharedFolders = [];
/**
* Files shared between deploys. Commonly used for database configurations etc.
*
* @var string[]
*/
private $sharedFiles = [];
/**
* Folders that should be writable but not shared between deploys. All shared folders are writable by default.
*
* @var string[]
*/
private $writableFolders = [];
/**
*
* Add file / directory that will not be deployed. File patterns are added as `tar --exclude=`;
*
* @var string[]
*/
private $deployExclude = self::DEFAULT_DEPLOY_EXCLUDE;
/**
* Tasks to run prior to deploying the application to build everything. For example M2 static content deploy
* or running your gulp build.
*
* @var string[]
*/
private $buildTasks = [];
/**
* Tasks to run on all or specific servers to deploy.
*
* @var string[]
*/
private $deployTasks = [];
/**
* Configurations for after deploy tasks. Commonly used to send deploy email or push a New Relic deploy tag.
* These after deploy tasks are run on the production server(s).
*
* @see \Hypernode\DeployConfiguration\AfterDeployTask\Cloudflare
* @see \Hypernode\DeployConfiguration\AfterDeployTask\EmailNotification
* @see \Hypernode\DeployConfiguration\AfterDeployTask\NewRelic
* @see \Hypernode\DeployConfiguration\AfterDeployTask\SlackWebhook
*
* @var TaskConfigurationInterface[]
*/
private $afterDeployTasks = [];
/**
* @var TaskConfigurationInterface[]
*/
private $platformConfigurations = [];
/**
* @var string
*/
private $phpVersion = 'php';
/**
* @var string
*/
private $publicFolder = 'pub';
/**
* @var string
*/
private $buildArchiveFile = 'build/build.tgz';
/**
* Add callbacks you want to excecute after all deploy tasks are initialized
* This allows you to reconfigure a deployer task
*
* @var array
*/
private $postInitializeCallbacks = [];
/**
* Directory that stores log files. Is used for automatically log aggregation over different hosts / scaling
* applications.
*
* @var string
*/
private $logDir = 'var/log';
/**
* @var LoggerInterface
*/
private $logger;
/**
* @var array
* @psalm-var array<string, mixed>
*/
private $deployerVariables = [];
/**
* @var string
*/
private $recipe = '';
public function __construct()
{
$this->logger = LoggingFactory::create(LogLevel::INFO);
$this->setDefaultComposerOptions();
}
public function setRecipe(string $recipe)
{
RecipeLoader::get()->loadRecipe($recipe);
$this->recipe = $recipe;
}
public function getRecipe(): string
{
return $this->recipe;
}
private function validateTask(string $task): bool
{
try {
task($task);
} catch (\InvalidArgumentException $e) {
return false;
}
return true;
}
public function addBuildTask(string $task): self
{
if ($this->validateTask($task)) {
$this->buildTasks[] = $task;
} else {
throw new \RuntimeException(sprintf("Build task %s does not exist!", $task));
}
return $this;
}
/**
* @return string[]
*/
public function getBuildTasks(): array
{
return $this->buildTasks;
}
public function addDeployTask(string $task): self
{
if ($this->validateTask($task)) {
$this->deployTasks[] = $task;
} else {
throw new \RuntimeException(sprintf("Deploy task %s does not exist!", $task));
}
return $this;
}
/**
* @return string[]
*/
public function getDeployTasks(): array
{
return $this->deployTasks;
}
/**
* @param mixed $value
*/
public function setVariable(string $key, $value, string $stage = 'all'): void
{
$this->deployerVariables[$stage][$key] = $value;
}
/**
* @return array
* @psalm-return array<string, mixed>
*/
public function getVariables(string $stage = 'all'): array
{
return $this->deployerVariables[$stage] ?? [];
}
public function addStage(string $name, string $domain, string $username = 'app'): Stage
{
$stage = new Stage($name, $domain, $username);
$this->stages[] = $stage;
return $stage;
}
/**
* @param string[] $options
* @return void
*/
public function setComposerOptions(array $options): self
{
$this->setVariable('composer_options', implode(' ', $options));
return $this;
}
public function setDefaultComposerOptions(): self
{
$this->setComposerOptions(self::DEFAULT_COMPOSER_OPTIONS);
return $this;
}
/**
* @return Stage[]
*/
public function getStages(): array
{
return $this->stages;
}
/**
* @param string[] $folders
*/
public function setSharedFolders(array $folders): self
{
$this->sharedFolders = [];
foreach ($folders as $folder) {
$this->addSharedFolder($folder);
}
return $this;
}
public function addSharedFolder(string $folder): self
{
$this->sharedFolders[] = $folder;
return $this;
}
/**
* @return string[]
*/
public function getSharedFolders(): array
{
return $this->sharedFolders;
}
/**
* @param string[] $files
*/
public function setSharedFiles(array $files): self
{
$this->sharedFiles = [];
foreach ($files as $file) {
$this->addSharedFile($file);
}
return $this;
}
public function addSharedFile(string $file): self
{
$this->sharedFiles[] = $file;
return $this;
}
/**
* @return string[]
*/
public function getSharedFiles(): array
{
return $this->sharedFiles;
}
/**
* @return string[]
*/
public function getWritableFolders(): array
{
return $this->writableFolders;
}
public function addWritableFolder(string $folder): self
{
$this->writableFolders[] = $folder;
return $this;
}
/**
* @param string[] $writableFolders
*/
public function setWritableFolders(array $writableFolders): self
{
$this->writableFolders = [];
foreach ($writableFolders as $folder) {
$this->addWritableFolder($folder);
}
return $this;
}
/**
* @param string[] $excludes
*/
public function setDeployExclude(array $excludes): self
{
$this->deployExclude = [];
foreach ($excludes as $exclude) {
$this->addDeployExclude($exclude);
}
return $this;
}
public function addDeployExclude(string $exclude): self
{
$this->deployExclude[] = $exclude;
return $this;
}
/**
* @return string[]
*/
public function getDeployExclude(): array
{
return $this->deployExclude;
}
/**
* @return TaskConfigurationInterface[]
*/
public function getAfterDeployTasks(): array
{
return $this->afterDeployTasks;
}
/**
* @param TaskConfigurationInterface[] $afterDeployTasks
*/
public function setAfterDeployTasks($afterDeployTasks): self
{
$this->afterDeployTasks = [];
foreach ($afterDeployTasks as $taskConfig) {
$this->addAfterDeployTask($taskConfig);
}
return $this;
}
public function addAfterDeployTask(TaskConfigurationInterface $taskConfig): self
{
$this->afterDeployTasks[] = $taskConfig;
return $this;
}
/**
* @return TaskConfigurationInterface[]
*/
public function getPlatformConfigurations(): array
{
return $this->platformConfigurations;
}
/**
* @param TaskConfigurationInterface[] $platformConfigurations
* @return $this
*/
public function setPlatformConfigurations(array $platformConfigurations): self
{
$this->platformConfigurations = [];
foreach ($platformConfigurations as $serverConfiguration) {
$this->addPlatformConfiguration($serverConfiguration);
}
return $this;
}
/**
* @return Configuration
*/
public function addPlatformConfiguration(TaskConfigurationInterface $platformConfiguration): self
{
$this->platformConfigurations[] = $platformConfiguration;
return $this;
}
public function getPhpVersion(): string
{
return $this->phpVersion;
}
public function setPhpVersion(string $phpVersion): self
{
$this->phpVersion = $phpVersion;
return $this;
}
public function getPublicFolder(): string
{
return $this->publicFolder;
}
public function setPublicFolder(string $publicFolder): self
{
$this->publicFolder = $publicFolder;
return $this;
}
public function getPostInitializeCallbacks(): array
{
return $this->postInitializeCallbacks;
}
public function setPostInitializeCallbacks(array $callbacks): self
{
$this->postInitializeCallbacks = $callbacks;
return $this;
}
public function addPostInitializeCallback(callable $callback): self
{
$this->postInitializeCallbacks[] = $callback;
return $this;
}
public function getBuildArchiveFile(): string
{
return $this->buildArchiveFile;
}
public function setBuildArchiveFile(string $buildArchiveFile): self
{
$this->buildArchiveFile = $buildArchiveFile;
return $this;
}
public function getLogDir(): string
{
return $this->logDir;
}
/**
* Directory containing log files
*/
public function setLogDir(string $logDir): self
{
$this->logDir = $logDir;
return $this;
}
public function getLogger(): LoggerInterface
{
return $this->logger;
}
public function setLogger(LoggerInterface $logger): self
{
$this->logger = $logger;
return $this;
}
}
You can’t perform that action at this time.