@salesforcedevs/sfdocs-e2e 1.0.5 → 1.0.6-alpha

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforcedevs/sfdocs-e2e",
-  "version": "1.0.5",
+  "version": "1.0.6-alpha",
   "description": "E2E test suite for SFDocs static portal pages (SSG)",
   "license": "ISC",
   "bin": {
@@ -31,6 +31,7 @@
     "@wdio/spec-reporter": "^7.19.0",
     "allure-commandline": "2.20.1",
     "got": "^11.8.3",
+    "gray-matter": "~4.0.3",
     "ts-node": "^10.9.1",
     "typescript": "^4.1.3",
     "wdio-video-reporter": "^3.4.0",

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

@@ -0,0 +1,148 @@
+import GuidePage from '../pageobjects/guide.page';
+import * as fs from 'fs';
+import * as path from 'path';
+import * as matter from 'gray-matter';
+
+let page: GuidePage;
+let liquidEnabled = false;
+
+describe('Liquid Template Rendering', () => {
+    before(async () => {
+        try {
+            // Check frontmatter to determine if Liquid is enabled
+            const contentPath = path.resolve(
+                __dirname,
+                '../../../../example-repository/content/en-us/liquid-project/guides/liquid-quickstart.md',
+            );
+
+            if (fs.existsSync(contentPath)) {
+                const fileContent = fs.readFileSync(contentPath, 'utf-8');
+                const { data: frontmatter } = matter(fileContent);
+                liquidEnabled = frontmatter?.liquid?.enabled === true;
+            }
+
+            page = new GuidePage('/docs/liquid-project/guide/liquid-quickstart.html');
+            page.open();
+            await page.waitPageLoad();
+        } catch (e) {
+            liquidEnabled = false;
+        }
+    });
+
+    beforeEach(async () => {
+        if (liquidEnabled) {
+            page = new GuidePage('/docs/liquid-project/guide/liquid-quickstart.html');
+            page.open();
+            await page.waitPageLoad();
+        }
+    });
+
+    it('Should render Liquid variables from frontmatter and data.yaml', async function () {
+        if (!liquidEnabled) {
+            this.skip();
+        }
+
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+
+        expect(text.includes('GitHub for writers')).toBeTruthy();
+        expect(text.includes('Hello from data.yaml')).toBeTruthy();
+
+        const html = await content.getHTML();
+        expect(html.includes('{{ topic }}')).toBeFalsy();
+        expect(html.includes('{{ data.greeting }}')).toBeFalsy();
+    });
+
+    it('Should render included templates from shared directory', async function () {
+        if (!liquidEnabled) {
+            this.skip();
+        }
+
+        const content = await $('>>>doc-content-layout');
+        const html = await content.getHTML();
+
+        expect(html.includes('AccountId') || html.includes('Type:')).toBeTruthy();
+        expect(html.includes('Properties:')).toBeTruthy();
+        expect(html.includes('Special Access Rules')).toBeTruthy();
+        expect(html.includes('{% include')).toBeFalsy();
+    });
+
+    it('Should render loops over data arrays', async function () {
+        if (!liquidEnabled) {
+            this.skip();
+        }
+
+        const content = await $('>>>doc-content-layout');
+        const html = await content.getHTML();
+        const text = await content.getText();
+
+        expect(text.includes('create()')).toBeTruthy();
+        expect(text.includes('query()')).toBeTruthy();
+        expect(text.includes('update()')).toBeTruthy();
+
+        const listItems = await content.$$('li');
+        expect(listItems.length).toBeGreaterThan(5);
+
+        expect(html.includes('{% for')).toBeFalsy();
+        expect(html.includes('{%- for')).toBeFalsy();
+        expect(html.includes('{% endfor')).toBeFalsy();
+    });
+
+    it('Should not process Liquid syntax inside code blocks', async function () {
+        if (!liquidEnabled) {
+            this.skip();
+        }
+
+        const content = await $('>>>doc-content-layout');
+        const html = await content.getHTML();
+        const codeBlock = await content.$('code');
+
+        expect(await codeBlock.isExisting()).toBeTruthy();
+
+        const codeHtml = await codeBlock.getHTML();
+        expect(codeHtml.includes('{{ data.greeting }}')).toBeTruthy();
+        expect(codeHtml.includes('{{ topic }}')).toBeTruthy();
+        expect(codeHtml.includes('{% for item in items %}')).toBeTruthy();
+
+        const text = await content.getText();
+        expect(text.includes('Visit')).toBeTruthy();
+    });
+
+    it('Should render capture blocks from included files', async function () {
+        if (!liquidEnabled) {
+            this.skip();
+        }
+
+        const content = await $('>>>doc-content-layout');
+        const html = await content.getHTML();
+        const text = await content.getText();
+
+        expect(text.includes('My Heading')).toBeTruthy();
+        expect(text.includes('This is content for ID1.')).toBeTruthy();
+        expect(text.includes('Another Heading')).toBeTruthy();
+        expect(text.includes('Content for ID2.')).toBeTruthy();
+
+        expect(html.includes('{%- capture')).toBeFalsy();
+        expect(html.includes('{% endcapture')).toBeFalsy();
+        expect(html.includes('{{ id1 }}')).toBeFalsy();
+        expect(html.includes('{{ id2 }}')).toBeFalsy();
+    });
+
+    it('Should not process Liquid when frontmatter has liquid.enabled as false', async function () {
+        if (!liquidEnabled) {
+            this.skip();
+        }
+
+        const disabledPage = new GuidePage(
+            '/docs/liquid-project/guide/liquid-learning-resources.html',
+        );
+        disabledPage.open();
+        await disabledPage.waitPageLoad();
+
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+
+        expect(text.includes('Liquid Resource')).toBeTruthy();
+        expect(text.includes('Liquid is a templating language supported in SFDocs')).toBeTruthy();
+    });
+});