spec/cordova/platform/remove.spec.js

/**
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF 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.
*/

const path = require('node:path');
const fs = require('node:fs');
const events = require('cordova-common').events;
const rewire = require('rewire');
const cordova_util = require('../../../src/cordova/util');
const promiseutil = require('../../../src/util/promise-util');

describe('cordova/platform/remove', function () {
    const projectRoot = '/some/path';
    const cfg_parser_mock = function () {};
    let hooks_mock;
    const package_json_mock = jasmine.createSpyObj('package json mock', ['cordova', 'dependencies']);
    package_json_mock.dependencies = {};
    package_json_mock.cordova = {};

    let platform_remove;

    beforeEach(function () {
        hooks_mock = jasmine.createSpyObj('hooksRunner mock', ['fire']);
        hooks_mock.fire.and.returnValue(Promise.resolve());
        cfg_parser_mock.prototype = jasmine.createSpyObj('config parser mock', ['write', 'getEngines', 'removeEngine']);

        platform_remove = rewire('../../../src/cordova/platform/remove');
        platform_remove.__set__({
            HooksRunner: _ => _,
            npmUninstall: _ => Promise.resolve(''),
            ConfigParser: cfg_parser_mock
        });

        spyOn(fs, 'existsSync').and.returnValue(false);
        spyOn(fs, 'writeFileSync');
        spyOn(cordova_util, 'removePlatformPluginsJson');
        spyOn(events, 'emit');
        spyOn(cordova_util, 'requireNoCache').and.returnValue({});
        cfg_parser_mock.prototype.getEngines.and.returnValue([{ name: 'atari', spec: '^0.0.1' }]);
    });

    describe('error/warning conditions', function () {
        it('should require specifying at least one platform', function () {
            return expectAsync(
                platform_remove('remove', hooks_mock)
            ).toBeRejectedWithError(/No platform\(s\) specified\./);
        });
    });
    describe('happy path (success conditions)', function () {
        it('should fire the before_platform_* hook', function () {
            platform_remove(hooks_mock, projectRoot, ['atari'], { save: true });
            expect(hooks_mock.fire).toHaveBeenCalledWith('before_platform_rm', jasmine.any(Object));
        });

        it('should remove <platform>.json file from plugins directory', function () {
            return platform_remove(hooks_mock, projectRoot, ['atari'], { save: true })
                .then(function () {
                    expect(cordova_util.removePlatformPluginsJson).toHaveBeenCalled();
                });
        });

        it('should remove from config.xml and platforms.json', function () {
            return platform_remove(hooks_mock, projectRoot, ['atari'], { save: true })
                .then(function () {
                    expect(cordova_util.removePlatformPluginsJson).toHaveBeenCalled();
                    expect(cfg_parser_mock.prototype.write).toHaveBeenCalled();
                    expect(events.emit).toHaveBeenCalledWith('log', jasmine.stringMatching(/Removing platform atari from config.xml file/));
                    expect(events.emit).toHaveBeenCalledWith('verbose', jasmine.stringMatching(/Removing platform atari from platforms.json file/));
                });
        });

        it('should remove from package.json', function () {
            package_json_mock.cordova = { platforms: ['atari'] };
            cordova_util.requireNoCache.and.returnValue(package_json_mock);
            spyOn(fs, 'readFileSync').and.returnValue('file');
            fs.existsSync.and.callFake(function (filePath) {
                if (path.basename(filePath) === 'package.json') {
                    return true;
                } else {
                    return false;
                }
            });
            return platform_remove(hooks_mock, projectRoot, ['atari'], { save: true })
                .then(function () {
                    expect(fs.writeFileSync).toHaveBeenCalled();
                    expect(events.emit).toHaveBeenCalledWith('log', jasmine.stringMatching(/Removing atari from cordova.platforms array in package.json/));
                });
        });

        it('fetch should be called', function () {
            spyOn(promiseutil, 'Q_chainmap').and.returnValue(true);
            return platform_remove(hooks_mock, projectRoot, ['atari'], {})
                .then(function () {
                    expect(promiseutil.Q_chainmap).toHaveBeenCalled();
                    expect(hooks_mock.fire).toHaveBeenCalledWith('after_platform_rm', {});
                });
        });

        it('should file the after_platform_* hook', function () {
            return platform_remove(hooks_mock, projectRoot, ['atari'], { save: true })
                .then(function (result) {
                    expect(hooks_mock.fire).toHaveBeenCalledWith('after_platform_rm', Object({ save: true }));
                });
        });
    });
});