docusaurus/v1/lib/server/__tests__/routing.test.js

/**
 * Copyright (c) 2017-present, Facebook, Inc.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */
const routing = require('../routing.js');

describe('Blog routing', () => {
  const blogRegex = routing.blog({baseUrl: '/'});
  const blogRegex2 = routing.blog({baseUrl: '/react/'});

  test('valid blog', () => {
    expect('/blog/test.html').toMatch(blogRegex);
    expect('/react/blog/test.html').toMatch(blogRegex2);
  });

  test('invalid blog', () => {
    expect('/react/blog/test.html').not.toMatch(blogRegex);
    expect('/blog/test.html').not.toMatch(blogRegex2);
  });

  test('assets not classified as blog', () => {
    expect('/blog/assets/any.png').not.toMatch(blogRegex);
    expect('/react/blog/assets/any.png').not.toMatch(blogRegex2);
  });

  test('docs not classified as blog', () => {
    expect('/docs/en/blog.html').not.toMatch(blogRegex);
    expect('/docs/en/blog/blog.html').not.toMatch(blogRegex);
    expect('/react/docs/en/blog.html').not.toMatch(blogRegex2);
    expect('/react/docs/en/blog/blog.html').not.toMatch(blogRegex2);
  });
});

describe('Docs routing', () => {
  const docsRegex = routing.docs({baseUrl: '/', docsUrl: 'docs'});
  const docsRegex2 = routing.docs({baseUrl: '/reason/', docsUrl: 'docs'});

  test('valid docs', () => {
    expect('/docs/en/test.html').toMatch(docsRegex);
    expect('/reason/docs/en/test.html').toMatch(docsRegex2);
  });

  test('invalid docs', () => {
    expect('/reason/docs/en/test.html').not.toMatch(docsRegex);
    expect('/docs/en/test.html').not.toMatch(docsRegex2);
  });

  test('assets not classified as docs', () => {
    expect('/docs/en/notvalid.png').not.toMatch(docsRegex);
    expect('/reason/docs/en/notvalid.png').not.toMatch(docsRegex2);
  });

  test('blog not classified as docs', () => {
    expect('/blog/docs.html').not.toMatch(docsRegex);
    expect('/blog/docs/docs.html').not.toMatch(docsRegex);
    expect('/reason/blog/docs.html').not.toMatch(docsRegex2);
    expect('/reason/blog/docs/docs.html').not.toMatch(docsRegex2);
  });
});

describe('Dot routing', () => {
  const dotRegex = routing.dotfiles();

  test('valid url with dot after last slash', () => {
    expect('/docs/en/test.23').toMatch(dotRegex);
    expect('/robots.hai.2').toMatch(dotRegex);
    expect('/blog/1.2.3').toMatch(dotRegex);
    expect('/this.is.my').toMatch(dotRegex);
  });

  test('html file is invalid', () => {
    expect('/docs/en.html').not.toMatch(dotRegex);
    expect('/users.html').not.toMatch(dotRegex);
    expect('/blog/asdf.html').not.toMatch(dotRegex);
    expect('/end/1234/asdf.html').not.toMatch(dotRegex);
    expect('/test/lol.huam.html').not.toMatch(dotRegex);
  });

  test('extension-less url is not valid', () => {
    expect('/reason/test').not.toMatch(dotRegex);
    expect('/asdff').not.toMatch(dotRegex);
    expect('/blog/asdf.ghg/').not.toMatch(dotRegex);
    expect('/end/1234.23.55/').not.toMatch(dotRegex);
  });
});

