@salesforcedevs/sfdocs-e2e 1.0.2 → 1.0.3-alpha

package/README.md

@@ -106,6 +106,7 @@ npx sfdocs-e2e --baseUrl http://localhost:8080
 # Choose a config suite
 npx sfdocs-e2e --config portal
 npx sfdocs-e2e --config static-portal
+npx sfdocs-e2e --config static-dsc-portal
 npx sfdocs-e2e --config search
 
 # Help

package/bin/run-e2e.js

@@ -56,6 +56,7 @@ Environment Variables:
 const configName = parsedArgs.config || 'static-portal';
 const configMap = {
     'static-portal': 'static-portal-wdio.conf.js',
+    'static-dsc-portal': 'static-dsc-portal-wdio.conf.js',
     portal: 'portal-wdio.conf.js',
     search: 'search-wdio.conf.js',
 };

package/common-wdio.conf.js

@@ -80,6 +80,7 @@ const defaultCapabilities = [
     },
 ];
 const defaultMochaTimeoutInterval = 200000; //increased timeout because its taking more time to load for references file
+const isGithubActions = Boolean(process.env.GITHUB_ACTIONS);
 
 // Resolve ChromeDriver version: env var → Chrome for Testing API lookup → latest
 const resolvedChromeDriverVersion = resolveChromedriverVersion();
