Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow redis compression options to be specified during setup:install process #21053

Merged
merged 6 commits into from
Mar 30, 2019
Merged

Allow redis compression options to be specified during setup:install process #21053

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fa47719
allowing setup:install to specify redis-compress-data and redis-compr…
cmacdonald-au Feb 8, 2019
dd913cf
Allowing compression by default (previous, standard behaviour). Clean…
cmacdonald-au Feb 8, 2019
68623a9
cleaning expected blank config test struct
cmacdonald-au Feb 8, 2019
eb213d8
cm/redis listens for compression_lib - be consistent
cmacdonald-au Feb 8, 2019
ce6dee1
Correct options ordering in assertions
cmacdonald-au Feb 10, 2019
337397a
ENGCOM-4267: Static tests fix.
p-bystritsky Mar 21, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions setup/src/Magento/Setup/Model/ConfigOptionsList/Cache.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,17 @@ class Cache implements ConfigOptionsListInterface
const INPUT_KEY_CACHE_BACKEND_REDIS_DATABASE = 'cache-backend-redis-db';
const INPUT_KEY_CACHE_BACKEND_REDIS_PORT = 'cache-backend-redis-port';
const INPUT_KEY_CACHE_BACKEND_REDIS_PASSWORD = 'cache-backend-redis-password';
const INPUT_KEY_CACHE_BACKEND_REDIS_COMPRESS_DATA = 'cache-backend-redis-compress-data';
const INPUT_KEY_CACHE_BACKEND_REDIS_COMPRESSION_LIB = 'cache-backend-redis-compression-lib';
const INPUT_KEY_CACHE_ID_PREFIX = 'cache-id-prefix';

const CONFIG_PATH_CACHE_BACKEND = 'cache/frontend/default/backend';
const CONFIG_PATH_CACHE_BACKEND_SERVER = 'cache/frontend/default/backend_options/server';
const CONFIG_PATH_CACHE_BACKEND_DATABASE = 'cache/frontend/default/backend_options/database';
const CONFIG_PATH_CACHE_BACKEND_PORT = 'cache/frontend/default/backend_options/port';
const CONFIG_PATH_CACHE_BACKEND_PASSWORD = 'cache/frontend/default/backend_options/password';
const CONFIG_PATH_CACHE_BACKEND_COMPRESS_DATA = 'cache/frontend/default/backend_options/compress_data';
const CONFIG_PATH_CACHE_BACKEND_COMPRESSION_LIB = 'cache/frontend/default/backend_options/compression_lib';
const CONFIG_PATH_CACHE_ID_PREFIX = 'cache/frontend/default/id_prefix';

