Ghost/core/test/unit/utils/blog-icon_spec.js

// jshint unused: false
var should = require('should'),
    sinon = require('sinon'),
    _ = require('lodash'),
    settingsCache = require('../../../server/settings/cache'),
    configUtils = require('../../utils/configUtils'),
    testUtils = require('../../utils'),
    config = configUtils.config,
    path = require('path'),
    rewire = require('rewire'),

    // stuff we are testing
    blogIcon = rewire('../../../server/utils/blog-icon'),

    sandbox = sinon.sandbox.create();

describe('Blog Icon', function () {
    before(function () {
        configUtils.restore();
    });

    afterEach(function () {
        configUtils.restore();
        sandbox.restore();
        rewire('../../../server/utils/blog-icon');
    });

    describe('getIconUrl', function () {
        it('custom uploaded ico blog icon', function () {
            sandbox.stub(settingsCache, 'get').withArgs('icon').returns('/content/images/2017/04/my-icon.ico');
            blogIcon.getIconUrl().should.eql('/favicon.ico');
        });

        it('custom uploaded png blog icon', function () {
            sandbox.stub(settingsCache, 'get').withArgs('icon').returns('/content/images/2017/04/my-icon.png');
            blogIcon.getIconUrl().should.eql('/favicon.png');
        });

        it('default ico blog icon', function () {
            blogIcon.getIconUrl().should.eql('/favicon.ico');
        });
        describe('absolute URL', function () {
            it('custom uploaded ico blog icon', function () {
                configUtils.set({url: 'http://my-ghost-blog.com/'});
                sandbox.stub(settingsCache, 'get').withArgs('icon').returns('/content/images/2017/04/my-icon.ico');
                blogIcon.getIconUrl(true).should.eql('http://my-ghost-blog.com/favicon.ico');
            });

            it('custom uploaded png blog icon', function () {
                configUtils.set({url: 'http://my-ghost-blog.com/'});
                sandbox.stub(settingsCache, 'get').withArgs('icon').returns('/content/images/2017/04/my-icon.png');
                blogIcon.getIconUrl(true).should.eql('http://my-ghost-blog.com/favicon.png');
            });

            it('default ico blog icon', function () {
                configUtils.set({url: 'http://my-ghost-blog.com/'});
                blogIcon.getIconUrl(true).should.eql('http://my-ghost-blog.com/favicon.ico');
            });
        });

        describe('with subdirectory', function () {
            it('custom uploaded ico blog icon', function () {
                sandbox.stub(settingsCache, 'get').withArgs('icon').returns('/content/images/2017/04/my-icon.ico');
                configUtils.set({url: 'http://my-ghost-blog.com/blog'});

                blogIcon.getIconUrl().should.eql('/blog/favicon.ico');
            });

            it('custom uploaded png blog icon', function () {
                sandbox.stub(settingsCache, 'get').withArgs('icon').returns('/content/images/2017/04/my-icon.png');
                configUtils.set({url: 'http://my-ghost-blog.com/blog'});

                blogIcon.getIconUrl().should.eql('/blog/favicon.png');
            });

            it('default ico blog icon', function () {
                configUtils.set({url: 'http://my-ghost-blog.com/blog'});
                blogIcon.getIconUrl().should.eql('/blog/favicon.ico');
            });
        });
    });

    describe('getIconPath', function () {
        it('custom uploaded ico blog icon', function () {
            sandbox.stub(settingsCache, 'get').withArgs('icon').returns('/content/images/2017/04/my-icon.ico');
            blogIcon.getIconPath().should.eql('/2017/04/my-icon.ico');
        });

        it('custom uploaded png blog icon', function () {
            sandbox.stub(settingsCache, 'get').withArgs('icon').returns('/content/images/2017/04/my-icon.png');
            blogIcon.getIconPath().should.eql('/2017/04/my-icon.png');
        });

        it('default ico blog icon', function () {
            blogIcon.getIconPath().should.eql(path.join(__dirname, '../../../server/public/favicon.ico'));
        });

        describe('with subdirectory', function () {
            it('custom uploaded ico blog icon', function () {
                sandbox.stub(settingsCache, 'get').withArgs('icon').returns('/blog/content/images/2017/04/my-icon.ico');
                configUtils.set({url: 'http://my-ghost-blog.com/blog'});

                blogIcon.getIconPath().should.eql('/2017/04/my-icon.ico');
            });

            it('custom uploaded png blog icon', function () {
                sandbox.stub(settingsCache, 'get').withArgs('icon').returns('/blog/content/images/2017/04/my-icon.png');
                configUtils.set({url: 'http://my-ghost-blog.com/blog'});

                blogIcon.getIconPath().should.eql('/2017/04/my-icon.png');
            });

            it('default ico blog icon', function () {
                configUtils.set({url: 'http://my-ghost-blog.com/blog'});
                blogIcon.getIconPath().should.eql(path.join(__dirname, '../../../server/public/favicon.ico'));
            });
        });
    });

    describe('isIcoImageType', function () {
        it('returns true, if icon is .ico filetype', function () {
            blogIcon.isIcoImageType('icon.ico').should.be.true();
        });

        it('returns false, if icon is not .ico filetype', function () {
            blogIcon.isIcoImageType('icon.png').should.be.false();
        });
    });

    describe('getIconType', function () {
        it('returns x-icon for ico icons', function () {
            blogIcon.getIconType('favicon.ico').should.eql('x-icon');
        });

        it('returns png for png icon', function () {
            blogIcon.getIconType('favicon.png').should.eql('png');
        });
    });

    describe('getIconDimensions', function () {
        it('[success] returns .ico dimensions', function (done) {
            blogIcon.getIconDimensions(path.join(__dirname, '../../utils/fixtures/images/favicon.ico'))
                .then(function (result) {
                    should.exist(result);
                    result.should.eql({
                        width: 48,
                        height:48
                    });
                    done();
                }).catch(done);
        });

        it('[success] returns .png dimensions', function (done) {
            blogIcon.getIconDimensions(path.join(__dirname, '../../utils/fixtures/images/favicon.png'))
                .then(function (result) {
                    should.exist(result);
                    result.should.eql({
                        width: 100,
                        height:100
                    });
                    done();
                }).catch(done);
        });

        it('[success] returns .ico dimensions for icon with multiple sizes', function (done) {
            blogIcon.getIconDimensions(path.join(__dirname, '../../utils/fixtures/images/favicon_multi_sizes.ico'))
                .then(function (result) {
                    should.exist(result);
                    result.should.eql({
                        width: 64,
                        height:64
                    });
                    done();
                }).catch(done);
        });

        it('[failure] return error message', function (done) {
            var sizeOfStub = sandbox.stub();

            sizeOfStub.throws({error: 'image-size could not find dimensions'});

            blogIcon.__set__('sizeOf', sizeOfStub);

            blogIcon.getIconDimensions(path.join(__dirname, '../../utils/fixtures/images/favicon_multi_sizes.ico'))
                .catch(function (error) {
                    should.exist(error);
                    error.message.should.eql('Could not fetch icon dimensions.');
                    done();
                });
        });
    });
});