Merge pull request #112 from SOHELAHMED7/100-timestamp-migrations-do-not-work-in-mariadb

undefined

Author: cebe

.github/workflows/test.yml

@@ -21,38 +21,32 @@ jobs:
       fail-fast: true
       matrix:
         php-versions: ['7.1', '7.2', '7.3', '7.4']
+
+    # TODO use cache
     steps:
       - uses: actions/checkout@v2
 
-      - name: Setup PHP, with composer and extensions
-        uses: shivammathur/setup-php@v2 #https://github.com/shivammathur/setup-php
+      # Run every tests inside Docker container
+      - name: Docker Compose Setup
+        uses: ndeloof/[email protected]
         with:
-          php-version: ${{ matrix.php-versions }}
-          extensions: mbstring, intl, gd, zip, dom, pgsql
-          tools: php-cs-fixer
-
-      - name: Get composer cache directory
-        id: composercache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+          # version: v3.5 # defaults to 'latest'
+          legacy: true    # will also install in PATH as `docker-compose`
 
-      - name: Cache Composer packages
-        id: composer-cache
-        uses: actions/cache@v2
-        with:
-          path: ${{ steps.composercache.outputs.dir }}
-          key: ${{ runner.os }}-php-${{ matrix.php-versions }}-${{ hashFiles('**/composer.json') }}
-          restore-keys: |
-            ${{ runner.os }}-php-${{ matrix.php-versions }}
+      - name: Clean
+        run: make clean_all
 
-      - name: Install deps
-        run: composer install --prefer-dist --no-progress --no-suggest --optimize-autoloader
+      - name: docker-compose up
+        run: make up
 
-      - name: Prepare permissions
-        run: mkdir -p tests/tmp && chmod -R 0777 tests/tmp
+      - name: Install Docker and composer dependencies
+        run: make installdocker
 
-      - name: Unit tests
-        run: php vendor/bin/phpunit
+      - name: Migrate
+        run: make migrate
 
       - name: Check style
-        run: make check-style
+        run: make check-style-from-host
 
+      - name: Run tests
+        run: make testdocker

Makefile

@@ -7,6 +7,9 @@ all:
 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'
+
 fix-style:
 	vendor/bin/indent --tabs composer.json
 	vendor/bin/indent --spaces .php_cs.dist
@@ -28,20 +31,40 @@ clean:
 
 up:
 	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)
 
 cli:
 	docker-compose exec php bash
 
 migrate:
-	mkdir -p "tests/tmp/app"
-	mkdir -p "tests/tmp/docker_app"
+	docker-compose run --rm php sh -c 'mkdir -p "tests/tmp/app"'
+	docker-compose run --rm php sh -c 'mkdir -p "tests/tmp/docker_app"'
 	docker-compose run --rm php sh -c 'cd /app/tests && ./yii migrate  --interactive=0'
 
 installdocker:
 	docker-compose run --rm php composer install && chmod +x tests/yii
 
 testdocker:
-	docker-compose run --rm php sh -c 'vendor/bin/phpunit tests/unit'
+	docker-compose run --rm php sh -c 'vendor/bin/phpunit'
 
 .PHONY: all check-style fix-style install test clean clean_all up cli installdocker migrate testdocker
 
+
+# Docs:
+
+# outside docker
+#     clean_all
+#     clean (in both)
+#     up
+#     cli
+#     migrate
+#     installdocker
+#     testdocker
+
+# inside docker
+#     check-style
+#     fix-style
+#     install
+#     test
+#     clean (in both)

README.md

