Add version for output (#94)

SmetDenis · web-flow · commit 1a31cb4a9c0f · 2024-03-26T20:34:29.000+03:00
Enhanced the software to include a versioning feature that is reflected
in console output during CSV validation as well as in the CliApplication
class itself. The feature fetches the version from a new ".version"
file, unless it's operating in a PHPunit environment, in which case it
outputs a generic 'unknown version' message.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -167,6 +167,9 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.pull_request.head.ref }}
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -197,6 +200,9 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.pull_request.head.ref }}
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -232,6 +238,12 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.pull_request.head.ref }}
+
+      - name: Save the current version
+        run: make build-version --no-print-directory
 
       - name: Login to Docker Hub
         uses: docker/login-action@v3
@@ -242,6 +254,7 @@ jobs:
       - name: 🐳 Building Docker Image
         uses: docker/build-push-action@v5
         with:
+          context: .
           push: false
           tags: jbzoo/csv-blueprint:local
 
@@ -262,6 +275,9 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.pull_request.head.ref }}
 
       - name: 👍 Valid CSV files
         uses: ./
diff --git a/.github/workflows/release-docker.yml b/.github/workflows/release-docker.yml
@@ -23,6 +23,12 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.ref_name }}
+
+      - name: Save the current version
+        run: make build-version --no-print-directory
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
diff --git a/.github/workflows/release-phar.yml b/.github/workflows/release-phar.yml
@@ -23,11 +23,14 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.ref_name }}
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.1
+          php-version: 8.3
           tools: composer
 
       - name: Build project in production mode
diff --git a/.gitignore b/.gitignore
@@ -18,3 +18,4 @@ phpunit.xml
 /docker/preload.php
 *.cache
 *.phar
+.version
diff --git a/Dockerfile b/Dockerfile
@@ -16,16 +16,22 @@ FROM php:8.3-cli-alpine
 ADD --chmod=0755 https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions /usr/local/bin/
 RUN install-php-extensions opcache @composer
 
+
 # Install application
+# run `make build-version` before!
 ENV COMPOSER_ALLOW_SUPERUSER=1
 COPY . /app
+COPY ./.version /app/
 RUN cd /app                                         \
     && composer install --no-dev                    \
                         --classmap-authoritative    \
                         --no-progress               \
+                        --no-suggest                \
+                        --optimize-autoloader       \
     && composer clear-cache                         \
     && chmod +x /app/csv-blueprint
 
+
 RUN mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini"
 COPY ./docker/php.ini /usr/local/etc/php/conf.d/docker-z99-php.ini
 
diff --git a/Makefile b/Makefile
@@ -31,17 +31,29 @@ INVALID_SCHEMA  ?= --schema='./tests/schemas/demo_invalid.yml'
 build: ##@Project Build project in development mode
 	@composer install --optimize-autoloader
 	@rm -f `pwd`/ci-report-converter
+	@make build-version
 
 build-prod: ##@Project Build project in production mode
-	@composer install --no-dev --classmap-authoritative
+	@composer install --no-dev --classmap-authoritative --no-progress --no-suggest --optimize-autoloader
 	@rm -f `pwd`/ci-report-converter
+	@make build-version
 
 build-phar-file: ##@Project Build PHAR file
 	curl -L "https://github.com/box-project/box/releases/download/4.5.1/box.phar" -o ./build/box.phar
+	@make build-version
 	@php ./build/box.phar --version
 	@php ./build/box.phar compile -vv
 	@ls -lh ./build/csv-blueprint.phar
 
+build-version: ##@Project Save version info
+	$(eval TAG := $(shell git describe --tags --abbrev=0))
+	$(eval BRANCH := $(shell git rev-parse --abbrev-ref HEAD))
+	$(eval LAST_COMMIT_DATE := $(shell git log -1 --format=%cI))
+	$(eval SHORT_COMMIT_HASH := $(shell git rev-parse --short HEAD))
+	$(eval STABLE_FLAG := $(shell git diff --quiet $(TAG) HEAD -- && echo "true" || echo "false"))
+	@echo "$(TAG)\n$(STABLE_FLAG)\n$(BRANCH)\n$(LAST_COMMIT_DATE)\n$(SHORT_COMMIT_HASH)" > `pwd`/.version
+	@echo "Version info saved to `pwd`/.version"
+
 update: ##@Project Update dependencies
 	@echo "Composer flags: $(JBZOO_COMPOSER_UPDATE_FLAGS)"
 	@composer update $(JBZOO_COMPOSER_UPDATE_FLAGS)
@@ -62,6 +74,7 @@ demo-github: ##@Demo Run demo invalid CSV for GitHub Actions
 # Docker ###############################################################################################################
 docker-build: ##@Docker (Re-)build Docker image
 	$(call title,"Building Docker Image")
+	@make build-version
 	@docker build -t $(DOCKER_IMAGE) .
 
 docker-demo: ##@Docker Run demo via Docker
