Merge pull request #62 from magento/varnish-tests

Varnish tests

Author: paliarush

etc/config.yaml.dist

@@ -23,6 +23,8 @@ repository_url:
     # - "git@github.com:magento/magento2-sample-data.git"
     # - "git@github.com:magento/magento2-sample-data-ee.git"
     # - "git@github.com:magento/magento2b2b.git"
+  # If set to 1, shallow clone will be used to speed up the project initialization. Custom branches will not be available if shallow clone used
+  shallow_clone: 0
 
 guest:
   # [To apply changes: init_project.sh -f] NFS will be used for folder synchronization on *nix and OSX hosts by default.
@@ -41,7 +43,7 @@ environment:
   php_version: "7.0"
   composer_prefer_source: 0
   # [To apply changes: m-reinstall OR m-varnish enable/disable]
-  use_varnish: 0
+  use_varnish: 1
   # [To apply changes: m-reinstall] Possible values: mysql, elasticsearch
   search_engine: "elasticsearch"
 

init_project.sh

@@ -34,6 +34,7 @@ repository_url_ee="$(bash "${devbox_dir}/scripts/get_config_value.sh" "repositor
 composer_project_name="$(bash "${devbox_dir}/scripts/get_config_value.sh" "composer_project_name")"
 composer_project_url="$(bash "${devbox_dir}/scripts/get_config_value.sh" "composer_project_url")"
 checkout_source_from="$(bash "${devbox_dir}/scripts/get_config_value.sh" "checkout_source_from")"
+use_git_shallow_clone="$(bash "${devbox_dir}/scripts/get_config_value.sh" "repository_url_shallow_clone")"
 
 function checkoutSourceCodeFromGit()
 {
@@ -119,13 +120,17 @@ function initGitRepository()
         fi
         directory="${magento_ce_dir}/${BASH_REMATCH[1]}"
     fi
-    git clone ${repo} "${directory}" 2> >(logError) > >(log)
 
-    if [[ -n ${branch} ]]; then
-        status "Checking out branch ${branch} of ${repository_name} repository"
-        cd "${directory}"
-        git fetch 2> >(logError) > >(log)
-        git checkout ${branch} 2> >(log) > >(log)
+    if [[ ${use_git_shallow_clone} -eq 1 ]] ; then
+        git clone --depth 1 ${repo} "${directory}" 2> >(logError) > >(log)
+    else
+        git clone ${repo} "${directory}" 2> >(logError) > >(log)
+        if [[ -n ${branch} ]]; then
+            status "Checking out branch ${branch} of ${repository_name} repository"
+            cd "${directory}"
+            git fetch 2> >(logError) > >(log)
+            git checkout ${branch} 2> >(log) > >(log)
+        fi
     fi
     cd "${devbox_dir}"
 }

m-varnish

@@ -18,6 +18,9 @@ arguments=$@
 cd "${devbox_dir}"
 executeInMagento2Container "${devbox_dir}/scripts/guest/m-varnish" -- ${arguments} 2> >(logError)
 
-bash "${devbox_dir}/k-rebuild-environment" "$@" 2> >(logError)
+bash "${devbox_dir}/k-rebuild-environment" 2> >(logError)
+
+# TODO: Remove when MySQL state is persisted between rebuilds
+bash "${devbox_dir}/m-reinstall" 2> >(logError)
 
 info "$(regular)See details in $(bold)${devbox_dir}/log/${current_script_name}.log$(regular). For debug output set $(bold)debug:devbox_project$(regular) to $(bold)1$(regular) in $(bold)etc/config.yaml$(regular)"

scripts/guest/configure_varnish

@@ -20,19 +20,10 @@ restart_services=0
 use_varnish="$(bash "${devbox_dir}/scripts/get_config_value.sh" "environment_use_varnish")"
 if [[ $use_varnish == 1 ]]; then
     status "Updating Magento database to use varnish FPC"
