MAGETWO-88597: Varnish Config Access List

Author: Oleksandr Gorkun

app/code/Magento/PageCache/Model/System/Config/Backend/AccessList.php

@@ -0,0 +1,37 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\PageCache\Model\System\Config\Backend;
+
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Phrase;
+
+/**
+ * Access List config field.
+ */
+class AccessList extends Varnish
+{
+    /**
+     * @inheritDoc
+     */
+    public function beforeSave()
+    {
+        parent::beforeSave();
+
+        $value = $this->getValue();
+        if (!is_string($value) || !preg_match('/^[\w\s\.\-\,\:]+$/', $value)) {
+            throw new LocalizedException(
+                new Phrase(
+                    'Access List value "%1" is not valid. '
+                    .'Please use only IP addresses and host names.',
+                    [$value]
+                )
+            );
+        }
+    }
+}

app/code/Magento/PageCache/Test/Unit/Model/System/Config/Backend/AccessListTest.php

@@ -0,0 +1,90 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\PageCache\Test\Unit\Model\System\Config\Backend;
+
+use Magento\PageCache\Model\System\Config\Backend\AccessList;
+use PHPUnit\Framework\TestCase;
+use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
+use Magento\Framework\App\Config\ScopeConfigInterface;
+
+class AccessListTest extends TestCase
+{
+    /**
+     * @var AccessList
+     */
+    private $accessList;
+
+    /**
+     * @inheritDoc
+     */
+    protected function setUp()
+    {
+        $objectManager = new ObjectManager($this);
+        $configMock = $this->getMockForAbstractClass(
+            ScopeConfigInterface::class
+        );
+        $configMock->expects($this->any())
+            ->method('getValue')
+            ->with('system/full_page_cache/default')
+            ->willReturn(['access_list' => 'localhost']);
+        $this->accessList = $objectManager->getObject(
+            AccessList::class,
+            [
+                'config' => $configMock,
+                'data' => ['field' => 'access_list']
+            ]
+        );
+    }
+
+    /**
+     * @return array
+     */
+    public function getValidValues(): array
+    {
+        return [
+            ['localhost', 'localhost'],
+            [null, 'localhost'],
+            ['127.0.0.1', '127.0.0.1'],
+            ['127.0.0.1, localhost, ::2', '127.0.0.1, localhost, ::2'],
+        ];
+    }
+
+    /**
+     * @param mixed $value
+     * @param mixed $expectedValue
+     * @dataProvider getValidValues
+     */
+    public function testBeforeSave($value, $expectedValue)
+    {
+        $this->accessList->setValue($value);
+        $this->accessList->beforeSave();
+        $this->assertEquals($expectedValue, $this->accessList->getValue());
+    }
+
+    /**
+     * @return array
+     */
+    public function getInvalidValues(): array
+    {
+        return [
+            ['\\bull val\\'],
+            ['{*I am not an IP*}'],
+            ['{*I am not an IP*}, 127.0.0.1'],
+        ];
+    }
+
+    /**
+     * @param mixed $value
+     * @expectedException \Magento\Framework\Exception\LocalizedException
+     * @dataProvider getInvalidValues
+     */
+    public function testBeforeSaveInvalid($value)
+    {
+        $this->accessList->setValue($value);
+        $this->accessList->beforeSave();
+    }
+}

app/code/Magento/PageCache/etc/adminhtml/system.xml

@@ -20,7 +20,7 @@
                         <label>Access list</label>
                         <comment>IPs access list separated with ',' that can purge Varnish configuration for config file generation.
                             If field is empty default value localhost will be saved.</comment>
-                        <backend_model>Magento\PageCache\Model\System\Config\Backend\Varnish</backend_model>
+                        <backend_model>Magento\PageCache\Model\System\Config\Backend\AccessList</backend_model>
                         <depends>
                             <field id="caching_application">1</field>
                         </depends>