Merge pull request #155 from magento-commerce/MCLOUD-13558

andriyShevtsov · web-flow · commit d052b04034ea · 2025-07-22T09:45:03.000-05:00
MCLOUD-13558: Add valkey to cloud-docker
diff --git a/config/services.xml b/config/services.xml
@@ -24,6 +24,7 @@
                 <argument type="service" id="Magento\CloudDocker\Compose\ProductionBuilder\Service\Database\DbQuote" />
                 <argument type="service" id="Magento\CloudDocker\Compose\ProductionBuilder\Service\Database\DbSales" />
                 <argument type="service" id="Magento\CloudDocker\Compose\ProductionBuilder\Service\Redis" />
+                <argument type="service" id="Magento\CloudDocker\Compose\ProductionBuilder\Service\Valkey" />
                 <argument type="service" id="Magento\CloudDocker\Compose\ProductionBuilder\Service\ElasticSearch" />
                 <argument type="service" id="Magento\CloudDocker\Compose\ProductionBuilder\Service\OpenSearch" />
                 <argument type="service" id="Magento\CloudDocker\Compose\ProductionBuilder\Service\Fpm" />
diff --git a/src/Command/BuildCompose.php b/src/Command/BuildCompose.php
@@ -138,6 +138,11 @@ protected function configure(): void
                 null,
                 InputOption::VALUE_REQUIRED,
                 'Redis version'