diff --git a/README.md b/README.md
@@ -792,6 +792,7 @@ Default report format is `table`:
 ./csv-blueprint validate:csv --csv='./tests/fixtures/demo.csv' --schema='./tests/schemas/demo_invalid.yml'
 
 
+CSV Blueprint: vX.Y.Z
 Found Schemas   : 1
 Found CSV files : 1
 Pairs by pattern: 1
@@ -877,10 +878,6 @@ It's random ideas and plans. No orderings and deadlines. <u>But batch processing
   * Extending with custom rules and custom report formats. Plugins?
   * Input encoding detection + `BOM` (right now it's experimental). It works but not so accurate... UTF-8/16/32 is the best choice for now.
 
-* **Release workflow**
-  * Auto insert tool version into the Docker image and phar file. It's important to know the version of the tool you are using.
-  * Show version as part of output.
-
 * **Performance and optimization**
   * Benchmarks as part of the CI(?) and Readme. It's important to know how much time the validation process takes.
   * Parallel validation of really-really large files (1GB+ ?). I know you have them and not so much memory.
diff --git a/box.json.dist b/box.json.dist
@@ -18,7 +18,10 @@
         "schema-examples",
         "src"
     ],
-    "files"       : ["csv-blueprint.php"],
+    "files"       : [
+        "csv-blueprint.php",
+        ".version"
+    ],
     "git-version" : "git-version",
 
     "finder"      : [{"in" : "vendor"}]
diff --git a/csv-blueprint.php b/csv-blueprint.php
@@ -16,8 +16,6 @@
 
 namespace JBZoo\CsvBlueprint;
 
-use JBZoo\Cli\CliApplication;
-
 \define('PATH_ROOT', __DIR__);
 
 $vendorPaths = [
@@ -41,18 +39,9 @@
     throw new \ErrorException($message, 0, $severity, $file, $line);
 });
 
-(new CliApplication('CSV Blueprint', '@git-version@'))
+$cliApp = (new CliApplication('CSV Blueprint', Utils::getVersion(true)));
+$cliApp->setVersion(Utils::getVersion(false));
+
+$cliApp
     ->registerCommandsByPath(PATH_ROOT . '/src/Commands', __NAMESPACE__)
-    ->setLogo(
-        <<<'EOF'
-             _____            ______ _                       _       _   
-            /  __ \           | ___ \ |                     (_)     | |  
-            | /  \/_____   __ | |_/ / |_   _  ___ _ __  _ __ _ _ __ | |_ 
-            | |   / __\ \ / / | ___ \ | | | |/ _ \ '_ \| '__| | '_ \| __|
-            | \__/\__ \\ V /  | |_/ / | |_| |  __/ |_) | |  | | | | | |_ 
-             \____/___/ \_/   \____/|_|\__,_|\___| .__/|_|  |_|_| |_|\__|
-                                                 | |                     
-                                                 |_|                     
-            EOF,
-    )
     ->run();