describe('Feed routing', () => {
  const feedRegex = routing.feed({baseUrl: '/'});
  const feedRegex2 = routing.feed({baseUrl: '/reason/'});

  test('valid feed url', () => {
    expect('/blog/atom.xml').toMatch(feedRegex);
    expect('/blog/feed.xml').toMatch(feedRegex);
    expect('/reason/blog/atom.xml').toMatch(feedRegex2);
    expect('/reason/blog/feed.xml').toMatch(feedRegex2);
  });

  test('invalid feed url', () => {
    expect('/blog/blog/feed.xml').not.toMatch(feedRegex);
    expect('/blog/test.xml').not.toMatch(feedRegex);
    expect('/reason/blog/atom.xml').not.toMatch(feedRegex);
    expect('/reason/blog/feed.xml').not.toMatch(feedRegex);
    expect('/blog/feed.xml/test.html').not.toMatch(feedRegex);
    expect('/blog/atom.xml').not.toMatch(feedRegex2);
    expect('/blog/feed.xml').not.toMatch(feedRegex2);
    expect('/reason/blog/test.xml').not.toMatch(feedRegex2);
    expect('/reason/blog/blog/feed.xml').not.toMatch(feedRegex2);
    expect('/reason/blog/blog/atom.xml').not.toMatch(feedRegex2);
  });

  test('not a feed', () => {
    expect('/blog/atom').not.toMatch(feedRegex);
    expect('/reason/blog/feed').not.toMatch(feedRegex2);
  });
});

describe('Extension-less url routing', () => {
  const noExtRegex = routing.noExtension();

  test('valid no extension url', () => {
    expect('/test').toMatch(noExtRegex);
    expect('/reason/test').toMatch(noExtRegex);
  });

  test('url with file extension', () => {
    expect('/robots.txt').not.toMatch(noExtRegex);
    expect('/reason/robots.txt').not.toMatch(noExtRegex);
    expect('/docs/en/docu.html').not.toMatch(noExtRegex);
    expect('/reason/robots.html').not.toMatch(noExtRegex);
    expect('/blog/atom.xml').not.toMatch(noExtRegex);
    expect('/reason/sitemap.xml').not.toMatch(noExtRegex);
    expect('/main.css').not.toMatch(noExtRegex);
    expect('/reason/custom.css').not.toMatch(noExtRegex);
  });
});

describe('Page routing', () => {
  const pageRegex = routing.page({baseUrl: '/', docsUrl: 'docs'});
  const pageRegex2 = routing.page({baseUrl: '/reason/', docsUrl: 'docs'});

  test('valid page url', () => {
    expect('/index.html').toMatch(pageRegex);
    expect('/en/help.html').toMatch(pageRegex);
    expect('/reason/index.html').toMatch(pageRegex2);
    expect('/reason/ro/users.html').toMatch(pageRegex2);
  });

  test('docs not considered as page', () => {
    expect('/docs/en/test.html').not.toMatch(pageRegex);
    expect('/reason/docs/en/test.html').not.toMatch(pageRegex2);
  });

  test('blog not considered as page', () => {
    expect('/blog/index.html').not.toMatch(pageRegex);
    expect('/reason/blog/index.html').not.toMatch(pageRegex2);
  });

  test('not a page', () => {
    expect('/yangshun.jpg').not.toMatch(pageRegex);
    expect('/reason/endilie.png').not.toMatch(pageRegex2);
  });
});

describe('Sitemap routing', () => {
  const sitemapRegex = routing.sitemap({baseUrl: '/'});
  const sitemapRegex2 = routing.sitemap({baseUrl: '/reason/'});

  test('valid sitemap url', () => {
    expect('/sitemap.xml').toMatch(sitemapRegex);
    expect('/reason/sitemap.xml').toMatch(sitemapRegex2);
  });

  test('invalid sitemap url', () => {
    expect('/reason/sitemap.xml').not.toMatch(sitemapRegex);
    expect('/reason/sitemap.xml.html').not.toMatch(sitemapRegex);
    expect('/sitemap/sitemap.xml').not.toMatch(sitemapRegex);
    expect('/reason/sitemap/sitemap.xml').not.toMatch(sitemapRegex);
    expect('/sitemap.xml').not.toMatch(sitemapRegex2);
  });

  test('not a sitemap', () => {
    expect('/sitemap').not.toMatch(sitemapRegex);
    expect('/reason/sitemap').not.toMatch(sitemapRegex2);
  });
});