-    # TODO: Make credentials configurable
-    mysql -u"root" -p"123123q" -h"magento2-mysql" -D magento -e "INSERT INTO core_config_data
-        ( scope, scope_id, path, value ) VALUES
-        ( 'default', '0', 'system/full_page_cache/caching_application', '2' )
-         ON DUPLICATE KEY UPDATE value = 2
-    ;"
+    "${DEVBOX_ROOT}/scripts/guest/update_magento_config" 'system/full_page_cache/caching_application' '2'
 else
     status "Updating Magento database to not use varnish FPC"
-    mysql -u"root" -p"123123q" -h"magento2-mysql" -D magento -e "INSERT INTO core_config_data
-        ( scope, scope_id, path, value ) VALUES
-        ( 'default', '0', 'system/full_page_cache/caching_application', '1' )
-         ON DUPLICATE KEY UPDATE value = 1
-    ;"
+    "${DEVBOX_ROOT}/scripts/guest/update_magento_config" 'system/full_page_cache/caching_application' '1'
 fi
 
 decrementNestingLevel

tests/CeFromComposerNoNfsTest.sh

@@ -64,6 +64,8 @@ function testCeFromComposerNoNfs()
     assertRedisCacheIsEnabled
 
     executeExtendedCommonAssertions
+
+    assertMainPageServedByBuiltInCache
 }
 
 ## Call and Run all Tests

tests/EeLinkingTest.sh

@@ -51,9 +51,9 @@ See logs in ${logs_dir}"
 
 ## Tests
 
-function testNoCustomConfigBasicTest()
+function testEeLinking()
 {
-    current_config_name="no_custom_config"
+    current_config_name="ce_shallow_clone_no_nfs"
     current_codebase="ee"
     installEnvironment
 #    assertVarnishDisabled
@@ -70,6 +70,11 @@ function testNoCustomConfigBasicTest()
     assertMagentoSwitchToCeWorks
     assertMagentoFrontendAccessible
     assertMagentoEditionIsCE
+
+    assertMainPageServedByVarnish
+
+    assertVarnishDisablingWorks
+    assertVarnishEnablingWorks
 }
 
 ## Call and Run all Tests

tests/NoCustomConfigBasicTest.sh

@@ -51,9 +51,9 @@ See logs in ${logs_dir}"
 
 ## Tests
 