@@ -181,15 +182,25 @@ exports.config = {
     // Services take over a specific job you don't want to take care of. They enhance
     // your test setup with almost no effort. Unlike plugins, they don't add new
     // commands. Instead, they hook themselves up into the test process.
-    services: [
-        [
-            'selenium-standalone',
-            {
-                installArgs: { drivers }, // drivers to install
-                args: { drivers }, // drivers to use
-            },
-        ],
-    ],
+    services: isGithubActions
+        ? []
+        : [
+              [
+                  'selenium-standalone',
+                  {
+                      installArgs: { drivers }, // drivers to install
+                      args: { drivers }, // drivers to use
+                  },
+              ],
+          ],
+    ...(isGithubActions
+        ? {
+              protocol: 'http',
+              hostname: '127.0.0.1',
+              port: 4444,
+              path: '/wd/hub',
+          }
+        : {}),
 
     // Framework you want to run your specs with.
     // The following are supported: Mocha, Jasmine, and Cucumber

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforcedevs/sfdocs-e2e",
-  "version": "1.0.2",
+  "version": "1.0.3-alpha",
   "description": "E2E test suite for SFDocs static portal pages (SSG)",
   "license": "ISC",
   "bin": {
@@ -16,6 +16,7 @@
     "test:e2e": "TS_NODE_TRANSPILE_ONLY=true TS_NODE_PROJECT=./tsconfig.json wdio wdio.conf.js",
     "test:e2e:portal": "TS_NODE_TRANSPILE_ONLY=true TS_NODE_PROJECT=./tsconfig.json wdio portal-wdio.conf.js",
     "test:e2e:static:portal": "TS_NODE_TRANSPILE_ONLY=true TS_NODE_PROJECT=./tsconfig.json wdio static-portal-wdio.conf.js",
+    "test:e2e:static:dsc:portal": "TS_NODE_TRANSPILE_ONLY=true TS_NODE_PROJECT=./tsconfig.json wdio static-dsc-portal-wdio.conf.js",
     "test:scope-search": "TS_NODE_TRANSPILE_ONLY=true TS_NODE_PROJECT=./tsconfig.json wdio search-wdio.conf.js",
     "release:alpha:e2e": "f() { bash bin/publish.sh $1 --tag alpha; }; f",
     "release:e2e": "f() { bash bin/publish.sh $1; }; f"

package/src/content-repo/specs/homepage.test.ts

@@ -13,7 +13,7 @@ describe('Homepage', () => {
     it('should show the expected number of projects', async () => {
         const projectCards = await HomePage.projectCards;
 
-        expect(projectCards.length).toEqual(18);
+        expect(projectCards.length).toEqual(19);
     });
 
     // it('is accessible', () => {

package/src/shared/specs/guides.test.ts

@@ -11,7 +11,7 @@ describe('Guides layout> ', () => {
         await page.waitPageLoad();
     });
 
-    layoutTest(page);
+    layoutTest(page, 'doc-header');
 
     it('should have Guides tab as active', async () => {
         const selectedHeaderNavItem = await page.getActiveNavTab();

package/src/shared/specs/layout-tests.ts

@@ -18,7 +18,9 @@ export default function layoutTest(givenPage: Page, headerTag = 'dx-global-heade
             const header = await $(headerTag);
             await header.waitForDisplayed();
             expect(await header.isDisplayed()).toBeTruthy();
-            expect(await header.getText()).toContain('Developers');
+            if (headerTag === 'dx-global-header') {
+                expect(await header.getText()).toContain('Developers');
+            }
         });
 
         it.skip('should display global search box', async () => {

package/src/shared/specs/overview.test.ts

@@ -11,7 +11,7 @@ describe('/docs/api overview page > ', () => {
         (await $('dx-section')).waitForDisplayed();
     });
 
-    layoutTest(page);
+    layoutTest(page, 'doc-header');
 
     it('should show Overview, Guides and Reference tabs and have Overview as active', async () => {
         const overviewPageSection = await $('>>>.content-type-overview');

package/src/shared/specs/reference.test.ts

@@ -9,9 +9,10 @@ describe('API Pages', () => {
         beforeEach(async () => {
             referencePage = new ReferencePage('/docs/commerce/test-cc-orders-api/references');
             referencePage.open();
+            await referencePage.waitForSpecBasedReferencePageLoad();
         });
 
-        layoutTest(referencePage);
+        layoutTest(referencePage, 'doc-header');
 
         it('should have the right title', async () => {
             expect(browser).toHaveTitle('TEST Commerce Cloud Orders APIs');
@@ -85,6 +86,7 @@ describe('Reference Versioning', () => {
     beforeEach(async () => {
         referencePage = new ReferencePage('/docs/c-cart-apis/references/ref1?meta=Summary');
         referencePage.open();
+        await referencePage.waitForSpecBasedReferencePageLoad();
     });
 
     it('should check for the presence of version picker dropdown', async () => {
@@ -133,7 +135,7 @@ describe('Reference Versioning', () => {
 
         await versionOptions[1].waitForClickable();
         await versionOptions[1].click();
-        await browser.pause(1000);
+        await referencePage.waitForSpecBasedReferencePageLoad();
 
         const apiTitle = await (await $('>>>div.api-title span')).getText();
         const apiVersion = await (await $('>>>p.version span')).getText();

package/static-dsc-portal-wdio.conf.js

@@ -0,0 +1,49 @@
+/**
+ * WebdriverIO configuration for E2E tests on Static Portal Pages (SSG) on DSC
+ *
+ * Prerequisites:
+ * 1. Build static pages: yarn build:static:portal
+ * 2. Start static server: yarn start:static:portal (runs on port 3000)
+ * 3. Run tests: yarn test:e2e:static:portal
+ */
+const BASE_CONFIG = require('./common-wdio.conf');
+
+exports.config = {
+    ...BASE_CONFIG.config,
+    // Static pages are served on port 3000 by default; override via E2E_BASE_URL env var
+    baseUrl: process.env.E2E_BASE_URL || 'http://localhost:3000',
+
+    // Reuse the same portal specs - static pages have the same URL structure
+    specs: ['./src/content-repo/specs/**/*.test.ts', './src/shared/specs/*.test.ts'],
+
+    // Exclude tests that require dynamic server features or pages not in static build
+    exclude: [
+        './src/content-repo/specs/homepage.test.ts',
+        './src/content-repo/specs/guideAndReferencePage.test.ts',
+        './src/content-repo/specs/sitemap.test.ts',
+    ],
+
+    // Output directory for static test results
+    outputDir: './_results_/static-portal',
+
+    // Override reporters to use separate output directories
+    reporters: [
+        'spec',
+        [
+            require('wdio-video-reporter'),
+            {
+                saveAllVideos: false,
+                videoSlowdownMultiplier: 3,
+                outputDir: './_results_/static-portal/videos',
+            },
+        ],
+        [
+            'allure',
+            {
+                outputDir: './_results_/static-portal/allure-raw',
+                disableWebdriverStepsReporting: true,
+                disableWebdriverScreenshotsReporting: false,
+            },
+        ],
+    ],
+};