Merge pull request #889 from Webperf-se/cache-folder

Added support for using custom cache folder
Webperf-se · Jan 24, 2025 · 927392f · 927392f
2 parents 8f573e0 + d128931
commit 927392f
Show file tree

Hide file tree

Showing 19 changed files with 47 additions and 47 deletions.
diff --git a/.github/workflows/regression-test-404.yml b/.github/workflows/regression-test-404.yml
@@ -65,10 +65,10 @@ jobs:
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: RUNNING TEST - LINUX
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://webperf.se/2f08c/finns-det-en-sida/pa-den-har-adressen/testanrop/?webperf-core-test-2 -o data/testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting tests.sitespeed.xvfb=true --setting tests.page-not-found.override-url=false --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://webperf.se/2f08c/finns-det-en-sida/pa-den-har-adressen/testanrop/?webperf-core-test-2 -o data/testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting tests.sitespeed.xvfb=true --setting tests.page-not-found.override-url=false --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github/workflows/verify_result.py -t ${{ matrix.version }}
     - if: ${{ matrix.os == 'windows-latest' }}
       name: RUNNING TEST - WINDOWS
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://webperf.se/2f08c/finns-det-en-sida/pa-den-har-adressen/testanrop/?webperf-core-test-2 -o data\testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting tests.page-not-found.override-url=false --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://webperf.se/2f08c/finns-det-en-sida/pa-den-har-adressen/testanrop/?webperf-core-test-2 -o data\testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting tests.page-not-found.override-url=false --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github\workflows\verify_result.py -t ${{ matrix.version }}
diff --git a/.github/workflows/regression-test-a11y-statement.yml b/.github/workflows/regression-test-a11y-statement.yml
@@ -69,10 +69,10 @@ jobs:
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: RUNNING TEST - LINUX
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://msb.se?webperf-core-test-26 -o data/testresult-${{ matrix.version }}.json --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://msb.se?webperf-core-test-26 -o data/testresult-${{ matrix.version }}.json --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github/workflows/verify_result.py -t ${{ matrix.version }}
     - if: ${{ matrix.os == 'windows-latest' }}
       name: RUNNING TEST - WINDOWS
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://msb.se?webperf-core-test-26 -o data\testresult-${{ matrix.version }}.json --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://msb.se?webperf-core-test-26 -o data\testresult-${{ matrix.version }}.json --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github\workflows\verify_result.py -t ${{ matrix.version }}
diff --git a/.github/workflows/regression-test-css.yml b/.github/workflows/regression-test-css.yml
@@ -71,10 +71,10 @@ jobs:
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: RUNNING TEST - LINUX
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-7 -o data/testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting tests.sitespeed.xvfb=true --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-7 -o data/testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting tests.sitespeed.xvfb=true --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github/workflows/verify_result.py -t ${{ matrix.version }}
     - if: ${{ matrix.os == 'windows-latest' }}
       name: RUNNING TEST - WINDOWS
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-7 -o data\testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-7 -o data\testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github\workflows\verify_result.py -t ${{ matrix.version }}
diff --git a/.github/workflows/regression-test-energy-efficiency.yml b/.github/workflows/regression-test-energy-efficiency.yml
@@ -69,10 +69,10 @@ jobs:
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: RUNNING TEST - LINUX
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-22 -o data/testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting tests.sitespeed.xvfb=true --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-22 -o data/testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting tests.sitespeed.xvfb=true --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github/workflows/verify_result.py -t ${{ matrix.version }}
     - if: ${{ matrix.os == 'windows-latest' }}
       name: RUNNING TEST - WINDOWS
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-22 -o data\testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-22 -o data\testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github\workflows\verify_result.py -t ${{ matrix.version }}
diff --git a/.github/workflows/regression-test-google-lighthouse-based.yml b/.github/workflows/regression-test-google-lighthouse-based.yml
@@ -54,12 +54,12 @@ jobs:
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: RUNNING TEST - LINUX
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-${{ matrix.version }} -o data/testresult-${{ matrix.version }}.json --setting tests.sitespeed.xvfb=true --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-${{ matrix.version }} -o data/testresult-${{ matrix.version }}.json --setting tests.sitespeed.xvfb=true --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github/workflows/verify_result.py -t ${{ matrix.version }}
     - if: ${{ matrix.os == 'windows-latest' }}
       name: RUNNING TEST - WINDOWS
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-${{ matrix.version }} -o data\testresult-${{ matrix.version }}.json --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-${{ matrix.version }} -o data\testresult-${{ matrix.version }}.json --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github\workflows\verify_result.py -t ${{ matrix.version }}
     - if: ${{ matrix.os == 'ubuntu-latest' && matrix.version == 1 }}
       name: RUNNING TEST - LINUX

