-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile
653 lines (586 loc) · 26.7 KB
/
Makefile
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
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
###
# Plugin specific settings for Makefile - You may need to change information
# in the included file!
###
include build_config/plugin_config.mk
###
# Standard settings for Makefile - Probably won't need to change anything here
###
SHELL := /bin/bash
BASE_PATH := $(PWD)
FIND := $(shell which find)
CURL := $(shell which curl)
UNZIP := $(shell which unzip)
PHP_BIN := $(shell which php)
DC_BIN := $(shell which docker-compose)
SQL_BACKUP_FILE ?= tests/_data
MYSQL_DATABASE ?= wordpress
MYSQL_USER ?= wordpress
MYSQL_PASSWORD ?= wordpress
DB_IMAGE ?= mariadb
WORDPRESS_DB_HOST ?= localhost
WP_PLUGIN_URL ?= "https://downloads.wordpress.org/plugin/"
E20R_PLUGIN_URL ?= "https://eighty20results.com/protected-content"
WP_CONTAINER_NAME ?= codecep-wp-$(E20R_PLUGIN_NAME)
DB_CONTAINER_NAME ?= $(DB_IMAGE)-wp-$(E20R_PLUGIN_NAME)
FOUND_INTEGRATION_TESTS ?= $(wildcard tests/integration/testcases/*.php)
FOUND_UNIT_TESTS ?= $(wildcard tests/unit/testcases/*.php)
FOUND_WP_ACCEPTANCE_TESTS ?= $(wildcard /tests/acceptance/testcases/*.php)
FOUND_FUNCTIONAL_TESTS ?= $(wildcard tests/functional/testcases/*.php)
# Default is to not use coverage unless we know we're on a local (non-GitHub) system
COVERAGE_SETTINGS ?=
UNIT_TEST_CASE_PATH := tests/unit/testcases/
INTEGRATION_TEST_CASE_PATH := tests/integration/testcases/
FUNCTIONAL_TEST_CASE_PATH := tests/functional/testcases/
ACCEPTANCE_TEST_CASE_PATH := tests/acceptance/testcases/
ifneq ($(wildcard ./tests/docker/docker.hub.key),)
$(info Path to key for docker hub exists)
CONTAINER_ACCESS_TOKEN := $(shell cat ./tests/docker/docker.hub.key)
COVERAGE_SETTINGS := --coverage-xml coverage.xml
endif
ifneq ($(wildcard ./docker.hub.key),)
$(info Path to key for docker hub exists)
CONTAINER_ACCESS_TOKEN := $(shell cat ./docker.hub.key)
COVERAGE_SETTINGS := --coverage-xml coverage.xml
endif
ifeq ($(DOCKER_USER),)
$(info Using Makefile variable to set the docker hub username)
DOCKER_USER ?= $(DOCKER_HUB_USER)
endif
CONTAINER_REPO ?= 'docker.io/$(DOCKER_USER)'
DOCKER_IS_RUNNING := $(shell ps -ef | grep Docker.app | wc -l | xargs)
ifeq ($(CONTAINER_ACCESS_TOKEN),)
$(info Setting CONTAINER_ACCESS_TOKEN from environment variable)
CONTAINER_ACCESS_TOKEN := $(shell echo "$${CONTAINER_ACCESS_TOKEN}" )
COVERAGE_SETTINGS :=
endif
DOWNLOAD_MODULE := 1
# Determine if there is a local (to this system) instance of the E20R Utilities module repository
ifneq ($(wildcard $(E20R_UTILITIES_PATH)/src/E20R/licensing/class-licensing.php),)
DOWNLOAD_MODULE := $(shell grep -q 'public function __construct' $(E20R_UTILITIES_PATH)/src/licensing/class-licensing.php 2>/dev/null && echo "0")
endif
$(info Download the E20R Utilities module: $(DOWNLOAD_MODULE))
# PROJECT := $(shell basename ${PWD}) # This is the default as long as the plugin name matches
PROJECT ?= $(E20R_PLUGIN_NAME)
VOLUME_CONTAINER ?= $(PROJECT)_volume
# Settings for docker-compose
DC_CONFIG_FILE ?= $(PWD)/docker-compose.yml
DC_ENV_FILE ?= $(PWD)/tests/_envs/.env.testing
STACK_RUNNING := $(shell APACHE_RUN_USER=$(APACHE_RUN_USER) APACHE_RUN_GROUP=$(APACHE_RUN_GROUP) COMPOSE_INTERACTIVE_NO_CLI=1 \
DB_IMAGE=$(DB_IMAGE) DB_VERSION=$(DB_VERSION) WP_VERSION=$(WP_VERSION) VOLUME_CONTAINER=$(VOLUME_CONTAINER) \
docker-compose --project-name $(PROJECT) --env-file $(DC_ENV_FILE) --file $(DC_CONFIG_FILE) ps -q 2> /dev/null | wc -l | xargs)
$(info Number of running docker images:$(STACK_RUNNING))
.PHONY: \
docs \
readme \
changelog \
metadata \
git-log \
clean \
clean-inc \
clean-wp-deps \
real-clean \
wp-deps \
e20r-deps \
php-composer \
is-docker-running \
docker-deps \
docker-compose-deps \
start-stack \
stop-stack \
restart \
shell \
lint-tests \
code-standard-tests \
phpstan-tests \
unit-tests \
integration-tests \
acceptance-tests \
build-tests \
new-release \
wp-shell \
wp-log \
db-shell \
db-backup \
db-import \
tests \
image-build \
image-pull \
image-push \
image-scan \
docker-hub-login \
hub-login \
hub-nologin \
prerequisite
#
# Make sure the plugin name is set to something
#
prerequisite:
@echo "Testing prerequisite variable settings"
@mkdir -p tests/_output/
@chmod 777 tests/_output
@if [[ "$(E20R_PLUGIN_NAME)" =~ "default-plugin-name" ]]; then \
echo "The E20R_PLUGIN_NAME environment variable must be configured before running this command!"; \
exit 1; \
fi
#
# Clean up Codeception and GitHub action artifacts
#
clean: prerequisite
@if [[ -n "$(STACK_RUNNING)" ]]; then \
if [[ -f $(COMPOSER_DIR)/bin/codecept ]]; then \
$(COMPOSER_DIR)/bin/codecept clean ; \
fi ; \
fi
@rm -rf _actions/
@rm -rf workflow
#
# Remove all installed composer, WordPress and E20R plugins/components from the $(COMPOSER_DIR) - /inc - directory
#
clean-inc: prerequisite
@if [[ -d $(COMPOSER_DIR) ]]; then \
echo "Removing existing composer packages from $(COMPOSER_DIR)" ; \
find $(COMPOSER_DIR)/ -type d -maxdepth 1 ! -name inc -exec rm -rf {} \; ; \
if [[ -f "$(COMPOSER_DIR)/autoload.php" ]]; then \
rm $(COMPOSER_DIR)/*.php ; \
fi ; \
else \
echo "No existing composer packages to remove from $(COMPOSER_DIR)" ; \
mkdir -p $(COMPOSER_DIR) ; \
fi
#
# Log in to your Docker HUB account before performing pull/push operations
#
hub-login:
$(info Local network status is: '$(LOCAL_NETWORK_STATUS)' so we should continue?)
@if [[ "Xactive" == "X$(LOCAL_NETWORK_STATUS)" ]]; then \
echo "Yes, logging in to Docker Hub using the '$(DOCKER_USER)' account" ; \
docker login --username $(DOCKER_USER) --password $(CONTAINER_ACCESS_TOKEN) ; \
else \
echo "Skipping docker-cli based hub login!" ; \
fi
#
# Target to use when not running locally
#
hub-nologin:
@echo "Skipping CLI based docker login operation"
#
# Conditional execution based on whether or not we're running on a MacOS based host with
# it's network interface up and running
#
ifeq ($(LOCAL_NETWORK_STATUS), )
$(info Using GitHub Action based login for Docker HUB)
docker-hub-login: hub-nologin
else
$(info Using CLI based login for Docker HUB)
docker-hub-login: hub-login
endif
#
# (re)Build the Docker images for this development/test environment
#
image-build: docker-deps
$(info Building the docker container stack for $(PROJECT)?)
@if [[ "X$(LOCAL_NETWORK_STATUS)" != "Xinactive" ]]; then \
echo "Yes, building containers for Unit, Integration and Functional testing!" ; \
APACHE_RUN_USER=$(APACHE_RUN_USER) APACHE_RUN_GROUP=$(APACHE_RUN_GROUP) \
DB_IMAGE=$(DB_IMAGE) DB_VERSION=$(DB_VERSION) WP_VERSION=$(WP_VERSION) VOLUME_CONTAINER=$(VOLUME_CONTAINER) \
docker compose --project-name $(PROJECT) --env-file $(DC_ENV_FILE) --file $(DC_CONFIG_FILE) build --pull --progress tty ; \
fi
#
# Trigger the security scan of the docker image(s)
#
image-scan: docker-hub-login
@APACHE_RUN_USER=$(APACHE_RUN_USER) APACHE_RUN_GROUP=$(APACHE_RUN_GROUP) \
DB_IMAGE=$(DB_IMAGE) DB_VERSION=$(DB_VERSION) WP_VERSION=$(WP_VERSION) VOLUME_CONTAINER=$(VOLUME_CONTAINER) \
docker scan --accept-license $(CONTAINER_REPO)/$(PROJECT)_wordpress:$(WP_IMAGE_VERSION)
#
# Push the custom Docker images for this plugin to the Docker HUB (security scan if possible)
# FIXME: Enable the image-scan target (if we can get the issues fixed)
#
image-push: docker-hub-login # image-scan
@APACHE_RUN_USER=$(APACHE_RUN_USER) APACHE_RUN_GROUP=$(APACHE_RUN_GROUP) \
DB_IMAGE=$(DB_IMAGE) DB_VERSION=$(DB_VERSION) WP_VERSION=$(WP_VERSION) VOLUME_CONTAINER=$(VOLUME_CONTAINER) \
docker tag $(PROJECT)_wordpress $(CONTAINER_REPO)/$(PROJECT)_wordpress:$(WP_IMAGE_VERSION)
@APACHE_RUN_USER=$(APACHE_RUN_USER) APACHE_RUN_GROUP=$(APACHE_RUN_GROUP) \
DB_IMAGE=$(DB_IMAGE) DB_VERSION=$(DB_VERSION) WP_VERSION=$(WP_VERSION) VOLUME_CONTAINER=$(VOLUME_CONTAINER) \
docker push $(CONTAINER_REPO)/$(PROJECT)_wordpress:$(WP_IMAGE_VERSION)
#
# Attempt to pull (download) the plugin specific Docker images for the test/development environment
#
image-pull: docker-hub-login
$(info Downloading $(CONTAINER_REPO)/$(PROJECT)_wordpress:$(WP_IMAGE_VERSION)?)
@if docker manifest inspect $(CONTAINER_REPO)/$(PROJECT)_wordpress:$(WP_IMAGE_VERSION) > /dev/null; then \
if [[ "X$(LOCAL_NETWORK_STATUS)" != "Xinactive" ]]; then \
echo "Yes, pulling $(CONTAINER_REPO)/$(PROJECT)_wordpress:$(WP_IMAGE_VERSION) image from Docker repo" ; \
APACHE_RUN_USER=$(APACHE_RUN_USER) APACHE_RUN_GROUP=$(APACHE_RUN_GROUP) \
DB_IMAGE=$(DB_IMAGE) DB_VERSION=$(DB_VERSION) WP_VERSION=$(WP_VERSION) VOLUME_CONTAINER=$(VOLUME_CONTAINER) \
docker pull $(CONTAINER_REPO)/$(PROJECT)_wordpress:$(WP_IMAGE_VERSION); \
fi ; \
fi
#
# Clean up Composer and WP/E20R dependencies as well as the Docker container(s) used for testing/development
#
real-clean: prerequisite stop-stack clean clean-inc clean-wp-deps
@echo "Removing docker images" && \
docker image remove $(PROJECT)_wordpress --force
#
# Install the composer.phar file to the local directory
#
php-composer: prerequisite
@if [[ ! -z "$(PHP_BIN)" && "Xinactive" != "X$(LOCAL_NETWORK_STATUS)" ]]; then \
bin/install-composer.sh $(BASE_PATH); \
fi
#
# Install the Composer packages required by this plugin when it is released
#
composer-prod: composer.json real-clean clean-inc php-composer
@echo "Install/Update the Production composer dependencies"
@$(PHP_BIN) $(COMPOSER_BIN) update --ansi --prefer-stable --no-dev
#
# Install the required Composer packages to develop/test this plugin
#
composer-dev: composer.json php-composer
@echo "Use composer to install/update the PHP test dependencies"
@$(PHP_BIN) $(COMPOSER_BIN) update --ansi --prefer-stable
#
# Install docker-compose for use
# FIXME: At some point soon, we should be able to use `docker compose ...` rather than `docker-compose ...`
#
docker-compose: prerequisite
@if [[ -z "$(DC_BIN)" && ! -f /usr/local/bin/docker-compose ]]; then \
echo "Installing docker-compose" && \
sudo curl --silent -L https://github.com/docker/compose/releases/download/$(COMPOSER_VERSION)/docker-compose-`uname -s`-`uname -m` \
-o /usr/local/bin/docker-compose && \
sudo chmod +x /usr/local/bin/docker-compose ; \
fi
#
# Remove any WP or E20R custom plugins from inc/wp_plugins/*
#
clean-wp-deps: prerequisite
@rm -rf $(COMPOSER_DIR)/wp_plugins/*
# git archive --prefix="$${e20r_plugin}/" --format=zip --output="$(COMPOSER_DIR)/wp_plugins/$${e20r_plugin}.zip" --worktree-attributes main &&
#
# Install custom plugins from Eighty/20 Results (hosted on eighty20results.com) or in the local filesystem
# Test whether there is a local presence for the specified custom plugin and build it if present.
# If not present on the local filesystem, then we'll download it and install it to inc/wp_plugins
#
e20r-deps: prerequisite
@echo "Loading defined E20R custom plugin dependencies"
@mkdir -p $(COMPOSER_DIR)/wp_plugins
@DOWNLOAD_MODULE=${DOWNLOAD_MODULE} ; \
for e20r_plugin in $(E20R_DEPENDENCIES) ; do \
echo "Checking for presence of $(COMPOSER_DIR)/wp_plugins/$${e20r_plugin}..." ; \
if [[ ! -d "$(COMPOSER_DIR)/wp_plugins/$${e20r_plugin}" ]]; then \
echo "Download or build $${e20r_plugin}.zip dependency?" && \
if [[ "0" -eq "$${DOWNLOAD_MODULE}" && "00-e20r-utilities" -eq "$${e20r_plugin}" ]]; then \
echo "Build $${e20r_plugin} archive and save to $(COMPOSER_DIR)/wp_plugins/$${e20r_plugin}" && \
cd ${E20R_UTILITIES_PATH} && \
make build && \
new_kit="$$(ls -art build/kits/$${e20r_plugin}* | tail -1)" && \
echo "Copy $${new_kit} to $(BASE_PATH)/$(COMPOSER_DIR)/wp_plugins/$${e20r_plugin}.zip" && \
cp "$${new_kit}" "$(BASE_PATH)/$(COMPOSER_DIR)/wp_plugins/$${e20r_plugin}.zip" && \
cd $(BASE_PATH) ; \
else \
echo "Download $${e20r_plugin} to $(COMPOSER_DIR)/wp_plugins/$${e20r_plugin}" && \
$(CURL) --silent -L "$(E20R_PLUGIN_URL)/$${e20r_plugin}.zip" -o "$(COMPOSER_DIR)/wp_plugins/$${e20r_plugin}.zip" ; \
fi ; \
mkdir -p "$(COMPOSER_DIR)/wp_plugins/$${e20r_plugin}" && \
echo "Installing the $${e20r_plugin}.zip plugin" && \
$(UNZIP) -o "$(COMPOSER_DIR)/wp_plugins/$${e20r_plugin}.zip" -d $(COMPOSER_DIR)/wp_plugins/ 2>&1 > /dev/null && \
rm -f "$(COMPOSER_DIR)/wp_plugins/$${e20r_plugin}.zip" ; \
fi ; \
done
#
# Check if Docker is running. If not, exit the make operation
#
is-docker-running: prerequisite
@if [[ "0" -eq $(DOCKER_IS_RUNNING) ]]; then \
echo "Error: Docker is not running on this system!" && \
exit 1; \
fi
#
# Install docker-compose and the WordPress plugins or E20R plugin dependencies listed
#
docker-deps: prerequisite is-docker-running docker-compose wp-deps
#
# Install any composer dependencies (test & development) plus
# WordPress plugins (using the WP.org plugin slug) that are listed as dependencies in the WP_DEPENDENCIES, and
# triggers the e20r-deps target, which installs any Eighty20Results.com custom plugins we need (normally the
# E20R Utilities module).
#
wp-deps: prerequisite clean composer-dev e20r-deps
@echo "Loading WordPress plugin dependencies"
@for dep_plugin in ${WP_DEPENDENCIES} ; do \
if [[ ! -d "$(COMPOSER_DIR)/wp_plugins/$${dep_plugin}" ]]; then \
echo "Download and install $${dep_plugin} to $(COMPOSER_DIR)/wp_plugins/$${dep_plugin}" && \
mkdir -p "$(COMPOSER_DIR)/wp_plugins/$${dep_plugin}" && \
$(CURL) --silent -L "$(WP_PLUGIN_URL)/$${dep_plugin}.zip" -o "$(COMPOSER_DIR)/wp_plugins/$${dep_plugin}.zip" && \
$(UNZIP) -o "$(COMPOSER_DIR)/wp_plugins/$${dep_plugin}.zip" -d $(COMPOSER_DIR)/wp_plugins/ 2>&1 > /dev/null && \
rm -f "$(COMPOSER_DIR)/wp_plugins/$${dep_plugin}.zip" ; \
fi ; \
done
#
# Install all required docker dependencies (docker-compose)
# NOTE: This target assumes the main docker binaries are installed on the system where this Makefile runs!)
#
start-stack: prerequisite docker-deps image-pull image-build
@echo "Number of running containers for $(PROJECT): $(STACK_RUNNING)"
@if [[ "2" -ne $(STACK_RUNNING) ]]; then \
echo "Building and starting the WordPress stack for testing purposes" ; \
APACHE_RUN_USER=$(APACHE_RUN_USER) APACHE_RUN_GROUP=$(APACHE_RUN_GROUP) \
DB_IMAGE=$(DB_IMAGE) DB_VERSION=$(DB_VERSION) WP_VERSION=$(WP_VERSION) VOLUME_CONTAINER=$(VOLUME_CONTAINER) \
docker compose --project-name $(PROJECT) --env-file $(DC_ENV_FILE) --file $(DC_CONFIG_FILE) up --detach --remove-orphans ; \
fi
@echo "Started the $(PROJECT) docker environment..."
#
# Start the docker-compose stack for this plugin _and_ import the .sql file (data) stored as
# ./tests/_data/{PLUGIN_NAME}.sql
#
db-import: start-stack
@echo "Maybe load WordPress data...?"
@bin/wait-for-db.sh "$(MYSQL_USER)" "$(MYSQL_PASSWORD)" "$(WORDPRESS_DB_HOST)" "$(E20R_PLUGIN_NAME)"
@if [[ -f $(SQL_BACKUP_FILE)/$(E20R_PLUGIN_NAME).sql ]]; then \
echo "Loading WordPress data to use for testing $(E20R_PLUGIN_NAME)" && \
docker compose --project-name $(PROJECT) --env-file $(DC_ENV_FILE) --file $(DC_CONFIG_FILE) exec -T database \
mysql \
--user=$(MYSQL_USER) \
--password="$(MYSQL_PASSWORD)" \
--host=$(WORDPRESS_DB_HOST) \
$(MYSQL_DATABASE) < $(SQL_BACKUP_FILE)/$(E20R_PLUGIN_NAME).sql ; \
fi
#
# Stop the docker compose stack for this plugin
#
stop-stack: prerequisite
@echo "Number of running containers for $(PROJECT): $(STACK_RUNNING)"
@if [[ 0 -lt "$(STACK_RUNNING)" ]]; then \
echo "Stopping the $(PROJECT) WordPress stack" ; \
APACHE_RUN_USER=$(APACHE_RUN_USER) APACHE_RUN_GROUP=$(APACHE_RUN_GROUP) \
DB_IMAGE=$(DB_IMAGE) DB_VERSION=$(DB_VERSION) WP_VERSION=$(WP_VERSION) VOLUME_CONTAINER=$(VOLUME_CONTAINER) \
docker compose --project-name $(PROJECT) --env-file $(DC_ENV_FILE) --file $(DC_CONFIG_FILE) down 2>/dev/null ; \
fi
#
# Restart the docker-compose stack and re-import the database
#
restart: prerequisite stop-stack db-import
#
# Open a shell against the Docker container for the WordPress instance
#
wp-shell: prerequisite
@APACHE_RUN_USER=$(APACHE_RUN_USER) APACHE_RUN_GROUP=$(APACHE_RUN_GROUP) \
DB_IMAGE=$(DB_IMAGE) DB_VERSION=$(DB_VERSION) WP_VERSION=$(WP_VERSION) VOLUME_CONTAINER=$(VOLUME_CONTAINER) \
docker compose --project-name $(PROJECT) --env-file $(DC_ENV_FILE) --file $(DC_CONFIG_FILE) exec wordpress /bin/bash
#
# Show the Docker logs for the WordPress instance
# (likely containing debug logging from the plugin - if it uses the error_log() function)
#
wp-log: prerequisite
@APACHE_RUN_USER=$(APACHE_RUN_USER) APACHE_RUN_GROUP=$(APACHE_RUN_GROUP) \
DB_IMAGE=$(DB_IMAGE) DB_VERSION=$(DB_VERSION) WP_VERSION=$(WP_VERSION) VOLUME_CONTAINER=$(VOLUME_CONTAINER) \
docker compose --project-name $(PROJECT) --env-file $(DC_ENV_FILE) --file $(DC_CONFIG_FILE) logs -f wordpress
#
# Open a shell against the Docker container for the MariaDB instance
#
db-shell: prerequisite start-stack
@echo "Launching the docker shell for the user"
@APACHE_RUN_USER=$(APACHE_RUN_USER) APACHE_RUN_GROUP=$(APACHE_RUN_GROUP) \
DB_IMAGE=$(DB_IMAGE) DB_VERSION=$(DB_VERSION) WP_VERSION=$(WP_VERSION) VOLUME_CONTAINER=$(VOLUME_CONTAINER) \
docker compose --project-name $(PROJECT) --env-file $(DC_ENV_FILE) --file $(DC_CONFIG_FILE) exec database /bin/bash
#
# Saves the MySQL Database content to the designated (local) path.
# NOTE: You will need to commit/update the .sql file
#
db-backup: prerequisite
@APACHE_RUN_USER=$(APACHE_RUN_USER) APACHE_RUN_GROUP=$(APACHE_RUN_GROUP) COMPOSE_INTERACTIVE_NO_CLI=1 \
DB_IMAGE=$(DB_IMAGE) DB_VERSION=$(DB_VERSION) WP_VERSION=$(WP_VERSION) VOLUME_CONTAINER=$(VOLUME_CONTAINER) \
docker compose --project-name $(PROJECT) --env-file $(DC_ENV_FILE) --file $(DC_CONFIG_FILE) exec database \
/usr/bin/mysqldump -u$(MYSQL_USER) -p'$(MYSQL_PASSWORD)' -h$(WORDPRESS_DB_HOST) $(MYSQL_DATABASE) > $(SQL_BACKUP_FILE)/$(E20R_PLUGIN_NAME).sql
#
# Using the local environment to execute the PHPStan tests (code analysis)
#
phpstan-tests: composer-dev wp-deps
@echo "Loading the PHP-Stan tests for $(PROJECT)"
@$(PHP_BIN) ./$(COMPOSER_DIR)/bin/phpstan analyze \
--ansi \
--debug \
-v \
--configuration=./phpstan.dist.neon \
--no-interaction \
--memory-limit=-1
#
# Using the local environment to execute the PHP Code Standards tests (using WPCS-Extra ruleset)
#
code-standard-tests: wp-deps
@echo "Running WP Code Standards testing for $(PROJECT)"
@$(PHP_BIN) $(COMPOSER_DIR)/bin/phpcs \
--runtime-set ignore_warnings_on_exit true \
--report=full \
--colors \
-p \
-s \
--standard=phpcs.xml \
--ignore='$(PHP_IGNORE_PATHS)' \
--extensions=php \
$(PHP_CODE_PATHS)
#
# Using codeception to execute standard Unit Tests for this plugin
#
unit-tests: wp-deps
@echo "Testing if we need to run unit tests"
@if [[ -n "$(FOUND_UNIT_TESTS)" ]]; then \
echo "Running all unit tests for $(PROJECT)"; \
$(PHP_BIN) $(COMPOSER_DIR)/bin/codecept run unit --steps --verbose --debug $(COVERAGE_SETTINGS) -- $(UNIT_TEST_CASE_PATH); \
fi
unit: wp-deps
@if [[ -n "$(FOUND_UNIT_TESTS)" && -n "$(TEST_TO_RUN)" ]]; then \
echo "Running Unit tests for $(PROJECT)/$(TEST_TO_RUN)"; \
$(PHP_BIN) $(COMPOSER_DIR)/bin/codecept run unit --steps --verbose --debug $(COVERAGE_SETTINGS) -- $(UNIT_TEST_CASE_PATH)/$(TEST_TO_RUN); \
else \
echo "Error: Either FOUND_UNIT_TESTS is empty or TEST_TO_RUN is empty. Exiting!" ; \
exit 1 ; \
fi
coverage: wp-deps
@if [[ -n "$(FOUND_UNIT_TESTS)" ]]; then \
echo "Running Unit tests for $(PROJECT)"; \
$(PHP_BIN) $(COMPOSER_DIR)/bin/codecept run unit --steps --verbose --debug $(COVERAGE_SETTINGS) -- $(UNIT_TEST_CASE_PATH); \
fi
#
# Using codeception to execute the WP Unit Tests (aka WP integration tests) for this plugin
#
integration-tests: integration-start
@echo "Testing if we need to run integration tests"
@if [[ -n "$(FOUND_INTEGRATION_TESTS)" ]]; then \
echo "Running all integration tests for $(PROJECT)"; \
pwd ; \
ls -lart /var/www/html/wp-content/plugins/e20r-members-list/ ; \
echo "Show permissions for _* directories"; \
ls -lart /var/www/html/wp-content/plugins/e20r-members-list/tests/_* ; \
APACHE_RUN_USER=$(APACHE_RUN_USER) APACHE_RUN_GROUP=$(APACHE_RUN_GROUP) COMPOSE_INTERACTIVE_NO_CLI=1 \
DB_IMAGE=$(DB_IMAGE) DB_VERSION=$(DB_VERSION) WP_VERSION=$(WP_VERSION) VOLUME_CONTAINER=$(VOLUME_CONTAINER) \
docker compose --project-name $(PROJECT) --env-file $(DC_ENV_FILE) --file $(DC_CONFIG_FILE) \
exec -T -w /var/www/html/wp-content/plugins/$(PROJECT)/ wordpress \
$(COMPOSER_DIR)/bin/codecept run integration --verbose --debug --steps $(COVERAGE_SETTINGS) -- $(INTEGRATION_TEST_CASE_PATH) && \
echo "Completed running all integration tests" ; \
fi
integration-start: docker-deps start-stack db-import
integration:
@if [[ -n "$(FOUND_INTEGRATION_TESTS)" ]]; then \
echo "Running specific Integration test(s) for $(PROJECT)/$(TEST_TO_RUN)"; \
APACHE_RUN_USER=$(APACHE_RUN_USER) APACHE_RUN_GROUP=$(APACHE_RUN_GROUP) COMPOSE_INTERACTIVE_NO_CLI=1 \
DB_IMAGE=$(DB_IMAGE) DB_VERSION=$(DB_VERSION) WP_VERSION=$(WP_VERSION) VOLUME_CONTAINER=$(VOLUME_CONTAINER) \
docker compose --project-name $(PROJECT) --env-file $(DC_ENV_FILE) --file $(DC_CONFIG_FILE) \
exec -T -w /var/www/html/wp-content/plugins/$(PROJECT)/ wordpress \
$(COMPOSER_DIR)/bin/codecept run integration --verbose --debug --steps $(COVERAGE_SETTINGS) -- $(INTEGRATION_TEST_CASE_PATH)$(TEST_TO_RUN); \
fi
#
# Using codeception to execute the WP Unit Tests (aka WP integration tests) for this plugin
#
functional-tests: docker-deps start-stack db-import
@echo "Testing if we need to run functional tests"
@if [[ -n "$(FOUND_FUNCTIONAL_TESTS)" ]]; then \
echo "Running all functional tests for $(PROJECT)"; \
APACHE_RUN_USER=$(APACHE_RUN_USER) APACHE_RUN_GROUP=$(APACHE_RUN_GROUP) COMPOSE_INTERACTIVE_NO_CLI=1 \
DB_IMAGE=$(DB_IMAGE) DB_VERSION=$(DB_VERSION) WP_VERSION=$(WP_VERSION) VOLUME_CONTAINER=$(VOLUME_CONTAINER) \
docker compose --project-name $(PROJECT) --env-file $(DC_ENV_FILE) --file $(DC_CONFIG_FILE) \
exec -T -w /var/www/html/wp-content/plugins/$(PROJECT)/ wordpress \
$(COMPOSER_DIR)/bin/codecept run functional --verbose --debug --steps $(COVERAGE_SETTINGS) -- $(FUNCTIONAL_TEST_CASE_PATH); \
fi
# TODO: Add coverage support to the functional-test target
#
# Using codeception to execute the Plugin Acceptance tests
#
acceptance-tests: docker-deps start-stack db-import
@echo "Testing if we need to run acceptance tests"
@if [[ -n "$(FOUND_WP_ACCEPTANCE_TESTS)" ]]; then \
echo "Running all acceptance tests for $(PROJECT)"; \
APACHE_RUN_USER=$(APACHE_RUN_USER) APACHE_RUN_GROUP=$(APACHE_RUN_GROUP) COMPOSE_INTERACTIVE_NO_CLI=1 \
DB_IMAGE=$(DB_IMAGE) DB_VERSION=$(DB_VERSION) WP_VERSION=$(WP_VERSION) VOLUME_CONTAINER=$(VOLUME_CONTAINER) \
docker compose --project-name $(PROJECT) --env-file $(DC_ENV_FILE) --file $(DC_CONFIG_FILE) \
exec -T -w /var/www/html/wp-content/plugins/${PROJECT}/ wordpress \
$(COMPOSER_DIR)/bin/codecept run acceptance --debug --verbose --steps $(COVERAGE_SETTINGS) $(ACCEPTANCE_TEST_CASE_PATH); \
fi
#
# Using codeception to build the plugin
#
build-test: docker-deps start-stack db-import
@APACHE_RUN_USER=$(APACHE_RUN_USER) APACHE_RUN_GROUP=$(APACHE_RUN_GROUP) COMPOSE_INTERACTIVE_NO_CLI=1 \
DB_IMAGE=$(DB_IMAGE) DB_VERSION=$(DB_VERSION) WP_VERSION=$(WP_VERSION) VOLUME_CONTAINER=$(VOLUME_CONTAINER) \
docker compose --project-name $(PROJECT) --env-file $(DC_ENV_FILE) --file $(DC_CONFIG_FILE) \
exec -T -w /var/www/html/wp-content/plugins/${PROJECT}/ \
wordpress $(PWD)/$(COMPOSER_DIR)/bin/codecept build -v
#
# Using codeception to execute all defined tests for the plugin
#
tests: prerequisite clean wp-deps code-standard-tests phpstan-tests unit-tests db-import integration-tests functional-tests acceptance-tests stop-stack
#
# Generate a GIT commit log in build_readmes/current.txt
#
git-log: prerequisite
@E20R_MAIN_BRANCH_NAME=$(E20R_MAIN_BRANCH_NAME) ./bin/create_log.sh
#
# Generate (and update) the custom WP Plugin Updater metadata.json file
#
metadata: prerequisite
@./bin/metadata.sh "$(E20R_PLUGIN_BASE_FILE)" "$(E20R_DEPLOYMENT_SERVER)"
#
# Generate the CHANGELOG.md file for the plugin based on the git commit log
#
changelog: prerequisite build_readmes/current.txt
@./bin/changelog.sh "$(E20R_PLUGIN_BASE_FILE)" "$(E20R_DEPLOYMENT_SERVER)"
#
# Generate and update the README.txt plus README.md files for the plugin
#
readme: prerequisite
@./bin/readme.sh "$(E20R_PLUGIN_BASE_FILE)" "$(E20R_DEPLOYMENT_SERVER)"
#
# Build the plugin .zip archive (and upload to the eighty20results.com server if applicable
# Saves the built plugin .zip archive to build/kits
#
$(E20R_PLUGIN_BASE_FILE): prerequisite stop-stack clean-inc composer-prod
@export E20R_PLUGIN_VERSION="$$(./bin/get_plugin_version.sh $(E20R_PLUGIN_BASE_FILE))" ; \
if [[ ! -f "build/kits/$(E20R_PLUGIN_NAME)-$${E20R_PLUGIN_VERSION}.zip" ]]; then \
if [[ -z "$${USE_LOCAL_BUILD}" ]]; then \
echo "Deploying kit to $(E20R_DEPLOYMENT_SERVER)" && \
E20R_PLUGIN_NAME="$(E20R_PLUGIN_NAME)" ./bin/build-plugin.sh "$(E20R_PLUGIN_BASE_FILE)" "$(E20R_DEPLOYMENT_SERVER)"; \
else \
rm -rf $(COMPOSER_DIR)/wp_plugins && \
mkdir -p build/kits/ && \
E20R_PLUGIN_VERSION="$$(./bin/get_plugin_version.sh $(E20R_PLUGIN_BASE_FILE))" \
git archive --prefix=$(E20R_PLUGIN_NAME)/ --format=zip --output="build/kits/$(E20R_PLUGIN_NAME)-$${E20R_PLUGIN_VERSION}.zip" --worktree-attributes "$(E20R_MAIN_BRANCH_NAME)" ; \
fi ; \
fi
#
# Build the plugin .zip archive (and upload to the eighty20results.com server if applicable
# Saves the built plugin .zip archive to build/kits
#
build: prerequisite stop-stack clean-inc composer-prod $(E20R_PLUGIN_BASE_FILE)
@export E20R_PLUGIN_VERSION="$$(./bin/get_plugin_version.sh $(E20R_PLUGIN_BASE_FILE))" ; \
if [[ ! -f "build/kits/$(E20R_PLUGIN_NAME)-$${E20R_PLUGIN_VERSION}.zip" ]]; then \
echo "Package for $(E20R_PLUGIN_NAME) not found!" ; \
exit 1 ; \
else \
echo "$(E20R_PLUGIN_NAME)-$${E20R_PLUGIN_VERSION}.zip is complete" ; \
fi && \
rm -rf "build/$(E20R_PLUGIN_NAME)" || die "Error: Cannot remove build/kits/$(E20R_PLUGIN_NAME)"
deploy: prerequisite build
@echo "Deploy $(E20R_PLUGIN_NAME) to $(E20R_DEPLOYMENT_SERVER)"
@export E20R_PLUGIN_VERSION="$$(./bin/get_plugin_version.sh $(E20R_PLUGIN_BASE_FILE))" ; \
if [[ ! -f "build/kits/$(E20R_PLUGIN_NAME)-$${E20R_PLUGIN_VERSION}.zip" ]]; then \
echo "Error: ${PWD}/build/kits/$(E20R_PLUGIN_NAME)-$${E20R_PLUGIN_VERSION}.zip not found!" ; \
ls -l "${PWD}/build/kits/" ; \
exit 1; \
fi ; \
echo "Preparing to deploy the $${E20R_PLUGIN_NAME}-$${E20R_PLUGIN_VERSION}.zip plugin archive to the $(E20R_DEPLOYMENT_SERVER) Server" && \
E20R_MAIN_BRANCH_NAME="$(E20R_MAIN_BRANCH_NAME)" ./bin/deploy.sh "$(E20R_PLUGIN_BASE_FILE)" "$(E20R_DEPLOYMENT_SERVER)"
#new-release: test composer-prod
# @./build_env/get_plugin_version.sh && \
# git tag $${VERSION} && \
# ./build_env/create_release.sh
#
# Generate the README.*, CHANGELOG.md and metadata.json files for the plugin (all current docs)
#
docs: prerequisite changelog readme metadata
@if ! git commit -m "Updated the changelog source file" build_readmes/current.txt; then \
echo "No need to commit build_readmes/current.txt (no changes recorded)" ; \
exit 0 ; \
fi