This project contains code that you can use to build your own test suite.
The suite can be used to test parts of the site infrastructure that are important for whatever your Analytics/Marketing team ads on top of it using the tag management system.
Running this suite as a regression tests effectively prevents dev from pulling the ground from under analytics feet.
The Site Infrastructure Tests framework is based on cucumber/gherkin. Check https://docs.cucumber.io/guides/10-minute-tutorial/#write-a-scenario for a quick introduction.
Tests, called "features" in cucumber/gherkin, describe how we expect the site to react to loading a page or actions happening on the page.
In order to use the framework on your site, you provide features.
This framework is based on puppeteer, so after you cloned it and ran npm install, you can directly run npm run test.
While gherkin describes the formal language used in features, the semantics of the statements still has to be coded. The following list shows all statements / tests that are currently available.
Here is an example of a feature file:
@analytics
Feature: Minimal tracking infrastructure on the home page is ok
As an analytics team
I want the home page to contain tracking infrastructure
so I can track data and analyse it
@trackingdata
Scenario: The home page loads and all data is present
Given the page "https://www.jan-exner.de/" is loaded
And we wait for 1 second
Then there is a data layer element called "digitalData.page.pageInfo.language"
And the "digitalData.page.pageInfo.pageName" data layer element is "Home"
@trackingtools
Scenario: The home page loads and contains DTM
Given the page "https://www.jan-exner.de/" is loaded
Then DTM is present
And the DTM library is "satelliteLib-f898bce177301e894492bf685fe6bc28e8eca6c5"This example contains 1 feature called "Minimal tracking infrastructure on the home page is ok", as well as 2 scenarios.
Each scenario is describes with "Given", "When" (optional), and "Then" phrases. "And" phrases do exactly what you'd think they'd do.
The "The home page loads and contains DTM" scenario first loads the page on "https://www.jan-exner.de/", then runs two checks: "DTM is present" and "the DTM library is ...".
The feature passes the test if all "Then" statements in all scenarios are successful.
When you write features, you can use the following statements.
These statements can be used to setup for the tests in the scenarios. You must use at least the page "<URL>" is loaded.
Causes the framework to load the page behind that URL in Chrome.
Example: the page "https://www.jan-exner.de/" is loaded
Causes the framework to execute the Javascript code inside Chrome.
Example: the snippet "window.jan=true;" is executed
Causes the framework to wait a number of seconds before working any further.
Example: we wait for 1 second
Example: we wait for 5 seconds
Statements that are not related to any specific tools.
Causes the framework to test whether there is a data layer element with the name given.
Example: there is a data layer element called "digitalData.page.pageInfo.pageName"
Example: the data layer element "digitalData.page.pageInfo.pageName" exists
Note: both phrases test the exact same thing
Note: this can be used to test the presence of any Javascript variable
Causes the framework to compare the value of the data element with the value given.
Example: the "digitalData.page.pageInfo.pageName" data layer element is "Home"
Causes the framework to compare the value of the data element with the value given. Same as above but for numeric values.
Example: the "digitalData.page.pageInfo.ageInDays" data layer element is 5
Causes the framework to test whether the DOM element of the given name/path exists.
Example: the DOM element "button.cartAdd" exists
Causes the framework to test whether the DOM element of the given name/path exists n times.
Example: the DOM element "button.cartAdd" exists 2 times
Causes the framework to execute the Javascript snippet given and check whether it evaluates to true.
Example: the snippet "window.jan" evaluates to true
There are statements that are directly associated with Adobe Experience Cloud solutions.
Causes the framework to test whether Launch, by Adobe is being loaded on the page
Example: Launch is present
Causes the framework to test whether DTM is being loaded on the page
Example: DTM is present
Causes the framework to test whether the DTM library is the correct one.
Example: the DTM library is "satelliteLib-f898bce177301e894492bf685fe6bc28e8eca6c5"
Causes the framework to test whether the Experience Cloud ID Service (aka Marketing Cloud ID Service, aka Visitor ID Service)
Example: MCID is present
Example: ECID is present
Example: Experience Cloud ID Service is present
Note that the three examples are equivalent and will result in the exact same test.
Causes the framework to test whether Experience Cloud ID Service is at least of a specific version.
Example: MCID version is "2.1.0" or later
Example: ECID version is "2.1.0" or later
Example Experience Cloud ID Service version is "2.1.0" or later
Note that the three examples are equivalent and will result in the exact same test.
Causes the framework to test whether Experience Cloud ID Service is not too recent.
Example: MCID version is below "2.4"
Example: ECID version is below "2.4"
Example: Experience Cloud ID Service version is below "2.4"
Note that the three examples are equivalent and will result in the exact same test.
Causes the framework to test whether Analytics is loaded into the page.
Example: AA is present
Example: Adobe Analytics is present
Note that the two examples are equivalent and will result in the exact same test.
Causes the framework to test whether Analytics is at least of a specific version.
Example: AA version is "2.4.0" or later
Example: Adobe Analytics version is "2.4.0" or later
Note that the two examples are equivalent and will result in the exact same test.
Causes the framework to test whether the Analytics library is of the given type ("AppMeasurement", "legacy", or "none")
Example: AA lib type is "AppMeasurement"
Example: Adobe Analytics lib type is "AppMeasurement"
Note that the two examples are equivalent and will result in the exact same test.
Causes the framework to test whether a tracking call for Analytics was sent.
Example: an AA call has been sent for report suite "jexnerprod"
Example: an Adobe Analytics call has been sent for report suite "jexnerprod"
Note that the two examples are equivalent and will result in the exact same test.
Causes the framework to check the latest Adobe Analytics tracking call for a specific key (or "variable") and test that the value is correct.
Example: latest AA|Adobe Analytics tracking call contains key "v3" with value "default"
Causes the framework to test whether Target has been loaded.
Example: AT is present
Example Adobe Target is present
Note that the two examples are equivalent and will result in the exact same test.
Causes the framework to test whether Target is at least of a specific version.
Example: AT version version is "1.0" or later
Example: Adobe Target version is "1.0" or later
Note that the two examples are equivalent and will result in the exact same test.
Causes the framework to test whether the Target library is of the given type ("at.js", "legacy", or "none")
Example: AT lib type is "at.js"
Example: Adobe Target lib type is "at.js"
Note that the two examples are equivalent and will result in the exact same test.
Causes the framework to test whether a Target mbox of the given name exists on the page.
Example: AT mbox named "target-global-mbox" exists
Example: Adobe Target mbox named "target-global-mbox" exists
Some statements test other tools, too.
Causes the framework to test whether jQuery has been loaded into the page.
Example:
Causes the framework to test whether jQuery is at least of a specific version
Example: the jQuery version is "2.0.0" or later
Causes the framework to test whether the jQuery version is not too recent.
Example: the jQuery version is below "3"
Causes the framework to test whether Google Tag Manager is loaded into the page.
Example: GTM is present
Causes the framework to test whether Ensighten Manage is loaded into the page.
Example: Ensighten Manage is present
Causes the framework to test whether Tealium IQ is loaded into the page.
Example: Tealium IQ is present
Causes the framework to retrieve the window.performance.timing object from the browser and to log it into the 'timings.csv' file.
Example: log Browser Performance Timing