+            )->addOption(
+                Source\CliSource::OPTION_VALKEY,
+                null,
+                InputOption::VALUE_REQUIRED,
+                'Valkey version'
             )->addOption(
                 Source\CliSource::OPTION_ES,
                 null,
@@ -188,6 +193,16 @@ protected function configure(): void
                 null,
                 InputOption::VALUE_NONE,
                 'Disable Opensearch'
+            )->addOption(
+                Source\CliSource::OPTION_NO_REDIS,
+                null,
+                InputOption::VALUE_NONE,
+                'Disable Redis'
+            )->addOption(
+                Source\CliSource::OPTION_NO_DB,
+                null,
+                InputOption::VALUE_NONE,
+                'Disable Database'
             )->addOption(
                 Source\CliSource::OPTION_NO_MAILHOG,
                 null,
diff --git a/src/Compose/BuilderInterface.php b/src/Compose/BuilderInterface.php
@@ -29,6 +29,7 @@ interface BuilderInterface
     public const SERVICE_TLS = ServiceInterface::SERVICE_TLS;
     public const SERVICE_RABBITMQ = ServiceInterface::SERVICE_RABBITMQ;
     public const SERVICE_REDIS = ServiceInterface::SERVICE_REDIS;
+    public const SERVICE_VALKEY = ServiceInterface::SERVICE_VALKEY;
     public const SERVICE_ELASTICSEARCH = ServiceInterface::SERVICE_ELASTICSEARCH;
     public const SERVICE_OPENSEARCH = ServiceInterface::SERVICE_OPENSEARCH;
     public const SERVICE_NODE = ServiceInterface::SERVICE_NODE;
diff --git a/src/Compose/ProductionBuilder/CliDepend.php b/src/Compose/ProductionBuilder/CliDepend.php
@@ -27,6 +27,9 @@ class CliDepend
         BuilderInterface::SERVICE_REDIS => [
             'condition' => 'service_healthy'
         ],
+        BuilderInterface::SERVICE_VALKEY => [
+            'condition' => 'service_healthy'
+        ],
         BuilderInterface::SERVICE_ELASTICSEARCH => [
             'condition' => 'service_healthy'
         ],
diff --git a/src/Compose/ProductionBuilder/Service/Valkey.php b/src/Compose/ProductionBuilder/Service/Valkey.php
@@ -0,0 +1,93 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CloudDocker\Compose\ProductionBuilder\Service;
+
+use Magento\CloudDocker\Compose\BuilderInterface;
+use Magento\CloudDocker\Compose\ProductionBuilder\ServiceBuilderInterface;
+use Magento\CloudDocker\Config\Config;
+use Magento\CloudDocker\Service\ServiceFactory;
+
+/**
+ * Returns Redis service configuration
+ */
+class Valkey implements ServiceBuilderInterface
+{
+    /**
+     * @var ServiceFactory
+     */
+    private ServiceFactory $serviceFactory;
+
+    /**
+     * @param ServiceFactory $serviceFactory
+     */
+    public function __construct(ServiceFactory $serviceFactory)
+    {
+        $this->serviceFactory = $serviceFactory;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getName(): string
+    {
+        return BuilderInterface::SERVICE_VALKEY;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getServiceName(): string
+    {
+        return $this->getName();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getConfig(Config $config): array
+    {
+        $configArray = $this->serviceFactory->create(
+            $this->getServiceName(),
+            $config->getServiceVersion($this->getServiceName()),
+            [
+            BuilderInterface::SERVICE_HEALTHCHECK => [
+              'test' => 'valkey-cli ping || exit 1',
+              'interval' => '30s',
+              'timeout' => '30s',
+              'retries' => 3
+            ]
+            ],
+            $config->getServiceImage($this->getServiceName()),
+            $config->getCustomRegistry()
+        );
+
+        // Set both 'cache' and 'valkey.magento2.docker' as aliases unconditionally
+        $configArray['networks'][BuilderInterface::NETWORK_MAGENTO]['aliases'] = [
+          'cache',
+          'valkey.magento2.docker'
+        ];
+
+        return $configArray;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getNetworks(): array
+    {
+        return [BuilderInterface::NETWORK_MAGENTO];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getDependsOn(Config $config): array
+    {
+        return [];
+    }
+}
diff --git a/src/Config/Relationship.php b/src/Config/Relationship.php
@@ -55,6 +55,12 @@ class Relationship
                 'port' => '6379'
             ]
         ],
+        'valkey' => [
+          [
+            'host' => 'cache',
+            'port' => '6379'
+          ]
+        ],
         'elasticsearch' => [
             [
                 'host' => 'elasticsearch',
diff --git a/src/Config/Source/CliSource.php b/src/Config/Source/CliSource.php
@@ -27,6 +27,7 @@ class CliSource implements SourceInterface
     public const OPTION_EXPOSE_DB_QUOTE_PORT = 'expose-db-quote-port';
     public const OPTION_EXPOSE_DB_SALES_PORT = 'expose-db-sales-port';
     public const OPTION_REDIS = 'redis';
+    public const OPTION_VALKEY = 'valkey';
     public const OPTION_ES = 'es';
     public const OPTION_OS = 'os';
     public const OPTION_RABBIT_MQ = 'rmq';
@@ -37,6 +38,8 @@ class CliSource implements SourceInterface
     public const OPTION_INSTALLATION_TYPE = 'installation-type';
     public const OPTION_NO_ES = 'no-es';
     public const OPTION_NO_OS = 'no-os';
+    public const OPTION_NO_REDIS = 'no-redis';
+    public const OPTION_NO_DB = 'no-db';
     public const OPTION_NO_MAILHOG = 'no-mailhog';
     public const OPTION_NO_TLS = 'no-tls';
 
@@ -124,6 +127,9 @@ class CliSource implements SourceInterface
         self::OPTION_REDIS => [
             self::SERVICES_REDIS => true
         ],
+        self::OPTION_VALKEY => [
+          self::SERVICES_VALKEY => true
+        ],
         self::OPTION_ES => [
             self::SERVICES_ES => true
         ],
@@ -146,6 +152,8 @@ class CliSource implements SourceInterface
     private static $disableOptionsMap = [
         self::OPTION_NO_ES => self::SERVICES_ES,
         self::OPTION_NO_OS => self::SERVICES_OS,
+        self::OPTION_NO_REDIS => self::SERVICES_REDIS,
+        self::OPTION_NO_DB => self::SERVICES_DB,
         self::OPTION_NO_MAILHOG => self::SERVICES_MAILHOG,
         self::OPTION_NO_TLS => self::SERVICES_TLS,
     ];
diff --git a/src/Config/Source/CloudSource.php b/src/Config/Source/CloudSource.php
@@ -47,6 +47,7 @@ class CloudSource implements SourceInterface
         ServiceInterface::SERVICE_ELASTICSEARCH => ['elasticsearch', 'es'],
         ServiceInterface::SERVICE_OPENSEARCH => ['opensearch', 'os'],
         ServiceInterface::SERVICE_REDIS => ['redis'],
+        ServiceInterface::SERVICE_VALKEY => ['cache','valkey'],
         ServiceInterface::SERVICE_RABBITMQ => ['rmq', 'rabbitmq']
     ];
 
diff --git a/src/Config/Source/SourceInterface.php b/src/Config/Source/SourceInterface.php
@@ -73,6 +73,11 @@ interface SourceInterface
      */
     public const SERVICES_REDIS = self::SERVICES . '.' . ServiceInterface::SERVICE_REDIS;
 
+    /**
+     * Valkey
+     */
+    public const SERVICES_VALKEY = self::SERVICES . '.' . ServiceInterface::SERVICE_VALKEY;
+
     /**
      * ES
      */
diff --git a/src/Service/ServiceFactory.php b/src/Service/ServiceFactory.php
@@ -105,6 +105,26 @@ class ServiceFactory
                 ]
             ],
         ],
+        ServiceInterface::SERVICE_VALKEY => [
+          'image' => 'valkey/valkey',
+          'pattern' => self::PATTERN_STD,
+          'config' => [
+            'volumes' => [
+              '/data',
+            ],
+            'ports' => [6379],
+            'sysctls' => [
+              'net.core.somaxconn' => 1024,
+            ],
+            'ulimits' => [
+              'nproc' => 65535,
+              'nofile' => [
+                'soft' => 20000,
+                'hard' => 40000
+              ],
+            ]
+          ],
+        ],
         ServiceInterface::SERVICE_ELASTICSEARCH => [
             'image' => 'magento/magento-cloud-docker-elasticsearch',
             'pattern' => self::PATTERN_VERSIONED,
diff --git a/src/Service/ServiceInterface.php b/src/Service/ServiceInterface.php
@@ -23,6 +23,7 @@ interface ServiceInterface
     public const SERVICE_DB_SALES = 'mysql-sales';
     public const SERVICE_NGINX = 'nginx';
     public const SERVICE_REDIS = 'redis';
+    public const SERVICE_VALKEY = 'valkey';
     public const SERVICE_ELASTICSEARCH = 'elasticsearch';
     public const SERVICE_OPENSEARCH = 'opensearch';
     public const SERVICE_RABBITMQ = 'rabbitmq';
diff --git a/src/Test/Functional/Acceptance/Valkey83Cest.php b/src/Test/Functional/Acceptance/Valkey83Cest.php
@@ -0,0 +1,19 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CloudDocker\Test\Functional\Acceptance;
+
+/**
+ * @group php83
+ */
+class Valkey83Cest extends ValkeyCest
+{
+    /**
+     * Template version for testing
+     */
+    protected const TEMPLATE_VERSION = '2.4.7';
+}
diff --git a/src/Test/Functional/Acceptance/ValkeyCest.php b/src/Test/Functional/Acceptance/ValkeyCest.php
@@ -0,0 +1,119 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CloudDocker\Test\Functional\Acceptance;
+
+use CliTester;
+use Codeception\Example;
+use Robo\Exception\TaskException;
+
+/**
+ * @group php84
+ */
+class ValkeyCest extends AbstractCest
+{
+    /**
+     * Template version for testing
+     */
+    protected const TEMPLATE_VERSION = '2.4.8';
+
+    /**
+     * @param        CliTester $I
+     * @param        Example   $data
+     * @dataProvider dataProvider
+     * @return       void
+     * @throws       TaskException
+     */
+    public function testValkey(CliTester $I, Example $data)
+    {
+        $I->generateDockerCompose($this->buildCommand($data));
+        $I->replaceImagesWithCustom();
+        $I->startEnvironment();
+        
+        // Test Valkey connectivity (this also confirms it's running)
+        $I->runDockerComposeCommand('exec -T valkey valkey-cli ping');
+        $I->seeInOutput('PONG');
+        
+        // Test that Valkey container is running and healthy
+        $I->runDockerComposeCommand('ps');
+        $I->seeInOutput('valkey');
+        $I->seeInOutput('(healthy)');
+        
+        // Test that Valkey is accessible through cache alias (using nc to test network connectivity)
+        $I->runDockerComposeCommand('exec -T fpm nc -z cache 6379');
+        $I->seeInOutput('');  // nc returns empty output on success
+        
+        // Test that Valkey is accessible through valkey.magento2.docker alias
+        $I->runDockerComposeCommand('exec -T fpm nc -z valkey.magento2.docker 6379');
+        $I->seeInOutput('');
+        
+        // Test basic Valkey functionality
+        $I->runDockerComposeCommand('exec -T valkey valkey-cli set test_key "test_value"');
+        $I->seeInOutput('OK');
+        
+        $I->runDockerComposeCommand('exec -T valkey valkey-cli get test_key');
+        $I->seeInOutput('test_value');
+        
+        // Test Valkey info command to verify version
+        $I->runDockerComposeCommand('exec -T valkey valkey-cli info server');
+        $I->seeInOutput('valkey_version:' . $data['version']);
+        
+        // Test confirmed: Valkey is accessible on port 6379 (validated via info command above)
+        
+        // Test memory usage reporting
+        $I->runDockerComposeCommand('exec -T valkey valkey-cli info memory');
+        $I->seeInOutput('used_memory:');
+        $I->seeInOutput('used_memory_human:');
+        
+        // Test health check functionality
+        $I->runDockerComposeCommand('exec -T valkey valkey-cli ping');
+        $I->seeInOutput('PONG');
+        
+        // Test data persistence
+        $I->runDockerComposeCommand('exec -T valkey valkey-cli set persistent_key "persistent_value"');
+        $I->seeInOutput('OK');
+        
+        $I->runDockerComposeCommand('exec -T valkey valkey-cli get persistent_key');
+        $I->seeInOutput('persistent_value');
+        
+        // Test database operations
+        $I->runDockerComposeCommand('exec -T valkey valkey-cli dbsize');
+        $I->seeInOutput('2'); // We should have 2 keys: test_key and persistent_key
+        
+        // Test that Valkey configuration is accessible
+        $I->runDockerComposeCommand('exec -T valkey valkey-cli config get save');
+        $I->seeInOutput('save');
+    }
+
+    /**
+     * Builds build:compose command from given test data
+     *
+     * @param  Example $data
+     * @return string
+     */
+    private function buildCommand(Example $data): string
+    {
+        $command = sprintf(
+            '--mode=production --valkey=%s --no-es --no-os --no-redis',
+            $data['version']
+        );
+
+        return $command;
+    }
+
+    /**
+     * @return array
+     */
+    protected function dataProvider(): array
+    {
+        return [
+            [
+                'version' => '8.0',
+            ],
+        ];
+    }
+}
diff --git a/src/Test/Unit/Config/RelationshipTest.php b/src/Test/Unit/Config/RelationshipTest.php

Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,12 @@ class Relationship`
`55`	`55`	`'port' => '6379'`
`56`	`56`	`]`
`57`	`57`	`],`
	`58`	`+ 'valkey' => [`
	`59`	`+ [`
	`60`	`+ 'host' => 'cache',`
	`61`	`+ 'port' => '6379'`
	`62`	`+ ]`
	`63`	`+ ],`
`58`	`64`	`'elasticsearch' => [`
`59`	`65`	`[`
`60`	`66`	`'host' => 'elasticsearch',`