markdown.test.tsx

/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 *
 * Any modifications Copyright OpenSearch Contributors. See
 * GitHub history for details.
 */

/*
 * Licensed to Elasticsearch B.V. under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch B.V. licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import React from 'react';
import { shallow } from 'enzyme';

import { Markdown } from './markdown';

test('render', () => {
  const component = shallow(<Markdown />);
  expect(component).toMatchSnapshot();
});

test('should never render html tags', () => {
  const component = shallow(
    <Markdown markdown="<div>I may be dangerous if rendered as html</div>" />
  );
  expect(component).toMatchSnapshot();
});

test('should render links with parentheses correctly', () => {
  const component = shallow(
    <Markdown markdown="[link](https://example.com/foo/bar?group=(()filters:!t))" />
  );
  expect(component.render().find('a').prop('href')).toBe(
    'https://example.com/foo/bar?group=(()filters:!t)'
  );
});

test('should add `noreferrer` and `nooopener` to unknown links in new tabs', () => {
  const component = shallow(
    <Markdown
      openLinksInNewTab={true}
      markdown="[link](https://example.com/foo/bar?group=(()filters:!t))"
    />
  );
  expect(component.render().find('a').prop('rel')).toBe('noopener noreferrer');
});

// TODO: In @elastic/eui/src/services/url.ts it is unknown if it does not match the regex
// TODO: [RENAMEME] if we fork EUI and update that regex then we can include this test again
xtest('should only add `nooopener` to known links in new tabs', () => {
  const component = shallow(
    <Markdown openLinksInNewTab={true} markdown="[link](https://opensearch.org/cool/path" />
  );
  expect(component.render().find('a').prop('rel')).toBe('noopener');
});

describe('props', () => {
  const markdown = 'I am *some* [content](https://en.wikipedia.org/wiki/Content) with `markdown`';

  test('markdown', () => {
    const component = shallow(<Markdown markdown={markdown} />);
    expect(component).toMatchSnapshot();
  });

  test('openLinksInNewTab', () => {
    const component = shallow(<Markdown markdown={markdown} openLinksInNewTab={true} />);
    expect(component).toMatchSnapshot();
  });

  test('whiteListedRules', () => {
    const component = shallow(
      <Markdown markdown={markdown} whiteListedRules={['backticks', 'emphasis']} />
    );
    expect(component).toMatchSnapshot();
  });

  test('should update markdown when openLinksInNewTab prop change', () => {
    const component = shallow(<Markdown markdown={markdown} openLinksInNewTab={false} />);
    expect(component.render().find('a').prop('target')).not.toBe('_blank');
    component.setProps({ openLinksInNewTab: true });
    expect(component.render().find('a').prop('target')).toBe('_blank');
  });

  test('should update markdown when whiteListedRules prop change', () => {
    const md = '*emphasis* `backticks`';
    const component = shallow(
      <Markdown markdown={md} whiteListedRules={['emphasis', 'backticks']} />
    );
    expect(component.render().find('em')).toHaveLength(1);
    expect(component.render().find('code')).toHaveLength(1);
    component.setProps({ whiteListedRules: ['backticks'] });
    expect(component.render().find('code')).toHaveLength(1);
    expect(component.render().find('em')).toHaveLength(0);
  });
});