Merge pull request Webperf-se#279 from Webperf-se/issue-244

Issue 281

Author: 7h3Rabbit

.github/workflows/regression-test-http.yml

@@ -14,8 +14,12 @@ jobs:
     strategy:
             matrix:
                 os: [ubuntu-latest, windows-latest]
-                config: ['review_show_improvements_only=True']
+                config: ['review_show_improvements_only=True,sitespeed_use_docker=False,csp_only=False', 'review_show_improvements_only=True,sitespeed_use_docker=False,csp_only=True']
                 version: [21]
+                include:
+                  - os: ubuntu-latest
+                    config: 'review_show_improvements_only=True,sitespeed_use_docker=True'
+                    version: 21
     steps:
     - name: Check out repository code
       uses: actions/checkout@v4
@@ -26,6 +30,21 @@ jobs:
         architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified
     - name: Setup dependencies using pip
       run: pip install -r requirements.txt
+    - name: Setup Node.js (v4 version 20.x)
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20.x'
+    - if: ${{ matrix.os == 'ubuntu-latest' }}
+      shell: bash
+      name: Setup Google Chrome browser (ONLY used for Sitespeed)
+      run: |
+        wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add - 
+        sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
+        sudo apt-get update
+        sudo apt-get --only-upgrade install google-chrome-stable
+        google-chrome --version
+    - name: Setup Sitespeed.io npm package (ONLY used for Sitespeed)
+      run: npm install sitespeed.io
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: Setup config (using SAMPLE-config.py as config.py) - LINUX
       run: python .github/workflows/verify_result.py -c ${{ matrix.config }}

SAMPLE-config.py

@@ -33,6 +33,9 @@
 # Tells sitespeed if we should use it as a docker image or a npm package
 sitespeed_use_docker = True
 
+# Tells sitespeed max timeout for website calls
+sitespeed_timeout = 300
+
 # how many iterations of Sitespeed.io requests would you like? Has to be at least 2 not to fail
 sitespeed_iterations = 2
 
@@ -51,12 +54,18 @@
 # GITHUB API Token, used for calls to github API (to remove call limit)
 github_api_key = None
 
+# Tell tests to use detailed report (when available) for review and rating
+use_detailed_report = False
+
+# Tells HTTP test to ignore everything except the CSP part (great if you run it against sitemap to get CSP recommendation)
+csp_only = False
+
+# Tells webperf_core to use following DNS Server for dns lookups
+dns_server = '8.8.8.8'
+
 # Tell software test to use stealth mode or not, default is 'True'
 software_use_stealth = True
 
-# Tell software test to use detailed report for review and rating
-software_use_detailed_report = False
-
 # Tell software test the path to where you have repo of: https://github.com/github/advisory-database
 # Used to find CVE:s for npm packages
 software_github_adadvisory_database_path = None

docs/tests/http.md

@@ -10,8 +10,9 @@ Add small description of what this test is.
 
 Checks if HTTP requests are redirected to HTTPS.
 A common misstake is to forget to force this redirect for root domain if www. subdomain is used.
+Also checks for HSTS support.
 
-### TLS and SSL support
+### TLS support
 
 Checks for Secure encryption support
 * Checks for TLS 1.3 support
@@ -20,22 +21,24 @@ Checks for Secure encryption support
 Checks for Insecure encryption support
 * Checks for TLS 1.1 support
 * Checks for TLS 1.0 support
-* Checks for SSL 3.0 support (Require host modification)
-* Checks for SSL 2.0 support (Require host modification)
 * Checks if certificate used match website domain
 
 ### HTTP protocol support
 
 * Checks for HTTP/1.1 support
 * Checks for HTTP/2 support
-* Checks for HTTP/3 support ( Tested using https://http3check.net/ )
-* Checks for Quick support ( Tested using https://http3check.net/ )
+* Checks for HTTP/3 support
 
 ### IPv6 and IPv4 support
 
 * Checks for IPv4 support
 * Checks for IPv6 support
 
+### Content Security Policy (CSP) support
+
+* Checks for CSP support
+* Gives CSP recommendation if it could improve 0.75 or more in rating
+
 ## How are rating being calculated?
 
 This section has not been written yet.
@@ -60,10 +63,33 @@ Read more on the [general page for github actions](../getting-started-github-act
 ### Setup Locally
 
 * Follow [general local setup steps for this repository](../getting-started-local.md)
-* Checking for HTTP/3 and Quick support require access to and from https://http3check.net/ to the url you want to test.
+* It is highly recommended to set `cache_when_possible` to `True` and to set `cache_time_delta` to
+* It is highly recommended to set `cache_time_delta` to at least 12 hours (Fail to do so may result in banning of service like github).
+
+#### Using NPM package
+
+* Download and install Node.js (v1 version 14.x)
+* Download and install Google Chrome browser
+* Download and install Mozilla Firefox browser
+* Install SiteSpeed NPM package ( `npm install sitespeed.io` )
+* Set `sitespeed_use_docker = False` in your `config.py`
+
+##### Windows Specific
+
+* Allow node to connect through Windows firewall
+
+#### Using Docker image
 
+* Make sure Docker command is globally accessible on your system.
+* Set `sitespeed_use_docker = True` in your `config.py`
 
 ## FAQ
 
-No frequently asked questions yet :)
+### How to get CSP recommendation for website
+Did you know you can get a CSP recommendation for all/part of your website?
+Do the following and webperf_core will give a CSP recommendation for more than 1 page.
+* Set `csp_only = True` in your `config.py`
+* Point webperf_core to your sitemap or your own list pages you want to test.
 
+Example, below will take first 25 items from sitemap:
+`python default.py -r -t 21 --input-take=25 -i https://nimbleinitiatives.com/sitemap.xml`

docs/tests/software.md

@@ -133,7 +133,7 @@ TODO: Add links to blogs and articles showing how to remove info regarding what
 * We recommend you to make use `software_use_stealth` is set to `True`, change this to `False` at your own risk.
 * It is highly recommended to set `cache_when_possible` to `True` and to set `cache_time_delta` to
 * It is highly recommended to set `cache_time_delta` to at least 12 hours (Fail to do so may result in banning of service like github).
-* If you want to get more detailed information, please set `software_use_detailed_report` to `True`.
+* If you want to get more detailed information, please set `use_detailed_report` to `True`.
 * Depending on your preference, follow below NPM package or Docker image steps below.
 
 #### Using NPM package