-function testNoCustomConfigBasicTest()
+function testNoCustomConfigBasic()
 {
-    current_config_name="no_custom_config"
+    current_config_name="ce_shallow_clone_no_nfs"
     current_codebase="ce"
     installEnvironment
 #    assertVarnishDisabled

tests/_files/ce23_with_sample_data_mysql_search_no_nfs_config.yaml

@@ -20,8 +20,10 @@ repository_url:
   ee: ""
   additional_repositories:
     - "git@github.com:magento/magento2-sample-data.git::2.3"
-  # - "git@github.com:magento/magento2-sample-data-ee.git"
-  # - "git@github.com:magento/magento2b2b.git"
+    # - "git@github.com:magento/magento2-sample-data-ee.git"
+    # - "git@github.com:magento/magento2b2b.git"
+  # If set to 1, shallow clone will be used to speed up the project initialization
+  shallow_clone: 0
 
 guest:
   # [To apply changes: init_project.sh -f] NFS will be used for folder synchronization on *nix and OSX hosts by default.

tests/_files/ce_shallow_clone_no_nfs_config.yaml

@@ -0,0 +1,71 @@
+# [To apply changes: init_project.sh -fc] Possible values: git, composer
+checkout_source_from: "git"
+
+composer_project:
+  # Current section used only if 'checkout_source_from' is set to 'composer'
+
+  # [To apply changes: init_project.sh -fc]
+  # Custom version can be provided by using '={version}' appended to repo name. E.g. name: "magento/project-community-edition=2.2.0". Otherwise, default version is used
+  name: "magento/project-community-edition"
+  # Make sure to specify valid keys for this repository in etc/composer/auth.json
+  url: "https://repo.magento.com"
+
+repository_url:
+  # Current section used only if 'checkout_source_from' is set to 'git'
+
+  # [To apply changes: init_project.sh -fc]
+  # git@github.com:magento/magento2ce.git OR custom one. Use '::' to specify a specific branch, e.g: git@github.com:magento/magento2.git::2.1
+  ce: "git@github.com:magento/magento2.git"
+  # git@github.com:magento/magento2ee.git OR custom one
+  ee: ""
+  additional_repositories:
+    # [To apply changes: m-switch-to-ce -f OR m-switch-to-ee -f]
+    # - "git@github.com:magento/magento2-sample-data.git"
+    # - "git@github.com:magento/magento2-sample-data-ee.git"
+    # - "git@github.com:magento/magento2b2b.git"
+  # If set to 1, shallow clone will be used to speed up the project initialization
+  shallow_clone: 1
+
+guest:
+  # [To apply changes: init_project.sh -f] NFS will be used for folder synchronization on *nix and OSX hosts by default.
+  use_nfs: 0
+  # [To apply changes: init_project.sh -f] The placeholder IP will be replaced with auto-detected value, unless modified manually before execution of "init_project.sh" script.
+  nfs_server_ip: "0.0.0.0"
+  # [To apply changes: devbox reload] Default is 2Gb, around 3Gb is necessary to run functional tests.
+  memory: 2048
+  # Recommended number of CPUs is 2
+  cpus: 1
+  ip_address: "192.168.10.2"
+  forwarded_ssh_port: 3000
+
+environment:
+  # [To apply changes: devbox reload] Valid versions: 5.6, 7.0, 7.1, 7.2
+  php_version: "7.0"
+  composer_prefer_source: 0
+  # [To apply changes: m-reinstall OR m-varnish enable/disable]
+  use_varnish: 1
+  # [To apply changes: m-reinstall] Possible values: mysql, elasticsearch
+  search_engine: "elasticsearch"
+
+magento:
+  # [To apply changes: m-switch-to-ce -f OR m-switch-to-ee -f] Generate customer (customer@example.com:123123qQ), category, simple product, configurable product after successful Magento installation
+  generate_basic_data: 1
+  # [To apply changes: init_project.sh -f]
+  host_name: "magento2.devbox2"
+  # [To apply changes: m-reinstall]
+  admin_frontname: "admin"
+  language: "en_US"
+  timezone: "America/Chicago"
+  currency: "USD"
+  admin_user: "admin"
+  admin_password: "123123q"
+  # [Changes applied on m-clear-cache] Available options: developer, production, default
+  mode: "developer"
+
+debug:
+  # [Changes applied on m-clear-cache] Enable template path and block name hints on storefront
+  magento_storefront: 0
+  # [Changes applied on m-clear-cache] Enable template path hints in the admin panel
+  magento_admin: 0
+  # [Changes applied immediately] Enable detailed output from all scripts provided by current devbox project
+  devbox_project: 0

tests/include/assertions.sh

@@ -197,34 +197,44 @@ function assertVarnishEnablingWorks()
 
     cd "${devbox_dir}"
     bash m-varnish enable >>${current_log_file_path} 2>&1
-    assertVarnishEnabled
     assertMagentoFrontendAccessible
+    assertMainPageServedByVarnish
 }
 
