feat: added test for build-rss.js

scripts/build-rss.js

@@ -16,60 +16,63 @@ function clean(s) {
 }
 
 module.exports = function rssFeed(type, title, desc, outputPath) {
+  try {
+    const posts = getAllPosts()[`${type}`]
+      .sort((i1, i2) => {
+        const i1Date = new Date(i1.date)
+        const i2Date = new Date(i2.date)
 
-  const posts = getAllPosts()[`${type}`]
-    .sort((i1, i2) => {
-      const i1Date = new Date(i1.date)
-      const i2Date = new Date(i2.date)
+        if (i1.featured && !i2.featured) return -1
+        if (!i1.featured && i2.featured) return 1
+        return i2Date - i1Date
+      })
 
-      if (i1.featured && !i2.featured) return -1
-      if (!i1.featured && i2.featured) return 1
-      return i2Date - i1Date
-    })
+    const base = 'https://www.asyncapi.com'
+    const tracking = '?utm_source=rss';
 
-  const base = 'https://www.asyncapi.com'
-  const tracking = '?utm_source=rss';
+    const feed = {}
+    const rss = {}
+    rss['@version'] = '2.0'
+    rss["@xmlns:atom"] = 'http://www.w3.org/2005/Atom'
+    rss.channel = {}
+    rss.channel.title = title
+    rss.channel.link = `${base}/${outputPath}`
+    rss.channel["atom:link"] = {}
+    rss.channel["atom:link"]["@rel"] = 'self'
+    rss.channel["atom:link"]["@href"] = rss.channel.link
+    rss.channel["atom:link"]["@type"] = 'application/rss+xml'
+    rss.channel.description = desc
+    rss.channel.language = 'en-gb';
+    rss.channel.copyright = 'Made with :love: by the AsyncAPI Initiative.';
+    rss.channel.webMaster = '[email protected] (AsyncAPI Initiative)'
+    rss.channel.pubDate = new Date().toUTCString()
+    rss.channel.generator = 'next.js'
+    rss.channel.item = []
 
-  const feed = {}
-  const rss = {}
-  rss['@version'] = '2.0'
-  rss["@xmlns:atom"] = 'http://www.w3.org/2005/Atom'
-  rss.channel = {}
-  rss.channel.title = title
-  rss.channel.link = `${base}/${outputPath}`
-  rss.channel["atom:link"] = {}
-  rss.channel["atom:link"]["@rel"] = 'self'
-  rss.channel["atom:link"]["@href"] = rss.channel.link
-  rss.channel["atom:link"]["@type"] = 'application/rss+xml'
-  rss.channel.description = desc
-  rss.channel.language = 'en-gb';
-  rss.channel.copyright = 'Made with :love: by the AsyncAPI Initiative.';
-  rss.channel.webMaster = '[email protected] (AsyncAPI Initiative)'
-  rss.channel.pubDate = new Date().toUTCString()
-  rss.channel.generator = 'next.js'
-  rss.channel.item = []
-
-  for (let post of posts) {
-    const link = `${base}${post.slug}${tracking}`;
-    const item = { title: post.title, description: clean(post.excerpt), link, category: type, guid: { '@isPermaLink': true, '': link }, pubDate: new Date(post.date).toUTCString() }
-    if (post.cover) {
-      const enclosure = {};
-      enclosure["@url"] = base+post.cover;
-      enclosure["@length"] = 15026; // dummy value, anything works
-      enclosure["@type"] = 'image/jpeg';
-      if (typeof enclosure["@url"] === 'string') {
-        let tmp = enclosure["@url"].toLowerCase();
-        if (tmp.indexOf('.png')>=0) enclosure["@type"] = 'image/png';
-        if (tmp.indexOf('.svg')>=0) enclosure["@type"] = 'image/svg+xml';
-        if (tmp.indexOf('.webp')>=0) enclosure["@type"] = 'image/webp';
+    for (let post of posts) {
+      const link = `${base}${post.slug}${tracking}`;
+      const item = { title: post.title, description: clean(post.excerpt), link, category: type, guid: { '@isPermaLink': true, '': link }, pubDate: new Date(post.date).toUTCString() }
+      if (post.cover) {
+        const enclosure = {};
+        enclosure["@url"] = base + post.cover;
+        enclosure["@length"] = 15026; // dummy value, anything works
+        enclosure["@type"] = 'image/jpeg';
+        if (typeof enclosure["@url"] === 'string') {
+          let tmp = enclosure["@url"].toLowerCase();
+          if (tmp.indexOf('.png') >= 0) enclosure["@type"] = 'image/png';
+          if (tmp.indexOf('.svg') >= 0) enclosure["@type"] = 'image/svg+xml';
+          if (tmp.indexOf('.webp') >= 0) enclosure["@type"] = 'image/webp';
+        }
+        item.enclosure = enclosure;
       }
-      item.enclosure = enclosure;
+      rss.channel.item.push(item)
     }
-    rss.channel.item.push(item)
-  }
 
-  feed.rss = rss
+    feed.rss = rss
 
-  const xml = json2xml.getXml(feed,'@','',2)
-  fs.writeFileSync(`./public/${outputPath}`, xml, 'utf8')
-};
+    const xml = json2xml.getXml(feed, '@', '', 2)
+    fs.writeFileSync(`./public/${outputPath}`, xml, 'utf8')
+  } catch (err) {
+    throw new Error(`Failed to generate RSS feed: ${err.message}`);
+  }
+};

tests/build-rss.test.js

@@ -0,0 +1,81 @@
+const fs = require('fs');
+const path = require('path');
+const rssFeed = require('../scripts/build-rss');
+const { mockRssData, title, type, desc, outputPath } = require('./fixtures/rssData');
+
+jest.mock('../config/posts.json', () => mockRssData, { virtual: true });
+
+describe('rssFeed', () => {
+  const testOutputDir = path.join(__dirname, '..', 'public', 'test-output');
+
+  beforeEach(() => {
+    fs.mkdirSync(testOutputDir, { recursive: true });
+  });
+
+  afterEach(() => {
+    if (fs.existsSync(testOutputDir)) {
+      fs.readdirSync(testOutputDir).forEach(file => {
+        fs.unlinkSync(path.join(testOutputDir, file));
+      });
+      fs.rmdirSync(testOutputDir);
+    }
+  });
+
+  it('should generate RSS feed and write to file', () => {
+    rssFeed(type, title, desc, outputPath);
+
+    const filePath = path.join(__dirname, '..', 'public', outputPath);
+    expect(fs.existsSync(filePath)).toBe(true);
+    const fileContent = fs.readFileSync(filePath, 'utf8');
+    expect(fileContent).toContain('<rss version="2.0"');
+    expect(fileContent).toContain('<title>Test Blog RSS</title>');
+  });
+
+  it('should sort posts by date and featured status', () => {
+    rssFeed(type, title, desc, outputPath);
+
+    const filePath = path.join(__dirname, '..', 'public', outputPath);
+    const fileContent = fs.readFileSync(filePath, 'utf8');
+
+    const itemTitles = fileContent.match(/<title>(.*?)<\/title>/g);
+    expect(itemTitles[1]).toContain('Test Post 1');
+    expect(itemTitles[2]).toContain('Test Post 2');
+    expect(itemTitles[3]).toContain('PNG Post');
+    expect(itemTitles[4]).toContain('SVG Post');
+    expect(itemTitles[5]).toContain('WebP Post');
+  });
+
+  it('should add enclosure for posts with cover image', () => {
+    rssFeed(type, title, desc, outputPath);
+
+    const filePath = path.join(__dirname, '..', 'public', outputPath);
+    const fileContent = fs.readFileSync(filePath, 'utf8');
+
+    expect(fileContent).toContain('<enclosure url="https://www.asyncapi.com/img/test-cover.jpg"');
+    expect(fileContent).toContain('type="image/jpeg"');
+  });
+
+  it('should set correct enclosure type based on image extension', () => {
+    rssFeed(type, title, desc, outputPath);
+
+    const filePath = path.join(__dirname, '..', 'public', outputPath);
+    const fileContent = fs.readFileSync(filePath, 'utf8');
+
+    expect(fileContent).toContain('<enclosure url="https://www.asyncapi.com/img/test-cover.png"');
+    expect(fileContent).toContain('type="image/png"');
+    expect(fileContent).toContain('<enclosure url="https://www.asyncapi.com/img/test-cover.svg"');
+    expect(fileContent).toContain('type="image/svg+xml"');
+    expect(fileContent).toContain('<enclosure url="https://www.asyncapi.com/img/test-cover.webp"');
+    expect(fileContent).toContain('type="image/webp"');
+  });
+
+  it('should throw error when write operation fails', () => {
+    const outputPath = "invalid/path"
+    try{
+      rssFeed(type, title, desc, outputPath)
+    }catch(err){
+      expect(err.message).toMatch(/ENOENT|EACCES/);
+    }
+  });
+
+});

tests/fixtures/rssData.js

@@ -0,0 +1,50 @@
+const mockRssData = {
+    blog: [
+        {
+            title: 'Test Post 1',
+            slug: '/blog/test-post-1',
+            excerpt: 'This is a test post',
+            date: '2024-07-07',
+            featured: true,
+            cover: '/img/test-cover.jpg'
+        },
+        {
+            title: 'Test Post 2',
+            slug: '/blog/test-post-2',
+            excerpt: 'This is another test post',
+            date: '2024-07-06',
+            featured: false
+        },
+        {
+            title: 'PNG Post',
+            slug: '/blog/png-post',
+            excerpt: 'This is a post with PNG image',
+            date: '2024-07-05',
+            featured: false,
+            cover: '/img/test-cover.png'
+        },
+        {
+            title: 'SVG Post',
+            slug: '/blog/svg-post',
+            excerpt: 'This is a post with SVG image',
+            date: '2024-07-04',
+            featured: false,
+            cover: '/img/test-cover.svg'
+        },
+        {
+            title: 'WebP Post',
+            slug: '/blog/webp-post',
+            excerpt: 'This is a post with WebP image',
+            date: '2024-07-03',
+            featured: false,
+            cover: '/img/test-cover.webp'
+        }
+    ]
+};
+
+const type = 'blog';
+const title = 'Test Blog RSS';
+const desc = 'Test blog RSS feed';
+const outputPath = 'test-output/blog.xml';
+
+module.exports = { mockRssData, title, type, desc, outputPath };