diff --git a/src/CliApplication.php b/src/CliApplication.php
@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * JBZoo Toolbox - Csv-Blueprint.
+ *
+ * This file is part of the JBZoo Toolbox project.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT
+ * @copyright  Copyright (C) JBZoo.com, All rights reserved.
+ * @see        https://github.com/JBZoo/Csv-Blueprint
+ */
+
+declare(strict_types=1);
+
+namespace JBZoo\CsvBlueprint;
+
+class CliApplication extends \JBZoo\Cli\CliApplication
+{
+    private array $appLogo = [
+        '  __________   __   ___  __                  _      __ ',
+        ' / ___/ __/ | / /  / _ )/ /_ _____ ___  ____(_)__  / /_',
+        '/ /___\ \ | |/ /  / _  / / // / -_) _ \/ __/ / _ \/ __/',
+        '\___/___/ |___/  /____/_/\_,_/\__/ .__/_/ /_/_//_/\__/ ',
+        '                               /_/                    ',
+    ];
+
+    public function getLongVersion(): string
+    {
+        $logo = '<info>' . \implode("</info>\n<info>", $this->appLogo) . '</info>';
+
+        return "{$logo}</info>\n" . Utils::getVersion(false);
+    }
+}
diff --git a/src/Commands/ValidateCsv.php b/src/Commands/ValidateCsv.php
@@ -107,6 +107,10 @@ protected function configure(): void
 
     protected function executeAction(): int
     {
+        if ($this->isHumanReadableMode()) {
+            $this->_('CSV Blueprint: ' . Utils::getVersion(false, true));
+        }
+
         if ($this->getOptBool('profile')) {
             \define('PROFILE_MODE', true);
         }
diff --git a/src/Utils.php b/src/Utils.php
@@ -23,6 +23,7 @@
 use Symfony\Component\Finder\SplFileInfo;
 
 use function JBZoo\Cli\cli;
+use function JBZoo\Utils\bool;
 
 final class Utils
 {
@@ -291,6 +292,45 @@ public static function printFile(string $fullpath): string
         return "{$directory}<blue>{$basename}</blue>";
     }
 
+    public static function getVersion(bool $tagOnly = false, bool $oneLine = false): string
+    {
+        if (self::isPhpUnit()) {
+            return 'Unknown version (PhpUnit)';
+        }
+
+        $versionFile = __DIR__ . '/../.version';
+        if (!\file_exists($versionFile)) {
+            return 'Version file not found';
+        }
+
+        $parts = \array_filter(\explode("\n", (string)\file_get_contents($versionFile)));
+
+        $expectedParts = 5;
+        if (\count($parts) < $expectedParts) {
+            return 'Invalid version file format';
+        }
+
+        [$tag, $isStable, $branch, $date, $hash] = $parts;
+
+        $dateStr = self::convertTzToUTC($date)->format('d M Y H:i \U\T\C');
+        $tag     = 'v' . \ltrim($tag, 'v');
+
+        if ($tagOnly) {
+            return $tag;
+        }
+
+        $version = ["<info>{$tag}</info>", $dateStr];
+
+        if (!bool($isStable)) {
+            $version[] = '<comment>Experimental!</comment>';
+            $version[] = "\nBranch: {$branch} ({$hash})";
+        }
+
+        $result = \implode('  ', $version);
+
+        return \trim($oneLine ? \str_replace("\n", ' ', $result) : $result);
+    }
+
     /**
      * @param SplFileInfo[] $files
      */
@@ -309,4 +349,15 @@ private static function filterNotUsedFiles(array $files): array
     {
         return \array_keys(\array_filter($files, static fn ($value) => $value === false));
     }
+
+    private static function isPhpUnit(): bool
+    {
+        return \defined('PHPUNIT_COMPOSER_INSTALL') || \defined('__PHPUNIT_PHAR__');
+    }
+
+    private static function convertTzToUTC(string $dateWithSourceTZ): \DateTime
+    {
+        return (new \DateTime($dateWithSourceTZ, new \DateTimeZone('UTC')))
+            ->setTimezone(new \DateTimeZone('UTC'));
+    }
 }
diff --git a/tests/Commands/ValidateCsvBasicTest.php b/tests/Commands/ValidateCsvBasicTest.php
@@ -33,6 +33,7 @@ public function testValidateOneCsvPositive(): void
         ]);
 
         $expected = $expected = <<<'TXT'
+            CSV Blueprint: Unknown version (PhpUnit)
             Found Schemas   : 1
             Found CSV files : 1
             Pairs by pattern: 1
@@ -66,6 +67,7 @@ public function testValidateOneCsvNegative(): void
         ]);
 
         $expected = <<<'TXT'
+            CSV Blueprint: Unknown version (PhpUnit)
             Found Schemas   : 1
             Found CSV files : 1
             Pairs by pattern: 1
@@ -105,6 +107,7 @@ public function testValidateOneCsvWithInvalidSchemaNegative(): void
         ]);
 
         $expected = <<<'TXT'
+            CSV Blueprint: Unknown version (PhpUnit)
             Found Schemas   : 1
             Found CSV files : 1
             Pairs by pattern: 1
@@ -167,6 +170,7 @@ public function testInvalidSchemaNotMatched(): void
         [$actual, $exitCode] = Tools::virtualExecution('validate:csv', $options);
 
         $expected = <<<'TXT'
+            CSV Blueprint: Unknown version (PhpUnit)
             Found Schemas   : 1
             Found CSV files : 1
             Pairs by pattern: 0
@@ -216,6 +220,7 @@ public function testInvalidSchemaAndNotFoundCSV(): void
         [$actual, $exitCode] = Tools::virtualExecution('validate:csv', $options);
 
         $expected = <<<'TXT'
+            CSV Blueprint: Unknown version (PhpUnit)
             Found Schemas   : 1
             Found CSV files : 0
             Pairs by pattern: 0
@@ -261,6 +266,7 @@ public function testValidateOneCsvNoHeaderNegative(): void
         ]);
 
         $expected = $expected = <<<'TXT'
+            CSV Blueprint: Unknown version (PhpUnit)
             Found Schemas   : 1
             Found CSV files : 1
             Pairs by pattern: 1
diff --git a/tests/Commands/ValidateCsvBatchCsvTest.php b/tests/Commands/ValidateCsvBatchCsvTest.php
diff --git a/tests/Commands/ValidateCsvBatchSchemaTest.php b/tests/Commands/ValidateCsvBatchSchemaTest.php
diff --git a/tests/Commands/ValidateCsvQuickTest.php b/tests/Commands/ValidateCsvQuickTest.php
diff --git a/tests/Commands/ValidateCsvReportsTest.php b/tests/Commands/ValidateCsvReportsTest.php
diff --git a/tests/ReadmeTest.php b/tests/ReadmeTest.php