-function assertVarnishEnabled()
+function assertMainPageServedByVarnish()
 {
-    echo "${blue}## assertVarnishEnabled${regular}"
-    echo "## assertVarnishEnabled" >>${current_log_file_path}
-
-    listenerOnPort80="$(devbox ssh -c 'sudo netstat -tulnp | grep ':::80[^0-9]'')"
-    assertTrue 'Varnish is not listening on port 80' '[[ ${listenerOnPort80} =~ varnishd ]]'
-
-    listenerOnPort8080="$(devbox ssh -c 'sudo netstat -tulnp | grep ':::8080[^0-9]'')"
-    assertTrue 'Apache is not listening on port 8080' '[[ ${listenerOnPort8080} =~ apache2 ]]'
+    echo "${blue}## assertMainPageServedByVarnish${regular}"
+    echo "## assertMainPageServedByVarnish" >>${current_log_file_path}
 
-    varnish_version="$(devbox ssh -c 'varnishd -V')"
-    version_pattern="4\.[0-9]+\.[0-9]+"
-    assertTrue 'Varnish version should be 4.x.x' '[[ ${varnish_version} =~ ${version_pattern} ]]'
+    curl "${current_magento_base_url}" > /dev/null 2>&1
+    is_cache_hit="$(curl "${current_magento_base_url}" -v 2>&1 | grep "X-Magento-Cache-Debug: HIT")"
+    if [[ ${is_cache_hit} == '' ]]; then
+        fail 'Main page is not served from cache (or Magento is not in Developer mode)'
+    else
+        # "Age:" header is available when Varnish is on, however it is not available when built-cache is enabled
+        cache_tags_available="$(curl "${current_magento_base_url}" -v 2>&1 | grep "Age:")"
+        if [[ ${cache_tags_available} == '' ]]; then
+            fail 'Built-in cache seems to be enabled instead of Varnish'
+        fi
+    fi
 }
 
-function assertMainPageServedByVarnish()
+function assertMainPageServedByBuiltInCache()
 {
-    echo "${blue}## assertMainPageServedByVarnish${regular}"
-    echo "## assertMainPageServedByVarnish" >>${current_log_file_path}
+    echo "${blue}## assertMainPageServedByBuiltInCache${regular}"
+    echo "## assertMainPageServedByBuiltInCache" >>${current_log_file_path}
 
     curl "${current_magento_base_url}" > /dev/null 2>&1
-    is_varnish_hit="$(curl "${current_magento_base_url}" -v 2>&1 | grep "X-Magento-Cache-Debug: HIT")"
-    assertFalse 'Main page is not served by Varnish (or Magento is not in Developer mode)' '[[ ${is_varnish_hit} == '' ]]'
+    is_cache_hit="$(curl "${current_magento_base_url}" -v 2>&1 | grep "X-Magento-Cache-Debug: HIT")"
+    if [[ ${is_cache_hit} == '' ]]; then
+        fail 'Main page is not served from cache (or Magento is not in Developer mode)'
+    else
+        # "Age:" header is available when Varnish is on, however it is not available when built-cache is enabled
+        cache_tags_available="$(curl "${current_magento_base_url}" -v 2>&1 | grep "Age:")"
+        if [[ ${cache_tags_available} != '' ]]; then
+            fail 'Varnish cache seems to be enabled instead of built-in cache'
+        fi
+    fi
 }
 
 function assertVarnishDisablingWorks()
@@ -235,21 +245,8 @@ function assertVarnishDisablingWorks()
     cd "${devbox_dir}"
     bash m-varnish disable >>${current_log_file_path} 2>&1
 
-    assertVarnishDisabled
     assertMagentoFrontendAccessible
-}
-
-function assertVarnishDisabled()
-{
-    echo "${blue}## assertVarnishDisabled${regular}"
-    echo "## assertVarnishDisabled" >>${current_log_file_path}
-
-    cd "${devbox_dir}"
-    listenerOnPort80="$(devbox ssh -c 'sudo netstat -tulnp | grep ':::80[^0-9]'')"
-    assertTrue 'Apache is not listening on port 80' '[[ ${listenerOnPort80} =~ apache2 ]]'
-
-    listenerOnPort8080="$(devbox ssh -c 'sudo netstat -tulnp | grep ':::8080[^0-9]'')"
-    assertFalse 'Varnish shout not listen on port 8080' '[[ ${listenerOnPort8080} =~ varnishd ]]'
+    assertMainPageServedByBuiltInCache
 }
 
 function assertNoErrorsInLogs()