@@ -70,6 +70,8 @@ On console you can run the generator with `./yii gii/api --openApiPath=@app/open
 
 Run `./yii gii/api --help` for all options.
 
+See [Petstore example](https://github.com/OAI/OpenAPI-Specification/blob/main/examples/v3.0/petstore.yaml) for example OpenAPI spec.
+
 
 ## OpenAPI extensions
 
@@ -114,9 +116,27 @@ Explicitly specify primary key name for table, if it is different from "id"
 
 ### `x-db-type`
 
-Explicitly specify the database type for a column. (MUST contains only db type! (json, jsonb, uuid, varchar etc))
-If x-db-type sets as false, property will be processed as virtual;
-It will be added in model as public property, but skipped for migrations generation
+Explicitly specify the database type for a column. (MUST contains only real DB type! (`json`, `jsonb`, `uuid`, `varchar` etc.)).
+If x-db-type sets as `false`, property will be processed as virtual;
+It will be added in model as public property, but skipped for migrations generation.
+
+Example values of `x-db-type` are:
+
+ - `false` (boolean false)
+ - as string and its value can be like:
+     - text
+     - text[]
+     - INTEGER PRIMARY KEY AUTO_INCREMENT
+     - decimal(12,4)
+     - json
+     - varchar
+     - VARCHAR
+     - SMALLINT UNSIGNED ZEROFILL
+     - MEDIUMINT(10) UNSIGNED ZEROFILL COMMENT "comment" (note the double quotes here)
+
+Such values are not allowed:
+   - `int null default null after low_price` (null and default will be handled by `nullable` and `default` keys respectively)
+   - MEDIUMINT(10) UNSIGNED ZEROFILL NULL DEFAULT '7' COMMENT 'comment' AFTER `seti`, ADD INDEX `t` (`w`)
 
 ### `x-indexes`
 Specify table indexes
@@ -248,6 +268,97 @@ $this->update('{{%company}}', ['name' => 'No name']);
 $this->alterColumn('{{%company}}', 'name', $this->string(128)->notNull());
 ```
 
+### Handling of `NOT NULL` constraints
+
+`NOT NULL` in DB migrations is determined by `nullable` and `required` properties of the OpenAPI schema.
+e.g. attribute = 'my_property'.
+
+- If you define attribute neither "required" nor via "nullable", then it is by default `NULL`:
+
+```yaml
+  ExampleSchema:
+    properties:
+      my_property:
+        type: string
+```
+
+- If you define attribute in "required", then it is `NOT NULL`
+
+```yaml
+  ExampleSchema:
+    required:
+     - my_property
+    properties:
+      my_property:
+        type: string
+```
+
+- If you define attribute via "nullable", then it overrides "required", e.g. allow `NULL` in this case:
+
+```yaml
+  ExampleSchema:
+    required:
+      - my_property
+    properties:
+      my_property:
+        type: string
+        nullable: true
+```
+
+- If you define attribute via "nullable", then it overrides "required", e.g. `NOT NULL` in this case:
+
+```yaml
+  test_table:
+    required:
+    properties:
+      my_property:
+        type: string
+        nullable: false
+```
+
+### Handling of `enum` (#enum, #MariaDb)
+It work on MariaDb.
+
+ ```yaml
+  test_table:
+    properties:
+      my_property:
+        enum:
+          - one
+          - two
+          - three
+```
+
+### Handling of `numeric` (#numeric, #MariaDb)
+precision-default = 10
+scale-default = 2
+
+- You can define attribute like "numeric(precision,scale)":
+ ```yaml
+  test_table:
+    properties:
+      my_property:
+        x-db-type: decimal(12,4)
+```
+DB-Result = decimal(12,4)
+
+- You can define attribute like "numeric(precision)" with default scale-default = 2:
+ ```yaml
+  test_table:
+    properties:
+      my_property:
+        x-db-type: decimal(12)
+```
+DB-Result = decimal(12,2)
+
+- You can define attribute like "numeric" with precision-default = 10 and scale-default = 2:
+ ```yaml
+  test_table:
+    properties:
+      my_property:
+        x-db-type: decimal
+```
+DB-Result = decimal(10,2)
 
 ## Screenshots
 
@@ -259,6 +370,32 @@ Generated files:
 
 ![Gii Generated Files](doc/screenshot-files.png)
 
+# Development
+
+There commands are available to develop and check the tests. It can be used inside the Docker container. To enter into bash of container run `make cli` .
+
+```bash
+./yii migrate-mysql/up
+./yii migrate-mysql/down 4
+
+./yii migrate-maria/up
+./yii migrate-maria/down 4
+
+./yii migrate-pgsql/up
+./yii migrate-pgsql/down 4
+```
+
+To apply multiple migration with one command:
+
+```bash
+./yii migrate-mysql/up --interactive=0 && \
+./yii migrate-mysql/down --interactive=0 4 && \
+./yii migrate-maria/up --interactive=0 && \
+./yii migrate-maria/down --interactive=0 4 && \
+./yii migrate-pgsql/up --interactive=0 && \
+./yii migrate-pgsql/down --interactive=0 4
+```
+
 # Support
 
 **Need help with your API project?**
