test/sponsors-test.js

// Copyright (c) 2020, Compiler Explorer Authors
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//     * Redistributions of source code must retain the above copyright notice,
//       this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

import {loadSponsorsFromString, parse} from '../lib/sponsors';

import {should} from './utils';

describe('Sponsors', () => {
    it('should expand names to objects', () => {
        parse('moo').name.should.eq('moo');
    });
    it('should handle just names', () => {
        parse({name: 'moo'}).name.should.eq('moo');
    });
    it('should default empty params', () => {
        const obj = parse('moo');
        should.equal(obj.description, undefined);
        should.equal(obj.url, undefined);
        obj.onclick.should.eq('');
        should.equal(obj.img, undefined);
        should.equal(obj.icon, undefined);
        should.equal(obj.icon_dark, undefined);
        obj.topIcon.should.be.false;
        obj.sideBySide.should.be.false;
        should.equal(obj.statsId, undefined);
    });
    it('should pass through descriptions', () => {
        parse({name: 'moo', description: 'desc'}).description.should.eq('desc');
    });
    it('should pass through icons', () => {
        parse({name: 'bob', icon: 'icon'}).icon.should.eq('icon');
    });
    it('should pick icons over images', () => {
        parse({name: 'bob', img: 'img', icon: 'icon'}).icon.should.eq('icon');
    });
    it('should pick icons if not img', () => {
        parse({name: 'bob', img: 'img'}).icon.should.eq('img');
    });
    it('should pick dark icons if specified', () => {
        parse({name: 'bob', icon: 'icon', icon_dark: 'icon_dark'}).icon_dark.should.eq('icon_dark');
    });
    it('should handle topIcons', () => {
        parse({name: 'bob', topIcon: true}).topIcon.should.be.true;
    });
    it('should handle clicks', () => {
        parse({
            name: 'bob',
            url: 'https://some.host/click',
        }).onclick.should.eq('window.onSponsorClick("https://some.host/click");');
    });

    it('should load a simple example', () => {
        const sample = loadSponsorsFromString(`
---
levels:
  - name: Patreon Legends
    description: 'These amazing people have pledged at the highest level of support. Huge thanks to these fine folks:'
    sponsors:
      - name: Kitty Kat
        url: https://meow.meow
      - name: Aardvark
        url: https://ard.vark
  - name: Patreons
    description: 'Thanks to all my patrons:'
    sponsors:
      - Lovely
      - People
      - Yay
`);
        sample.should.not.be.null;
        sample.levels.length.should.eq(2);
        sample.levels[0].name.should.eq('Patreon Legends');
        sample.levels[1].name.should.eq('Patreons');
    });

    it('should sort sponsors by name', () => {
        const peeps = loadSponsorsFromString(`
---
levels:
  - name: a
    description: d
    sponsors:
    - D
    - C
    - A
    - B
        `).levels[0].sponsors;
        peeps.map(sponsor => sponsor.name).should.deep.equals(['A', 'B', 'C', 'D']);
    });
    it('should sort sponsors by priority then name', () => {
        const peeps = loadSponsorsFromString(`
---
levels:
  - name: a
    description: d
    sponsors:
    - name: D
      priority: 100
    - name: C
      priority: 50
    - name: B
      priority: 50
        `).levels[0].sponsors;
        peeps
            .map(sponsor => {
                return {name: sponsor.name, priority: sponsor.priority};
            })
            .should.deep.equals([
                {name: 'D', priority: 100},
                {name: 'B', priority: 50},
                {name: 'C', priority: 50},
            ]);
    });

    it('should pick out the top level icons', () => {
        const icons = loadSponsorsFromString(`
---
levels:
  - name: a
    description: d
    sponsors:
    - name: one
      img: pick_me
      topIcon: true
    - name: two
      img: not_me
  - name: another level
    description: more
    sponsors:
    - name: three
      img: not_me_either
      topIcon: false
    - name: four
      img: pick_me_also
      topIcon: true
    - name: five
      topIcon: true
        `).icons;
        icons.map(s => s.name).should.deep.equals(['one', 'four']);
    });
});