.github/workflows/ci.yaml

@@ -21,9 +21,6 @@ jobs:
       - name: Debug bring up test stack
         if: failure()
         run: docker compose logs
-      - name: Take down test stack
-        if: always()
-        run: make stop
   build-and-push:
     needs: [tests]
     runs-on: ubuntu-latest

Dockerfile

@@ -54,5 +54,8 @@ ENV APACHE_DOCUMENT_ROOT=/app/web
 RUN sed -ri -e 's!/var/www/html!${APACHE_DOCUMENT_ROOT}!g' /etc/apache2/sites-available/*.conf
 RUN sed -ri -e 's!/var/www/!${APACHE_DOCUMENT_ROOT}!g' /etc/apache2/apache2.conf /etc/apache2/conf-available/*.conf
 RUN sed -ri -e 's!</VirtualHost>!\tFallbackResource app_prod.php\n</VirtualHost>!g' /etc/apache2/sites-available//000-default.conf
-RUN mkdir /app/var
+
+# Create /app/var only if it doesn't exist as a file or directory
+RUN sh -c '[ ! -e /app/var ] && mkdir /app/var || echo "/app/var already exists"'
+
 RUN chown -R www-data:www-data /app/var

Makefile

@@ -1,51 +1,67 @@
 .PHONY: dev
 dev: bring-up-app-and-queue-watcher
-	docker compose logs --follow
+	docker compose --file docker-compose.yaml --file docker-compose.dev.yaml logs --follow
+
+.PHONY: prod
+prod: bring-up-app-and-queue-watcher
+	docker compose --file docker-compose.yaml --file docker-compose.dev.yaml logs --follow
 
 .PHONY: bring-up-app-and-queue-watcher
-bring-up-app-and-queue-watcher: config.php
-	docker compose up --wait
+bring-up-app-and-queue-watcher: config.php build
+	docker compose --file docker-compose.yaml --file docker-compose.dev.yaml up --wait
 
 .PHONY: bring-up-app-without-queue-watcher
-bring-up-app-without-queue-watcher: config.php
-	docker compose up app --wait
-	docker compose down queue-watcher
+bring-up-app-without-queue-watcher: config.php build
+	docker compose --file docker-compose.yaml --file docker-compose.dev.yaml up app --wait
+	docker compose --file docker-compose.yaml --file docker-compose.dev.yaml down queue-watcher
+
+.PHONY: build
+build:
+	docker compose --file docker-compose.yaml --file docker-compose.dev.yaml build
 
 .PHONY: check
 check: static-analysis test
 
 .PHONY: static-analysis
-static-analysis:
-	docker compose run --rm --no-deps app vendor/bin/phpcs --standard=phpcs.xml.dist --warning-severity=0 -p src/ tests/ web/
-	docker compose run --rm --no-deps app vendor/bin/composer-dependency-analyser
-	docker compose run --rm --no-deps app vendor/bin/phpstan analyse
+static-analysis: config.php build
+	docker compose --file docker-compose.yaml --file docker-compose.dev.yaml run --rm --no-deps app vendor/bin/phpcs --standard=phpcs.xml.dist --warning-severity=0 -p src/ tests/ web/
+	docker compose --file docker-compose.yaml --file docker-compose.dev.yaml run --rm --no-deps app vendor/bin/composer-dependency-analyser
+	docker compose --file docker-compose.yaml --file docker-compose.dev.yaml run --rm --no-deps app vendor/bin/phpstan analyse
 
 .PHONY: test
-test: bring-up-app-and-queue-watcher
-	docker compose exec app vendor/bin/phpunit $(TEST)
+test: config.php bring-up-app-and-queue-watcher
+	docker compose --file docker-compose.yaml --file docker-compose.dev.yaml exec app vendor/bin/phpunit $(TEST)
+
+.PHONY: clean
+clean:
+	docker compose --file docker-compose.yaml --file docker-compose.dev.yaml down --volumes
+	rm -rf var/logs/*.json
 
 .PHONY: all-checks
-all-checks: bring-up-app-without-queue-watcher
-	docker compose exec app bash project_tests.sh
+all-checks: config.php clean bring-up-app-without-queue-watcher
+	docker compose --file docker-compose.yaml --file docker-compose.dev.yaml exec app bash project_tests.sh
 
 .PHONY: stop
 stop:
-	docker compose down
-
-.PHONY: clean
-clean:
-	docker compose down --volumes
-	rm -rf var/logs/*.json
+	docker compose --file docker-compose.yaml --file docker-compose.dev.yaml down
 
 ENTITY = all
-.PHONY: import-all
-import-all:
-	docker compose exec app bin/console queue:import $(ENTITY)
+.PHONY: import-entity
+import-entity: config.php bring-up-app-and-queue-watcher
+	docker compose --file docker-compose.yaml --file docker-compose.dev.yaml exec app bin/console queue:import $(ENTITY)
+
+.PHONY: import-all-entities-in-journal-test-environment
+import-all-entities-in-journal-test-environment:
+	kubectl -n journal--test create job --from=cronjob/search-queue-import-all import-all-$(shell date "+%Y%m%d-%H%M")
 
 .PHONY: update-api-sdk
-update-api-sdk: config.php
-	docker compose run --no-deps setup composer install
-	docker compose run --no-deps setup composer update 'elife/api' 'elife/api-sdk' --no-suggest --no-interaction
+update-api-sdk: config.php build
+	docker compose --file docker-compose.yaml --file docker-compose.dev.yaml run --no-deps setup composer install
+	docker compose --file docker-compose.yaml --file docker-compose.dev.yaml run --no-deps setup composer update 'elife/api' 'elife/api-sdk' --no-suggest --no-interaction
+
+.PHONY: clean-index-for-search-test
+clean-index-for-search-test:
+	kubectl -n journal--test exec -it $$(kubectl get pods -n journal--test -o json | jq -r '.items[] | select(.metadata.name | startswith("search-queue-watcher-")) | .metadata.name' | head -n1) -- ./bin/console search:setup -d
 
 config.php:
 	cp config.php.dist config.php

README.md

@@ -59,25 +59,3 @@ docker compose down queue-watcher
 docker compose exec app bash project_tests.sh
 ```
 NOTE: these integration tests require the queue watcher  to not be running so the tests can control when items are consumed. This is why we make sure to stop watcher services.
-
-### Local web app, external opensearch
-
-Port-forward the `journal--test` instance of opensearch:
-
-```shell
-kubectl port-forward service/opensearch --address 0.0.0.0 -n journal--test 9200:9200
-```
-
-Modify `$config['elastic_servers']` to point to `journal--test` opensearch in `/config.php`
-
-```shell
-'elastic_servers' => ['https://admin:admin@host.docker.internal:9200'],
-```
-
-Run the app only:
-
-```shell
-docker compose -f docker-compose.app.yaml up --wait
-```
-
-Visit: http://localhost:8888/search

composer.json

@@ -14,7 +14,7 @@
     },
     "require": {
         "php": "8.3.*",
-        "aws/aws-sdk-php": "3.339.1",
+        "aws/aws-sdk-php": "3.339.2",
         "beberlei/assert": "^3.3",
         "doctrine/annotations": "^1.4",
         "elasticsearch/elasticsearch": "^7.11",

docker-compose.dev.yaml

@@ -0,0 +1,7 @@
+services:
+  app:
+    build:
+      target: dev
+    environment:
+      - GATEWAY_HOST=api-dummy:8080
+

docker-compose.yaml

@@ -70,9 +70,6 @@ services:
     build:
       context: .
       dockerfile: Dockerfile
-      target: dev
-    environment:
-      - GATEWAY_HOST=api-dummy:8080
     volumes:
       - ./:/app
       - ./config.php:/app/config.php