diff --git a/.github/workflows/regression-test-html.yml b/.github/workflows/regression-test-html.yml
@@ -71,10 +71,10 @@ jobs:
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: RUNNING TEST - LINUX
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-6 -o data/testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting tests.sitespeed.xvfb=true --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-6 -o data/testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting tests.sitespeed.xvfb=true --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github/workflows/verify_result.py -t ${{ matrix.version }}
     - if: ${{ matrix.os == 'windows-latest' }}
       name: RUNNING TEST - WINDOWS
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-6 -o data\testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-6 -o data\testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github\workflows\verify_result.py -t ${{ matrix.version }}
diff --git a/.github/workflows/regression-test-http.yml b/.github/workflows/regression-test-http.yml
@@ -69,10 +69,10 @@ jobs:
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: RUNNING TEST - LINUX
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-21 -o data/testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting tests.sitespeed.xvfb=true --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-21 -o data/testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting tests.sitespeed.xvfb=true --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github/workflows/verify_result.py -t ${{ matrix.version }}
     - if: ${{ matrix.os == 'windows-latest' }}
       name: RUNNING TEST - WINDOWS
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-21 -o data\testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-21 -o data\testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github\workflows\verify_result.py -t ${{ matrix.version }}
diff --git a/.github/workflows/regression-test-lint-css.yml b/.github/workflows/regression-test-lint-css.yml
@@ -71,20 +71,20 @@ jobs:
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: RUNNING TEST - LINUX (no-errors)
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-27-no-errors -o data/testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting tests.sitespeed.xvfb=true --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-27-no-errors -o data/testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting tests.sitespeed.xvfb=true --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github/workflows/verify_result.py -t ${{ matrix.version }}
     - if: ${{ matrix.os == 'windows-latest' }}
       name: RUNNING TEST - WINDOWS (no-errors)
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-27-no-errors -o data\testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-27-no-errors -o data\testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github\workflows\verify_result.py -t ${{ matrix.version }}
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: RUNNING TEST - LINUX (with-errors)
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-27-with-errors -o data/testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting tests.sitespeed.xvfb=true --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-27-with-errors -o data/testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting tests.sitespeed.xvfb=true --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github/workflows/verify_result.py -t ${{ matrix.version }}
     - if: ${{ matrix.os == 'windows-latest' }}
       name: RUNNING TEST - WINDOWS (with-errors)
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-27-with-errors -o data\testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-27-with-errors -o data\testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github\workflows\verify_result.py -t ${{ matrix.version }}
diff --git a/.github/workflows/regression-test-software.yml b/.github/workflows/regression-test-software.yml
@@ -66,10 +66,10 @@ jobs:
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: RUNNING TEST - LINUX
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-25-no-errors -o data/testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting tests.sitespeed.xvfb=true --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-25-no-errors -o data/testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting tests.sitespeed.xvfb=true --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github/workflows/verify_result.py -t ${{ matrix.version }}
     - if: ${{ matrix.os == 'windows-latest' }}
       name: RUNNING TEST - WINDOWS
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-25-no-errors -o data\testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-25-no-errors -o data\testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github\workflows\verify_result.py -t ${{ matrix.version }}
diff --git a/.github/workflows/regression-test-tracking.yml b/.github/workflows/regression-test-tracking.yml
@@ -125,10 +125,10 @@ jobs:
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: RUNNING TEST - LINUX
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-23 -o data/testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting tests.sitespeed.xvfb=true --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-23 -o data/testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting tests.sitespeed.xvfb=true --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github/workflows/verify_result.py -t ${{ matrix.version }}
     - if: ${{ matrix.os == 'windows-latest' }}
       name: RUNNING TEST - WINDOWS
       run: |
-         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-23 -o data\testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting tests.sitespeed.cache.folder=unittests
+         python default.py -t ${{ matrix.version }} -r -u https://webperf.se?webperf-core-test-23 -o data\testresult-${{ matrix.version }}.json --setting ${{ matrix.config }} --setting general.cache.use=true --setting general.cache.max-age=5256000 --setting general.cache.folder=unittests
          python .github\workflows\verify_result.py -t ${{ matrix.version }}
diff --git a/defaults/settings.json b/defaults/settings.json
@@ -16,6 +16,7 @@
         "useragent": "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:133.0) Gecko/20100101 Firefox/133.0",
         "cache": {
             "use": false,
+            "folder": "cache",
             "max-age": 60
         }
     },
@@ -41,10 +42,7 @@
             "timeout": 30,
             "mobile": false,
             "iterations": 2,
-            "xvfb": false,
-            "cache": {
-                "folder": "cache"
-            }
+            "xvfb": false
         },
         "software": {
             "advisory": {

diff --git a/docs/settings-json.md b/docs/settings-json.md
@@ -90,6 +90,11 @@ resulting in less requests and strain on the url you are testing.
 
 See `general.cache.max-age` setting to determine how long.
 
+### general.cache.folder `(Default = "cache")`
+This tells webperf-core what foldername to use for cache.
+This take no effect unless `general.cache.use` is set to `true`.
+
+
 ### general.cache.max-age `(Default = 60 minutes)`
 This tells webperf-core how long to use cached resources in minutes.
 This take no effect unless `general.cache.use` is set to `true`.

diff --git a/engines/sitespeed_result.py b/engines/sitespeed_result.py
@@ -4,6 +4,7 @@
 from urllib.parse import urlparse
 import re
 from engines.utils import use_item
+from helpers.setting_helper import get_config
 
 def get_url_from_file_content(input_filename):
     """
@@ -90,4 +91,5 @@ def read_sites(hostname_or_argument, input_skip, input_take):
     list: A list of sites where each site is represented as a
           list containing the path to the HAR file and the URL.
     """
-    return read_sites_from_directory('cache', hostname_or_argument, input_skip, input_take)
+    cache_folder = get_config('general.cache.folder')
+    return read_sites_from_directory(cache_folder, hostname_or_argument, input_skip, input_take)