Merge branches 'master' and 'controller-namespace-issue-for-modules-in-urlprefixes' of github.com:php-openapi/yii2-openapi into controller-namespace-issue-for-modules-in-urlprefixes

Author: SOHELAHMED7

.github/workflows/test.yml

@@ -22,7 +22,6 @@ jobs:
       matrix:
         php-versions: ['7.4', '8.0', '8.1', '8.2', '8.3']
 
-    # TODO use cache
     steps:
       - uses: actions/checkout@v3
 
@@ -32,18 +31,30 @@ jobs:
       # Run every tests inside Docker container
       - name: Docker Compose Setup
         uses: ndeloof/install-compose-action@v0.0.1
-        with:
-          # version: v3.5 # defaults to 'latest'
-          legacy: true    # will also install in PATH as `docker-compose`
 
       - name: Clean
         run: make clean_all
 
-      - name: docker-compose up
+      - name: docker compose up
         run: make up
 
+      # https://github.com/shivammathur/setup-php?tab=readme-ov-file#cache-composer-dependencies
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "dir=./tests/tmp/.composer/cache/files" >> $GITHUB_OUTPUT
+
+      - name: Make tests dir writable for restoring cache in next step
+        run: make tests_dir_write_permission
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('composer.json') }}
+          restore-keys: ${{ runner.os }}-composer-
+
       - name: Install Docker and composer dependencies
-        run: docker-compose exec php php -v && make installdocker
+        run: docker compose exec php php -v && make installdocker
 
       - name: Migrate
         run: make UID=0 migrate

CONTRIBUTING.md

@@ -10,7 +10,7 @@ cd yii2-openapi
 make clean_all
 make up
 make installdocker
-sudo chmod -R 777 tests/tmp/ # https://github.com/cebe/yii2-openapi/issues/156
+sudo chmod -R 777 tests/tmp/ # TODO avoid 777 https://github.com/cebe/yii2-openapi/issues/156
 make migrate
 
 # to check everything is setup up correctly ensure all tests passes
@@ -84,7 +84,7 @@ Creating yii2-openapi_maria_1    ... done
 Creating yii2-openapi_mysql_1    ... done
 Creating yii2-openapi_postgres_1 ... done
 Creating yii2-openapi_php_1      ... done
-docker-compose exec php bash
+docker compose exec php bash
 
 root@f9928598f841:/app# php -v
 
@@ -95,6 +95,14 @@ with Zend OPcache v7.4.27, Copyright (c), by Zend Technologies
 with Xdebug v2.9.6, Copyright (c) 2002-2020, by Derick Rethans
 ```
 
+If a PHP version is changed as mentioned above, then following operations must be performed:
+
+```
+rm -rf vendor
+rm -rf composer.lock
+composer install
+```
+
 Issues and solutions
 --------------------
 

Makefile

@@ -10,7 +10,7 @@ check-style:
 	vendor/bin/php-cs-fixer fix --diff --dry-run
 
 check-style-from-host:
-	docker-compose run --rm php sh -c 'vendor/bin/php-cs-fixer fix --diff --dry-run'
+	docker compose run --rm php sh -c 'vendor/bin/php-cs-fixer fix --diff --dry-run'
 
 fix-style:
 	vendor/bin/indent --tabs composer.json
@@ -24,41 +24,46 @@ test:
 	php $(PHPARGS) vendor/bin/phpunit
 
 clean_all:
-	docker-compose down
+	docker compose down --remove-orphans
 	sudo rm -rf tests/tmp/*
 
 clean:
 	sudo rm -rf tests/tmp/app/*
 	sudo rm -rf tests/tmp/docker_app/*
 
 down:
-	docker-compose down --remove-orphans
+	docker compose down --remove-orphans
 
 up:
-	docker-compose up -d
+	docker compose up -d
 	echo "Waiting for mariadb to start up..."
-	docker-compose exec -T mysql timeout 60s sh -c "while ! (mysql -udbuser -pdbpass -h maria --execute 'SELECT 1;' > /dev/null 2>&1); do echo -n '.'; sleep 0.1 ; done; echo 'ok'" || (docker-compose ps; docker-compose logs; exit 1)
+	docker compose exec -T mysql timeout 60s sh -c "while ! (mysql -udbuser -pdbpass -h maria --execute 'SELECT 1;' > /dev/null 2>&1); do echo -n '.'; sleep 0.1 ; done; echo 'ok'" || (docker compose ps; docker compose logs; exit 1)
 
-	# Solution to problem https://stackoverflow.com/questions/50026939/php-mysqli-connect-authentication-method-unknown-to-the-client-caching-sha2-pa
-	# if updated to PHP 7.4 or more, this command is not needed (TODO)
-	docker-compose exec -T mysql timeout 60s sh -c "while ! (mysql --execute \"ALTER USER 'dbuser'@'%' IDENTIFIED WITH mysql_native_password BY 'dbpass';\" > /dev/null 2>&1); do echo -n '.'; sleep 0.1 ; done; echo 'ok'" || (docker-compose ps; docker-compose logs; exit 1)
+	echo "Waiting for Mysql to start up..."
+	docker compose exec -T mysql timeout 60s sh -c "while ! (mysql -udbuser -pdbpass -h mysql --execute 'SELECT 1;' > /dev/null 2>&1); do echo -n '.'; sleep 0.1 ; done; echo 'ok'" || (docker compose ps; docker compose logs; exit 1)
 
 cli:
-	docker-compose exec --user=$(UID) php bash
+	docker compose exec --user=$(UID) php bash
+
+cli_root:
+	docker compose exec --user="root" php bash
 
 cli_mysql:
-	docker-compose exec --user=$(UID) mysql bash
+	docker compose exec --user=$(UID) mysql bash
 
 migrate:
-	docker-compose run --user=$(UID) --rm php sh -c 'mkdir -p "tests/tmp/app"'
-	docker-compose run --user=$(UID) --rm php sh -c 'mkdir -p "tests/tmp/docker_app"'
-	docker-compose run --user=$(UID) --rm php sh -c 'cd /app/tests && ./yii migrate  --interactive=0'
+	docker compose run --user=$(UID) --rm php sh -c 'mkdir -p "tests/tmp/app"'
+	docker compose run --user=$(UID) --rm php sh -c 'mkdir -p "tests/tmp/docker_app"'
+	docker compose run --user=$(UID) --rm php sh -c 'cd /app/tests && ./yii migrate  --interactive=0'
 
 installdocker:
-	docker-compose run --user=$(UID) --rm php composer install && chmod +x tests/yii
+	docker compose run --user=$(UID) --rm php composer install && chmod +x tests/yii
+
+tests_dir_write_permission:
+	docker compose run --user="root" --rm php chmod -R 777 tests/tmp/ # TODO avoid 777 https://github.com/cebe/yii2-openapi/issues/156
 
 testdocker:
-	docker-compose run --user=$(UID) --rm php sh -c 'vendor/bin/phpunit --repeat 3'
+	docker compose run --user=$(UID) --rm php sh -c 'vendor/bin/phpunit --repeat 3'
 
 efs: clean_all up migrate # Everything From Scratch