@@ -268,3 +405,4 @@ Professional support, consulting as well as software development services are av
 https://www.cebe.cc/en/contact
 
 Development of this library is sponsored by [cebe.:cloud: "Your Professional Deployment Platform"](https://cebe.cloud).
+

composer.json

@@ -24,7 +24,8 @@
 		"yiisoft/yii2-gii": "~2.0.0 | ~2.1.0 | ~2.2.0| ~2.3.0",
 		"laminas/laminas-code": "^3.4",
 		"insolita/yii2-fractal": "^1.0.0",
-		"fakerphp/faker": "^1.9"
+		"fakerphp/faker": "^1.9",
+		"sam-it/yii2-mariadb": "^2.0"
 	},
 	"require-dev": {
 		"cebe/indent": "*",

docker-compose.yml

@@ -33,19 +33,21 @@ services:
             MYSQL_USER: dbuser
             MYSQL_PASSWORD: dbpass
             MYSQL_DATABASE: testdb
+
     maria:
-        image: mariadb
+        image: mariadb:10.8
         ports:
             - '23306:3306'
         volumes:
             - ./tests/tmp/maria:/var/lib/mysql:rw
         environment:
-            TZ: UTC
-            MYSQL_ALLOW_EMPTY_PASSWORD: 1
-            MYSQL_USER: dbuser
-            MYSQL_PASSWORD: dbpass
-            MYSQL_DATABASE: testdb
-            MYSQL_INITDB_SKIP_TZINFO: 1
+            # TZ: UTC
+            # MARIADB_ALLOW_EMPTY_PASSWORD: 1
+            MARIADB_ROOT_PASSWORD: verysecret
+            MARIADB_USER: dbuser
+            MARIADB_PASSWORD: dbpass
+            MARIADB_DATABASE: testdb
+            # MYSQL_INITDB_SKIP_TZINFO: 1
     postgres:
         image: postgres:12
         ports:

src/db/ColumnSchema.php

@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * @copyright Copyright (c) 2018 Carsten Brandt <[email protected]> and contributors
+ * @license https://github.com/cebe/yii2-openapi/blob/master/LICENSE
+ */
+
+namespace cebe\yii2openapi\db;
+
+class ColumnSchema extends \yii\db\ColumnSchema
+{
+    /**
+     * @var string|null|false
+     * Custom DB type which contains real DB type
+     * Contains x-db-type string if present in OpenAPI YAML/json file
+     * @see \cebe\yii2openapi\lib\items\Attribute::$xDbType and `x-db-type` docs in README.md
+     * Used to detect what kind of migration code for column is to be generated
+     * e.g. `double_p double precision NULL DEFAULT NULL`
+     * instead of
+     * ```php
+     *   $this->createTable('{{%alldbdatatypes}}', [
+     *       ...
+     *       'double_p' => 'double precision NULL DEFAULT NULL',
+     *       ...
+     * ```
+     */
+    public $xDbType;
+}

src/generator/ApiGenerator.php

@@ -7,6 +7,9 @@
 
 namespace cebe\yii2openapi\generator;
 
+use yii\db\mysql\Schema as MySqlSchema;
+use SamIT\Yii2\MariaDb\Schema as MariaDbSchema;
+use yii\db\pgsql\Schema as PgSqlSchema;
 use cebe\openapi\Reader;
 use cebe\openapi\spec\OpenApi;
 use cebe\yii2openapi\lib\Config;
@@ -502,4 +505,19 @@ protected function getOpenApiWithoutReferences():OpenApi
         }
         return $this->_openApiWithoutRef;
     }
+
+    public static function isPostgres():bool
+    {
+        return Yii::$app->db->schema instanceof PgSqlSchema;
+    }
+
+    public static function isMysql():bool
+    {
+        return (Yii::$app->db->schema instanceof MySqlSchema && !static::isMariaDb());
+    }
+
+    public static function isMariaDb():bool
+    {
+        return strpos(Yii::$app->db->schema->getServerVersion(), 'MariaDB') !== false;
+    }
 }

src/lib/AttributeResolver.php

@@ -203,6 +203,8 @@ protected function resolveProperty(PropertySchema $property, bool $isRequired):v
                   ->setDescription($property->getAttr('description', ''))
                   ->setReadOnly($property->isReadonly())
                   ->setDefault($property->guessDefault())
+                  ->setXDbType($property->getAttr('x-db-type'))
+                  ->setNullable($property->getProperty()->getSerializableData()->nullable ?? null)
                   ->setIsPrimary($property->isPrimaryKey());
         if ($property->isReference()) {
             if ($property->isVirtual()) {