docusaurus/packages/docusaurus-1.x/lib/server/__tests__/blog.test.js

/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */
const path = require('path');
const fs = require('fs-extra');
const blog = require('../blog');
const metadataUtils = require('../metadataUtils');
const {replaceAssetsLink} = require('../utils.js');

const siteConfig = {
  baseUrl: '/',
};

const testFile = path.join(
  __dirname,
  '__fixtures__',
  '2018-08-17-docusaurus.md',
);

fs.existsSync = jest.fn().mockReturnValue(true);

describe('getMetadata', () => {
  test('file does not exist', () => {
    fs.existsSync.mockReturnValueOnce(null);
    expect(
      blog.getMetadata('/this/path/does-not-exist/', siteConfig),
    ).toBeNull();
  });

  test('null/undefined', () => {
    expect(blog.getMetadata(null, siteConfig)).toBeNull();
    expect(blog.getMetadata(undefined, siteConfig)).toBeNull();
  });

  test('blog file', () => {
    const metadata = blog.getMetadata(testFile, siteConfig);
    expect(metadata).toMatchSnapshot();
    expect(metadata).not.toBeNull();
    expect(metadata).toHaveProperty('id');
    expect(metadata).toHaveProperty('path');
    expect(metadata).toHaveProperty('content');
  });
});

describe('fileToUrl', () => {
  test('invalid file path', () => {
    expect(blog.fileToUrl(null)).toBeNull();
    expect(blog.fileToUrl(undefined)).toBeNull();
    expect(blog.fileToUrl(true)).toBeNull();
    fs.existsSync.mockReturnValueOnce(null);
    expect(blog.fileToUrl('2018-03-02-this-does-not-exist.md')).toBeNull();
  });

  test('valid filepath', () => {
    expect(blog.fileToUrl(testFile)).toEqual('2018/08/17/docusaurus.html');
  });
});

describe('urlToSource', () => {
  test('invalid url path', () => {
    expect(blog.urlToSource(null)).toBeNull();
    expect(blog.urlToSource(undefined)).toBeNull();
    expect(blog.urlToSource(true)).toBeNull();
  });
  test('valid url path', () => {
    expect(blog.urlToSource(`${blog.fileToUrl(testFile)}`)).toEqual(
      '2018-08-17-docusaurus.md',
    );
    expect(blog.urlToSource('2018/03/04/test-name-lol.html')).toEqual(
      '2018-03-04-test-name-lol.md',
    );
  });
});

describe('replaceAssetsLink', () => {
  test('transform document with valid assets link', () => {
    const doc1 = fs.readFileSync(
      path.join(__dirname, '__fixtures__', 'doc1.md'),
      'utf8',
    );
    const rawContent1 = metadataUtils.extractMetadata(doc1).rawContent;
    const content1 = replaceAssetsLink(rawContent1, '/blog');
    expect(content1).toMatchSnapshot();
    expect(content1).toContain('![image1](/blog/assets/image1.png)');
    expect(content1).toContain('![image2](/blog/assets/image2.jpg)');
    expect(content1).toContain('![image3](/blog/assets/image3.gif)');
    expect(content1).toContain('![image4](assets/image4.bmp)');
    expect(content1).not.toContain('![image1](assets/image1.png)');
    expect(content1).not.toContain('![image2](assets/image2.jpg)');
    expect(content1).not.toContain('![image3](assets/image3.gif)');
    expect(content1).not.toContain('![image4](/blog/assets/image4.bmp)');
    expect(content1).not.toEqual(rawContent1);
  });

  test('does not transform document without valid assets link', () => {
    const doc2 = fs.readFileSync(
      path.join(__dirname, '__fixtures__', 'doc2.md'),
      'utf8',
    );
    const rawContent2 = metadataUtils.extractMetadata(doc2).rawContent;
    const content2 = replaceAssetsLink(rawContent2, '/blog');
    expect(content2).toMatchSnapshot();
    expect(content2).not.toContain('![image1](/blog/assets/image1.png)');
    expect(content2).not.toContain('![image2](/blog/assets/image2.jpg)');
    expect(content2).not.toContain('![image3](/blog/assets/image3.gif)');
    expect(content2).toEqual(rawContent2);
  });
});