/**
Expand All @@ -43,7 +47,9 @@ class Cache implements ConfigOptionsListInterface
self::INPUT_KEY_CACHE_BACKEND_REDIS_SERVER => '127.0.0.1',
self::INPUT_KEY_CACHE_BACKEND_REDIS_DATABASE => '0',
self::INPUT_KEY_CACHE_BACKEND_REDIS_PORT => '6379',
self::INPUT_KEY_CACHE_BACKEND_REDIS_PASSWORD => ''
self::INPUT_KEY_CACHE_BACKEND_REDIS_PASSWORD => '',
self::INPUT_KEY_CACHE_BACKEND_REDIS_COMPRESS_DATA => '1',
self::INPUT_KEY_CACHE_BACKEND_REDIS_COMPRESSION_LIB => '',
];

/**
Expand All @@ -60,7 +66,9 @@ class Cache implements ConfigOptionsListInterface
self::INPUT_KEY_CACHE_BACKEND_REDIS_SERVER => self::CONFIG_PATH_CACHE_BACKEND_SERVER,
self::INPUT_KEY_CACHE_BACKEND_REDIS_DATABASE => self::CONFIG_PATH_CACHE_BACKEND_DATABASE,
self::INPUT_KEY_CACHE_BACKEND_REDIS_PORT => self::CONFIG_PATH_CACHE_BACKEND_PORT,
self::INPUT_KEY_CACHE_BACKEND_REDIS_PASSWORD => self::CONFIG_PATH_CACHE_BACKEND_PASSWORD
self::INPUT_KEY_CACHE_BACKEND_REDIS_PASSWORD => self::CONFIG_PATH_CACHE_BACKEND_PASSWORD,
self::INPUT_KEY_CACHE_BACKEND_REDIS_COMPRESS_DATA => self::CONFIG_PATH_CACHE_BACKEND_COMPRESS_DATA,
self::INPUT_KEY_CACHE_BACKEND_REDIS_COMPRESSION_LIB => self::CONFIG_PATH_CACHE_BACKEND_COMPRESSION_LIB,
];

/**
Expand Down Expand Up @@ -115,12 +123,24 @@ public function getOptions()
self::CONFIG_PATH_CACHE_BACKEND_PASSWORD,
'Redis server password'
),
new TextConfigOption(
self::INPUT_KEY_CACHE_BACKEND_REDIS_COMPRESS_DATA,
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_CACHE_BACKEND_COMPRESS_DATA,
'Set to 0 to disable compression (default is 1, enabled)'
),
new TextConfigOption(
self::INPUT_KEY_CACHE_BACKEND_REDIS_COMPRESSION_LIB,
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_CACHE_BACKEND_COMPRESSION_LIB,
'Compression lib to use [snappy,lzf,l4z,zstd,gzip] (leave blank to determine automatically)'
),
new TextConfigOption(
self::INPUT_KEY_CACHE_ID_PREFIX,
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_CACHE_ID_PREFIX,
'ID prefix for cache keys'
)
),
];
}

Expand Down
33 changes: 22 additions & 11 deletions setup/src/Magento/Setup/Model/ConfigOptionsList/PageCache.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@

namespace Magento\Setup\Model\ConfigOptionsList;

use Magento\Framework\Setup\ConfigOptionsListInterface;
use Magento\Framework\Config\File\ConfigFilePool;
use Magento\Framework\App\DeploymentConfig;
use Magento\Framework\Config\Data\ConfigData;
use Magento\Framework\Config\File\ConfigFilePool;
use Magento\Framework\Setup\ConfigOptionsListInterface;
use Magento\Framework\Setup\Option\SelectConfigOption;
use Magento\Framework\Setup\Option\TextConfigOption;
use Magento\Setup\Validator\RedisConnectionValidator;
Expand All @@ -26,16 +26,18 @@ class PageCache implements ConfigOptionsListInterface
const INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SERVER = 'page-cache-redis-server';
const INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_DATABASE = 'page-cache-redis-db';
const INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_PORT = 'page-cache-redis-port';
const INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_COMPRESS_DATA = 'page-cache-redis-compress-data';
const INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_PASSWORD = 'page-cache-redis-password';
const INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_COMPRESS_DATA = 'page-cache-redis-compress-data';
const INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_COMPRESSION_LIB = 'page-cache-redis-compression-lib';
const INPUT_KEY_PAGE_CACHE_ID_PREFIX = 'page-cache-id-prefix';

const CONFIG_PATH_PAGE_CACHE_BACKEND = 'cache/frontend/page_cache/backend';
const CONFIG_PATH_PAGE_CACHE_BACKEND_SERVER = 'cache/frontend/page_cache/backend_options/server';
const CONFIG_PATH_PAGE_CACHE_BACKEND_DATABASE = 'cache/frontend/page_cache/backend_options/database';
const CONFIG_PATH_PAGE_CACHE_BACKEND_PORT = 'cache/frontend/page_cache/backend_options/port';
const CONFIG_PATH_PAGE_CACHE_BACKEND_COMPRESS_DATA = 'cache/frontend/page_cache/backend_options/compress_data';
const CONFIG_PATH_PAGE_CACHE_BACKEND_PASSWORD = 'cache/frontend/page_cache/backend_options/password';
const CONFIG_PATH_PAGE_CACHE_BACKEND_COMPRESS_DATA = 'cache/frontend/page_cache/backend_options/compress_data';
const CONFIG_PATH_PAGE_CACHE_BACKEND_COMPRESSION_LIB = 'cache/frontend/page_cache/backend_options/compression_lib';
const CONFIG_PATH_PAGE_CACHE_ID_PREFIX = 'cache/frontend/page_cache/id_prefix';

/**
Expand All @@ -45,8 +47,9 @@ class PageCache implements ConfigOptionsListInterface
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SERVER => '127.0.0.1',
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_DATABASE => '1',
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_PORT => '6379',
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_PASSWORD => '',
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_COMPRESS_DATA => '0',
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_PASSWORD => ''
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_COMPRESSION_LIB => '',
];

/**
Expand All @@ -63,8 +66,10 @@ class PageCache implements ConfigOptionsListInterface
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SERVER => self::CONFIG_PATH_PAGE_CACHE_BACKEND_SERVER,
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_DATABASE => self::CONFIG_PATH_PAGE_CACHE_BACKEND_DATABASE,
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_PORT => self::CONFIG_PATH_PAGE_CACHE_BACKEND_PORT,
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_PASSWORD => self::CONFIG_PATH_PAGE_CACHE_BACKEND_PASSWORD,
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_COMPRESS_DATA => self::CONFIG_PATH_PAGE_CACHE_BACKEND_COMPRESS_DATA,
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_PASSWORD => self::CONFIG_PATH_PAGE_CACHE_BACKEND_PASSWORD
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_COMPRESSION_LIB =>
self::CONFIG_PATH_PAGE_CACHE_BACKEND_COMPRESSION_LIB,
];

/**
Expand Down Expand Up @@ -113,24 +118,30 @@ public function getOptions()
self::CONFIG_PATH_PAGE_CACHE_BACKEND_PORT,
'Redis server listen port'
),
new TextConfigOption(
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_PASSWORD,
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_PAGE_CACHE_BACKEND_PASSWORD,
'Redis server password'
),
new TextConfigOption(
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_COMPRESS_DATA,
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_PAGE_CACHE_BACKEND_COMPRESS_DATA,
'Set to 1 to compress the full page cache (use 0 to disable)'
),
new TextConfigOption(
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_PASSWORD,
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_COMPRESSION_LIB,
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_PAGE_CACHE_BACKEND_PASSWORD,
'Redis server password'
self::CONFIG_PATH_PAGE_CACHE_BACKEND_COMPRESSION_LIB,
'Compression library to use [snappy,lzf,l4z,zstd,gzip] (leave blank to determine automatically)'
),
new TextConfigOption(
self::INPUT_KEY_PAGE_CACHE_ID_PREFIX,
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_PAGE_CACHE_ID_PREFIX,
'ID prefix for cache keys'
)
),
];
}

Expand Down Expand Up @@ -224,7 +235,7 @@ private function validateRedisConfig(array $options, DeploymentConfig $deploymen
self::CONFIG_PATH_PAGE_CACHE_BACKEND_DATABASE,
$this->getDefaultConfigValue(self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_DATABASE)
);

$config['password'] = isset($options[self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_PASSWORD])
? $options[self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_PASSWORD]
: $deploymentConfig->get(
Expand Down
25 changes: 20 additions & 5 deletions setup/src/Magento/Setup/Test/Unit/Model/ConfigOptionsList/CacheTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ protected function setUp()
public function testGetOptions()
{
$options = $this->configOptionsList->getOptions();
$this->assertCount(6, $options);
$this->assertCount(8, $options);

$this->assertArrayHasKey(0, $options);
$this->assertInstanceOf(SelectConfigOption::class, $options[0]);
Expand All @@ -69,7 +69,15 @@ public function testGetOptions()

$this->assertArrayHasKey(5, $options);
$this->assertInstanceOf(TextConfigOption::class, $options[5]);
$this->assertEquals('cache-id-prefix', $options[5]->getName());
$this->assertEquals('cache-backend-redis-compress-data', $options[5]->getName());

$this->assertArrayHasKey(6, $options);
$this->assertInstanceOf(TextConfigOption::class, $options[6]);
$this->assertEquals('cache-backend-redis-compression-lib', $options[6]->getName());

$this->assertArrayHasKey(7, $options);
$this->assertInstanceOf(TextConfigOption::class, $options[7]);
$this->assertEquals('cache-id-prefix', $options[7]->getName());
}

/**
Expand All @@ -88,7 +96,9 @@ public function testCreateConfigCacheRedis()
'server' => '',
'port' => '',
'database' => '',
'password' => ''
'password' => '',
'compress_data' => '',
'compression_lib' => '',
],
'id_prefix' => $this->expectedIdPrefix(),
]
Expand All @@ -115,18 +125,23 @@ public function testCreateConfigWithRedisConfig()
'server' => 'localhost',
'port' => '1234',
'database' => '5',
'password' => ''
'password' => '',
'compress_data' => '1',
'compression_lib' => 'gzip',
],
'id_prefix' => $this->expectedIdPrefix(),
]
]
]
];

$options = [
'cache-backend' => 'redis',
'cache-backend-redis-server' => 'localhost',
'cache-backend-redis-port' => '1234',
'cache-backend-redis-db' => '5'
'cache-backend-redis-db' => '5',
'cache-backend-redis-compress-data' => '1',
'cache-backend-redis-compression-lib' => 'gzip'
];

$configData = $this->configOptionsList->createConfig($options, $this->deploymentConfigMock);
Expand Down
21 changes: 14 additions & 7 deletions setup/src/Magento/Setup/Test/Unit/Model/ConfigOptionsList/PageCacheTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ protected function setUp()
public function testGetOptions()
{
$options = $this->configList->getOptions();
$this->assertCount(7, $options);
$this->assertCount(8, $options);

$this->assertArrayHasKey(0, $options);
$this->assertInstanceOf(SelectConfigOption::class, $options[0]);
Expand All @@ -65,15 +65,19 @@ public function testGetOptions()

$this->assertArrayHasKey(4, $options);
$this->assertInstanceOf(TextConfigOption::class, $options[4]);
$this->assertEquals('page-cache-redis-compress-data', $options[4]->getName());
$this->assertEquals('page-cache-redis-password', $options[4]->getName());

$this->assertArrayHasKey(5, $options);
$this->assertInstanceOf(TextConfigOption::class, $options[5]);
$this->assertEquals('page-cache-redis-password', $options[5]->getName());
$this->assertEquals('page-cache-redis-compress-data', $options[5]->getName());

$this->assertArrayHasKey(6, $options);
$this->assertInstanceOf(TextConfigOption::class, $options[6]);
$this->assertEquals('page-cache-id-prefix', $options[6]->getName());
$this->assertEquals('page-cache-redis-compression-lib', $options[6]->getName());

$this->assertArrayHasKey(7, $options);
$this->assertInstanceOf(TextConfigOption::class, $options[7]);
$this->assertEquals('page-cache-id-prefix', $options[7]->getName());
}

/**
Expand All @@ -93,7 +97,8 @@ public function testCreateConfigWithRedis()
'port' => '',
'database' => '',
'compress_data' => '',
'password' => ''
'password' => '',
'compression_lib' => '',
],
'id_prefix' => $this->expectedIdPrefix(),
]
Expand All @@ -120,8 +125,9 @@ public function testCreateConfigWithRedisConfiguration()
'server' => 'foo.bar',
'port' => '9000',
'database' => '6',
'password' => '',
'compress_data' => '1',
'password' => ''
'compression_lib' => 'gzip',
],
'id_prefix' => $this->expectedIdPrefix(),
]
Expand All @@ -134,7 +140,8 @@ public function testCreateConfigWithRedisConfiguration()
'page-cache-redis-server' => 'foo.bar',
'page-cache-redis-port' => '9000',
'page-cache-redis-db' => '6',
'page-cache-redis-compress-data' => '1'
'page-cache-redis-compress-data' => '1',
'page-cache-redis-compression-lib' => 'gzip',
];

$configData = $this->configList->createConfig($options, $this->deploymentConfigMock);
Expand Down